# API Catalogar objetos
A API Catalogar objetos descreve os tipos de dados e a API relacionada trabalhar com catálogos no AWS Glue.
**Topics**
+ [API de catálogos](aws-glue-api-catalog-catalogs.md)
+ [API de banco de dados](aws-glue-api-catalog-databases.md)
+ [API de tabela](aws-glue-api-catalog-tables.md)
+ [API de partição](aws-glue-api-catalog-partitions.md)
+ [API de conexões](aws-glue-api-catalog-connections.md)
+ [API User-defined Function](aws-glue-api-catalog-functions.md)
+ [Importar um catálogo do Athena para AWS Glue](aws-glue-api-catalog-migration.md)
# API de catálogos
A API de catálogos descreve as APIs para criar, excluir, localizar, atualizar e listar catálogos.
## Tipos de dados
+ [Estrutura do catálogo](#aws-glue-api-catalog-catalogs-Catalog)
+ [Estrutura CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput)
+ [Estrutura TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog)
+ [Estrutura CatalogPropriedades](#aws-glue-api-catalog-catalogs-CatalogProperties)
+ [Estrutura CatalogPropertiesOutput](#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput)
+ [Estrutura DataLakeAccessProperties](#aws-glue-api-catalog-catalogs-DataLakeAccessProperties)
+ [Estrutura IcebergOptimizationProperties](#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties)
+ [Estrutura DataLakeAccessPropertiesOutput](#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput)
+ [Estrutura IcebergOptimizationPropertiesOutput](#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput)
+ [Estrutura FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog)
## Estrutura do catálogo
O objeto de catálogo representa um agrupamento lógico de bancos de dados no Catálogo de Dados do AWS Glue ou em uma fonte federada. Agora você pode criar um catálogo federado do Redshift ou um catálogo contendo links de recursos para bancos de dados do Redshift em outra conta ou região.
**Campos**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo. Para conceder acesso ao catálogo padrão, esse campo não deve ser fornecido.
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 64 bytes de comprimento e correspondente a [Custom string pattern #25](aws-glue-api-common.md#regex_25).
O nome do catálogo. Não pode ser igual ao ID da conta.
+ `ResourceArn` – String UTF-8.
O nome do recurso da Amazon (ARN) atribuído ao recurso de catálogo.
+ `Description`: string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
String de descrição com não mais de 2.048 bytes de comprimento que corresponde ao padrão de string com várias linhas do endereço URI. Uma descrição do catálogo.
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Um array de mapa de pares de chave-valor que definem parâmetros e propriedades do catálogo.
+ `CreateTime` – Timestamp.
A hora em que o catálogo foi criado.
+ `UpdateTime` – Timestamp.
A hora em que o catálogo foi atualizado pela última vez.
+ `TargetRedshiftCatalog` – Um objeto [TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog).
Um objeto `TargetRedshiftCatalog` que descreve um catálogo de destino para vinculação de recursos de banco de dados.
+ `FederatedCatalog` – Um objeto [FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog).
Um objeto `FederatedCatalog` que aponta para uma entidade fora do Catálogo de Dados do AWS Glue.
+ `CatalogProperties` – Um objeto [CatalogPropertiesOutput](#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput).
Um objeto `CatalogProperties` que especifica propriedades de acesso ao data lake e outras propriedades personalizadas.
+ `CreateTableDefaultPermissions`: um array de objetos [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions).
Uma matriz de objetos `PrincipalPermissions`. Cria um conjunto de permissões padrão nas tabelas para as entidades principais. Usado pelo AWS Lake Formation. Não usado no curso normal de operações do AWS Glue.
+ `CreateDatabaseDefaultPermissions`: um array de objetos [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions).
Uma matriz de objetos `PrincipalPermissions`. Cria um conjunto de permissões padrão nos bancos de dados para as entidades principais. Usado pelo AWS Lake Formation. Não usado no curso normal de operações do AWS Glue.
+ `AllowFullTableExternalDataAccess` – string UTF-8 (valores válidos: `True` \$1 `False`).
Permite o acesso de mecanismos de entidades externas aos dados contidos nos locais do Amazon S3 registrados no Lake Formation.
## Estrutura CatalogInput
Uma estrutura que descreve as propriedades do catálogo.
**Campos**
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
String de descrição com não mais de 2.048 bytes de comprimento que corresponde ao padrão de string com várias linhas do endereço URI. Uma descrição do catálogo.
+ `FederatedCatalog` – Um objeto [FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog).
Um objeto `FederatedCatalog`. Uma estrutura `FederatedCatalog` que faz referência a uma entidade fora do Catálogo de Dados do AWS Glue, por exemplo, um banco de dados do Redshift.
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Um array de mapa de pares de chave-valor que definem os parâmetros e as propriedades do catálogo.
+ `TargetRedshiftCatalog` – Um objeto [TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog).
Um objeto `TargetRedshiftCatalog` que descreve um catálogo de destino para vinculação de recursos.
+ `CatalogProperties` – Um objeto [CatalogProperties](#aws-glue-api-catalog-catalogs-CatalogProperties).
Um objeto `CatalogProperties` que especifica propriedades de acesso ao data lake e outras propriedades personalizadas.
+ `CreateTableDefaultPermissions`: um array de objetos [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions).
Uma matriz de objetos `PrincipalPermissions`. Cria um conjunto de permissões padrão nas tabelas para as entidades principais. Usado pelo AWS Lake Formation. Normalmente, deve ser definido explicitamente como uma lista vazia.
+ `CreateDatabaseDefaultPermissions`: um array de objetos [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions).
Uma matriz de objetos `PrincipalPermissions`. Cria um conjunto de permissões padrão nos bancos de dados para as entidades principais. Usado pelo AWS Lake Formation. Normalmente, deve ser definido explicitamente como uma lista vazia.
+ `AllowFullTableExternalDataAccess` – string UTF-8 (valores válidos: `True` \$1 `False`).
Permite o acesso de mecanismos de entidades externas aos dados contidos nos locais do Amazon S3 registrados no Lake Formation.
## Estrutura TargetRedshiftCatalog
Uma estrutura descreve um catálogo de destino para vinculação de recursos.
**Campos**
+ `CatalogArn` – *Obrigatório:* string UTF-8.
O Nome do recurso da Amazon (ARN) do recurso de catálogo.
## Estrutura CatalogPropriedades
Uma estrutura que especifica propriedades de acesso ao data lake e outras propriedades personalizadas.
**Campos**
+ `DataLakeAccessProperties` – Um objeto [DataLakeAccessProperties](#aws-glue-api-catalog-catalogs-DataLakeAccessProperties).
Um objeto `DataLakeAccessProperties` que especifica propriedades para configurar o acesso ao data lake para seu recurso de catálogo no Catálogo de Dados do AWS Glue.
+ `IcebergOptimizationProperties` – Um objeto [IcebergOptimizationProperties](#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties).
Uma estrutura que especifica as propriedades de otimização da tabela do Iceberg para o catálogo. Isso inclui a configuração para operações de compactação, retenção e exclusão de arquivos órfãos que podem ser aplicadas às tabelas do Iceberg nesse catálogo.
+ `CustomProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Propriedades adicionais de chave-valor para o catálogo, como otimizações de estatísticas de colunas.
## Estrutura CatalogPropertiesOutput
Atributos de propriedade que incluem propriedades de configuração para o recurso do catálogo.
**Campos**
+ `DataLakeAccessProperties` – Um objeto [DataLakeAccessPropertiesOutput](#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput).
Um objeto `DataLakeAccessProperties` com propriedades de entrada para configurar o acesso ao data lake para seu recurso de catálogo no Catálogo de Dados do AWS Glue.
+ `IcebergOptimizationProperties` – Um objeto [IcebergOptimizationPropertiesOutput](#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput).
Um objeto `IcebergOptimizationPropertiesOutput` que especifica configurações de otimização de tabelas do Iceberg para o catálogo, incluindo configurações para operações de compactação, retenção e exclusão de arquivos órfãos.
+ `CustomProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Propriedades adicionais de chave-valor para o catálogo, como otimizações de estatísticas de colunas.
## Estrutura DataLakeAccessProperties
Propriedades de entrada para configurar o acesso ao data lake para seu recurso de catálogo no Catálogo de Dados do AWS Glue.
**Campos**
+ `DataLakeAccess` – Booleano.
Ativa ou desativa o acesso ao data lake para aplicações Apache Spark que acessam bancos de dados do Amazon Redshift no Catálogo de Dados por meio de qualquer mecanismo diferente do Redshift, como Amazon Athena, Amazon EMR ou AWS Glue ETL.
+ `DataTransferRole` – String UTF-8 correspondente a [Custom string pattern #53](aws-glue-api-common.md#regex_53).
Um perfil que será assumido pelo AWS Glue para transferir dados para dentro/fora do bucket de preparação durante uma consulta.
+ `KmsKey` – String UTF-8.
Uma chave de criptografia que será usada para o bucket de preparação que será criado junto com o catálogo.
+ `CatalogType` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Especifica um tipo de catálogo federado para o recurso de catálogo nativo. No momento, o único tipo compatível é `aws:redshift`.
## Estrutura IcebergOptimizationProperties
Uma estrutura que especifica as propriedades de otimização da tabela do Iceberg para o catálogo, incluindo configurações para operações de compactação, retenção e exclusão de arquivos órfãos.
**Campos**
+ `RoleArn` – String UTF-8 correspondente a [Custom string pattern #53](aws-glue-api-common.md#regex_53).
O Nome do recurso da Amazon (ARN) do perfil do IAM que será assumido para executar operações de otimização da tabela do Iceberg.
+ `Compaction` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Um mapa de pares de chave/valor que especificam parâmetros de configuração para operações de compactação da tabela do Iceberg, que otimizam o layout dos arquivos de dados para melhorar a performance da consulta.
+ `Retention` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Um mapa de pares de chave/valor que especificam parâmetros de configuração para operações de retenção da tabela do Iceberg, que gerencia o ciclo de vida dos snapshots da tabela para controlar os custos de armazenamento.
+ `OrphanFileDeletion` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Um mapa de pares de chave/valor que especificam parâmetros de configuração para operações de exclusão de arquivos órfãos do Iceberg, que identificam e removem arquivos que não são mais referenciados pelos metadados da tabela.
## Estrutura DataLakeAccessPropertiesOutput
As propriedades de saída da configuração de acesso ao data lake para seu recurso de catálogo no Catálogo de Dados do AWS Glue.
**Campos**
+ `DataLakeAccess` – Booleano.
Ativa ou desativa o acesso ao data lake para aplicações Apache Spark que acessam bancos de dados do Amazon Redshift no Catálogo de Dados.
+ `DataTransferRole` – String UTF-8 correspondente a [Custom string pattern #53](aws-glue-api-common.md#regex_53).
Um perfil que será assumido pelo AWS Glue para transferir dados para dentro/fora do bucket de preparação durante uma consulta.
+ `KmsKey` – String UTF-8.
Uma chave de criptografia que será usada para o bucket de preparação que será criado junto com o catálogo.
+ `ManagedWorkgroupName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome computacional do Redshift sem servidor gerenciado criado para seu recurso de catálogo.
+ `ManagedWorkgroupStatus` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O status computacional do Redshift sem servidor gerenciado.
+ `RedshiftDatabaseName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do recurso de banco de dados do Redshift padrão na computação gerenciada.
+ `StatusMessage` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Uma mensagem que fornece informações mais detalhadas sobre o status do grupo de trabalho gerenciado.
+ `CatalogType` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Especifica um tipo de catálogo federado para o recurso de catálogo nativo. No momento, o único tipo compatível é `aws:redshift`.
## Estrutura IcebergOptimizationPropertiesOutput
Uma estrutura que contém as propriedades de saída da configuração de otimização da tabela do Iceberg para o recurso do catálogo no Catálogo de Dados do AWS Glue.
**Campos**
+ `RoleArn` – String UTF-8 correspondente a [Custom string pattern #53](aws-glue-api-common.md#regex_53).
O Nome do recurso da Amazon (ARN) do perfil do IAM que é assumido para executar operações de otimização da tabela do Iceberg.
+ `Compaction` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Um mapa de pares de chave/valor que especificam parâmetros de configuração para operações de compactação da tabela do Iceberg, que otimizam o layout dos arquivos de dados para melhorar a performance da consulta.
+ `Retention` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Um mapa de pares de chave/valor que especificam parâmetros de configuração para operações de retenção da tabela do Iceberg, que gerencia o ciclo de vida dos snapshots da tabela para controlar os custos de armazenamento.
+ `OrphanFileDeletion` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Um mapa de pares de chave/valor que especificam parâmetros de configuração para operações de exclusão de arquivos órfãos do Iceberg, que identificam e removem arquivos que não são mais referenciados pelos metadados da tabela.
+ `LastUpdatedTime` – Timestamp.
A data e hora em que as propriedades de otimização do Iceberg foram atualizadas pela última vez.
## Estrutura FederatedCatalog
Um catálogo que aponta para uma entidade fora do Catálogo de Dados do AWS Glue.
**Campos**
+ `Identifier`: string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Um identificador exclusivo para o catálogo federado.
+ `ConnectionName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da conexão com uma fonte de dados externa, por exemplo, um catálogo federado do Redshift.
+ `ConnectionType` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O tipo de conexão usado para acessar o catálogo federado, especificando o protocolo ou método para conexão com a fonte de dados externa.
## Operações
+ [Ação CreateCatalog (Python: create\$1catalog)](#aws-glue-api-catalog-catalogs-CreateCatalog)
+ [Ação UpdateCatalog (Python: update\$1catalog)](#aws-glue-api-catalog-catalogs-UpdateCatalog)
+ [Ação DeleteCatalog (Python: delete\$1catalog)](#aws-glue-api-catalog-catalogs-DeleteCatalog)
+ [Ação GetCatalog (Python: get\$1catalog)](#aws-glue-api-catalog-catalogs-GetCatalog)
+ [Ação GetCatalogs (Python: get\$1catalogs)](#aws-glue-api-catalog-catalogs-GetCatalogs)
## Ação CreateCatalog (Python: create\$1catalog)
Cria um novo catálogo no Catálogo de Dados do AWS Glue.
**Solicitação**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 64 bytes de comprimento e correspondente a [Custom string pattern #25](aws-glue-api-common.md#regex_25).
O nome do catálogo a ser criado.
+ `CatalogInput` – *Obrigatório:* um objeto [CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput).
Um objeto `CatalogInput` que define os metadados do catálogo.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais que 50 pares.
Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes.
Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento.
Um array de mapa dos pares de chave-valor contendo não mais que 50 pares. Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes. Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento. As tags que você atribui ao catálogo.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederatedResourceAlreadyExistsException`
+ `FederationSourceException`
## Ação UpdateCatalog (Python: update\$1catalog)
Atualiza as propriedades de um catálogo existente no Catálogo de Dados do AWS Glue.
**Solicitação**
+ `CatalogId` – *Obrigatório*: string de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo.
+ `CatalogInput` – *Obrigatório:* um objeto [CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput).
Um objeto `CatalogInput` que especifica as novas propriedades de um catálogo existente.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `FederationSourceException`
## Ação DeleteCatalog (Python: delete\$1catalog)
Remove o catálogo especificado do Catálogo de Dados do AWS Glue.
Depois de concluir essa operação, você não terá mais acesso aos bancos de dados, às tabelas (e a todas as versões de tabela e partições que podem pertencer às tabelas) e às funções definidas pelo usuário no catálogo excluído. O AWS Glue exclui esses recursos "órfãos" de forma assíncrona e pontual, a critério do serviço.
Para garantir exclusão imediata de todos os recursos relacionados, antes de chamar a operação `DeleteCatalog`, use `DeleteTableVersion` (ou `BatchDeleteTableVersion`), `DeletePartition` (ou `BatchDeletePartition`), `DeleteTable` (ou `BatchDeleteTable`), `DeleteUserDefinedFunction` e `DeleteDatabase` para excluir qualquer recurso que pertence à tabela.
**Solicitação**
+ `CatalogId` – *Obrigatório*: string de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `FederationSourceException`
## Ação GetCatalog (Python: get\$1catalog)
O nome do catálogo a ser recuperado. O nome deve ser totalmente em minúsculas.
**Solicitação**
+ `CatalogId` – *Obrigatório*: string de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo pai em que o catálogo reside. Se nenhum for fornecido, o número da conta da AWS será usado por padrão.
**Resposta**
+ `Catalog` – Um objeto [Catálogo](#aws-glue-api-catalog-catalogs-Catalog).
Um objeto `Catalog`. A definição do catálogo especificado no Catálogo de Dados do AWS Glue.
**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## Ação GetCatalogs (Python: get\$1catalogs)
Recupera todos os catálogos definidos em um catálogo no Catálogo de Dados do AWS Glue. Para um caso de uso de catálogo federado do Redshift, essa operação retorna a lista de catálogos mapeados em bancos de dados do Redshift no catálogo de namespaces do Redshift.
**Solicitação**
+ `ParentCatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo pai em que o catálogo reside. Se nenhum for fornecido, o número da conta da AWS será usado por padrão.
+ `NextToken` – String UTF-8.
Um token de continuação, se esta for uma chamada de continuação.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.
O número máximo de catálogos a ser retornado em uma resposta.
+ `Recursive` – Booleano.
Determina se todos os catálogos existentes na hierarquia de catálogos devem ser listados, começando pelo `ParentCatalogId`. O padrão é `false` . Caso o valor seja `true`, a resposta incluirá a enumeração de todos os objetos de catálogo na hierarquia do `ParentCatalogID`.
+ `IncludeRoot` – Booleano.
Determina se o catálogo padrão, associado à conta e à região, deve ser incluído na listagem retornada. O padrão é `false`. Caso o valor seja `true` e `ParentCatalogId = NULL | AWS Account ID`, a resposta incluirá a enumeração de todos os catálogos, incluindo o catálogo padrão.
Caso o `ParentCatalogId` não seja nulo e este atributo seja informado como `false` ou `true`, será gerada uma exceção do tipo `InvalidInputException`.
**Resposta**
+ `CatalogList` – *Obrigatório:* uma matriz de objetos [Catálogo](#aws-glue-api-catalog-catalogs-Catalog).
Uma matriz de objetos `Catalog`. Uma lista de objetos `Catalog` do catálogo pai especificado.
+ `NextToken` – String UTF-8.
Um token de continuação para paginação da lista de tokens retornada, retornado se o segmento atual da lista não for o último.
**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
# API de banco de dados
O Banco de dados da API descreve os tipos de dados do banco de dados e inclui a API para criar, excluir, localizar, atualizar e listar bancos de dados.
## Tipos de dados
+ [Estrutura Database](#aws-glue-api-catalog-databases-Database)
+ [Estrutura DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput)
+ [Estrutura PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions)
+ [Estrutura DataLakePrincipal](#aws-glue-api-catalog-databases-DataLakePrincipal)
+ [Estrutura DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier)
+ [Estrutura FederatedDatabase](#aws-glue-api-catalog-databases-FederatedDatabase)
## Estrutura Database
O objeto `Database` representa um agrupamento lógico de tabelas que podem residir em uma metastore do Hive ou um RDBMS.
**Campos**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados. Para a compatibilidade com o Hive, as letras são transformadas em minúsculas quando a tabela é armazenada.
+ `Description`: string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma descrição do banco de dados.
+ `LocationUri` – URI (Uniform Resource Identifier), maior que 1 ou maior que 1024 bytes de comprimento, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
A localização do banco de dados (por exemplo, um caminho de HDFS).
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Esses pares de chave/valor definem parâmetros e propriedades do banco de dados.
+ `CreateTime` – Timestamp.
A hora em que o banco de dados de metadados foi criado no catálogo.
+ `CreateTableDefaultPermissions`: um array de objetos [PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions).
Cria um conjunto de permissões padrão na tabela para as entidades principais. Usado pelo AWS Lake Formation. Não usado no curso normal de operações do AWS Glue.
+ `TargetDatabase` – Um objeto [DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier).
Uma estrutura de `DatabaseIdentifier` que descreve um banco de dados de destino para vinculação de recursos.
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que o banco de dados reside.
+ `FederatedDatabase` – Um objeto [FederatedDatabase](#aws-glue-api-catalog-databases-FederatedDatabase).
Uma estrutura `FederatedDatabase` que referencia uma entidade fora do AWS Glue Data Catalog.
## Estrutura DatabaseInput
A estrutura usada para criar ou atualizar um banco de dados.
**Campos**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados. Para a compatibilidade com o Hive, as letras são transformadas em minúsculas quando a tabela é armazenada.
+ `Description`: string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma descrição do banco de dados.
+ `LocationUri` – URI (Uniform Resource Identifier), maior que 1 ou maior que 1024 bytes de comprimento, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
A localização do banco de dados (por exemplo, um caminho de HDFS).
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Esses pares de chave/valor definem parâmetros e propriedades do banco de dados.
Esses pares de chave/valor definem parâmetros e propriedades do banco de dados.
+ `CreateTableDefaultPermissions`: um array de objetos [PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions).
Cria um conjunto de permissões padrão na tabela para as entidades principais. Usado pelo AWS Lake Formation. Não usado no curso normal de operações do AWS Glue.
+ `TargetDatabase` – Um objeto [DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier).
Uma estrutura de `DatabaseIdentifier` que descreve um banco de dados de destino para vinculação de recursos.
+ `FederatedDatabase` – Um objeto [FederatedDatabase](#aws-glue-api-catalog-databases-FederatedDatabase).
Uma estrutura `FederatedDatabase` que referencia uma entidade fora do AWS Glue Data Catalog.
## Estrutura PrincipalPermissions
Permissões concedidas a uma entidade principal.
**Campos**
+ `Principal` – Um objeto [DataLakePrincipal](#aws-glue-api-catalog-databases-DataLakePrincipal).
A entidade principal que recebe permissões.
+ `Permissions` – Uma matriz de strings UTF-8.
As permissões que são concedidas à entidade principal.
## Estrutura DataLakePrincipal
A entidade principal do AWS Lake Formation.
**Campos**
+ `DataLakePrincipalIdentifier`: string UTF-8, não menos do que 1 ou superior a 255 bytes de comprimento.
Um identificador para a entidade principal do AWS Lake Formation.
## Estrutura DatabaseIdentifier
Uma estrutura de que descreve um banco de dados de destino para vinculação de recursos.
**Campos**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que o banco de dados reside.
+ `DatabaseName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados do catálogo.
+ `Region` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Região do banco de dados de destino.
## Estrutura FederatedDatabase
Um banco de dados que aponta para uma entidade fora do AWS Glue Data Catalog.
**Campos**
+ `Identifier`: string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Um identificador exclusivo do banco de dados federado.
+ `ConnectionName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da conexão com o metastore externo.
+ `ConnectionType` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O tipo de conexão usado para acessar o banco de dados federado, como JDBC, ODBC ou outros protocolos de conexão compatíveis.
## Operações
+ [Ação CreateDatabase (Python: create\$1database)](#aws-glue-api-catalog-databases-CreateDatabase)
+ [Ação UpdateDatabase (Python: update\$1database)](#aws-glue-api-catalog-databases-UpdateDatabase)
+ [Ação DeleteDatabase (Python: delete\$1database)](#aws-glue-api-catalog-databases-DeleteDatabase)
+ [Ação GetDatabase (Python: get\$1database)](#aws-glue-api-catalog-databases-GetDatabase)
+ [Ação GetDatabases (Python: get\$1databases)](#aws-glue-api-catalog-databases-GetDatabases)
## Ação CreateDatabase (Python: create\$1database)
Cria um novo banco de dados em um catálogo de dados.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que o banco de dados será criado. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseInput` – *Obrigatório:* um objeto [DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput).
Os metadados para o banco de dados.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais que 50 pares.
Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes.
Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento.
As tags que você atribui ao banco de dados.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `FederatedResourceAlreadyExistsException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## Ação UpdateDatabase (Python: update\$1database)
Atualiza uma definição de banco de dados existente no catálogo de dados.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que o banco de dados de metadados reside. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados a ser atualizado no catálogo. Para a compatibilidade com o Hive, as letras são transformadas em minúsculas.
+ `DatabaseInput` – *Obrigatório:* um objeto [DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput).
Um objeto `DatabaseInput` que especifica a nova definição do banco de dados de metadados no catálogo.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
+ `AlreadyExistsException`
## Ação DeleteDatabase (Python: delete\$1database)
Remove um banco de dados especificado de um Catálogo de dados.
**nota**
Depois de concluir essa operação, você não terá mais acesso às tabelas (e a todas as versões de tabela e partições que podem pertencer às tabelas) e às funções definidas pelo usuário no banco de dados excluído. O AWS Glue exclui esses recursos “órfãos” de forma assíncrona e pontual, a critério do serviço.
Para garantir exclusão imediata de todos os recursos relacionados, antes de chamar `DeleteDatabase`, use `DeleteTableVersion` ou `BatchDeleteTableVersion`, `DeletePartition` ou `BatchDeletePartition`, `DeleteUserDefinedFunction`, e `DeleteTable` ou `BatchDeleteTable`, para excluir qualquer recurso que pertence à tabela.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que o banco de dados reside. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados a ser excluído. Para a compatibilidade com o Hive, ele deve ser todo inserido em letras minúsculas.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## Ação GetDatabase (Python: get\$1database)
Recupera a definição de um banco de dados especificado.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que o banco de dados reside. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados a ser recuperado. Para a compatibilidade com o Hive, ele deve ser inserido todo em letras minúsculas.
**Resposta**
+ `Database` – Um objeto [Banco de dados](#aws-glue-api-catalog-databases-Database).
A definição do banco de dados especificado no Catálogo de dados.
**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## Ação GetDatabases (Python: get\$1databases)
Recupera todos os bancos de dados definidos em determinado Catálogo de dados.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados de onde `Databases` será recuperado. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `NextToken` – String UTF-8.
Um token de continuação, se esta for uma chamada de continuação.
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 100.
O número máximo de bancos de dados a ser retornado em uma resposta.
+ `ResourceShareType` – String UTF-8 (valores válidos: `FOREIGN` \$1 `ALL` \$1 `FEDERATED`).
Permite que você especifique que deseja listar os bancos de dados compartilhados com sua conta. Os valores permitidos são `FEDERATED`, `FOREIGN` ou `ALL`.
+ Se definido como `FEDERATED`, listará os bancos de dados federados (que referenciam uma entidade externa) compartilhados com sua conta.
+ Se definido como `FOREIGN`, listará os bancos de dados compartilhados com sua conta.
+ Se definido como `ALL`, listará os bancos de dados compartilhados com sua conta, bem como os bancos de dados em sua conta local.
+ `AttributesToGet` – Uma matriz de strings UTF-8.
Especifica os campos do banco de dados retornados pela chamada `GetDatabases`. Esse parâmetro não aceita uma lista vazia. A solicitação deve incluir o `NAME`.
**Resposta**
+ `DatabaseList` – *Obrigatório:* uma matriz de objetos [Banco de dados](#aws-glue-api-catalog-databases-Database).
Uma lista de objetos `Database` do catálogo especificado.
+ `NextToken` – String UTF-8.
Um token de continuação para paginação da lista de tokens retornada, retornado se o segmento atual da lista não for o último.
**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
# API de tabela
A Tabela da API descreve os tipos de dados e operações associadas a tabelas.
## Tipos de dados
+ [Estrutura Table](#aws-glue-api-catalog-tables-Table)
+ [Estrutura TableInput](#aws-glue-api-catalog-tables-TableInput)
+ [Estrutura FederatedTable](#aws-glue-api-catalog-tables-FederatedTable)
+ [Estrutura da coluna](#aws-glue-api-catalog-tables-Column)
+ [Estrutura StorageDescriptor](#aws-glue-api-catalog-tables-StorageDescriptor)
+ [Estrutura SchemaReference](#aws-glue-api-catalog-tables-SchemaReference)
+ [Estrutura SerDeInfo](#aws-glue-api-catalog-tables-SerDeInfo)
+ [Estrutura Order](#aws-glue-api-catalog-tables-Order)
+ [Estrutura SkewedInfo](#aws-glue-api-catalog-tables-SkewedInfo)
+ [Estrutura TableVersion](#aws-glue-api-catalog-tables-TableVersion)
+ [Estrutura TableError](#aws-glue-api-catalog-tables-TableError)
+ [Estrutura TableVersionError](#aws-glue-api-catalog-tables-TableVersionError)
+ [Estrutura SortCriterion](#aws-glue-api-catalog-tables-SortCriterion)
+ [Estrutura TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier)
+ [Estrutura KeySchemaElement](#aws-glue-api-catalog-tables-KeySchemaElement)
+ [Estrutura PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex)
+ [Estrutura PartitionIndexDescriptor](#aws-glue-api-catalog-tables-PartitionIndexDescriptor)
+ [Estrutura BackfillError](#aws-glue-api-catalog-tables-BackfillError)
+ [Estrutura IcebergInput](#aws-glue-api-catalog-tables-IcebergInput)
+ [Estrutura OpenTableFormatInput](#aws-glue-api-catalog-tables-OpenTableFormatInput)
+ [Estrutura ViewDefinition](#aws-glue-api-catalog-tables-ViewDefinition)
+ [Estrutura ViewDefinitionInput](#aws-glue-api-catalog-tables-ViewDefinitionInput)
+ [Estrutura ViewRepresentation](#aws-glue-api-catalog-tables-ViewRepresentation)
+ [Estrutura ViewRepresentationInput](#aws-glue-api-catalog-tables-ViewRepresentationInput)
+ [Estrutura UpdateOpenTableFormatInput](#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput)
+ [Estrutura UpdateIcebergInput](#aws-glue-api-catalog-tables-UpdateIcebergInput)
+ [Estrutura CreateIcebergTableInput](#aws-glue-api-catalog-tables-CreateIcebergTableInput)
+ [Estrutura UpdateIcebergTableInput](#aws-glue-api-catalog-tables-UpdateIcebergTableInput)
+ [Estrutura IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder)
+ [Estrutura IcebergSortField](#aws-glue-api-catalog-tables-IcebergSortField)
+ [Estrutura IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec)
+ [Estrutura IcebergPartitionField](#aws-glue-api-catalog-tables-IcebergPartitionField)
+ [Estrutura IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema)
+ [Estrutura IcebergStructField](#aws-glue-api-catalog-tables-IcebergStructField)
+ [Estrutura IcebergTableUpdate](#aws-glue-api-catalog-tables-IcebergTableUpdate)
+ [Esrtutura AuditContext](#aws-glue-api-catalog-tables-AuditContext)
## Estrutura Table
Representa uma coleção de dados relacionados, organizados em colunas e linhas.
**Campos**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela. Para a compatibilidade com o Hive, ele deve ser inserido todo em letras minúsculas.
+ `DatabaseName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados no qual os metadados da tabela residem. Para a compatibilidade com o Hive, ele deve ser todo inserido em letras minúsculas.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
A descrição da tabela.
+ `Owner` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O proprietário da tabela.
+ `CreateTime` – Timestamp.
A hora em que a definição da tabela foi criada no Catálogo de dados.
+ `UpdateTime` – Timestamp.
A última vez que a tabela foi atualizada.
+ `LastAccessTime` – Timestamp.
A última vez que a tabela foi acessada. Ela geralmente é extraída do HDFS e pode não ser confiável.
+ `LastAnalyzedTime` – Timestamp.
A última vez em que as estatísticas de colunas foram calculadas para esta tabela.
+ `Retention` – Número (inteiro), não mais do que None (Nenhum).
O tempo de retenção para esta tabela.
+ `StorageDescriptor` – Um objeto [StorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor).
Um descritor de armazenamento contendo informações sobre o armazenamento físico desta tabela.
+ `PartitionKeys`: um array de objetos [Coluna](#aws-glue-api-catalog-tables-Column).
Uma lista de colunas pela qual a tabela é particionada. Apenas os tipos primitivos são compatíveis como chaves de partição.
Ao criar uma tabela usada pelo Amazon Athena, e você não especificar nenhum `partitionKeys`, você deve definir pelo menos o valor de `partitionKeys` para uma lista vazia. Por exemplo:
`"PartitionKeys": []`
+ `ViewOriginalText` – String UTF-8 com comprimento não superior a 409.600 bytes.
Incluído para compatibilidade com o Apache Hive. Não usado no curso normal de operações do AWS Glue. Se a tabela for uma `VIRTUAL_VIEW`, algumas configurações do Athena serão codificadas em base64.
+ `ViewExpandedText` – String UTF-8 com comprimento não superior a 409.600 bytes.
Incluído para compatibilidade com o Apache Hive. Não usado no curso normal de operações do AWS Glue.
+ `TableType` – String UTF-8 com comprimento não superior a 255 bytes.
O tipo dessa tabela. O AWS Glue criará tabelas com o tipo `EXTERNAL_TABLE`. Outros serviços, como o Athena, poderão criar tabelas com tipos adicionais de tabela.
Tipos de tabela relacionados ao AWS Glue:
EXTERNAL\$1TABLE
Atributo compatível com o Hive: indica uma tabela não gerenciada pelo Hive.
GOVERNED
Usado pelo AWS Lake Formation. O AWS Glue Data Catalog entende `GOVERNED`.
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Esses pares de chave/valor definem propriedades associadas com a tabela.
+ `CreatedBy` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
A pessoa ou entidade que criou a tabela.
+ `IsRegisteredWithLakeFormation` – Booleano.
Indica se a tabela foi registrada com o AWS Lake Formation.
+ `TargetTable` – Um objeto [TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier).
Uma estrutura de `TableIdentifier` que descreve uma tabela de destino para vinculação de recursos.
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que a tabela reside.
+ `VersionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID da versão da tabela.
+ `FederatedTable` – Um objeto [FederatedTable](#aws-glue-api-catalog-tables-FederatedTable).
Uma estrutura `FederatedTable` que referencia uma entidade fora do AWS Glue Data Catalog.
+ `ViewDefinition` – Um objeto [ViewDefinition](#aws-glue-api-catalog-tables-ViewDefinition).
Uma estrutura que contém todas as informações que definem a visualização, incluindo o dialeto ou dialetos da visualização e a consulta.
+ `IsMultiDialectView` – Booleano.
Especifica se a visualização oferece suporte aos dialetos SQL de um ou mais mecanismos de consulta diferentes e, portanto, que ela pode ser lida por esses mecanismos.
## Estrutura TableInput
Uma estrutura usado para definir uma tabela.
**Campos**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela. Para a compatibilidade com o Hive, as letras são transformadas em minúsculas quando a tabela é armazenada.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
A descrição da tabela.
+ `Owner` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O proprietário da tabela. Incluído para compatibilidade com o Apache Hive. Não usado no curso normal de operações do AWS Glue.
+ `LastAccessTime` – Timestamp.
A última vez que a tabela foi acessada.
+ `LastAnalyzedTime` – Timestamp.
A última vez em que as estatísticas de colunas foram calculadas para esta tabela.
+ `Retention` – Número (inteiro), não mais do que None (Nenhum).
O tempo de retenção para esta tabela.
+ `StorageDescriptor` – Um objeto [StorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor).
Um descritor de armazenamento contendo informações sobre o armazenamento físico desta tabela.
+ `PartitionKeys`: um array de objetos [Coluna](#aws-glue-api-catalog-tables-Column).
Uma lista de colunas pela qual a tabela é particionada. Apenas os tipos primitivos são compatíveis como chaves de partição.
Ao criar uma tabela usada pelo Amazon Athena, e você não especificar nenhum `partitionKeys`, você deve definir pelo menos o valor de `partitionKeys` para uma lista vazia. Por exemplo:
`"PartitionKeys": []`
+ `ViewOriginalText` – String UTF-8 com comprimento não superior a 409.600 bytes.
Incluído para compatibilidade com o Apache Hive. Não usado no curso normal de operações do AWS Glue. Se a tabela for uma `VIRTUAL_VIEW`, algumas configurações do Athena serão codificadas em base64.
+ `ViewExpandedText` – String UTF-8 com comprimento não superior a 409.600 bytes.
Incluído para compatibilidade com o Apache Hive. Não usado no curso normal de operações do AWS Glue.
+ `TableType` – String UTF-8 com comprimento não superior a 255 bytes.
O tipo dessa tabela. O AWS Glue criará tabelas com o tipo `EXTERNAL_TABLE`. Outros serviços, como o Athena, poderão criar tabelas com tipos adicionais de tabela.
Tipos de tabela relacionados ao AWS Glue:
EXTERNAL\$1TABLE
Atributo compatível com o Hive: indica uma tabela não gerenciada pelo Hive.
GOVERNED
Usado pelo AWS Lake Formation. O AWS Glue Data Catalog entende `GOVERNED`.
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Esses pares de chave/valor definem propriedades associadas com a tabela.
+ `TargetTable` – Um objeto [TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier).
Uma estrutura de `TableIdentifier` que descreve uma tabela de destino para vinculação de recursos.
+ `ViewDefinition` – Um objeto [ViewDefinitionInput](#aws-glue-api-catalog-tables-ViewDefinitionInput).
Uma estrutura que contém todas as informações que definem a visualização, incluindo o dialeto ou dialetos da visualização e a consulta.
## Estrutura FederatedTable
Uma tabela que aponta para uma entidade fora do AWS Glue Data Catalog.
**Campos**
+ `Identifier` – string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Um identificador exclusivo da tabela federada.
+ `DatabaseIdentifier` – string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Um identificador exclusivo do banco de dados federado.
+ `ConnectionName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da conexão com o metastore externo.
+ `ConnectionType` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O tipo de conexão usada para acessar a tabela federada, especificando o protocolo ou método de conexão com a fonte de dados externa.
## Estrutura da coluna
Uma coluna em uma `Table`.
**Campos**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da `Column`.
+ `Type` – String UTF-8 com comprimento não superior a 131.072 bytes, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O tipo de dados da `Column`.
+ `Comment` – String de comentário, inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Um comentário de texto livre.
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Esses pares de chave-valor definem propriedades associadas à coluna.
## Estrutura StorageDescriptor
Descreve o armazenamento físico dos dados da tabela.
**Campos**
+ `Columns`: um array de objetos [Coluna](#aws-glue-api-catalog-tables-Column).
Uma lista de `Columns` na tabela.
+ `Location` – String de local, inferior a 2056 bytes de comprimento, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
A localização física da tabela. Por padrão, assume o formato da localização do warehouse, seguida pela localização do banco de dados no warehouse, seguida pelo nome da tabela.
+ `AdditionalLocations` – Uma matriz de strings UTF-8.
Uma lista de locais que apontam para o caminho onde uma tabela do Delta está localizada.
+ `InputFormat` – String de formato, inferior a 128 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O formato de entrada: `SequenceFileInputFormat` (binário), `TextInputFormat` ou um formato personalizado.
+ `OutputFormat` – String de formato, inferior a 128 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O formato de saída: `SequenceFileOutputFormat` (binário), `IgnoreKeyTextOutputFormat` ou um formato personalizado.
+ `Compressed` – Booleano.
`True` se os dados da tabela estiverem compactados, ou `False` se não estiverem.
+ `NumberOfBuckets` – Número (íntegro).
Você deverá especificar se a tabela contiver qualquer coluna de dimensão.
+ `SerdeInfo` – Um objeto [SerDeInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SerDeInfo).
As informações de serialização/desserialização (SerDe).
+ `BucketColumns` – Uma matriz de strings UTF-8.
Uma lista de colunas de agrupamento, armazenamento em clusters e armazenamento em buckets de reducers na tabela.
+ `SortColumns`: um array de objetos [Ordem](#aws-glue-api-catalog-tables-Order).
Uma lista que especifica a ordem de classificação de cada bucket na tabela.
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
As propriedades fornecidas pelo usuário em formato de chave/valor.
+ `SkewedInfo` – Um objeto [SkewedInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SkewedInfo).
As informações sobre valores que aparecem com frequência em uma coluna (valores distorcidos).
+ `StoredAsSubDirectories` – Booleano.
`True`, se os dados na tabela estiverem armazenados em subdiretórios, ou `False`, caso contrário.
+ `SchemaReference` – Um objeto [SchemaReference](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SchemaReference).
Um objeto que faz referência a um esquema armazenado no AWS Glue Schema Registry.
Ao criar uma tabela, você pode passar uma lista vazia de colunas para o esquema e, em vez disso, usar uma referência de esquema.
## Estrutura SchemaReference
Um objeto que faz referência a um esquema armazenado no AWS Glue Schema Registry.
**Campos**
+ `SchemaId` – Um objeto [SchemaId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId).
Uma estrutura que contém campos de identidade de esquema. Esse ou o `SchemaVersionId` tem que ser fornecido.
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O ID exclusivo atribuído a uma versão do esquema. Esse ou o `SchemaId` tem que ser fornecido.
+ `SchemaVersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
O número da versão do esquema.
## Estrutura SerDeInfo
As informações sobre um programa de serialização/desserialização (SerDe), que serve como extrator e carregador.
**Campos**
+ `Name` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nome de SerDe.
+ `SerializationLibrary` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Normalmente, é a classe que implementa o SerDe. Um exemplo é `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`.
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Esses pares de chave/valor definem parâmetros de inicialização para SerDe.
## Estrutura Order
Especifica a ordem de classificação de uma coluna classificada.
**Campos**
+ `Column`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da coluna.
+ `SortOrder` – *Obrigatório:* Número (inteiro), não mais do que 1.
Indica se a coluna é classificada em ordem crescente (`== 1`) ou decrescente (`==0`).
## Estrutura SkewedInfo
Especifica valores distorcidos em uma tabela. Valores distorcidos são aqueles que ocorrem com muita frequência.
**Campos**
+ `SkewedColumnNames` – Uma matriz de strings UTF-8.
Uma lista de nomes de colunas que contêm valores distorcidos.
+ `SkewedColumnValues` – Uma matriz de strings UTF-8.
Uma lista de valores que aparecem com tanta frequência que devem ser considerados distorcidos.
+ `SkewedColumnValueLocationMaps` – Um array de mapa dos pares de valor-chave.
Cada chave é uma sequência de caracteres UTF-8.
Cada valor é uma sequência de caracteres UTF-8.
Um mapeamento de valores distorcidos para as colunas nas quais estão presentes.
## Estrutura TableVersion
Especifica a versão de uma tabela.
**Campos**
+ `Table` – Um objeto [Tabela](#aws-glue-api-catalog-tables-Table).
A tabela em questão.
+ `VersionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O valor de ID que identifica esta versão da tabela. Um `VersionId` é uma representação em string de um inteiro. Cada versão é incrementada em 1.
## Estrutura TableError
Um registro de erro para operações de tabela.
**Campos**
+ `TableName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela. Para a compatibilidade com o Hive, ele deve ser inserido todo em letras minúsculas.
+ `ErrorDetail` – Um objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).
Os detalhes sobre o erro.
## Estrutura TableVersionError
Um registro de erro para operações da versão da tabela.
**Campos**
+ `TableName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela em questão.
+ `VersionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O valor de ID da versão em questão. Um `VersionID` é uma representação em string de um inteiro. Cada versão é incrementada em 1.
+ `ErrorDetail` – Um objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).
Os detalhes sobre o erro.
## Estrutura SortCriterion
Especifica um campo pelo qual classificar e uma ordem de classificação.
**Campos**
+ `FieldName`: string Value com no mínimo 1 e no máximo 1.024 bytes de comprimento.
O nome do campo no qual classificar.
+ `Sort` – string UTF-8 (valores válidos: `ASC="ASCENDING"` \$1 `DESC="DESCENDING"`).
Uma classificação crescente ou decrescente.
## Estrutura TableIdentifier
Uma estrutura que descreve uma tabela de destino para vinculação de recursos.
**Campos**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que a tabela reside.
+ `DatabaseName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogo que contém a tabela de destino.
+ `Name` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela de destino.
+ `Region` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Região da tabela de destino.
## Estrutura KeySchemaElement
Um par de chaves de partição que consiste em um nome e um tipo.
**Campos**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome de uma chave de partição.
+ `Type`: *obrigatório:* string UTF-8 com comprimento não superior a 131.072 bytes, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O tipo de uma chave de partição.
## Estrutura PartitionIndex
Uma estrutura para um índice de partição.
**Campos**
+ `Keys` – *Obrigatório:* uma matriz de strings UTF-8, pelo menos 1 string.
As chaves para o índice de partição.
+ `IndexName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do índice de partição.
## Estrutura PartitionIndexDescriptor
Um descritor para um índice de partição em uma tabela.
**Campos**
+ `IndexName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do índice de partição.
+ `Keys`: *obrigatório:* uma matriz de objetos [KeySchemaElement](#aws-glue-api-catalog-tables-KeySchemaElement), pelo menos uma estrutura.
Uma lista de uma ou mais chaves, como estruturas `KeySchemaElement`, para o índice de partição.
+ `IndexStatus`: *obrigatório:* string UTF-8 (valores válidos: `CREATING` \$1 `ACTIVE` \$1 `DELETING` \$1 `FAILED`).
O status do índice de partição.
Os possíveis status são:
+ CREATING (CRIANDO): o índice está sendo criado. Quando um índice está em um estado CREATING, o índice ou sua tabela não podem ser excluídos.
+ ACTIVE (ATIVO): a criação do índice foi bem-sucedida.
+ FAILED (FALHOU): a criação do índice falhou.
+ DELETING (EXCLUINDO): o índice é excluído da lista de índices.
+ `BackfillErrors`: um array de objetos [BackfillError](#aws-glue-api-catalog-tables-BackfillError).
Uma lista de erros que podem ocorrer no registro de índices de partição para uma tabela existente.
## Estrutura BackfillError
Uma lista de erros que podem ocorrer no registro de índices de partição para uma tabela existente.
Esses erros fornecem os detalhes sobre por que um registro de índice falhou e fornecem um número limitado de partições na resposta, para que você possa corrigir as partições com falha e tentar registrar o índice novamente. O conjunto mais comum de erros que podem ocorrer são categorizados da seguinte forma:
+ EncryptedPartitionError: as partições são encriptadas.
+ InvalidPartitionTypeDataError: o valor da partição não corresponde ao tipo de dados dessa coluna de partição.
+ MissingPartitionValueError: as partições são criptografadas.
+ UnsupportedPartitionCharacterError: caracteres dentro do valor da partição não são suportados. Por exemplo: U\$10000, U\$10001, U\$10002.
+ InternalError: qualquer erro que não pertence a outros códigos de erro.
**Campos**
+ `Code` – string UTF-8 (valores válidos: `ENCRYPTED_PARTITION_ERROR` \$1 `INTERNAL_ERROR` \$1 `INVALID_PARTITION_TYPE_DATA_ERROR` \$1 `MISSING_PARTITION_VALUE_ERROR` \$1 `UNSUPPORTED_PARTITION_CHARACTER_ERROR`).
O código de erro para um erro que ocorreu durante o registro de índices de partição para uma tabela existente.
+ `Partitions`: um array de objetos [PartitionValueList](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionValueList).
Uma lista com um número limitado de partições na resposta.
## Estrutura IcebergInput
Uma estrutura que define uma tabela de metadados do Apache Iceberg a ser criada no catálogo.
**Campos**
+ `MetadataOperation`: *obrigatório:* string UTF-8 (valores válidos: `CREATE`).
Uma operação de metadados obrigatória. Só pode ser definida como `CREATE`.
+ `Version` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
A versão da tabela para a tabela do Iceberg. Padronizado como 2.
+ `CreateIcebergTableInput` – Um objeto [CreateIcebergTableInput](#aws-glue-api-catalog-tables-CreateIcebergTableInput).
Os parâmetros de configuração necessários para criar uma nova tabela do Iceberg no Catálogo de Dados do AWS Glue, incluindo propriedades da tabela e especificações de metadados.
## Estrutura OpenTableFormatInput
Uma estrutura que representa uma tabela de formato aberto.
**Campos**
+ `IcebergInput` – Um objeto [IcebergInput](#aws-glue-api-catalog-tables-IcebergInput).
Especifica uma estrutura `IcebergInput` que define uma tabela de metadados do Apache Iceberg.
## Estrutura ViewDefinition
Uma estrutura que contém detalhes para representações.
**Campos**
+ `IsProtected` – Booleano.
É possível definir esse sinalizador como verdadeiro para instruir o mecanismo a não inserir as operações fornecidas pelo usuário no plano lógico da exibição durante o planejamento da consulta. No entanto, definir esse sinalizador não garante que o mecanismo estará em conformidade. Consulte a documentação do mecanismo para entender as garantias fornecidas, se houver.
+ `Definer` – String UTF-8, superior a 20 e inferior a 2048 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O definidor de uma visualização em SQL.
+ `SubObjects` – Uma matriz de strings UTF-8, no máximo 10 strings.
Uma lista de nomes do recurso da Amazon (ARNs) da tabela.
+ `Representations`: uma matriz de objetos [ViewRepresentation](#aws-glue-api-catalog-tables-ViewRepresentation), não menos do que 1 ou superior a 1.000 estruturas.
Uma lista de representações.
## Estrutura ViewDefinitionInput
Uma estrutura que contém detalhes para criar ou atualizar uma visualização do AWS Glue.
**Campos**
+ `IsProtected` – Booleano.
É possível definir esse sinalizador como verdadeiro para instruir o mecanismo a não inserir as operações fornecidas pelo usuário no plano lógico da exibição durante o planejamento da consulta. No entanto, definir esse sinalizador não garante que o mecanismo estará em conformidade. Consulte a documentação do mecanismo para entender as garantias fornecidas, se houver.
+ `Definer` – String UTF-8, superior a 20 e inferior a 2048 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O definidor de uma visualização em SQL.
+ `Representations`: uma matriz de objetos [ViewRepresentationInput](#aws-glue-api-catalog-tables-ViewRepresentationInput) com não menos que 1 nem mais que 10 estruturas.
Uma lista de estruturas que contém o dialeto da visualização e a consulta que define a visualização.
+ `SubObjects` – Uma matriz de strings UTF-8, no máximo 10 strings.
Uma lista dos ARNs da tabela base que compõem a visualização.
## Estrutura ViewRepresentation
Uma estrutura que contém o dialeto da visualização e a consulta que define a visualização.
**Campos**
+ `Dialect` – string UTF-8 (valores válidos: `REDSHIFT` \$1 `ATHENA` \$1 `SPARK`).
O dialeto do mecanismo de consulta.
+ `DialectVersion`: string UTF-8, não menos do que 1 ou superior a 255 bytes de comprimento.
A versão do dialeto do mecanismo de consulta. Por exemplo, 3.0.0.
+ `ViewOriginalText` – String UTF-8 com comprimento não superior a 409.600 bytes.
A consulta `SELECT` fornecida pelo cliente durante `CREATE VIEW DDL`. Esse SQL não é usado durante uma consulta em uma visualização (`ViewExpandedText` é usado em vez disso). `ViewOriginalText` é usada para casos como `SHOW CREATE VIEW` quando os usuários querem ver o comando DDL original que criou a visualização.
+ `ViewExpandedText` – String UTF-8 com comprimento não superior a 409.600 bytes.
O SQL expandido para a visualização. Esse SQL é usado pelos mecanismos durante o processamento de uma consulta em uma visualização. Os mecanismos podem realizar operações durante a criação da visualização para transformar `ViewOriginalText` em `ViewExpandedText`. Por exemplo:
+ Identificadores totalmente qualificados: `SELECT * from table1 -> SELECT * from db1.table1`
+ `ValidationConnection` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da conexão a ser usada para validar a representação específica da visualização.
+ `IsStale` – Booleano.
Os dialetos marcados como obsoletos não são mais válidos e devem ser atualizados antes que possam ser consultados em seus respectivos mecanismos de consulta.
## Estrutura ViewRepresentationInput
Uma estrutura que contém detalhes de uma representação para atualizar ou criar uma visualização do Lake Formation.
**Campos**
+ `Dialect` – string UTF-8 (valores válidos: `REDSHIFT` \$1 `ATHENA` \$1 `SPARK`).
Um parâmetro que especifica o tipo do mecanismo de uma representação específica.
+ `DialectVersion`: string UTF-8, não menos do que 1 ou superior a 255 bytes de comprimento.
Um parâmetro que especifica a versão do mecanismo de uma representação específica.
+ `ViewOriginalText` – String UTF-8 com comprimento não superior a 409.600 bytes.
Uma string que representa a consulta SQL original que descreve a visualização.
+ `ValidationConnection` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da conexão a ser usada para validar a representação específica da visualização.
+ `ViewExpandedText` – String UTF-8 com comprimento não superior a 409.600 bytes.
Uma string que representa a consulta SQL que descreve a exibição com ARNs de recursos expandidos
## Estrutura UpdateOpenTableFormatInput
Parâmetros de entrada para atualizar tabelas de formato de tabela aberta no Catálogo de Dados do AWS Glue, servindo como um wrapper para operações de atualização de formatos específicos, como o Apache Iceberg.
**Campos**
+ `UpdateIcebergInput` – Um objeto [UpdateIcebergInput](#aws-glue-api-catalog-tables-UpdateIcebergInput).
Parâmetros de atualização específicos do Apache Iceberg que definem as modificações da tabela a serem aplicadas, incluindo alterações de esquema, especificações de partição e propriedades da tabela.
## Estrutura UpdateIcebergInput
Parâmetros de entrada específicos para atualizar tabelas do Apache Iceberg no Catálogo de Dados do AWS Glue, contendo as operações de atualização a serem aplicadas a uma tabela existente do Iceberg.
**Campos**
+ `UpdateIcebergTableInput` – *Obrigatório:* um objeto [UpdateIcebergTableInput](#aws-glue-api-catalog-tables-UpdateIcebergTableInput).
As operações de atualização específicas a serem aplicadas à tabela do Iceberg, contendo uma lista de atualizações que definem o novo estado da tabela, incluindo esquema, partições e propriedades.
## Estrutura CreateIcebergTableInput
Os parâmetros de configuração necessários para criar uma nova tabela do Iceberg no Catálogo de Dados do AWS Glue, incluindo propriedades da tabela e especificações de metadados.
**Campos**
+ `Location`: – *obrigatório:* string de local com não mais do que 2.056 bytes de comprimento, combinando com [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
O local no S3 onde os dados de tabelas do Iceberg serão armazenados.
+ `Schema` – *Obrigatório:* um objeto [IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema).
A definição do esquema que especifica a estrutura, os tipos de campo e os metadados da tabela do Iceberg.
+ `PartitionSpec` – Um objeto [IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec).
A especificação de particionamento que define como os dados da tabela do Iceberg serão organizados e particionados para otimizar o desempenho da consulta.
+ `WriteOrder` – Um objeto [IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder).
A especificação da ordem de classificação que define como os dados deverão ser ordenados em cada partição para otimizar o desempenho da consulta.
+ `Properties` –
Pares de chave e valor de propriedades adicionais de tabela e definições de configuração para a tabela do Iceberg.
## Estrutura UpdateIcebergTableInput
Contém as operações de atualização a serem aplicadas a uma tabela existente do Iceberg no Catálogo de Dados do AWS Glue, definindo o novo estado dos metadados da tabela.
**Campos**
+ `Updates` – *Obrigatório:* uma matriz de objetos [IcebergTableUpdate](#aws-glue-api-catalog-tables-IcebergTableUpdate).
A lista de operações de atualização de tabela que especificam as alterações a serem feitas na tabela do Iceberg, incluindo modificações no esquema, especificações de partição e propriedades da tabela.
## Estrutura IcebergSortOrder
Define a especificação da ordem de classificação para uma tabela do Iceberg, determinando como os dados deverão ser ordenados nas partições para otimizar o desempenho da consulta.
**Campos**
+ `OrderId`: *obrigatório:* número (inteiro).
O identificador exclusivo para essa especificação de ordem de classificação nos metadados da tabela do Iceberg.
+ `Fields` – *Obrigatório:* uma matriz de objetos [IcebergSortField](#aws-glue-api-catalog-tables-IcebergSortField).
A lista de campos e suas direções de classificação que definem os critérios de ordenação dos dados da tabela do Iceberg.
## Estrutura IcebergSortField
Define um único campo dentro de uma especificação de ordem de classificação do Iceberg, incluindo o campo de origem, transformação, direção de classificação e ordenação de valores nulos.
**Campos**
+ `SourceId`: *obrigatório:* número (inteiro).
O identificador do campo de origem do esquema da tabela no qual esse campo de classificação se baseia.
+ `Transform` – *Obrigatório:* string UTF-8.
A função de transformação aplicada ao campo de origem antes da classificação, como identidade, bucket ou truncar.
+ `Direction` – *Obrigatório:* string UTF-8 (valores válidos: `asc="ASC"` \$1 `desc="DESC"`).
A direção de classificação desse campo, ascendente ou descendente.
+ `NullOrder` – *Obrigatório:* string UTF-8 (valores válidos: `nulls-first="NULLS_FIRST"` \$1 `nulls-last="NULLS_LAST"`).
O comportamento de ordenação para os valores nulos nesse campo, especificando se os nulos devem aparecer primeiro ou por último na ordem de classificação.
## Estrutura IcebergPartitionSpec
Define a especificação de particionamento para uma tabela do Iceberg, determinando como os dados da tabela serão organizados e particionados para um desempenho ideal de consulta.
**Campos**
+ `Fields` – *Obrigatório:* uma matriz de objetos [IcebergPartitionField](#aws-glue-api-catalog-tables-IcebergPartitionField).
A lista de campos de partição que definem como os dados da tabela deverão ser particionados, incluindo campos de origem e suas transformações.
+ `SpecId` – Número (íntegro).
O identificador exclusivo para essa especificação de partição no histórico de metadados da tabela do Iceberg.
## Estrutura IcebergPartitionField
Define um único campo de partição dentro de uma especificação de partição do Iceberg, incluindo o campo de origem, a função de transformação, o nome da partição e o identificador exclusivo.
**Campos**
+ `SourceId`: *obrigatório:* número (inteiro).
O identificador do campo de origem do esquema da tabela no qual esse campo de partição se baseia.
+ `Transform` – *Obrigatório:* string UTF-8.
A função de transformação aplicada ao campo de origem para criar a partição, como identidade, bucket, truncar, ano, mês, dia ou hora.
+ `Name` – *Obrigatório:* string UTF-8, no mínimo 1 ou mais de 1024 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do campo de partição conforme ele aparecerá na estrutura da tabela particionada.
+ `FieldId` – Número (íntegro).
O identificador exclusivo atribuído a esse campo de partição na especificação de partição da tabela do Iceberg.
## Estrutura IcebergSchema
Define a estrutura do esquema para uma tabela do Iceberg, incluindo definições de campo, tipos de dados e metadados do esquema.
**Campos**
+ `SchemaId` – Número (íntegro).
O identificador exclusivo dessa versão do esquema no histórico de evolução do esquema da tabela do Iceberg.
+ `IdentifierFieldIds` – Uma matriz de números inteiros de 32 bits com sinal.
A lista de identificadores de campo que identificam exclusivamente os registros na tabela, usados para operações no nível de linha e desduplicação.
+ `Type` – string UTF-8 (valores válidos: `struct="STRUCT"`).
O tipo de raiz da estrutura do esquema, normalmente “struct” para esquemas de tabela do Iceberg.
+ `Fields` – *Obrigatório:* uma matriz de objetos [IcebergStructField](#aws-glue-api-catalog-tables-IcebergStructField).
A lista de definições de campo que compõem o esquema da tabela, incluindo nomes, tipos e metadados de campo.
## Estrutura IcebergStructField
Define um único campo em um esquema de tabela do Iceberg, incluindo seu identificador, nome, tipo de dados, nulidade e documentação.
**Campos**
+ `Id`: *obrigatório:* número (inteiro).
O identificador exclusivo atribuído a esse campo no esquema de tabela do Iceberg, usado para evolução do esquema e rastreamento de campo.
+ `Name` – *Obrigatório:* string UTF-8, no mínimo 1 ou mais de 1024 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do campo conforme ele aparece no esquema da tabela e nas operações de consulta.
+ `Type` – *obrigatório:* uma estrutura vazia chamada `IcebergDocument`.
A definição do tipo de dados para esse campo, especificando a estrutura e o formato dos dados que ele contém.
+ `Required`: *obrigatório:* booleano.
Indica se esse campo é obrigatório (não passível de anulação) ou opcional (passível de anulação) no esquema da tabela.
+ `Doc` – String de comentário, inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Texto opcional descritivo ou de documentação que fornece contexto adicional sobre a finalidade e o uso deste campo.
## Estrutura IcebergTableUpdate
Define um conjunto completo de atualizações a serem aplicadas a uma tabela do Iceberg, incluindo alterações de esquema, modificações de particionamento, ajustes de ordem de classificação, atualizações de localização e alterações de propriedades.
**Campos**
+ `Schema` – *Obrigatório:* um objeto [IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema).
A definição de esquema atualizada para a tabela do Iceberg, especificando quaisquer alterações na estrutura do campo, nos tipos de dados ou nos metadados do esquema.
+ `PartitionSpec` – Um objeto [IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec).
A especificação de particionamento atualizada que define como os dados da tabela devem ser reorganizados e particionados.
+ `SortOrder` – Um objeto [IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder).
A especificação atualizada da ordem de classificação que define como os dados deverão ser ordenados nas partições para um desempenho ideal de consulta.
+ `Location`: – *obrigatório:* string de local com não mais do que 2.056 bytes de comprimento, combinando com [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
O local atualizado no S3 onde os dados de tabelas do Iceberg serão armazenados.
+ `Properties` –
Pares atualizados de chave e valor de propriedades de tabela e definições de configuração para a tabela do Iceberg.
## Esrtutura AuditContext
Uma estrutura que contém o contexto de auditoria Lake Formation.
**Campos**
+ `AdditionalAuditContext` – String UTF-8 com comprimento não superior a 2048 bytes.
Uma string contendo as informações adicionais do contexto de auditoria.
+ `RequestedColumns` – Uma matriz de strings UTF-8.
As colunas solicitadas para auditoria.
+ `AllColumnsRequested` – Booleano.
Todas as solicitações de colunas para auditoria.
## Operações
+ [Ação CreateTable (Python: create\$1table)](#aws-glue-api-catalog-tables-CreateTable)
+ [Ação UpdateTable (Python: update\$1table)](#aws-glue-api-catalog-tables-UpdateTable)
+ [Ação DeleteTable (Python: delete\$1table)](#aws-glue-api-catalog-tables-DeleteTable)
+ [Ação BatchDeleteTable (Python: batch\$1delete\$1table)](#aws-glue-api-catalog-tables-BatchDeleteTable)
+ [Ação GetTable (Python: get\$1table)](#aws-glue-api-catalog-tables-GetTable)
+ [Ação GetTables (Python: get\$1tables)](#aws-glue-api-catalog-tables-GetTables)
+ [Ação GetTableVersion (Python: get\$1table\$1version)](#aws-glue-api-catalog-tables-GetTableVersion)
+ [Ação GetTableVersions (Python: get\$1table\$1versions)](#aws-glue-api-catalog-tables-GetTableVersions)
+ [Ação DeleteTableVersion (Python: delete\$1table\$1version)](#aws-glue-api-catalog-tables-DeleteTableVersion)
+ [Ação BatchDeleteTableVersion (Python: batch\$1delete\$1table\$1version)](#aws-glue-api-catalog-tables-BatchDeleteTableVersion)
+ [Ação SearchTables (Python: search\$1tables)](#aws-glue-api-catalog-tables-SearchTables)
+ [Ação GetPartitionIndexes (Python: get\$1partitions\$1indexes)](#aws-glue-api-catalog-tables-GetPartitionIndexes)
+ [Ação CreatePartitionIndex (Python: create\$1partition\$1index)](#aws-glue-api-catalog-tables-CreatePartitionIndex)
+ [Ação DeletePartitionIndex (Python: delete\$1partition\$1index)](#aws-glue-api-catalog-tables-DeletePartitionIndex)
+ [Ação GetColumnStatisticsForTable (Python: get\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-GetColumnStatisticsForTable)
+ [Ação UpdateColumnStatisticsForTable (Python: update\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-UpdateColumnStatisticsForTable)
+ [Ação DeleteColumnStatisticsForTable (Python: delete\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-DeleteColumnStatisticsForTable)
## Ação CreateTable (Python: create\$1table)
Cria uma definição de nova tabela no catálogo de dados.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que a será criada `Table`. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O banco de dados do catálogo em que a nova tabela será criada. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `Name` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O identificador exclusivo da tabela no banco de dados especificado que será criado no Catálogo de Dados do AWS Glue.
+ `TableInput` – Um objeto [TableInput](#aws-glue-api-catalog-tables-TableInput).
O objeto `TableInput` que define a tabela de metadados a ser criada no catálogo.
+ `PartitionIndexes`: uma matriz de objetos [PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex), não mais do que três estruturas.
Uma lista de índices de partição, estruturas `PartitionIndex`, para criar na tabela.
+ `TransactionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #44](aws-glue-api-common.md#regex_44).
O ID da transação.
+ `OpenTableFormatInput` – Um objeto [OpenTableFormatInput](#aws-glue-api-catalog-tables-OpenTableFormatInput).
Especifica uma estrutura `OpenTableFormatInput` ao criar uma tabela de formato aberto.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## Ação UpdateTable (Python: update\$1table)
Atualiza uma tabela de metadados no catálogo de dados.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual reside a tabela. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados do catálogo no qual a tabela reside. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `Name` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O identificador exclusivo da tabela no banco de dados especificado que será criado no Catálogo de Dados do AWS Glue.
+ `TableInput` – Um objeto [TableInput](#aws-glue-api-catalog-tables-TableInput).
O objeto `TableInput` atualizado que define a tabela de metadados no catálogo.
+ `SkipArchive` – Booleano.
Por padrão, o `UpdateTable` sempre cria uma versão arquivada da tabela antes de atualizá-la. No entanto, se `skipArchive` estiver definido como true, `UpdateTable` não cria a versão arquivada.
+ `TransactionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #44](aws-glue-api-common.md#regex_44).
O ID da transação na qual atualizar o conteúdo da tabela.
+ `VersionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID da versão na qual atualizar o conteúdo da tabela.
+ `ViewUpdateAction` – string UTF-8 (valores válidos: `ADD` \$1 `REPLACE` \$1 `ADD_OR_REPLACE` \$1 `DROP`).
A operação a ser executada ao atualizar a visualização.
+ `Force` – Booleano.
Um sinalizador que pode ser definido como verdadeiro para ignorar os requisitos correspondentes de correspondência do descritor de armazenamento e do subobjeto.
+ `UpdateOpenTableFormatInput` – Um objeto [UpdateOpenTableFormatInput](#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput).
Parâmetros de entrada para atualizar tabelas de formato de tabela aberta no Catálogo de Dados do AWS Glue, servindo como um wrapper para operações de atualização de formatos específicos, como o Apache Iceberg.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
+ `AlreadyExistsException`
## Ação DeleteTable (Python: delete\$1table)
Remove uma definição de tabela do catálogo de dados.
**nota**
Depois de concluir essa operação, você não terá mais acesso às partições e versões de tabela que pertençam à tabela excluída. O AWS Glue exclui esses recursos “órfãos” de forma assíncrona e pontual, a critério do serviço.
Para garantir a exclusão imediata de todos os recursos relacionados, antes de chamar `DeleteTable`, use `DeleteTableVersion` ou `BatchDeleteTableVersion`, e `DeletePartition` ou `BatchDeletePartition`, para excluir qualquer recurso que pertence à tabela.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual reside a tabela. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados do catálogo no qual a tabela reside. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nome da tabela a ser excluída. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `TransactionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #44](aws-glue-api-common.md#regex_44).
O ID da transação na qual excluir o conteúdo da tabela.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## Ação BatchDeleteTable (Python: batch\$1delete\$1table)
Exclui várias tabelas ao mesmo tempo.
**nota**
Depois de concluir essa operação, você não terá mais acesso às partições e versões de tabela que pertençam à tabela excluída. O AWS Glue exclui esses recursos “órfãos” de forma assíncrona e pontual, a critério do serviço.
Para garantir a exclusão imediata de todos os recursos relacionados, antes de chamar `BatchDeleteTable`, use `DeleteTableVersion` ou `BatchDeleteTableVersion`, e `DeletePartition` ou `BatchDeletePartition`, para excluir qualquer recurso que pertence à tabela.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual reside a tabela. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogo no qual as tabelas a serem excluídas residem. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `TablesToDelete` – *Obrigatório:* uma matriz de strings UTF-8, no máximo 100 strings.
Uma lista da tabela a ser excluída.
+ `TransactionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #44](aws-glue-api-common.md#regex_44).
O ID da transação na qual excluir o conteúdo da tabela.
**Resposta**
+ `Errors`: um array de objetos [TableError](#aws-glue-api-catalog-tables-TableError).
Uma lista de erros encontrados na tentativa de excluir as tabelas especificadas.
**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`
## Ação GetTable (Python: get\$1table)
Recupera a definição da `Table` em um catálogo de dados para uma tabela especificada.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual reside a tabela. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados no catálogo em que a tabela reside. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela para o qual recuperar a definição. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `TransactionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #44](aws-glue-api-common.md#regex_44).
O ID da transação na qual ler o conteúdo da tabela.
+ `QueryAsOfTime` – Timestamp.
A hora de ler o conteúdo da tabela. Se não estiver definido, o tempo de confirmação de transação mais recente será usado. Não pode ser especificado junto com `TransactionId`.
+ `AuditContext` – Um objeto [AuditContext](#aws-glue-api-catalog-tables-AuditContext).
Uma estrutura que contém o [contexto de auditoria](https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html) do Lake Formation.
+ `IncludeStatusDetails` – Booleano.
Especifica se devem ser incluídos detalhes de status relacionados a uma solicitação para criar ou atualizar uma exibição do Catálogo de Dados do AWS Glue.
**Resposta**
+ `Table` – Um objeto [Tabela](#aws-glue-api-catalog-tables-Table).
O objeto `Table` que define a tabela especificada.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## Ação GetTables (Python: get\$1tables)
Recupera as definições de algumas ou todas as tabelas em um determinado `Database`.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as tabelas. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O banco de dados no catálogo cujas tabelas serão listadas. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `Expression` – string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Um padrão de expressão regular. Se presente, apenas as tabelas cujos nomes correspondem ao padrão serão retornadas.
+ `NextToken` – String UTF-8.
Um token de continuação, incluído se esta for uma chamada de continuação.
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 100.
O número máximo de tabelas a serem retornados em uma única resposta.
+ `TransactionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #44](aws-glue-api-common.md#regex_44).
O ID da transação na qual ler o conteúdo da tabela.
+ `QueryAsOfTime` – Timestamp.
A hora de ler o conteúdo da tabela. Se não estiver definido, o tempo de confirmação de transação mais recente será usado. Não pode ser especificado junto com `TransactionId`.
+ `AuditContext` – Um objeto [AuditContext](#aws-glue-api-catalog-tables-AuditContext).
Uma estrutura que contém o [contexto de auditoria](https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html) do Lake Formation.
+ `IncludeStatusDetails` – Booleano.
Especifica se devem ser incluídos detalhes de status relacionados a uma solicitação para criar ou atualizar uma exibição do Catálogo de Dados do AWS Glue.
+ `AttributesToGet` – Uma matriz de strings UTF-8.
Especifica os campos do banco de dados retornados pela chamada `GetTables`. Esse parâmetro não aceita uma lista vazia. A solicitação deve incluir `NAME`.
As seguintes combinações de valores são válidas:
+ `NAME`: nomes de todas as tabelas no banco de dados.
+ `NAME`, `TABLE_TYPE`: nomes de todas as tabelas e dos tipos de tabelas.
**Resposta**
+ `TableList`: um array de objetos [Tabela](#aws-glue-api-catalog-tables-Table).
Uma lista de objetos `Table` solicitados.
+ `NextToken` – String UTF-8.
Um token de continuação, presente se o segmento de lista atual não for o último.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## Ação GetTableVersion (Python: get\$1table\$1version)
Recupera uma versão especificada de uma tabela.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as tabelas. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O banco de dados no catálogo em que a tabela reside. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `VersionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O valor de ID da versão de tabela a ser recuperada. Um `VersionID` é uma representação em string de um inteiro. Cada versão é incrementada em 1.
**Resposta**
+ `TableVersion` – Um objeto [TableVersion](#aws-glue-api-catalog-tables-TableVersion).
A versão da tabela solicitada.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação GetTableVersions (Python: get\$1table\$1versions)
Recupera uma lista de strings que identificam as versões disponíveis de uma tabela especificada.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as tabelas. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O banco de dados no catálogo em que a tabela reside. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `NextToken` – String UTF-8.
Um token de continuação, se esta não for a primeira chamada.
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 100.
O número máximo de versões de tabela a ser retornado em uma resposta.
**Resposta**
+ `TableVersions`: um array de objetos [TableVersion](#aws-glue-api-catalog-tables-TableVersion).
Uma lista de strings identificando versões disponíveis da tabela especificada.
+ `NextToken` – String UTF-8.
Um token de continuação, se a lista de versões disponíveis não incluir o último token.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação DeleteTableVersion (Python: delete\$1table\$1version)
Exclui uma versão especificada de uma tabela.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as tabelas. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O banco de dados no catálogo em que a tabela reside. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `VersionId`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID da versão de tabela a ser excluída. Um `VersionID` é uma representação em string de um inteiro. Cada versão é incrementada em 1.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## Ação BatchDeleteTableVersion (Python: batch\$1delete\$1table\$1version)
Exclui um lote especificado de versões de uma tabela.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as tabelas. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O banco de dados no catálogo em que a tabela reside. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela. Para a compatibilidade com o Hive, o nome deve ser inserido todo em letras minúsculas.
+ `VersionIds` – *Obrigatório:* uma matriz de strings UTF-8, no máximo 100 strings.
Uma lista dos IDs das versões a serem excluídas. Um `VersionId` é uma representação em string de um inteiro. Cada versão é incrementada em 1.
**Resposta**
+ `Errors`: um array de objetos [TableVersionError](#aws-glue-api-catalog-tables-TableVersionError).
Uma lista de erros encontrados durante a tentativa de excluir as versões de tabela especificadas.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## Ação SearchTables (Python: search\$1tables)
Pesquisa um conjunto de tabelas com base nas propriedades dos metadados da tabela, bem como no banco de dados pai. Você pode pesquisar condições de texto ou filtro.
Você só pode obter tabelas às quais tem acesso com base nas políticas de segurança definidas no Lake Formation. Você precisa de pelo menos um acesso somente leitura à tabela para que ela seja retornada. Se você não tiver acesso a todas as colunas na tabela, essas colunas não serão pesquisadas ao retornar a lista de tabelas de volta para você. Se você tiver acesso às colunas, mas não aos dados nas colunas, essas colunas e os metadados associados a essas colunas serão incluídos na pesquisa.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Um identificador exclusivo, que consiste em `account_id`.
+ `NextToken` – String UTF-8.
Um token de continuação, incluído se esta for uma chamada de continuação.
+ `Filters`: um array de objetos [PropertyPredicate](aws-glue-api-common.md#aws-glue-api-common-PropertyPredicate).
Uma lista de pares de chave/valor e um comparador usado para filtrar os resultados da pesquisa. Retorna todas as entidades correspondentes ao predicado.
O membro `Comparator` da estrutura `PropertyPredicate` é usado apenas para campos de tempo, e pode ser omitido para outros tipos de campo. Além disso, ao comparar valores de string, como quando `Key=Name`, um algoritmo de correspondência difusa é usado. O campo `Key` (por exemplo, o valor do campo `Name`) é dividido em tokens em certos caracteres de pontuação, por exemplo, -, :, \$1 etc. Em seguida, cada token é comparado por correspondência exata com o membro `Value` de `PropertyPredicate`. Por exemplo, se `Key=Name` e `Value=link`, as tabelas denominadas `customer-link` e `xx-link-yy` são retornadas, mas `xxlinkyy` não é.
+ `SearchText`: string Value com no mínimo 1 e no máximo 1.024 bytes de comprimento.
Uma string usada para uma pesquisa de texto.
Especificar um valor em filtros de aspas com base em uma correspondência exata com o valor.
+ `SortCriteria`: uma matriz de objetos [SortCriterion](#aws-glue-api-catalog-tables-SortCriterion), não mais do que uma estrutura.
Uma lista de critérios para classificar os resultados por um nome de campo, em uma ordem crescente ou decrescente.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.
O número máximo de tabelas a serem retornados em uma única resposta.
+ `ResourceShareType` – string UTF-8 (valores válidos: `FOREIGN` \$1 `ALL` \$1 `FEDERATED`).
Permite que você especifique que deseja pesquisar as tabelas compartilhadas com sua conta. Os valores permitidos são `FOREIGN` ou `ALL`.
+ Se definido como `FOREIGN`, listará as tabelas compartilhadas com sua conta.
+ Se definido como `ALL`, listará as tabelas compartilhadas com sua conta, bem como as tabelas em sua conta local.
+ `IncludeStatusDetails` – Booleano.
Especifica se devem ser incluídos detalhes de status relacionados a uma solicitação para criar ou atualizar uma exibição do Catálogo de Dados do AWS Glue.
**Resposta**
+ `NextToken` – String UTF-8.
Um token de continuação, presente se o segmento de lista atual não for o último.
+ `TableList`: um array de objetos [Tabela](#aws-glue-api-catalog-tables-Table).
Uma lista de objetos `Table` solicitados. A resposta `SearchTables` retorna apenas as tabelas às quais você tem acesso.
**Erros**
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`
## Ação GetPartitionIndexes (Python: get\$1partitions\$1indexes)
Recupera os índices de partição associados a uma tabela.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID de catálogo no qual reside a tabela.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Especifica o nome de um banco de dados a partir do qual você deseja recuperar índices de partição.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Especifica o nome de uma tabela para a qual você deseja recuperar os índices da partição.
+ `NextToken` – String UTF-8.
Um token de continuação, incluído se esta for uma chamada de continuação.
**Resposta**
+ `PartitionIndexDescriptorList`: um array de objetos [PartitionIndexDescriptor](#aws-glue-api-catalog-tables-PartitionIndexDescriptor).
Uma lista de descritores de índice.
+ `NextToken` – String UTF-8.
Um token de continuação, presente se o segmento de lista atual não for o último.
**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ConflictException`
## Ação CreatePartitionIndex (Python: create\$1partition\$1index)
Cria um índice de partição especificado em uma tabela existente.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID de catálogo no qual reside a tabela.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Especifica o nome de um banco de dados no qual você deseja criar um índice de partição.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Especifica o nome de uma tabela na qual você deseja criar um índice de partição.
+ `PartitionIndex` – *Obrigatório:* um objeto [PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex).
Especifica uma estrutura `PartitionIndex` para criar um índice de partição em uma tabela existente.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação DeletePartitionIndex (Python: delete\$1partition\$1index)
Exclui um índice de partição especificado de uma tabela existente.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID de catálogo no qual reside a tabela.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Especifica o nome de um banco de dados do qual você deseja excluir um índice de partição.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Especifica o nome de uma tabela da qual você deseja excluir um índice de partição.
+ `IndexName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do índice de partição a ser excluído.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ConflictException`
+ `GlueEncryptionException`
## Ação GetColumnStatisticsForTable (Python: get\$1column\$1statistics\$1for\$1table)
Recupera estatísticas de tabelas das colunas.
A permissão de Identity and Access Management (IAM) necessária para essa operação é `GetTable`.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as partições em questão. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogos no qual as partições residem.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela das partições.
+ `ColumnNames` – *Obrigatório:* uma matriz de strings UTF-8, no máximo 100 strings.
Uma lista de nomes de coluna.
**Resposta**
+ `ColumnStatisticsList`: um array de objetos [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics).
Lista de ColumnStatistics.
+ `Errors`: um array de objetos [ColumnError](aws-glue-api-common.md#aws-glue-api-common-ColumnError).
Lista de ColumnStatistics cuja recuperação falhou.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação UpdateColumnStatisticsForTable (Python: update\$1column\$1statistics\$1for\$1table)
Cria ou atualiza estatísticas de tabela das colunas.
A permissão de Identity and Access Management (IAM) necessária para essa operação é `UpdateTable`.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as partições em questão. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogos no qual as partições residem.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela das partições.
+ `ColumnStatisticsList` – *Obrigatório:* uma matriz de objetos [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics), não mais de 25 estruturas.
Uma lista de estatísticas de colunas.
**Resposta**
+ `Errors`: um array de objetos [ColumnStatisticsError](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError).
Lista de ColumnStatisticsErrors.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação DeleteColumnStatisticsForTable (Python: delete\$1column\$1statistics\$1for\$1table)
Recupera estatísticas de tabelas das colunas.
A permissão de Identity and Access Management (IAM) necessária para essa operação é `DeleteTable`.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as partições em questão. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogos no qual as partições residem.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela das partições.
+ `ColumnName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da coluna.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
# API de partição
A Partição da API descreve os tipos de dados e operações usadas para trabalhar com partições.
## Tipos de dados
+ [Estrutura Partition](#aws-glue-api-catalog-partitions-Partition)
+ [Estrutura PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput)
+ [Estrutura PartitionSpecWithSharedStorageDescriptor](#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor)
+ [Estrutura PartitionListComposingSpec](#aws-glue-api-catalog-partitions-PartitionListComposingSpec)
+ [Estrutura PartitionSpecProxy](#aws-glue-api-catalog-partitions-PartitionSpecProxy)
+ [Estrutura PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList)
+ [Estrutura Segment](#aws-glue-api-catalog-partitions-Segment)
+ [Estrutura PartitionError](#aws-glue-api-catalog-partitions-PartitionError)
+ [Estrutura BatchUpdatePartitionFailureEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry)
+ [Estrutura BatchUpdatePartitionRequestEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry)
+ [Estrutura StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor)
+ [Estrutura SchemaReference](#aws-glue-api-catalog-partitions-SchemaReference)
+ [Estrutura SerDeInfo](#aws-glue-api-catalog-partitions-SerDeInfo)
+ [Estrutura SkewedInfo](#aws-glue-api-catalog-partitions-SkewedInfo)
## Estrutura Partition
Representa uma fatia dos dados da tabela.
**Campos**
+ `Values` – Uma matriz de strings UTF-8.
Os valores da partição.
+ `DatabaseName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogo no qual a função será criada.
+ `TableName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela do banco de dados na qual criar a partição.
+ `CreationTime` – Timestamp.
A hora em que a partição foi criada.
+ `LastAccessTime` – Timestamp.
A hora em que a partição foi acessada pela última vez.
+ `StorageDescriptor` – Um objeto [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor).
Fornece informações sobre o local físico no qual a partição está armazenada.
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Esses pares de chave/valor definem parâmetros de partição.
+ `LastAnalyzedTime` – Timestamp.
A última vez em que as estatísticas de colunas foram calculadas para esta partição.
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do Data Catalog em que a partição reside.
## Estrutura PartitionInput
A estrutura usada para criar e atualizar uma partição.
**Campos**
+ `Values` – Uma matriz de strings UTF-8.
Os valores da partição. Embora este parâmetro não seja exigido pelo SDK, você deve especificá-lo para uma entrada válida.
Os valores das chaves da nova partição devem ser passados como uma matriz de objetos String que devem ser classificados na mesma ordem que as chaves de partição que aparecem no prefixo do Amazon S3. Caso contrário, o AWS Glue adicionará os valores às chaves incorretas.
+ `LastAccessTime` – Timestamp.
A hora em que a partição foi acessada pela última vez.
+ `StorageDescriptor` – Um objeto [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor).
Fornece informações sobre o local físico no qual a partição está armazenada.
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Esses pares de chave/valor definem parâmetros de partição.
+ `LastAnalyzedTime` – Timestamp.
A última vez em que as estatísticas de colunas foram calculadas para esta partição.
## Estrutura PartitionSpecWithSharedStorageDescriptor
Uma especificação de partição para partições que compartilham um local físico.
**Campos**
+ `StorageDescriptor` – Um objeto [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor).
As informações do armazenamento físico compartilhado.
+ `Partitions`: um array de objetos [Partition](#aws-glue-api-catalog-partitions-Partition).
Uma lista das partições que compartilham este local físico.
## Estrutura PartitionListComposingSpec
Lista as partições relacionadas.
**Campos**
+ `Partitions`: um array de objetos [Partition](#aws-glue-api-catalog-partitions-Partition).
Uma lista das partições na especificação de composição.
## Estrutura PartitionSpecProxy
Fornece um caminho raiz para as partições especificadas.
**Campos**
+ `DatabaseName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O banco de dados de catálogo no qual residem as partições.
+ `TableName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela que contém as partições.
+ `RootPath` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O caminho raiz do proxy para as partições.
+ `PartitionSpecWithSharedSD` – Um objeto [PartitionSpecWithSharedStorageDescriptor](#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor).
Uma especificação de partições que compartilham o mesmo local de armazenamento físico.
+ `PartitionListComposingSpec` – Um objeto [PartitionListComposingSpec](#aws-glue-api-catalog-partitions-PartitionListComposingSpec).
Especifica uma lista de partições.
## Estrutura PartitionValueList
Contém uma lista dos valores que definem as partições.
**Campos**
+ `Values`: *obrigatório:* uma matriz de strings UTF-8.
A lista de valores.
## Estrutura Segment
Define uma região não sobreposta das partições de uma tabela, permitindo que várias solicitações sejam executadas simultaneamente.
**Campos**
+ `SegmentNumber` – *Obrigatório:* número (inteiro), não mais do que Nenhum.
O número de índice baseado em zero do segmento. Por exemplo, se o número total de segmentos for 4, os valores de `SegmentNumber` vão variar de 0 a 3.
+ `TotalSegments` – *Obrigatório:* número (inteiro), no mínimo 1 ou mais que 10.
O número total de segmentos.
## Estrutura PartitionError
Contém informações sobre um erro de partição.
**Campos**
+ `PartitionValues` – Uma matriz de strings UTF-8.
Os valores que definem a partição.
+ `ErrorDetail` – Um objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).
Os detalhes sobre o erro de partição.
## Estrutura BatchUpdatePartitionFailureEntry
Contém informações sobre um erro de partição de atualização em lote.
**Campos**
+ `PartitionValueList` – Uma matriz de strings UTF-8, no máximo 100 strings.
Uma lista dos valores que definem as partições.
+ `ErrorDetail` – Um objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).
Os detalhes sobre o erro de partição de atualização em lote.
## Estrutura BatchUpdatePartitionRequestEntry
Uma estrutura que contém os valores e a estrutura usados para atualizar uma partição.
**Campos**
+ `PartitionValueList` – *Obrigatório:* uma matriz de strings UTF-8, no máximo 100 strings.
Uma lista dos valores que definem as partições.
+ `PartitionInput` – *Obrigatório:* um objeto [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput).
A estrutura usada para atualizar uma partição.
## Estrutura StorageDescriptor
Descreve o armazenamento físico dos dados da tabela.
**Campos**
+ `Columns`: um array de objetos [Coluna](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Column).
Uma lista de `Columns` na tabela.
+ `Location` – String de local, inferior a 2056 bytes de comprimento, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
A localização física da tabela. Por padrão, assume o formato da localização do warehouse, seguida pela localização do banco de dados no warehouse, seguida pelo nome da tabela.
+ `AdditionalLocations` – Uma matriz de strings UTF-8.
Uma lista de locais que apontam para o caminho onde uma tabela do Delta está localizada.
+ `InputFormat` – String de formato, inferior a 128 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O formato de entrada: `SequenceFileInputFormat` (binário), `TextInputFormat` ou um formato personalizado.
+ `OutputFormat` – String de formato, inferior a 128 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O formato de saída: `SequenceFileOutputFormat` (binário), `IgnoreKeyTextOutputFormat` ou um formato personalizado.
+ `Compressed` – Booleano.
`True` se os dados da tabela estiverem compactados, ou `False` se não estiverem.
+ `NumberOfBuckets` – Número (íntegro).
Você deverá especificar se a tabela contiver qualquer coluna de dimensão.
+ `SerdeInfo` – Um objeto [SerDeInfo](#aws-glue-api-catalog-partitions-SerDeInfo).
As informações de serialização/desserialização (SerDe).
+ `BucketColumns` – Uma matriz de strings UTF-8.
Uma lista de colunas de agrupamento, armazenamento em clusters e armazenamento em buckets de reducers na tabela.
+ `SortColumns`: um array de objetos [Ordem](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Order).
Uma lista que especifica a ordem de classificação de cada bucket na tabela.
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
As propriedades fornecidas pelo usuário em formato de chave/valor.
+ `SkewedInfo` – Um objeto [SkewedInfo](#aws-glue-api-catalog-partitions-SkewedInfo).
As informações sobre valores que aparecem com frequência em uma coluna (valores distorcidos).
+ `StoredAsSubDirectories` – Booleano.
`True`, se os dados na tabela estiverem armazenados em subdiretórios, ou `False`, caso contrário.
+ `SchemaReference` – Um objeto [SchemaReference](#aws-glue-api-catalog-partitions-SchemaReference).
Um objeto que faz referência a um esquema armazenado no AWS Glue Schema Registry.
Ao criar uma tabela, você pode passar uma lista vazia de colunas para o esquema e, em vez disso, usar uma referência de esquema.
## Estrutura SchemaReference
Um objeto que faz referência a um esquema armazenado no AWS Glue Schema Registry.
**Campos**
+ `SchemaId` – Um objeto [SchemaId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId).
Uma estrutura que contém campos de identidade de esquema. Esse ou o `SchemaVersionId` tem que ser fornecido.
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O ID exclusivo atribuído a uma versão do esquema. Esse ou o `SchemaId` tem que ser fornecido.
+ `SchemaVersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
O número da versão do esquema.
## Estrutura SerDeInfo
As informações sobre um programa de serialização/desserialização (SerDe), que serve como extrator e carregador.
**Campos**
+ `Name` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nome de SerDe.
+ `SerializationLibrary` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Normalmente, é a classe que implementa o SerDe. Um exemplo é `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`.
+ `Parameters` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string de chave com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é uma string UTF-8 com comprimento não superior a 512.000 bytes.
Esses pares de chave/valor definem parâmetros de inicialização para SerDe.
## Estrutura SkewedInfo
Especifica valores distorcidos em uma tabela. Valores distorcidos são aqueles que ocorrem com muita frequência.
**Campos**
+ `SkewedColumnNames` – Uma matriz de strings UTF-8.
Uma lista de nomes de colunas que contêm valores distorcidos.
+ `SkewedColumnValues` – Uma matriz de strings UTF-8.
Uma lista de valores que aparecem com tanta frequência que devem ser considerados distorcidos.
+ `SkewedColumnValueLocationMaps` – Um array de mapa dos pares de valor-chave.
Cada chave é uma sequência de caracteres UTF-8.
Cada valor é uma sequência de caracteres UTF-8.
Um mapeamento de valores distorcidos para as colunas nas quais estão presentes.
## Operações
+ [Ação CreatePartition (Python: create\$1partition)](#aws-glue-api-catalog-partitions-CreatePartition)
+ [Ação BatchCreatePartition (Python: batch\$1create\$1partition)](#aws-glue-api-catalog-partitions-BatchCreatePartition)
+ [Ação UpdatePartition (Python: update\$1partition)](#aws-glue-api-catalog-partitions-UpdatePartition)
+ [Ação DeletePartition (Python: delete\$1partition)](#aws-glue-api-catalog-partitions-DeletePartition)
+ [Ação BatchDeletePartition (Python: batch\$1delete\$1partition)](#aws-glue-api-catalog-partitions-BatchDeletePartition)
+ [Ação GetPartition (Python: get\$1partition)](#aws-glue-api-catalog-partitions-GetPartition)
+ [Ação GetPartitions (Python: get\$1partitions)](#aws-glue-api-catalog-partitions-GetPartitions)
+ [Ação BatchGetPartition (Python: batch\$1get\$1partition)](#aws-glue-api-catalog-partitions-BatchGetPartition)
+ [Ação BatchUpdatePartition (Python: batch\$1update\$1partition)](#aws-glue-api-catalog-partitions-BatchUpdatePartition)
+ [Ação GetColumnStatisticsForPartition (Python: get\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-GetColumnStatisticsForPartition)
+ [Ação UpdateColumnStatisticsForPartition (Python: update\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-UpdateColumnStatisticsForPartition)
+ [Ação DeleteColumnStatisticsForPartition (Python: delete\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-DeleteColumnStatisticsForPartition)
## Ação CreatePartition (Python: create\$1partition)
Cria uma nova partição.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID da conta da AWS do catálogo no qual a partição deve ser criada.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de metadados no qual a partição deve ser criada.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela de metadados na qual a partição deve ser criada.
+ `PartitionInput` – *Obrigatório:* um objeto [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput).
Uma estrutura `PartitionInput` que define a partição a ser criada.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação BatchCreatePartition (Python: batch\$1create\$1partition)
Cria uma ou mais partições em uma operação em lote.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo no qual a partição deve ser criada. No momento, deve ser o ID da conta da AWS.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de metadados no qual a partição deve ser criada.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela de metadados na qual a partição deve ser criada.
+ `PartitionInputList` – *Obrigatório:* uma matriz de objetos [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput), não mais de 100 estruturas.
Uma lista das estruturas `PartitionInput` que definem as partições a serem criadas.
**Resposta**
+ `Errors`: um array de objetos [PartitionError](#aws-glue-api-catalog-partitions-PartitionError).
Os erros encontrados ao tentar criar as partições solicitadas.
**Erros**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação UpdatePartition (Python: update\$1partition)
Atualiza uma partição.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual reside a partição a ser atualizada. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados do catálogo no qual a tabela em questão reside.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela de metadados na qual a partição a ser atualizada está localizada.
+ `PartitionValueList` – *Obrigatório:* uma matriz de strings UTF-8, no máximo 100 strings.
Lista de valores de chaves-valor de partição que definem a partição a ser atualizada.
+ `PartitionInput` – *Obrigatório:* um objeto [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput).
O novo objeto de partição para o qual a partição será atualizada.
A propriedade `Values` não pode ser alterada. Se você quiser alterar as chaves-valor de uma partição, exclua e recrie a partição.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação DeletePartition (Python: delete\$1partition)
Exclui uma partição especificada.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual reside a partição a ser excluída. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados do catálogo no qual a tabela em questão reside.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela que contém a partição a ser excluída.
+ `PartitionValues`: *obrigatório:* uma matriz de strings UTF-8.
Os valores que definem a partição.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## Ação BatchDeletePartition (Python: batch\$1delete\$1partition)
Exclui uma ou mais partições em uma operação em lote.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual reside a partição a ser excluída. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados do catálogo no qual a tabela em questão reside.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela que contém as partições a serem excluídas.
+ `PartitionsToDelete` – *Obrigatório:* uma matriz de objetos [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList), não mais de 25 estruturas.
Uma lista das estruturas `PartitionInput` que definem as partições a serem excluídas.
**Resposta**
+ `Errors`: um array de objetos [PartitionError](#aws-glue-api-catalog-partitions-PartitionError).
Os erros encontrados ao tentar excluir as partições solicitadas.
**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## Ação GetPartition (Python: get\$1partition)
Recupera informações sobre uma partição especificada.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual reside a partição em questão. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogos no qual a partição reside.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela da partição.
+ `PartitionValues`: *obrigatório:* uma matriz de strings UTF-8.
Os valores que definem a partição.
**Resposta**
+ `Partition` – Um objeto [Partition](#aws-glue-api-catalog-partitions-Partition).
A informação solicitada, na forma de um objeto `Partition`.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## Ação GetPartitions (Python: get\$1partitions)
Recupera informações sobre as partições em uma tabela.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as partições em questão. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogos no qual as partições residem.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela das partições.
+ `Expression` – String de predicado, inferior a 2048 bytes de comprimento, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma expressão que filtra as partições a serem retornadas.
A expressão usa sintaxe SQL semelhante à cláusula de filtro SQL `WHERE`. O analisador de instrução SQL [JSQLParser](http://jsqlparser.sourceforge.net/home.php) analisa a expressão.
*Operadores*: estes são os operadores que você pode usar na chamada de API `Expression`:
=
Verifica se os valores dos dois operandos são iguais. Em caso afirmativo, a condição é verdadeira.
Exemplo: suponha que a "variável a" seja 10 e a "variável b" 20.
(a = b) não é verdadeiro.
< >
Verifica se os valores dos dois operandos são iguais. Se os valores não forem iguais, a condição será verdadeira.
Exemplo: (a < > b) é verdadeiro.
>
Verifica se o valor do operando esquerdo é maior que o valor do operando direito. Em caso afirmativo, a condição é verdadeira.
Exemplo: (a > b) não é verdadeiro.
<
Verifica se o valor do operando esquerdo é menor que o valor do operando direito. Em caso afirmativo, a condição é verdadeira.
Exemplo: (a < b) é verdadeiro.
>=
Verifica se o valor do operando esquerdo é maior ou igual ao valor do operando direito. Em caso afirmativo, a condição é verdadeira.
Exemplo: (a >= b) não é verdadeiro.
<=
Verifica se o valor do operando esquerdo é menor ou igual ao valor do operando direito. Em caso afirmativo, a condição é verdadeira.
Exemplo: (a \$1<= b) é verdadeiro.
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
Operadores lógicos.
*Tipos de chave de partição compatíveis*: veja a seguir as chaves de partição compatíveis.
+ `string`
+ `date`
+ `timestamp`
+ `int`
+ `bigint`
+ `long`
+ `tinyint`
+ `smallint`
+ `decimal`
Se um tipo que não seja válido for encontrado, uma exceção será lançada.
A lista a seguir mostra os operadores válidos em cada tipo. Quando você define um crawler, o tipo `partitionKey` é criado como um `STRING`, para ser compatível com as partições do catálogo.
*Exemplo de chamada de API*:
**Example**
A tabela `twitter_partition` tem três partições:
```
year = 2015
year = 2016
year = 2017
```
**Example**
Obter `year` da partição igual a 2015
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year*=*'2015'"
```
**Example**
Obter `year` da partição entre 2016 e 2018 (exclusivo)
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year>'2016' AND year<'2018'"
```
**Example**
Obtenha o `year` da partição entre 2015 e 2018 (inclusivo). As seguintes chamadas de API são equivalentes entre si:
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year>='2015' AND year<='2018'"
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year BETWEEN 2015 AND 2018"
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year IN (2015,2016,2017,2018)"
```
**Example**
Um filtro de partição curinga, onde a saída de chamada a seguir terá o ano de partição = 2017. Uma expressão regular não é suportada em `LIKE`.
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year LIKE '%7'"
```
+ `NextToken` – String UTF-8.
Um token de continuação, se esta não for a primeira chamada para recuperar essas partições.
+ `Segment` – Um objeto [Segmento](#aws-glue-api-catalog-partitions-Segment).
O segmento de partições da tabela a ser verificado nesta solicitação.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.
O número máximo de partições a serem retornados em uma única resposta.
+ `ExcludeColumnSchema` – Booleano.
Quando verdadeiro, especifica não retornar o esquema da coluna de partição. Útil quando você está interessado apenas em outros atributos de partição, como valores ou localização de partição. Essa abordagem evita o problema de uma resposta grande ao não retornar dados duplicados.
+ `TransactionId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #44](aws-glue-api-common.md#regex_44).
O ID da transação na qual ler o conteúdo da partição.
+ `QueryAsOfTime` – Timestamp.
A hora de ler o conteúdo da partição. Se não estiver definido, o tempo de confirmação de transação mais recente será usado. Não pode ser especificado junto com `TransactionId`.
**Resposta**
+ `Partitions`: um array de objetos [Partition](#aws-glue-api-catalog-partitions-Partition).
Uma lista de partições solicitadas.
+ `NextToken` – String UTF-8.
Um token de continuação, se a lista de partições retornada não incluir o último token.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `InvalidStateException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## Ação BatchGetPartition (Python: batch\$1get\$1partition)
Recupera partições em uma solicitação de lote.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as partições em questão. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogos no qual as partições residem.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela das partições.
+ `PartitionsToGet` – *Obrigatório:* uma matriz de objetos [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList), não mais de 1000 estruturas.
Uma lista de valores de partição que identifica as partições a serem recuperadas.
**Resposta**
+ `Partitions`: um array de objetos [Partition](#aws-glue-api-catalog-partitions-Partition).
Uma lista das partições solicitadas.
+ `UnprocessedKeys` – Uma matriz de objetos [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList), não mais de 1000 estruturas.
Uma lista dos valores de partição na solicitação para a qual as partições não foram retornadas.
**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `InvalidStateException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## Ação BatchUpdatePartition (Python: batch\$1update\$1partition)
Atualiza uma ou mais partições em uma operação em lote.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID de catálogo no qual a partição deve ser atualizada. No momento, deve ser o ID da conta da AWS.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de metadados no qual a partição deve ser atualizada.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela de metadados na qual a partição deve ser atualizada.
+ `Entries`: *obrigatório:* uma matriz de objetos [BatchUpdatePartitionRequestEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry), com número de estruturas entre 1 e 100.
Uma lista de até 100 objetos `BatchUpdatePartitionRequestEntry` a serem atualizados.
**Resposta**
+ `Errors`: um array de objetos [BatchUpdatePartitionFailureEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry).
Os erros encontrados ao tentar atualizar as partições solicitadas. Uma lista dos objetos `BatchUpdatePartitionFailureEntry`.
**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
## Ação GetColumnStatisticsForPartition (Python: get\$1column\$1statistics\$1for\$1partition)
Recupera estatísticas de partição das colunas.
A permissão de Identity and Access Management (IAM) necessária para essa operação é `GetPartition`.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as partições em questão. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogos no qual as partições residem.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela das partições.
+ `PartitionValues`: *obrigatório:* uma matriz de strings UTF-8.
Uma lista de valores de partição que identifica a partição.
+ `ColumnNames` – *Obrigatório:* uma matriz de strings UTF-8, no máximo 100 strings.
Uma lista de nomes de coluna.
**Resposta**
+ `ColumnStatisticsList`: um array de objetos [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics).
Lista de ColumnStatistics cuja recuperação falhou.
+ `Errors`: um array de objetos [ColumnError](aws-glue-api-common.md#aws-glue-api-common-ColumnError).
Ocorreu um erro durante a recuperação de dados de estatísticas de colunas.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação UpdateColumnStatisticsForPartition (Python: update\$1column\$1statistics\$1for\$1partition)
Cria ou atualiza estatísticas de partição de colunas.
A permissão de Identity and Access Management (IAM) necessária para essa operação é `UpdatePartition`.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as partições em questão. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogos no qual as partições residem.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela das partições.
+ `PartitionValues`: *obrigatório:* uma matriz de strings UTF-8.
Uma lista de valores de partição que identifica a partição.
+ `ColumnStatisticsList` – *Obrigatório:* uma matriz de objetos [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics), não mais de 25 estruturas.
Uma lista de estatísticas de colunas.
**Resposta**
+ `Errors`: um array de objetos [ColumnStatisticsError](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError).
Ocorreu um erro durante a atualização de dados de estatísticas de coluna
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação DeleteColumnStatisticsForPartition (Python: delete\$1column\$1statistics\$1for\$1partition)
Exclui as estatísticas de coluna de partição de uma coluna.
A permissão de Identity and Access Management (IAM) necessária para essa operação é `DeletePartition`.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual residem as partições em questão. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogos no qual as partições residem.
+ `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da tabela das partições.
+ `PartitionValues`: *obrigatório:* uma matriz de strings UTF-8.
Uma lista de valores de partição que identifica a partição.
+ `ColumnName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da coluna.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
# API de conexões
A API de conexões descreve os tipos de dados e a API relacionados a trabalhar com conexões no AWS Glue.
**Topics**
+ [API de conexão](aws-glue-api-catalog-connections-connections.md)
+ [API de tipos de conexão](aws-glue-api-catalog-connections-connections-type.md)
+ [Metadados de conexão e API de visualização](aws-glue-api-catalog-connections-connections-metadata.md)
# API de conexão
A API de conexão descreve os tipos de dados de conexão do AWS Glue e a API para criar, excluir, atualizar e listar conexões.
## Tipos de dados
+ [Estrutura Connection](#aws-glue-api-catalog-connections-connections-Connection)
+ [Estrutura ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput)
+ [Estrutura TestConnectionInput](#aws-glue-api-catalog-connections-connections-TestConnectionInput)
+ [Estrutura PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements)
+ [Estrutura GetConnectionsFilter](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter)
+ [Estrutura AuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration)
+ [Estrutura AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput)
+ [Estrutura OAuth2Properties](#aws-glue-api-catalog-connections-connections-OAuth2Properties)
+ [Estrutura OAuth2PropertiesInput](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput)
+ [Estrutura OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication)
+ [Estrutura AuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties)
+ [Estrutura BasicAuthenticationCredentials](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials)
+ [Estrutura OAuth2Credentials](#aws-glue-api-catalog-connections-connections-OAuth2Credentials)
## Estrutura Connection
Define uma conexão para uma fonte de dados.
**Campos**
+ `Name` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da definição da conexão.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
A descrição da conexão.
+ `ConnectionType` – String UTF-8 (valores válidos: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`).
O tipo da conexão. No momento, o SFTP não é compatível.
+ `MatchCriteria` – Uma matriz de strings UTF-8, no máximo 10 strings.
Uma lista de critérios que podem ser usados na seleção dessa conexão.
+ `ConnectionProperties`: um array de mapa dos pares de chave-valor com não mais do que 100 pares.
Cada chave é uma string UTF-8 (valores válidos: `HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`).
Cada chave é uma string Value com no mínimo 1 e no máximo 1.024 bytes de comprimento.
Esses pares de chave-valor definem parâmetros para a conexão ao usar o esquema de conexão versão 1:
+ `HOST` - O URI do host: o nome de domínio totalmente qualificado (FQDN) ou o endereço IPv4 do host do banco de dados.
+ `PORT` - O número da porta, entre 1024 e 65535, da porta na qual o host do banco de dados está escutando conexões de banco de dados.
+ `USER_NAME` - O nome com o qual realizar login no banco de dados. O valor da string para `USER_NAME` é "`USERNAME`".
+ `PASSWORD` - Uma senha, se for usada, para o nome do usuário.
+ `ENCRYPTED_PASSWORD` - Ao habilitar a proteção por senha de conexão, definindo as configurações de criptografia `ConnectionPasswordEncryption` no Catálogo de dados, este campo armazena a senha criptografada.
+ `JDBC_DRIVER_JAR_URI` – o caminho do Amazon Simple Storage Service (Amazon S3) do arquivo JAR que contém o driver JDBC a ser usado.
+ `JDBC_DRIVER_CLASS_NAME` - A classe do nome do driver do JDBC a ser usado.
+ `JDBC_ENGINE` - O nome do mecanismo JDBC a ser usado.
+ `JDBC_ENGINE_VERSION` - A versão do nome do mecanismo JDBC a ser usado.
+ `CONFIG_FILES` – (reservado para uso futuro.)
+ `INSTANCE_ID` - O ID da instância a ser usada.
+ `JDBC_CONNECTION_URL` – o URL para conexão com uma fonte de dados JDBC.
+ `JDBC_ENFORCE_SSL`: uma string boleana que não diferencia maiúsculas de minúsculas (true, false), que especifica se a correspondência do Secure Sockets Layer (SSL) com o nome do host será aplicada para a conexão JDBC no cliente. O padrão é falso.
+ `CUSTOM_JDBC_CERT`: um local do Amazon S3 que especifica o certificado raiz do cliente. O AWS Glue usa esse certificado raiz para validar o certificado do cliente ao se conectar ao banco de dados do cliente. O AWS Glue processa somente certificados X.509. O certificado fornecido deve ter codificação DER e ser fornecido no formato PEM de codificação Base64.
+ `SKIP_CUSTOM_JDBC_CERT_VALIDATION`: Por padrão, é `false`. O AWS Glue valida o algoritmo de assinatura e o algoritmo de chave pública de requerente para o certificado do cliente. Os únicos algoritmos permitidos para o algoritmo de assinatura são SHA256withRSA, SHA384withRSA ou SHA512withRSA. Para o algoritmo de chave pública do assunto, o comprimento da chave deve ser pelo menos 2048. Você pode definir o valor dessa propriedade como `true` para ignorar a validação do certificado do cliente pelo AWS Glue.
+ `CUSTOM_JDBC_CERT_STRING` — uma string de certificado JDBC personalizado que é usada para correspondência de domínio ou correspondência de nome distinto para evitar um ataque “man-in-the-middle”. No banco de dados Oracle, ela é usada como `SSL_SERVER_CERT_DN`; no Microsoft SQL Server, ela é usada como `hostNameInCertificate`.
+ `CONNECTION_URL` – o URL para conexão com uma fonte de dados geral (não JDBC).
+ `SECRET_ID`: o ID secreto usado para o gerente secreto de credenciais.
+ `CONNECTOR_URL`: o URL do conector para uma conexão MARKETPLACE ou CUSTOM (personalizada).
+ `CONNECTOR_TYPE`: o tipo do conector para uma conexão MARKETPLACE ou CUSTOM (personalizada).
+ `CONNECTOR_CLASS_NAME`: o nome da classe do conector para uma conexão MARKETPLACE ou CUSTOM (personalizada).
+ `KAFKA_BOOTSTRAP_SERVERS` – Uma lista separada por vírgulas de pares de host e porta que são os endereços dos agentes do Apache Kafka em um cluster do Kafka ao qual um cliente Kafka se conectará e se executará o próprio bootstrap.
+ `KAFKA_SSL_ENABLED`: para habilitar ou desabilitar o SSL em uma conexão Apache Kafka. O valor padrão é “true” (verdadeiro).
+ `KAFKA_CUSTOM_CERT`: o URL do Amazon S3 para o arquivo de certificado CA privado (formato.pem). O padrão é uma string vazia.
+ `KAFKA_SKIP_CUSTOM_CERT_VALIDATION`: para ignorar ou não a validação do arquivo de certificado CA. O AWS Glue valida para três algoritmos: SHA256withRSA, SHA384withRSA e SHA512withRSA. O valor padrão é “false” (falso).
+ `KAFKA_CLIENT_KEYSTORE`: a localização do Amazon S3 do arquivo de repositório de chaves do cliente para autenticação do lado do cliente Kafka (opcional).
+ `KAFKA_CLIENT_KEYSTORE_PASSWORD`: a senha para acessar o repositório de chaves fornecido (opcional).
+ `KAFKA_CLIENT_KEY_PASSWORD`: um repositório de chaves pode consistir em várias chaves, então essa é a senha para acessar a chave do cliente a ser usada com a chave do lado do servidor Kafka (opcional).
+ `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD`: a versão criptografada da senha do repositório de chaves do cliente Kafka (se o usuário tiver a configuração de senhas de criptografia do AWS Glue selecionada).
+ `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD`: a versão criptografada da senha da chave do cliente Kafka (se o usuário tiver a configuração de senhas de criptografia do AWS Glue selecionada).
+ `KAFKA_SASL_MECHANISM`: `"SCRAM-SHA-512"`, `"GSSAPI"`, `"AWS_MSK_IAM"` ou `"PLAIN"`. Esses são os [mecanismos SASL](https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml) compatíveis.
+ `KAFKA_SASL_PLAIN_USERNAME`: um nome de usuário em texto simples usado para autenticar com o mecanismo "PLAIN".
+ `KAFKA_SASL_PLAIN_PASSWORD`: uma senha em texto simples usado para autenticar com o mecanismo "PLAIN".
+ `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD`: a versão criptografada da senha Kafka SASL PLAIN (se o usuário tiver a configuração de senhas de criptografia AWS Glue selecionada).
+ `KAFKA_SASL_SCRAM_USERNAME` - Um nome de usuário em texto simples usado para autenticar com o mecanismo "SCRAM-SHA-512".
+ `KAFKA_SASL_SCRAM_PASSWORD` - Uma senha de texto simples usada para autenticar com o mecanismo "SCRAM-SHA-512".
+ `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` - A versão criptografada da senha Kafka SASL SCRAM (se o usuário tiver a configuração de senhas de criptografia AWS Glue selecionada).
+ `KAFKA_SASL_SCRAM_SECRETS_ARN`: o nome do recurso da Amazon de um segredo do AWS Secrets Manager.
+ `KAFKA_SASL_GSSAPI_KEYTAB` - A localização S3 de um arquivo Kerberos `keytab`. Um keytab armazena chaves de longo prazo para um ou mais principais. Para obter mais informações, consulte [Documentação do MIT Kerberos: Keytab](https://web.mit.edu/kerberos/krb5-latest/doc/basic/keytab_def.html).
+ `KAFKA_SASL_GSSAPI_KRB5_CONF` - A localização S3 de um arquivo Kerberos `krb5.conf`. Um krb5.conf armazena informações de configuração do Kerberos, como a localização do servidor KDC. Para obter mais informações, consulte [Documentação do MIT Kerberos: krb5.conf](https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html).
+ `KAFKA_SASL_GSSAPI_SERVICE` - O nome do serviço Kerberos, conforme definido com `sasl.kerberos.service.name` na sua [Configuração do Kafka](https://kafka.apache.org/documentation/#brokerconfigs_sasl.kerberos.service.name).
+ `KAFKA_SASL_GSSAPI_PRINCIPAL` - O nome do princial Kerberos usado por AWS Glue. Para obter mais informações, consulte [Documentação do Kafka: Configurando agentes do Kafka](https://kafka.apache.org/documentation/#security_sasl_kerberos_clientconfig).
+ `ROLE_ARN`: a função a ser usada para executar consultas.
+ `REGION`: a região da AWS onde as consultas serão executadas.
+ `WORKGROUP_NAME`: o nome de um grupo de trabalho do Amazon Redshift sem servidor ou grupo de trabalho do Amazon Athena no qual as consultas serão executadas.
+ `CLUSTER_IDENTIFIER`: o identificador de cluster de um cluster do Amazon Redshift no qual as consultas serão executadas.
+ `DATABASE`: o banco de dados do Amazon Redshift ao qual você está se conectando.
+ `SparkProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.
Propriedades de conexão específicas para o ambiente computacional Spark.
+ `AthenaProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.
Propriedades de conexão específicas para o ambiente computacional Athena.
+ `PythonProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.
Propriedades de conexão específicas para o ambiente computacional Python.
+ `PhysicalConnectionRequirements` – Um objeto [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements).
Os requisitos de conexão física, como nuvem virtual privada (VPC) e `SecurityGroup`, que são necessários para fazer essa conexão com êxito.
+ `CreationTime` – Timestamp.
A marca de data e hora em que essa definição de conexão foi criada.
+ `LastUpdatedTime` – Timestamp.
A marca de data e hora em que a definição de conexão foi atualizada pela última vez.
+ `LastUpdatedBy` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O usuário, grupo ou função que atualizou pela última vez essa definição de conexão.
+ `Status` – string UTF-8 (valores válidos: `READY` \$1 `IN_PROGRESS` \$1 `FAILED`).
O status da conexão. Pode ser `READY`, `IN_PROGRESS` ou `FAILED`.
+ `StatusReason`: string UTF-8 com não menos que 1 nem mais que 16.384 bytes de comprimento.
O motivo do status da conexão.
+ `LastConnectionValidationTime` – Timestamp.
Uma marca de data e hora da última validação dessa conexão.
+ `AuthenticationConfiguration` – Um objeto [AuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration).
As propriedades de autenticação da conexão.
+ `ConnectionSchemaVersion`: número (inteiro) não inferior a 1 nem superior a 2.
A versão do esquema de conexão para esta conexão. A versão 2 oferece suporte a propriedades para ambientes computacionais específicos.
+ `CompatibleComputeEnvironments` – Uma matriz de strings UTF-8.
Uma lista de ambientes computacionais compatíveis com a conexão.
## Estrutura ConnectionInput
Uma estrutura usada para especificar uma conexão para criar ou atualizar.
**Campos**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da conexão.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
A descrição da conexão.
+ `ConnectionType` – *Obrigatório:* string UTF-8 (valores válidos: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`).
O tipo da conexão. No momento, estes tipos são compatíveis:
+ `JDBC` – Designa uma conexão com um banco de dados por meio do Java Database Connectivity (JDBC).
As conexões de `JDBC` usam o seguinte ConnectionParameters.
+ Obrigatório: todos (`HOST`, `PORT`, `JDBC_ENGINE`) ou `JDBC_CONNECTION_URL`.
+ Obrigatório: todos (`USERNAME`, `PASSWORD`) ou `SECRET_ID`.
+ Opcional: `JDBC_ENFORCE_SSL`, `CUSTOM_JDBC_CERT`, `CUSTOM_JDBC_CERT_STRING`, `SKIP_CUSTOM_JDBC_CERT_VALIDATION`. Esses parâmetros são usados para configurar o SSL com o JDBC.
+ `KAFKA` – Designa uma conexão com uma plataforma de streaming do Apache Kafka.
As conexões de `KAFKA` usam o seguinte ConnectionParameters.
+ Obrigatório: `KAFKA_BOOTSTRAP_SERVERS`.
+ Opcional: `KAFKA_SSL_ENABLED`, `KAFKA_CUSTOM_CERT`, `KAFKA_SKIP_CUSTOM_CERT_VALIDATION`. Esses parâmetros são usados para configurar o SSL com o `KAFKA`.
+ Opcional: `KAFKA_CLIENT_KEYSTORE`, `KAFKA_CLIENT_KEYSTORE_PASSWORD`, `KAFKA_CLIENT_KEY_PASSWORD`, `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD`, `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD`. Esses parâmetros são usados para definir a configuração de cliente TLS com SSL no `KAFKA`.
+ (Opcional): `KAFKA_SASL_MECHANISM`. Pode ser especificado como `SCRAM-SHA-512`, `GSSAPI` ou `AWS_MSK_IAM`.
+ Opcional: `KAFKA_SASL_SCRAM_USERNAME`, `KAFKA_SASL_SCRAM_PASSWORD`, `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD`. Esses parâmetros são usados para configurar a autenticação SASL/SCRAM-SHA-512 com o `KAFKA`.
+ Opcional: `KAFKA_SASL_GSSAPI_KEYTAB`, `KAFKA_SASL_GSSAPI_KRB5_CONF`, `KAFKA_SASL_GSSAPI_SERVICE`, `KAFKA_SASL_GSSAPI_PRINCIPAL`. Esses parâmetros são usados para configurar a autenticação SASL/GSSAPI com o `KAFKA`.
+ `MONGODB` – Designa uma conexão com um banco de dados de documentos do MongoDB.
As conexões de `MONGODB` usam o seguinte ConnectionParameters.
+ Obrigatório: `CONNECTION_URL`.
+ Obrigatório: todos (`USERNAME`, `PASSWORD`) ou `SECRET_ID`.
+ `VIEW_VALIDATION_REDSHIFT`: designa uma conexão usada para validação de visualizações pelo Amazon Redshift.
+ `VIEW_VALIDATION_ATHENA`: designa uma conexão usada para validação de visualizações pelo Amazon Athena.
+ `NETWORK`: designa uma conexão de rede a uma fonte de dados dentro de um ambiente do Amazon Virtual Private Cloud (Amazon VPC).
As conexões de `NETWORK` não exigem ConnectionParameters. Em vez disso, forneça PhysicalConnectionRequirements.
+ `MARKETPLACE`: usa as definições de configurações contidas em um conector adquirido de AWS Marketplace para ler e gravar em armazenamentos de dados que não são suportados nativamente pelo AWS Glue.
As conexões de `MARKETPLACE` usam o seguinte ConnectionParameters.
+ Obrigatório: `CONNECTOR_TYPE`, `CONNECTOR_URL`, `CONNECTOR_CLASS_NAME`, `CONNECTION_URL`.
+ Obrigatório para conexões de `JDBC` `CONNECTOR_TYPE`: todos (`USERNAME`, `PASSWORD`) ou `SECRET_ID`.
+ `CUSTOM` - usa as definições de configurações contidas em um conector personalizado para ler e gravar em armazenamentos de dados que não são suportados nativamente pelo AWS Glue.
Para obter mais informações sobre os parâmetros de conexão necessários para um conector específico, consulte a documentação do conector em [Adicionar uma conexão do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/console-connections.html) no Guia do usuário do AWS Glue.
`SFTP`Não há suporte ao .
Para obter mais informações sobre como ConnectionProperties opcionais são usadas para configurar recursos no AWS Glue, consulte [Propriedades da conexão do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html).
Para obter mais informações sobre como ConnectionProperties opcionais são usadas para configurar recursos no AWS Glue Studio, consulte [Usar conectores e conexões](https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html).
+ `MatchCriteria` – Uma matriz de strings UTF-8, no máximo 10 strings.
Uma lista de critérios que podem ser usados na seleção dessa conexão.
+ `ConnectionProperties`: *obrigatório:* uma matriz de mapa dos pares de chave-valor, no máximo 100 pares.
Cada chave é uma string UTF-8 (valores válidos: `HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`).
Cada chave é uma string Value com no mínimo 1 e no máximo 1.024 bytes de comprimento.
Esses pares de chave/valor definem parâmetros para a conexão.
+ `SparkProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.
Propriedades de conexão específicas para o ambiente computacional Spark.
+ `AthenaProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.
Propriedades de conexão específicas para o ambiente computacional Athena.
+ `PythonProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.
Propriedades de conexão específicas para o ambiente computacional Python.
+ `PhysicalConnectionRequirements` – Um objeto [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements).
Os requisitos de conexão física, como nuvem privada virtual (VPC) e `SecurityGroup`, que são necessários para estabelecer essa conexão com êxito.
+ `AuthenticationConfiguration` – Um objeto [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput).
As propriedades de autenticação da conexão.
+ `ValidateCredentials` – Booleano.
Um sinalizador para validar as credenciais durante a criação da conexão. O padrão é true (verdadeiro).
+ `ValidateForComputeEnvironments` – Uma matriz de strings UTF-8.
Os ambientes computacionais em relação aos quais as propriedades de conexão especificadas são validadas.
## Estrutura TestConnectionInput
Uma estrutura usada para especificar o teste de uma conexão para um serviço.
**Campos**
+ `ConnectionType` – *Obrigatório:* string UTF-8 (valores válidos: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`).
O tipo da conexão a ser testada. Essa operação está disponível somente para os tipos de conexão `JDBC` ou `SALESFORCE`.
+ `ConnectionProperties`: *obrigatório:* uma matriz de mapa dos pares de chave-valor, no máximo 100 pares.
Cada chave é uma string UTF-8 (valores válidos: `HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`).
Cada chave é uma string Value com no mínimo 1 e no máximo 1.024 bytes de comprimento.
Os pares de chave-valor que definem parâmetros para a conexão.
As conexões do JDBC usam as seguintes propriedades de conexão:
+ Obrigatório: todos (`HOST`, `PORT`, `JDBC_ENGINE`) ou `JDBC_CONNECTION_URL`.
+ Obrigatório: todos (`USERNAME`, `PASSWORD`) ou `SECRET_ID`.
+ Opcional: `JDBC_ENFORCE_SSL`, `CUSTOM_JDBC_CERT`, `CUSTOM_JDBC_CERT_STRING`, `SKIP_CUSTOM_JDBC_CERT_VALIDATION`. Esses parâmetros são usados para configurar o SSL com o JDBC.
As conexões do SALESFORCE exigem que o membro `AuthenticationConfiguration` seja configurado.
+ `AuthenticationConfiguration` – Um objeto [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput).
Uma estrutura que contém a configuração de autenticação na solicitação TestConnection. Necessária para uma conexão ao Salesforce usando a autenticação OAuth.
## Estrutura PhysicalConnectionRequirements
O aplicativo cliente OAuth na resposta GetConnection.
**Campos**
+ `SubnetId` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID da sub-rede usada pela conexão.
+ `SecurityGroupIdList` – Uma matriz de strings UTF-8, no máximo 50 strings.
A lista de IDs de grupo de segurança usada pela conexão.
+ `AvailabilityZone` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
A zona de disponibilidade da conexão.
## Estrutura GetConnectionsFilter
Filtra as definições de conexão retornadas pela `GetConnections` operação da API.
**Campos**
+ `MatchCriteria` – Uma matriz de strings UTF-8, no máximo 10 strings.
Uma cadeia de critérios que deve corresponder aos critérios registrados na definição de conexão para a definição de conexão a ser retornada.
+ `ConnectionType` – String UTF-8 (valores válidos: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`).
O tipo de conexão a ser retornada. No momento, o SFTP não é compatível.
+ `ConnectionSchemaVersion`: número (inteiro) não inferior a 1 nem superior a 2.
Indica se a conexão foi criada com a versão 1 ou 2 do esquema.
## Estrutura AuthenticationConfiguration
Uma estrutura que contém a configuração de autenticação.
**Campos**
+ `AuthenticationType` – string UTF-8 (valores válidos: `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`).
Uma estrutura que contém a configuração de autenticação.
+ `SecretArn` – String UTF-8 correspondente a [Custom string pattern #36](aws-glue-api-common.md#regex_36).
O ARN do gerenciador de segredos para armazenar credenciais.
+ `KmsKeyArn` – String UTF-8 correspondente a [Custom string pattern #42](aws-glue-api-common.md#regex_42).
O nome do recurso da Amazon (ARN) da chave do KMS usada para criptografar informações de autenticação sensíveis. Essa chave é usada para proteger credenciais e outros dados sensíveis armazenados na configuração de autenticação.
+ `OAuth2Properties` – Um objeto [OAuth2Properties](#aws-glue-api-catalog-connections-connections-OAuth2Properties).
As propriedades da autenticação OAuth2.
## Estrutura AuthenticationConfigurationInput
Uma estrutura que contém a configuração de autenticação na solicitação CreateConnection.
**Campos**
+ `AuthenticationType` – string UTF-8 (valores válidos: `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`).
Uma estrutura que contém a configuração de autenticação na solicitação CreateConnection.
+ `OAuth2Properties` – Um objeto [OAuth2PropertiesInput](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput).
As propriedades da autenticação OAuth2 na solicitação CreateConnection.
+ `SecretArn` – String UTF-8 correspondente a [Custom string pattern #36](aws-glue-api-common.md#regex_36).
O ARN do gerenciador de segredos para armazenar as credenciais na solicitação CreateConnection.
+ `KmsKeyArn` – String UTF-8 correspondente a [Custom string pattern #42](aws-glue-api-common.md#regex_42).
O ARN da chave do KMS usada para criptografar a conexão. Recebida somente como entrada na solicitação e armazenada no Secret Manager.
+ `BasicAuthenticationCredentials` – Um objeto [BasicAuthenticationCredentials](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials).
As credenciais usadas quando o tipo de autenticação é autenticação básica.
+ `CustomAuthenticationCredentials` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.
As credenciais usadas quando o tipo de autenticação é autenticação personalizada.
## Estrutura OAuth2Properties
Uma estrutura que contém propriedades da autenticação OAuth2.
**Campos**
+ `OAuth2GrantType` – string UTF-8 (valores válidos: `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`).
O tipo de concessão de OAuth2. Por exemplo, `AUTHORIZATION_CODE`, `JWT_BEARER` ou `CLIENT_CREDENTIALS`.
+ `OAuth2ClientApplication` – Um objeto [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication).
O tipo de aplicação do cliente. Por exemplo, AWS\$1MANAGED ou USER\$1MANAGED.
+ `TokenUrl`: string UTF-8 com no máximo 256 bytes de comprimento e correspondente a [Custom string pattern #40](aws-glue-api-common.md#regex_40).
O URL do servidor de autenticação do provedor para trocar um código de autorização por um token de acesso.
+ `TokenUrlParametersMap` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é uma string UTF-8 com comprimento mínimo de 1 e comprimento máximo de 512 bytes.
Um mapa de parâmetros que são adicionados à solicitação de token `GET`.
## Estrutura OAuth2PropertiesInput
Uma estrutura que contém propriedades de OAuth2 na solicitação CreateConnection.
**Campos**
+ `OAuth2GrantType` – string UTF-8 (valores válidos: `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`).
O tipo de concessão OAuth2 na solicitação CreateConnection. Por exemplo, `AUTHORIZATION_CODE`, `JWT_BEARER` ou `CLIENT_CREDENTIALS`.
+ `OAuth2ClientApplication` – Um objeto [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication).
O tipo de aplicação cliente na solicitação CreateConnection. Por exemplo, `AWS_MANAGED` ou `USER_MANAGED`.
+ `TokenUrl` – string UTF-8 com no máximo 256 bytes de comprimento e correspondente a [Custom string pattern #40](aws-glue-api-common.md#regex_40).
O URL do servidor de autenticação do provedor para trocar um código de autorização por um token de acesso.
+ `TokenUrlParametersMap` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é uma string UTF-8 com comprimento mínimo de 1 e comprimento máximo de 512 bytes.
Um mapa de parâmetros que são adicionados à solicitação de token `GET`.
+ `AuthorizationCodeProperties` – Um objeto [AuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties).
O conjunto de propriedades necessárias para o tipo de concessão `AUTHORIZATION_CODE` de OAuth2.
+ `OAuth2Credentials` – Um objeto [OAuth2Credentials](#aws-glue-api-catalog-connections-connections-OAuth2Credentials).
As credenciais usadas quando o tipo de autenticação é autenticação OAuth2.
## Estrutura OAuth2ClientApplication
A aplicação cliente OAuth2 usada para a conexão.
**Campos**
+ `UserManagedClientApplicationClientId` – string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a [Custom string pattern #37](aws-glue-api-common.md#regex_37).
O ClientID da aplicação cliente se ClientAppType for `USER_MANAGED`.
+ `AWSManagedClientApplicationReference` – string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a [Custom string pattern #37](aws-glue-api-common.md#regex_37).
A referência à aplicação cliente do lado SaaS que é gerenciada pela AWS.
## Estrutura AuthorizationCodeProperties
O conjunto de propriedades necessárias para o fluxo de trabalho do tipo de concessão `AUTHORIZATION_CODE` de OAuth2.
**Campos**
+ `AuthorizationCode`: string UTF-8 com no mínimo 1 e no máximo 4.096 bytes de comprimento e correspondente a [Custom string pattern #37](aws-glue-api-common.md#regex_37).
Um código de autorização a ser usado na terceira etapa do fluxo de trabalho de concessão de `AUTHORIZATION_CODE`. Esse é um código de uso único que se torna inválido quando trocado por um token de acesso, portanto, é aceitável ter esse valor como parâmetro de solicitação.
+ `RedirectUri`: string UTF-8 com no máximo 512 bytes de comprimento e correspondente a [Custom string pattern #41](aws-glue-api-common.md#regex_41).
O URI de redirecionamento para o qual o usuário é redirecionado pelo servidor de autorização ao emitir um código de autorização. O URI é usado posteriormente quando o código de autorização é trocado por um token de acesso.
## Estrutura BasicAuthenticationCredentials
Usado para fornecer credenciais de autenticação básica caso nenhum valor tenha sido especificado para `SecretArn`.
**Campos**
+ `Username` – string UTF-8 com no máximo 512 bytes de comprimento e correspondente a [Custom string pattern #37](aws-glue-api-common.md#regex_37).
O nome de usuário usado para efetuar a conexão com a fonte de dados.
+ `Password` – string UTF-8 com no máximo 512 bytes de comprimento e correspondente a [Custom string pattern #33](aws-glue-api-common.md#regex_33).
A senha usada para efetuar a conexão com a fonte de dados.
## Estrutura OAuth2Credentials
As credenciais usadas quando o tipo de autenticação é autenticação OAuth2.
**Campos**
+ `UserManagedClientApplicationClientSecret` – string UTF-8 com no máximo 512 bytes de comprimento e correspondente a [Custom string pattern #38](aws-glue-api-common.md#regex_38).
O segredo do cliente da aplicação cliente, caso a aplicação cliente seja gerenciada pelo usuário.
+ `AccessToken`: string UTF-8 com no máximo 4.096 bytes de comprimento e correspondente a [Custom string pattern #38](aws-glue-api-common.md#regex_38).
O token de acesso usado quando o tipo de autenticação é OAuth2.
+ `RefreshToken`: string UTF-8 com no máximo 4.096 bytes de comprimento e correspondente a [Custom string pattern #38](aws-glue-api-common.md#regex_38).
O token de atualização usado quando o tipo de autenticação é OAuth2.
+ `JwtToken`: string UTF-8 com no máximo 8.000 bytes de comprimento e correspondente a [Custom string pattern #39](aws-glue-api-common.md#regex_39).
O padrão JSON Web Token (JWT) usado quando o tipo de autenticação é OAuth2.
## Operações
+ [Ação CreateConnection (Python: create\$1connection)](#aws-glue-api-catalog-connections-connections-CreateConnection)
+ [Ação DeleteConnection (Python: delete\$1connection)](#aws-glue-api-catalog-connections-connections-DeleteConnection)
+ [Ação GetConnection (Python: get\$1connection)](#aws-glue-api-catalog-connections-connections-GetConnection)
+ [Ação GetConnections (Python: get\$1connections)](#aws-glue-api-catalog-connections-connections-GetConnections)
+ [Ação UpdateConnection (Python: update\$1connection)](#aws-glue-api-catalog-connections-connections-UpdateConnection)
+ [Ação TestConnection (Python: test\$1connection)](#aws-glue-api-catalog-connections-connections-TestConnection)
+ [Ação BatchDeleteConnection (Python: batch\$1delete\$1connection)](#aws-glue-api-catalog-connections-connections-BatchDeleteConnection)
## Ação CreateConnection (Python: create\$1connection)
Cria uma definição de conexão no catálogo de dados.
As conexões usadas para criar recursos federados exigem a permissão `glue:PassConnection` do IAM.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que a conexão será criada. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `ConnectionInput` – *Obrigatório:* um objeto [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput).
Um objeto `ConnectionInput` que define a conexão a ser criada.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais que 50 pares.
Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes.
Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento.
As tags que você atribui à conexão.
**Resposta**
+ `CreateConnectionStatus` – string UTF-8 (valores válidos: `READY` \$1 `IN_PROGRESS` \$1 `FAILED`).
O status da solicitação de criação da conexão. A solicitação pode levar algum tempo para determinados tipos de autenticação, por exemplo, ao criar uma conexão OAuth com troca de tokens via VPC.
**Erros**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
## Ação DeleteConnection (Python: delete\$1connection)
Exclui uma conexão do catálogo de dados.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que a conexão residirá. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `ConnectionName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da conexão a ser excluída.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
## Ação GetConnection (Python: get\$1connection)
Recupera uma definição de conexão do catálogo de dados.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que a conexão residirá. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da definição de conexão a ser recuperada.
+ `HidePassword` – Booleano.
Permite recuperar os metadados de conexão sem retornar a senha. Por exemplo, o console do AWS Glue usa esse sinalizador para recuperar a conexão e não exibe a senha. Defina esse parâmetro quando o autor da chamada não tem permissão para usar a chave do AWS KMS para descriptografar a senha, mas tem permissão para acessar o restante das propriedades da conexão.
+ `ApplyOverrideForComputeEnvironment` – string UTF-8 (valores válidos: `SPARK` \$1 `ATHENA` \$1 `PYTHON`).
Para conexões que podem ser usadas em vários serviços, especifica as propriedades de retorno para o ambiente computacional especificado.
**Resposta**
+ `Connection` – Um objeto [Conexão](#aws-glue-api-catalog-connections-connections-Connection).
A definição de conexão solicitada.
**Erros**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
## Ação GetConnections (Python: get\$1connections)
Recupera uma lista de definições de conexão do catálogo de dados.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que as conexões residirão. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `Filter` – Um objeto [GetConnectionsFilter](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter).
Um filtro que controla quais conexões são retornadas.
+ `HidePassword` – Booleano.
Permite recuperar os metadados de conexão sem retornar a senha. Por exemplo, o console do AWS Glue usa esse sinalizador para recuperar a conexão e não exibe a senha. Defina esse parâmetro quando o autor da chamada não tem permissão para usar a chave do AWS KMS para descriptografar a senha, mas tem permissão para acessar o restante das propriedades da conexão.
+ `NextToken` – String UTF-8.
Um token de continuação, se esta for uma chamada de continuação.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.
O número máximo de conexões a ser retornado em uma resposta.
**Resposta**
+ `ConnectionList`: um array de objetos [Conexão](#aws-glue-api-catalog-connections-connections-Connection).
Uma lista das definições de conexão solicitadas.
+ `NextToken` – String UTF-8.
Um token de continuação, se a lista de conexões retornada não incluir a última das conexões filtradas.
**Erros**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
## Ação UpdateConnection (Python: update\$1connection)
Atualiza uma definição de conexão no catálogo de dados.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que a conexão residirá. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da definição de conexão a ser atualizada.
+ `ConnectionInput` – *Obrigatório:* um objeto [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput).
Um objeto `ConnectionInput` que redefine a conexão em questão.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
## Ação TestConnection (Python: test\$1connection)
Testa uma conexão com um serviço para validar as credenciais de serviço que você fornece.
Você pode fornecer um nome de conexão existente ou uma `TestConnectionInput` para testar uma entrada de conexão não existente. Fornecer ambos ao mesmo tempo causará um erro.
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
**Solicitação**
+ `ConnectionName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Opcional. O nome da conexão a ser testada. Se apenas o nome for fornecido, a operação obterá a conexão e a usará para o teste.
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo no qual a conexão está localizada.
+ `TestConnectionInput` – Um objeto [TestConnectionInput](#aws-glue-api-catalog-connections-connections-TestConnectionInput).
Uma estrutura usada para especificar o teste de uma conexão para um serviço.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConflictException`
+ `InternalServiceException`
## Ação BatchDeleteConnection (Python: batch\$1delete\$1connection)
Exclui uma lista de definições de conexão do catálogo de dados.
**Solicitação**
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que as conexões residirão. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `ConnectionNameList` – *Obrigatório:* uma matriz de strings UTF-8, no máximo 25 strings.
Uma lista de nomes das conexões a serem excluídas.
**Resposta**
+ `Succeeded` – Uma matriz de strings UTF-8.
Uma lista de nomes das definições de conexão que foram excluídas com sucesso.
+ `Errors` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Cada valor é um objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).
Um mapa dos nomes das conexões que não foram excluídas com sucesso (para acessar detalhes do erro).
**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`
# API de tipos de conexão
A API de tipo de conexão descreve as APIs do AWS Glue relacionadas à descrição dos tipos de conexão.
## APIs de gerenciamento de conexões
+ [Ação DescribeConnectionType (Python: describe\$1connection\$1type)](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
+ [Ação ListConnectionTypes (Python: list\$1connection\$1types)](#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes)
+ [Estrutura ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief)
+ [Estrutura de ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant)
## Ação DescribeConnectionType (Python: describe\$1connection\$1type)
A API `DescribeConnectionType` fornece detalhes completos das opções válidas para um determinado tipo de conexão no AWS Glue.
**Solicitação**
+ `ConnectionType`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do tipo de conexão a ser descrito.
**Resposta**
+ `ConnectionType` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do tipo de conexão.
+ `Description`: string UTF-8, com no máximo 1.024 bytes.
Uma descrição do tipo de conexão.
+ `Capabilities` – Um objeto [Capacidades](#aws-glue-api-catalog-connections-connections-type-Capabilities).
Os tipos de autenticação, os tipos de interface de dados (ambientes de computação) e as operações de dados compatíveis do conector.
+ `ConnectionProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.
Propriedades da conexão que são comuns entre ambientes computacionais.
+ `ConnectionOptions` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.
Retorna propriedades que podem ser definidas ao criar uma conexão no `ConnectionInput.ConnectionProperties`. `ConnectionOptions` define parâmetros que podem ser definidos em um script ETL do Spark no mapa de opções de conexão passado para um quadro de dados.
+ `AuthenticationConfiguration` – Um objeto [AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration).
O tipo da autenticação usada para a conexão.
+ `ComputeEnvironmentConfigurations` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é um objeto [ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration) A.
Os ambientes computacionais aceitos pela conexão.
+ `PhysicalConnectionRequirements` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.
Requisitos físicos para uma conexão, como especificações de VPC, sub-rede e grupo de segurança.
+ `AthenaConnectionProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.
Propriedades de conexão específicas para o ambiente computacional Athena.
+ `PythonConnectionProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.
Propriedades de conexão específicas para o ambiente computacional Python.
+ `SparkConnectionProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.
Propriedades de conexão específicas para o ambiente computacional Spark.
**Erros**
+ `ValidationException`
+ `InvalidInputException`
+ `InternalServiceException`
## Ação ListConnectionTypes (Python: list\$1connection\$1types)
A API `ListConnectionTypes` fornece um mecanismo de descoberta para aprender os tipos de conexão disponíveis no AWS Glue. A resposta contém uma lista de tipos de conexão com detalhes de alto nível do que é aceito para cada tipo de conexão. Os tipos de conexão listados são o conjunto de opções válidas para o valor `ConnectionType` na API `CreateConnection`.
**Solicitação**
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.
O número máximo de resultados a serem retornados.
+ `NextToken` – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Um token de continuação, se esta for uma chamada de continuação.
**Resposta**
+ `ConnectionTypes`: um array de objetos [ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief).
Uma lista de objetos `ConnectionTypeBrief` contendo informações breves sobre os tipos de conexão válidos.
+ `NextToken` – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Um token de continuação, se o segmento de lista atual não for o último.
**Erros**
+ `InternalServiceException`
## Estrutura ConnectionTypeBrief
Informações breves sobre um tipo de conexão compatível retornado pela API `ListConnectionTypes`.
**Campos**
+ `ConnectionType` – String UTF-8 (valores válidos: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`).
O nome do tipo de conexão.
+ `DisplayName` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.
O nome legível por humanos para o tipo de conexão exibido no console do AWS Glue.
+ `Vendor` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.
O nome do fornecedor ou provedor que criou ou mantém esse tipo de conexão.
+ `Description`: string UTF-8, com no máximo 1.024 bytes.
Uma descrição do tipo de conexão.
+ `Categories` – .
Uma lista das categorias às quais esse tipo de conexão pertence. As categorias ajudam os usuários a filtrar e encontrar os tipos de conexões apropriados com base em seus casos de uso.
+ `Capabilities` – Um objeto [Capacidades](#aws-glue-api-catalog-connections-connections-type-Capabilities).
Os tipos de autenticação, os tipos de interface de dados (ambientes de computação) e as operações de dados compatíveis do conector.
+ `LogoUrl` – String UTF-8.
O URL do logotipo associado a um tipo de conexão.
+ `ConnectionTypeVariants`: um array de objetos [ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant).
Uma lista das variantes disponíveis para esse tipo de conexão. Variantes diferentes podem oferecer configurações especializadas para determinados casos de uso ou implementações do mesmo tipo geral de conexão.
## Estrutura de ConnectionTypeVariant
Representa uma variante de um tipo de conexão do AWS Glue Data Catalog. Variantes de tipos de conexões oferecem configurações e comportamentos específicos para diferentes implementações do mesmo tipo geral de conexão.
**Campos**
+ `ConnectionTypeVariantName` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.
O identificador exclusivo da variante de tipo de conexão. Esse nome é usado internamente para identificar a variante específica de um tipo de conexão.
+ `DisplayName` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.
O nome legível por humanos da variante de tipo de conexão que é exibida no console do AWS Glue.
+ `Description`: string UTF-8, com no máximo 1.024 bytes.
Uma descrição detalhada da variante de tipo de conexão, incluindo finalidade, casos de uso e requisitos específicos de configuração.
+ `LogoUrl` – String UTF-8.
A URL do logotipo associado a uma variante de tipo de conexão.
## datatypes
+ [Estrutura Validation](#aws-glue-api-catalog-connections-connections-type-Validation)
+ [Estrutura AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration)
+ [Estrutura de capacidades](#aws-glue-api-catalog-connections-connections-type-Capabilities)
+ [Estrutura Property](#aws-glue-api-catalog-connections-connections-type-Property)
+ [Estrutura AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue)
+ [Estrutura ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration)
## Estrutura Validation
Define como a validação é executada em uma propriedade de conexão.
**Campos**
+ `ValidationType` – *Obrigatório:* string UTF-8 (valores válidos: `REGEX` \$1 `RANGE`).
O tipo de validação a ser realizada, como `REGEX`.
+ `Patterns` – .
Uma lista de padrões que se aplicam à validação.
+ `Description` *(obrigatório):* string UTF-8, podendo ter entre 1 e 1.024 bytes.
Uma descrição da validação.
+ `MaxLength` – Número (íntegro).
Um comprimento máximo para uma propriedade de conexão de string.
+ `Maximum` – Número (íntegro).
Um valor máximo ao especificar um tipo de validação `RANGE`.
+ `Minimum` – Número (íntegro).
Um valor mínimo ao especificar um tipo de validação `RANGE`.
## Estrutura AuthConfiguration
A configuração de autenticação para uma conexão retornada pela API `DescribeConnectionType`.
**Campos**
+ `AuthenticationType` – *Obrigatório:* um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property).
O tipo da autenticação de uma conexão.
+ `SecretArn` – Um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property).
O nome do recurso da Amazon (ARN) do Secrets Manager.
+ `OAuth2Properties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.
Um mapa de pares de chave-valore para as propriedades da OAuth2. Cada valor é um objeto `Property`.
+ `BasicAuthenticationProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.
Um mapa de pares de chave-valore para as propriedades da OAuth2. Cada valor é um objeto `Property`.
+ `CustomAuthenticationProperties` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.
Um mapa de pares de chave-valore para as propriedades da autenticação personalizada. Cada valor é um objeto `Property`.
## Estrutura de capacidades
Especifica os tipos de autenticação compatíveis retornados pela API `DescribeConnectionType`.
**Campos**
+ `SupportedAuthenticationTypes`: *obrigatório:* uma matriz de strings UTF-8.
Uma lista dos tipos de autenticação compatíveis.
+ `SupportedDataOperations`: *obrigatório:* uma matriz de strings UTF-8.
Uma lista das operações de dados compatíveis.
+ `SupportedComputeEnvironments`: *obrigatório:* uma matriz de strings UTF-8.
Uma lista de ambientes computacionais compatíveis.
## Estrutura Property
Um objeto que define um tipo de conexão para um ambiente computacional.
**Campos**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
O nome da propriedade.
+ `Description`: *obrigatório:* string UTF-8 com no máximo 1.024 bytes de comprimento.
Uma descrição da propriedade.
+ `Required`: *obrigatório:* booleano.
Indica se a propriedade é obrigatória.
+ `PropertyTypes`: *obrigatório:* uma matriz de strings UTF-8.
Descreve o tipo de propriedade.
+ `AllowedValues`: um array de objetos [AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue).
Uma lista de objetos `AllowedValue` representando os valores permitidos para a propriedade.
+ `DataOperationScopes` – Uma matriz de strings UTF-8.
Indica quais operações de dados são aplicáveis à propriedade.
## Estrutura AllowedValue
Um objeto que representa um valor permitido para uma propriedade.
**Campos**
+ `Description`: string UTF-8, com no máximo 1.024 bytes.
Uma descrição do valor permitido.
+ `Value`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
O valor permitido para a propriedade.
## Estrutura ComputeEnvironmentConfiguration
Um objeto contendo a configuração de um ambiente computacional (como Spark, Python ou Athena) retornado pela API `DescribeConnectionType`.
**Campos**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Um nome para a configuração do ambiente computacional.
+ `Description`: *obrigatório:* string UTF-8 com no máximo 1.024 bytes de comprimento.
Uma descrição do ambiente computacional.
+ `ComputeEnvironment` – *Obrigatório:* string UTF-8 (valores válidos: `SPARK` \$1 `ATHENA` \$1 `PYTHON`).
O tipo do ambiente de computação.
+ `SupportedAuthenticationTypes`: *obrigatório:* uma matriz de strings UTF-8.
Os tipos de autenticação com suporte para o ambiente computacional.
+ `ConnectionOptions`: *obrigatório:* uma matriz de mapa dos pares de chave-valor.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.
Os parâmetros usados como opções de conexão para o ambiente computacional.
+ `ConnectionPropertyNameOverrides`: *obrigatório:* uma matriz de mapa dos pares de chave-valor.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
O nome da propriedade de conexão é substituído para ambiente computacional.
+ `ConnectionOptionNameOverrides`: *obrigatório:* uma matriz de mapa dos pares de chave-valor.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.
O nome da opção de conexão é substituído para ambiente computacional.
+ `ConnectionPropertiesRequiredOverrides` – *Obrigatório:* .
As propriedades de conexão que são necessárias como substituição para o ambiente computacional.
+ `PhysicalConnectionPropertiesRequired` – Booleano.
Indica se as `PhysicalConnectionProperties` são necessários para o ambiente computacional.
# Metadados de conexão e API de visualização
As APIs de conexão a seguir descrevem as operações necessárias para descrever os metadados da conexão.
## Tipos de dados
+ [Estrutura Entity](#aws-glue-api-catalog-connections-connections-metadata-Entity)
+ [Estrutura Field](#aws-glue-api-catalog-connections-connections-metadata-Field)
## Estrutura Entity
Uma entidade sustentada por um determinado `ConnectionType`.
**Campos**
+ `EntityName` – String UTF-8.
O nome da entidade.
+ `Label` – String UTF-8.
Rótulo usado para a entidade.
+ `IsParentEntity` – Booleano.
Um valor booleano que ajuda a determinar se há subobjetos que podem ser listados.
+ `Description` – String UTF-8.
Uma descrição da entidade.
+ `Category` – String UTF-8.
O tipo das entidades que estão presentes na resposta. Esse valor depende da conexão de origem. Por exemplo, ele é `SObjects` para o Salesforce e `databases` ou `schemas` ou `tables` para fontes como o Amazon Redshift.
+ `CustomProperties` –
Um mapa opcional de chaves que pode ser retornado para uma entidade por um conector.
## Estrutura Field
O objeto `Field` tem informações sobre as diferentes propriedades associadas a um campo no conector.
**Campos**
+ `FieldName` – String UTF-8.
O identificador exclusivo do campo.
+ `Label` – String UTF-8.
Um rótulo legível usado para o campo.
+ `Description` – String UTF-8.
Uma descrição do campo.
+ `FieldType`: string UTF-8 (valores válidos: `INT` \$1 `SMALLINT` \$1 `BIGINT` \$1 `FLOAT` \$1 `LONG` \$1 `DATE` \$1 `BOOLEAN` \$1 `MAP` \$1 `ARRAY` \$1 `STRING` \$1 `TIMESTAMP` \$1 `DECIMAL` \$1 `BYTE` \$1 `SHORT` \$1 `DOUBLE` \$1 `STRUCT`).
O tipo dos dados no campo.
+ `IsPrimaryKey` – Booleano.
Indica se esse campo pode ser usado como chave primária para a entidade em questão.
+ `IsNullable` – Booleano.
Indica se esse campo pode ser anulável ou não.
+ `IsRetrievable` – Booleano.
Indica se esse campo pode ser adicionado na cláusula Select da consulta SQL ou se é recuperável ou não.
+ `IsFilterable` – Booleano.
Indica se esse campo pode ser usado em uma cláusula de filtro (cláusula `WHERE`) de uma instrução SQL ao consultar dados.
+ `IsPartitionable` – Booleano.
Indica se um determinado campo pode ser usado no particionamento da consulta feita para SaaS.
+ `IsCreateable` – Booleano.
Indica se esse campo pode ser criado como parte de uma gravação de destino.
+ `IsUpdateable` – Booleano.
Indica se esse campo pode ser atualizado como parte de uma gravação de destino.
+ `IsUpsertable` – Booleano.
Indica se esse campo pode ser upserted como parte de uma gravação de destino.
+ `IsDefaultOnCreate` – Booleano.
Indica se esse campo é preenchido automaticamente quando o objeto é criado, como um campo criado no timestamp.
+ `SupportedValues` – .
Uma lista de valores compatíveis para o campo.
+ `SupportedFilterOperators` – Uma matriz de strings UTF-8.
Indica os operadores de filtro de suporte para esse campo.
+ `CustomProperties` –
Mapa opcional das chaves que podem ser devolvidas.
## Operações
+ [Ação ListEntities (Python: list\$1entities)](#aws-glue-api-catalog-connections-connections-metadata-ListEntities)
+ [Ação DescribeEntity (Python: describe\$1entity)](#aws-glue-api-catalog-connections-connections-metadata-DescribeEntity)
+ [Ação GetEntityRecords (Python: get\$1entity\$1records)](#aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords)
## Ação ListEntities (Python: list\$1entities)
Retorna as entidades disponíveis compatíveis com o tipo de conexão.
**Solicitação**
+ `ConnectionName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Um nome para a conexão que tem as credenciais necessárias para consultar qualquer tipo de conexão.
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo que contém a conexão. Esse valor pode ser nulo. Por padrão, o ID da conta da AWS é o ID do catálogo.
+ `ParentEntityName` – String UTF-8.
O nome entidade pai para a qual você deseja escutar as filhas. Esse parâmetro usa um caminho totalmente qualificado da entidade para listar as entidades filhas.
+ `NextToken` – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Um token de continuação, incluído se esta for uma chamada de continuação.
+ `DataStoreApiVersion` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #23](aws-glue-api-common.md#regex_23).
A versão da API do conector SaaS.
**Resposta**
+ `Entities`: um array de objetos [Entidade](#aws-glue-api-catalog-connections-connections-metadata-Entity).
Uma lista dos objetos `Entity`.
+ `NextToken` – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Um token de continuação, presente se o segmento atual não for o último.
**Erros**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`
## Ação DescribeEntity (Python: describe\$1entity)
Fornece detalhes sobre a entidade usada com o tipo de conexão, com uma descrição do modelo de dados para cada campo na entidade selecionada.
A resposta inclui todos os campos que compõem a entidade.
**Solicitação**
+ `ConnectionName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da conexão que contém as credenciais do tipo de conexão.
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo que contém a conexão. Esse valor pode ser nulo. Por padrão, o ID da conta da AWS é o ID do catálogo.
+ `EntityName` – *Obrigatório:* string UTF-8.
O nome da entidade que você deseja descrever com base no tipo de conexão.
+ `NextToken` – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Um token de continuação, incluído se esta for uma chamada de continuação.
+ `DataStoreApiVersion` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #23](aws-glue-api-common.md#regex_23).
A versão da API usada para o armazenamento de dados.
**Resposta**
+ `Fields`: um array de objetos [Campo](#aws-glue-api-catalog-connections-connections-metadata-Field).
Descreve os campos dessa entidade de conector. Essa é a lista de objetos `Field`. `Field` é muito semelhante a uma tabela em um banco de dados. O objeto `Field` tem informações sobre as diferentes propriedades associadas a campos no conector.
+ `NextToken` – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Um token de continuação, presente se o segmento atual não for o último.
**Erros**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`
## Ação GetEntityRecords (Python: get\$1entity\$1records)
Essa API é usada para consultar dados de prévia de um determinado tipo de conexão ou de um Catálogo de Dados do AWS Glue nativo baseado no Amazon S3.
Retorna registros como um array de blobs JSON. Cada registro é formatado usando Jackson JsonNode com base no tipo de campo definido pela API `DescribeEntity`.
Os conectores Spark geram esquemas de acordo com o mesmo mapeamento de tipos de dados da API `DescribeEntity`. Os conectores Spark convertem dados nos tipos de dados apropriados e correspondentes ao esquema ao retornar linhas.
**Solicitação**
+ `ConnectionName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da conexão que contém as credenciais do tipo de conexão.
+ `CatalogId` – string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo que contém a conexão. Esse valor pode ser nulo. Por padrão, o ID da conta da AWS é o ID do catálogo.
+ `EntityName` – *Obrigatório:* string UTF-8.
Nome da entidade na qual queremos consultar os dados de prévia do tipo de conexão determinado.
+ `NextToken` – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Um token de continuação, incluído se esta for uma chamada de continuação.
+ `DataStoreApiVersion` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #23](aws-glue-api-common.md#regex_23).
A versão da API do conector SaaS.
+ `ConnectionOptions`: um array de mapa dos pares de chave-valor com não mais do que 100 pares.
Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento e correspondente a [Custom string pattern #18](aws-glue-api-common.md#regex_18).
Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento e correspondente a [Custom string pattern #17](aws-glue-api-common.md#regex_17).
Opções de conector necessárias para consultar os dados.
+ `FilterPredicate`: string UTF-8 com no mínimo 1 e no máximo 100.000 bytes de comprimento.
Um predicado de filtro que pode ser aplicado à solicitação de consulta.
+ `Limit`: *obrigatório:* número (longo) no mínimo igual a 1 e no máximo igual a 1.000.
Limita o número de registros buscados como resultado da solicitação.
+ `SelectedFields`: um array de strings UTF-8 com no mínimo 1 e no máximo 1.000 strings.
Lista de campos que queremos buscar como parte dos dados de prévia.
**Resposta**
+ `Records`: uma matriz de estruturas.
Uma lista de objetos solicitados.
+ `NextToken` – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Um token de continuação, presente se o segmento atual não for o último.
**Erros**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`
# API User-defined Function
A API User-defined Function descreve os tipos de dados e as operações do AWS Glue usados para trabalhar com funções.
## Tipos de dados
+ [Estrutura UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction)
+ [Estrutura UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput)
## Estrutura UserDefinedFunction
Representa o equivalente a uma definição de função do Hive definida pelo usuário (`UDF`).
**Campos**
+ `FunctionName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nome da função.
+ `DatabaseName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogo que contém a função.
+ `ClassName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
A classe Java que contém o código da função.
+ `OwnerName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O proprietário da função.
+ `OwnerType` – String UTF-8 (valores válidos: `USER` \$1 `ROLE` \$1 `GROUP`).
Tipo do proprietário.
+ `CreateTime` – Timestamp.
A hora em que a função foi criada.
+ `ResourceUris` – Uma matriz de objetos [ResourceUri](aws-glue-api-common.md#aws-glue-api-common-ResourceUri), não mais de 1000 estruturas.
Os URIs do recurso para a função.
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do Data Catalog em que a função reside.
## Estrutura UserDefinedFunctionInput
Uma estrutura usada para criar ou atualizar uma função definida pelo usuário.
**Campos**
+ `FunctionName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nome da função.
+ `ClassName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
A classe Java que contém o código da função.
+ `OwnerName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O proprietário da função.
+ `OwnerType` – String UTF-8 (valores válidos: `USER` \$1 `ROLE` \$1 `GROUP`).
Tipo do proprietário.
+ `ResourceUris` – Uma matriz de objetos [ResourceUri](aws-glue-api-common.md#aws-glue-api-common-ResourceUri), não mais de 1000 estruturas.
Os URIs do recurso para a função.
## Operações
+ [Ação CreateUserDefinedFunction (Python: create\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-CreateUserDefinedFunction)
+ [Ação UpdateUserDefinedFunction (Python: update\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-UpdateUserDefinedFunction)
+ [Ação DeleteUserDefinedFunction (Python: delete\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-DeleteUserDefinedFunction)
+ [Ação GetUserDefinedFunction (Python: get\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-GetUserDefinedFunction)
+ [Ação GetUserDefinedFunctions (Python: get\$1user\$1defined\$1functions)](#aws-glue-api-catalog-functions-GetUserDefinedFunctions)
## Ação CreateUserDefinedFunction (Python: create\$1user\$1defined\$1function)
Cria uma definição de nova função no catálogo de dados.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados em que a função será criada. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados de catálogos no qual a função será criada.
+ `FunctionInput` – *Obrigatório:* um objeto [UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput).
Um objeto `FunctionInput` que define a função a ser criada no catálogo de dados.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
## Ação UpdateUserDefinedFunction (Python: update\$1user\$1defined\$1function)
Atualiza uma definição de função existente no catálogo de dados.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual está a função a ser atualizada. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados do catálogo no qual está a função a ser atualizada.
+ `FunctionName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nome da função.
+ `FunctionInput` – *Obrigatório:* um objeto [UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput).
Um objeto `FunctionInput` que redefine a função no Catálogo de dados.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação DeleteUserDefinedFunction (Python: delete\$1user\$1defined\$1function)
Exclui uma definição função existente do catálogo de dados.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual está a função a ser excluída. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados do catálogo no qual a função está.
+ `FunctionName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da definição de função a ser excluída.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## Ação GetUserDefinedFunction (Python: get\$1user\$1defined\$1function)
Recupera uma definição de função especificada do catálogo de dados.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual está a função a ser recuperada. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados do catálogo no qual a função está.
+ `FunctionName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nome da função.
**Resposta**
+ `UserDefinedFunction` – Um objeto [UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction).
A definição de função solicitada.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## Ação GetUserDefinedFunctions (Python: get\$1user\$1defined\$1functions)
Recupera várias definições de função do Catálogo de dados.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo de dados no qual estão as funções a serem recuperadas. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DatabaseName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome do banco de dados do catálogo no qual as funções estão localizadas. Se nenhum for fornecido, as funções de todos os bancos de dados no catálogo serão retornadas.
+ `Pattern`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Uma string de padrão de função-nome opcional que filtra as definições de função retornadas.
+ `NextToken` – String UTF-8.
Um token de continuação, se esta for uma chamada de continuação.
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 100.
O número máximo de funções a ser retornado em uma resposta.
**Resposta**
+ `UserDefinedFunctions`: um array de objetos [UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction).
Uma lista das definições de função solicitadas.
+ `NextToken` – String UTF-8.
Um token de continuação, se a lista de funções retornadas não incluir a última função solicitada.
**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
# Importar um catálogo do Athena para AWS Glue
A API Migration descreve os tipos de dados e as operações do AWS Glue relacionados à migração de um catálogo de dados do Athena para o AWS Glue.
## Tipos de dados
+ [Estrutura CatalogImportStatus](#aws-glue-api-catalog-migration-CatalogImportStatus)
## Estrutura CatalogImportStatus
Uma estrutura que contém informações sobre o status da migração.
**Campos**
+ `ImportCompleted` – Booleano.
`True` se a migração for concluída, ou `False` caso contrário.
+ `ImportTime` – Timestamp.
A hora em que a migração foi iniciada.
+ `ImportedBy` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O nome da pessoa que iniciou a migração.
## Operações
+ [Ação ImportCatalogToGlue (Python: import\$1catalog\$1to\$1glue)](#aws-glue-api-catalog-migration-ImportCatalogToGlue)
+ [Ação GetCatalogImportStatus (Python: get\$1catalog\$1import\$1status)](#aws-glue-api-catalog-migration-GetCatalogImportStatus)
## Ação ImportCatalogToGlue (Python: import\$1catalog\$1to\$1glue)
Importa um Data Catalog existente do Amazon Athena para o AWS Glue.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo a ser importado. No momento, deve ser o ID da conta da AWS.
**Resposta**
+ *Nenhum parâmetro de resposta.*
**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`
## Ação GetCatalogImportStatus (Python: get\$1catalog\$1import\$1status)
Recupera o status de uma operação de migração.
**Solicitação**
+ `CatalogId`: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
O ID do catálogo a ser migrado. No momento, deve ser o ID da conta da AWS.
**Resposta**
+ `ImportStatus` – Um objeto [CatalogImportStatus](#aws-glue-api-catalog-migration-CatalogImportStatus).
O status de migração do catálogo especificado.
**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`