# APIs de integração no AWS Glue ## Tipos de dados + [Estrutura da integração](#aws-glue-api-integrations-Integration) + [Estrutura de IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig) + [Estrutura IntegrationPartition](#aws-glue-api-integrations-IntegrationPartition) + [Estrutura IntegrationError](#aws-glue-api-integrations-IntegrationError) + [Estrutura IntegrationFilter](#aws-glue-api-integrations-IntegrationFilter) + [Estrutura InboundIntegration](#aws-glue-api-integrations-InboundIntegration) + [Estrutura SourceProcessingProperties](#aws-glue-api-integrations-SourceProcessingProperties) + [Estrutura TargetProcessingProperties](#aws-glue-api-integrations-TargetProcessingProperties) + [Estrutura SourceTableConfig](#aws-glue-api-integrations-SourceTableConfig) + [Estrutura TargetTableConfig](#aws-glue-api-integrations-TargetTableConfig) ## Estrutura da integração Descreve uma integração ETL zero. **Campos** + `SourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN da origem da integração. + `TargetArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN do destino da integração. + `Description`: string UTF-8 com no máximo 1.000 bytes de comprimento e correspondente a [Custom string pattern #12](aws-glue-api-common.md#regex_12). Uma descrição da integração. + `IntegrationName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. Um nome exclusivo para a integração. + `IntegrationArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome do recurso da Amazon (ARN) da integração. + `KmsKeyId`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. O ARN de uma chave do KMS usada para criptografar o canal. + `AdditionalEncryptionContext` – 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 conjunto opcional de pares chave-valor não secretas que contém informações contextuais adicionais para criptografia. Isso só pode ser fornecido se `KMSKeyId` for fornecido. + `Tags`: um array de objetos [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag). Metadados atribuídos ao recurso que consiste em uma lista de pares chave-valor. + `Status`: *obrigatório:* string UTF-8 (valores válidos: `CREATING` \$1 `ACTIVE` \$1 `MODIFYING` \$1 `FAILED` \$1 `DELETING` \$1 `SYNCING` \$1 `NEEDS_ATTENTION`). Os possíveis status são: + CREATING: a integração está sendo criada. + ACTIVE: a criação da integração foi bem-sucedida. + MODIFYING: a integração está sendo modificada. + FAILED: a criação da integração falhou. + DELETING: a integração está sendo excluída. + SYNCING: a integração está sincronizando. + NEEDS\$1ATTENTION: a integração precisa de atenção, como sincronização. + `CreateTime`: *obrigatório:* carimbo de data e hora. A hora em que a integração foi criada (UTC). + `IntegrationConfig` – Um objeto [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig). As propriedades associadas à integração. + `Errors`: um array de objetos [IntegrationError](#aws-glue-api-integrations-IntegrationError). Uma lista de erros associados à integração. + `DataFilter`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. Seleciona tabelas de origem para a integração usando a sintaxe do filtro Maxwell. ## Estrutura de IntegrationConfig As propriedades associadas à integração. **Campos** + `RefreshInterval` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. Especifica a frequência com que as extrações do CDC (Change Data Capture) ou as cargas incrementais devem ocorrer. Esse parâmetro fornece flexibilidade para alinhar a taxa de atualização com seus padrões específicos de atualização de dados, considerações de carga do sistema e metas de otimização de performance. O incremento de tempo pode ser definido de 15 minutos a 8.640 minutos (seis dias). + `SourceProperties` – 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. Uma coleção de pares de chave-valor que especificam propriedades adicionais para a fonte de integração. Essas propriedades fornecem opções de configuração que podem ser usadas para personalizar o comportamento da fonte ODB durante as operações de integração de dados. + `ContinuousSync` – Booleano. Habilita a sincronização contínua para extrações de dados sob demanda de: 1) aplicações SaaS para serviços de dados da AWS como o Amazon Redshift e Amazon S3 e 2) DynamoDB para Amazon S3. ## Estrutura IntegrationPartition Uma estrutura que descreve como os dados são particionados no destino. **Campos** + `FieldName` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O nome do campo usado para particionar dados no destino. Evite usar colunas que tenham valores exclusivos para cada linha (por exemplo, "LastModifiedTimestamp", "SystemModTimeStamp") como a coluna de partição. Essas colunas não são adequadas para particionamento porque criam um grande número de partições pequenas, o que pode causar problemas de performance. + `FunctionSpec` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. Especifica a função usada para particionar dados no destino. Os valores aceitos desse parâmetro são: + `identity`: usa valores de origem diretamente sem transformação + `year`: extrai o ano dos valores do carimbo de data/hora (por exemplo, 2023) + `month`: extrai o mês dos valores do carimbo de data/hora (por exemplo, 2023-01) + `day`: extrai o dia dos valores do carimbo de data/hora (por exemplo, 2023-01-15) + `hour`: extrai a hora dos valores do carimbo de data/hora (por exemplo, 2023-01-15-14) + `ConversionSpec` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. Especifica o formato de timestamp dos dados da fonte. Os valores válidos são: + `epoch_sec`: timestamp da era Unix em segundos + `epoch_milli`: timetstamp da era Unix em milissegundos + `iso`: timestamp no formato ISO 8601 **nota** Especifique `ConversionSpec` apenas ao usar funções de partição baseadas em timestamp (ano, mês, dia ou hora). AWS Glue O Zero-ETL usa esse parâmetro para transformar corretamente os dados da fonte no formato de timestamp antes do particionamento. Não use colunas de alta cardinalidade com a função de partição `identity`. Colunas de alta cardinalidade incluem: Chaves primárias Campos de timestamp (como `LastModifiedTimestamp`, `CreatedDate`) Timestamps gerados pelo sistema O uso de colunas de alta cardinalidade com particionamento baseado em identidade cria muitas pequenas partições, o que pode degradar significativamente o desempenho de ingestão. ## Estrutura IntegrationError Um erro associado a uma integração ETL zero. **Campos** + `ErrorCode` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O código associado a este erro. + `ErrorMessage`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. Uma mensagem descrevendo o erro. ## Estrutura IntegrationFilter Um filtro que pode ser usado ao invocar uma solicitação `DescribeIntegrations`. **Campos** + `Name` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O nome do filtro. + `Values` – Uma matriz de strings UTF-8. Uma lista de valores de filtro. ## Estrutura InboundIntegration Uma estrutura para uma integração que grava dados em um recurso. **Campos** + `SourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN do recurso de origem para a integração. + `TargetArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN do recurso de destino para a integração. + `IntegrationArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN da integração ETL zero. + `Status`: *obrigatório:* string UTF-8 (valores válidos: `CREATING` \$1 `ACTIVE` \$1 `MODIFYING` \$1 `FAILED` \$1 `DELETING` \$1 `SYNCING` \$1 `NEEDS_ATTENTION`). Os possíveis status são: + CREATING: a integração está sendo criada. + ACTIVE: a criação da integração foi bem-sucedida. + MODIFYING: a integração está sendo modificada. + FAILED: a criação da integração falhou. + DELETING: a integração está sendo excluída. + SYNCING: a integração está sincronizando. + NEEDS\$1ATTENTION: a integração precisa de atenção, como sincronização. + `CreateTime`: *obrigatório:* carimbo de data e hora. A hora em que a integração foi criada (UTC). + `IntegrationConfig` – Um objeto [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig). As propriedades associadas à integração. + `Errors`: um array de objetos [IntegrationError](#aws-glue-api-integrations-IntegrationError). Uma lista de erros associados à integração. ## Estrutura SourceProcessingProperties As propriedades do recurso associadas à origem da integração. **Campos** + `RoleArn` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O perfil do IAM para acessar a conexão ao AWS Glue. ## Estrutura TargetProcessingProperties As propriedades do recurso associadas ao destino da integração. **Campos** + `RoleArn` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O perfil do IAM para acessar o banco de dados do AWS Glue. + `KmsArn`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. O ARN da chave do KMS usada para criptografia. + `ConnectionName` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. A conexão de rede do AWS Glue para configurar o trabalho do AWS Glue em execução na VPC do cliente. + `EventBusArn`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. O ARN de um barramento de eventos do Eventbridge para receber a notificação do status da integração. ## Estrutura SourceTableConfig Propriedades usadas pela perna de origem para processar dados da origem. **Campos** + `Fields` – Uma matriz de strings UTF-8. Uma lista de campos usados para filtragem em nível de coluna. Atualmente incompatível. + `FilterPredicate` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. Uma cláusula de condição usada para filtragem em nível de linha. Atualmente incompatível. + `PrimaryKey` – Uma matriz de strings UTF-8. Forneça o conjunto de chaves primárias para essa tabela. Atualmente compatível especificamente para entidades `EntityOf` do SAP, mediante solicitação. Entre em contato com o AWS Support para disponibilizar esse recurso. + `RecordUpdateField` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. Campo incremental extração baseado em timestamp. Atualmente incompatível. ## Estrutura TargetTableConfig Propriedades usadas pela perna de destino para particionar os dados no destino. **Campos** + `UnnestSpec` – string UTF-8 (valores válidos: `TOPLEVEL` \$1 `FULL` \$1 `NOUNNEST`). Especifica como os objetos aninhados são nivelados em elementos de nível superior. Os valores válidos são: "TOPLEVEL", "FULL" ou "NOUNNEST". + `PartitionSpec`: um array de objetos [IntegrationPartition](#aws-glue-api-integrations-IntegrationPartition). Determina o layout do arquivo no destino. + `TargetTableName` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O nome opcional de uma tabela de destino. ## Operações + [Ação CreateIntegration action (Python: create\$1integration)](#aws-glue-api-integrations-CreateIntegration) + [Ação ModifyIntegration (Python: modify\$1integration)](#aws-glue-api-integrations-ModifyIntegration) + [Ação DescribeIntegrations (Python: describe\$1integrations)](#aws-glue-api-integrations-DescribeIntegrations) + [Ação DeleteIntegration (Python: delete\$1integration)](#aws-glue-api-integrations-DeleteIntegration) + [Ação DescribeInboundIntegrations (Python: describe\$1inbound\$1integrations)](#aws-glue-api-integrations-DescribeInboundIntegrations) + [Ação CreateIntegrationTableProperties (Python: create\$1integration\$1table\$1properties)](#aws-glue-api-integrations-CreateIntegrationTableProperties) + [Ação UpdateIntegrationTableProperties (Python: update\$1integration\$1table\$1properties)](#aws-glue-api-integrations-UpdateIntegrationTableProperties) + [Ação GetIntegrationTableProperties (Python: get\$1integration\$1table\$1properties)](#aws-glue-api-integrations-GetIntegrationTableProperties) + [Ação DeleteIntegrationTableProperties (Python: delete\$1integration\$1table\$1properties)](#aws-glue-api-integrations-DeleteIntegrationTableProperties) + [Ação CreateIntegrationResourceProperty (Python: create\$1integration\$1resource\$1property)](#aws-glue-api-integrations-CreateIntegrationResourceProperty) + [Ação UpdateIntegrationResourceProperty (Python: update\$1integration\$1resource\$1property)](#aws-glue-api-integrations-UpdateIntegrationResourceProperty) + [Ação GetIntegrationResourceProperty (Python: get\$1integration\$1resource\$1property)](#aws-glue-api-integrations-GetIntegrationResourceProperty) + [Ação UntagResource (Python: untag\$1resource)](#aws-glue-api-integrations-UntagResource) + [Ação ListTagsForResource (Python: list\$1tags\$1for\$1resource)](#aws-glue-api-integrations-ListTagsForResource) ## Ação CreateIntegration action (Python: create\$1integration) Cria uma integração ETL zero na conta do chamador entre dois recursos com nomes do recurso da Amazon (ARNs): `SourceArn` e `TargetArn`. **Solicitação** + `IntegrationName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. Um nome exclusivo para uma integração no AWS Glue. + `SourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN do recurso de origem para a integração. + `TargetArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN do recurso de destino para a integração. + `Description`: string UTF-8 com no máximo 1.000 bytes de comprimento e correspondente a [Custom string pattern #12](aws-glue-api-common.md#regex_12). Uma descrição da integração. + `DataFilter`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. Seleciona tabelas de origem para a integração usando a sintaxe do filtro Maxwell. + `KmsKeyId`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. O ARN de uma chave do KMS usada para criptografar o canal. + `AdditionalEncryptionContext` – 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 conjunto opcional de pares chave-valor não secretas que contém informações contextuais adicionais para criptografia. Isso só pode ser fornecido se `KMSKeyId` for fornecido. + `Tags`: um array de objetos [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag). Metadados atribuídos ao recurso que consiste em uma lista de pares chave-valor. + `IntegrationConfig` – Um objeto [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig). As definições de configuração. **Resposta** + `SourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN do recurso de origem para a integração. + `TargetArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN do recurso de destino para a integração. + `IntegrationName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. Um nome exclusivo para uma integração no AWS Glue. + `Description`: string UTF-8 com no máximo 1.000 bytes de comprimento e correspondente a [Custom string pattern #12](aws-glue-api-common.md#regex_12). Uma descrição da integração. + `IntegrationArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome do recurso da Amazon (ARN) da integração criada. + `KmsKeyId`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. O ARN de uma chave do KMS usada para criptografar o canal. + `AdditionalEncryptionContext` – 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 conjunto opcional de pares chave-valor não secretas que contém informações contextuais adicionais para criptografia. + `Tags`: um array de objetos [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag). Metadados atribuídos ao recurso que consiste em uma lista de pares chave-valor. + `Status`: *obrigatório:* string UTF-8 (valores válidos: `CREATING` \$1 `ACTIVE` \$1 `MODIFYING` \$1 `FAILED` \$1 `DELETING` \$1 `SYNCING` \$1 `NEEDS_ATTENTION`). O status da integração que está sendo criada. Os possíveis status são: + CREATING: a integração está sendo criada. + ACTIVE: a criação da integração foi bem-sucedida. + MODIFYING: a integração está sendo modificada. + FAILED: a criação da integração falhou. + DELETING: a integração está sendo excluída. + SYNCING: a integração está sincronizando. + NEEDS\$1ATTENTION: a integração precisa de atenção, como sincronização. + `CreateTime`: *obrigatório:* carimbo de data e hora. A hora em que a integração foi criada (UTC). + `Errors`: um array de objetos [IntegrationError](#aws-glue-api-integrations-IntegrationError). Uma lista de erros associados à criação da integração. + `DataFilter`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. Seleciona tabelas de origem para a integração usando a sintaxe do filtro Maxwell. + `IntegrationConfig` – Um objeto [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig). As definições de configuração. **Erros** + `ValidationException` + `AccessDeniedException` + `ResourceNotFoundException` + `InternalServerException` + `IntegrationConflictOperationFault` + `IntegrationQuotaExceededFault` + `KMSKeyNotAccessibleFault` + `EntityNotFoundException` + `InternalServiceException` + `ConflictException` + `ResourceNumberLimitExceededException` + `InvalidInputException` ## Ação ModifyIntegration (Python: modify\$1integration) Modifica uma integração ETL zero na conta do chamador. **Solicitação** + `IntegrationIdentifier`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome do recurso da Amazon (ARN) da integração. + `Description`: string UTF-8 com no máximo 1.000 bytes de comprimento e correspondente a [Custom string pattern #12](aws-glue-api-common.md#regex_12). Uma descrição da integração. + `DataFilter`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. Seleciona tabelas de origem para a integração usando a sintaxe do filtro Maxwell. + `IntegrationConfig` – Um objeto [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig). As opções de configuração da integração. No momento, somente RefreshInterval pode ser modificada. + `IntegrationName` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. Um nome exclusivo para uma integração no AWS Glue. **Resposta** + `SourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN da origem da integração. + `TargetArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN do destino da integração. + `IntegrationName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. Um nome exclusivo para uma integração no AWS Glue. + `Description`: string UTF-8 com no máximo 1.000 bytes de comprimento e correspondente a [Custom string pattern #12](aws-glue-api-common.md#regex_12). Uma descrição da integração. + `IntegrationArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome do recurso da Amazon (ARN) da integração. + `KmsKeyId`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. O ARN de uma chave do KMS usada para criptografar o canal. + `AdditionalEncryptionContext` – 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 conjunto opcional de pares chave-valor não secretas que contém informações contextuais adicionais para criptografia. + `Tags`: um array de objetos [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag). Metadados atribuídos ao recurso que consiste em uma lista de pares chave-valor. + `Status`: *obrigatório:* string UTF-8 (valores válidos: `CREATING` \$1 `ACTIVE` \$1 `MODIFYING` \$1 `FAILED` \$1 `DELETING` \$1 `SYNCING` \$1 `NEEDS_ATTENTION`). O status da integração que está sendo modificada. Os possíveis status são: + CREATING: a integração está sendo criada. + ACTIVE: a criação da integração foi bem-sucedida. + MODIFYING: a integração está sendo modificada. + FAILED: a criação da integração falhou. + DELETING: a integração está sendo excluída. + SYNCING: a integração está sincronizando. + NEEDS\$1ATTENTION: a integração precisa de atenção, como sincronização. + `CreateTime`: *obrigatório:* carimbo de data e hora. A hora em que a integração foi criada (UTC). + `Errors`: um array de objetos [IntegrationError](#aws-glue-api-integrations-IntegrationError). Uma lista de erros associados à modificação da integração. + `DataFilter`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. Seleciona tabelas de origem para a integração usando a sintaxe do filtro Maxwell. + `IntegrationConfig` – Um objeto [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig). As opções de configuração atualizadas da integração. **Erros** + `ValidationException` + `AccessDeniedException` + `InternalServerException` + `IntegrationNotFoundFault` + `IntegrationConflictOperationFault` + `InvalidIntegrationStateFault` + `EntityNotFoundException` + `InternalServiceException` + `ConflictException` + `InvalidStateException` + `InvalidInputException` ## Ação DescribeIntegrations (Python: describe\$1integrations) A API é usada para recuperar uma lista de integrações. **Solicitação** + `IntegrationIdentifier` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O nome do recurso da Amazon (ARN) da integração. + `Marker` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. Um valor que indica o ponto de partida do próximo conjunto de registros de resposta em uma solicitação subsequente. + `MaxRecords` – Número (íntegro). O número total de itens para retornar na saída. + `Filters`: um array de objetos [IntegrationFilter](#aws-glue-api-integrations-IntegrationFilter). Uma lista de chaves e valores para filtrar os resultados. As chaves aceitas são "Status", "IntegrationName" e "SourceArn". IntegrationName está limitado a apenas um valor. **Resposta** + `Integrations`: um array de objetos [Integração](#aws-glue-api-integrations-Integration). Uma lista de integrações ETL zero. + `Marker` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. Um valor que indica o ponto de partida do próximo conjunto de registros de resposta em uma solicitação subsequente. **Erros** + `ValidationException` + `AccessDeniedException` + `InternalServerException` + `IntegrationNotFoundFault` + `EntityNotFoundException` + `InternalServiceException` + `InvalidInputException` ## Ação DeleteIntegration (Python: delete\$1integration) Exclui a integração ETL zero especificada. **Solicitação** + `IntegrationIdentifier`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome do recurso da Amazon (ARN) da integração. **Resposta** + `SourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN da origem da integração. + `TargetArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN do destino da integração. + `IntegrationName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. Um nome exclusivo para uma integração no AWS Glue. + `Description`: string UTF-8 com no máximo 1.000 bytes de comprimento e correspondente a [Custom string pattern #12](aws-glue-api-common.md#regex_12). Uma descrição da integração. + `IntegrationArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome do recurso da Amazon (ARN) da integração. + `KmsKeyId`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. O ARN de uma chave do KMS usada para criptografar o canal. + `AdditionalEncryptionContext` – 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 conjunto opcional de pares chave-valor não secretas que contém informações contextuais adicionais para criptografia. + `Tags`: um array de objetos [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag). Metadados atribuídos ao recurso que consiste em uma lista de pares chave-valor. + `Status`: *obrigatório:* string UTF-8 (valores válidos: `CREATING` \$1 `ACTIVE` \$1 `MODIFYING` \$1 `FAILED` \$1 `DELETING` \$1 `SYNCING` \$1 `NEEDS_ATTENTION`). O status da integração que está sendo excluída. Os possíveis status são: + CREATING: a integração está sendo criada. + ACTIVE: a criação da integração foi bem-sucedida. + MODIFYING: a integração está sendo modificada. + FAILED: a criação da integração falhou. + DELETING: a integração está sendo excluída. + SYNCING: a integração está sincronizando. + NEEDS\$1ATTENTION: a integração precisa de atenção, como sincronização. + `CreateTime`: *obrigatório:* carimbo de data e hora. A hora em que a integração foi criada (UTC). + `Errors`: um array de objetos [IntegrationError](#aws-glue-api-integrations-IntegrationError). Uma lista de erros associados à integração. + `DataFilter`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento. Seleciona tabelas de origem para a integração usando a sintaxe do filtro Maxwell. **Erros** + `ValidationException` + `AccessDeniedException` + `InternalServerException` + `IntegrationNotFoundFault` + `IntegrationConflictOperationFault` + `InvalidIntegrationStateFault` + `EntityNotFoundException` + `InternalServiceException` + `ConflictException` + `InvalidStateException` + `InvalidInputException` ## Ação DescribeInboundIntegrations (Python: describe\$1inbound\$1integrations) Retorna uma lista de integrações de entrada para a integração especificada. **Solicitação** + `IntegrationArn` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O nome do recurso da Amazon (ARN) da integração. + `Marker` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. Um token para especificar onde iniciar a paginação. Esse é o marcador de uma resposta anteriormente truncada. + `MaxRecords` – Número (íntegro). O número total de itens para retornar na saída. + `TargetArn` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O nome do recurso da Amazon (ARN) do recurso de destino na integração. **Resposta** + `InboundIntegrations`: um array de objetos [InboundIntegration](#aws-glue-api-integrations-InboundIntegration). Uma lista de integrações de entrada. + `Marker` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. Um valor que indica o ponto de partida do próximo conjunto de registros de resposta em uma solicitação subsequente. **Erros** + `ValidationException` + `AccessDeniedException` + `InternalServerException` + `IntegrationNotFoundFault` + `TargetResourceNotFound` + `OperationNotSupportedException` + `EntityNotFoundException` + `InternalServiceException` + `InvalidInputException` ## Ação CreateIntegrationTableProperties (Python: create\$1integration\$1table\$1properties) Essa API é usada para fornecer propriedades de substituição opcionais para as tabelas que precisam ser replicadas. Essas propriedades podem incluir propriedades de filtragem e particionamento das tabelas de origem e de destino. Para definir as propriedades de origem e destino, a mesma API precisa ser invocada com o ARN da conexão do AWS Glue como `ResourceArn` com `SourceTableConfig` e o ARN do banco de dados do AWS Glue como `ResourceArn` com `TargetTableConfig`, respectivamente. **Solicitação** + `ResourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome do recurso da Amazon (ARN) da tabela de destino para a qual devem ser criadas propriedades de tabelas de integração. Atualmente, essa API é compatível apenas com a criação de propriedades de tabelas de integração para tabelas de destino, e o ARN fornecido deve ser o ARN da tabela de destino no AWS Glue Data Catalog. A compatibilidade com a criação de propriedades de tabelas de integração para conexões de origem (usando o ARN da conexão) ainda não foi implementada e será adicionada em uma versão futura. + `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome da tabela a ser replicada. + `SourceTableConfig` – Um objeto [SourceTableConfig](#aws-glue-api-integrations-SourceTableConfig). Uma estrutura para a configuração da tabela de origem. Consulte a estrutura `SourceTableConfig` para ver a lista de propriedades de fontes compatíveis. + `TargetTableConfig` – Um objeto [TargetTableConfig](#aws-glue-api-integrations-TargetTableConfig). Uma estrutura para a configuração da tabela de destino. **Resposta** + *Nenhum parâmetro de resposta.* **Erros** + `ValidationException` + `AccessDeniedException` + `ResourceNotFoundException` + `InternalServerException` + `EntityNotFoundException` + `InternalServiceException` + `InvalidInputException` ## Ação UpdateIntegrationTableProperties (Python: update\$1integration\$1table\$1properties) Essa API é usada para fornecer propriedades de substituição opcionais para as tabelas que precisam ser replicadas. Essas propriedades podem incluir propriedades de filtragem e particionamento das tabelas de origem e de destino. Para definir as propriedades de origem e destino, a mesma API precisa ser invocada com o ARN da conexão do AWS Glue como `ResourceArn` com `SourceTableConfig` e o ARN do banco de dados do AWS Glue como `ResourceArn` com `TargetTableConfig`, respectivamente. A substituição será refletida em todas as integrações usando o mesmo `ResourceArn` e a mesma tabela de origem. **Solicitação** + `ResourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN da conexão da origem ou o ARN do banco de dados do destino. + `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome da tabela a ser replicada. + `SourceTableConfig` – Um objeto [SourceTableConfig](#aws-glue-api-integrations-SourceTableConfig). Uma estrutura para a configuração da tabela de origem. + `TargetTableConfig` – Um objeto [TargetTableConfig](#aws-glue-api-integrations-TargetTableConfig). Uma estrutura para a configuração da tabela de destino. **Resposta** + *Nenhum parâmetro de resposta.* **Erros** + `ValidationException` + `AccessDeniedException` + `ResourceNotFoundException` + `InternalServerException` + `EntityNotFoundException` + `InternalServiceException` + `InvalidInputException` ## Ação GetIntegrationTableProperties (Python: get\$1integration\$1table\$1properties) Essa API é usada para recuperar propriedades de substituição opcionais para as tabelas que precisam ser replicadas. Essas propriedades podem incluir propriedades de filtragem e partição das tabelas de origem e de destino. **Solicitação** + `ResourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome do recurso da Amazon (ARN) da tabela de destino para a qual devem ser recuperadas as propriedades de tabelas de integração. Atualmente, essa API é compatível apenas a recuperação de propriedades de tabelas de integração para tabelas de destino, e o ARN fornecido deve ser o ARN da tabela de destino no AWS Glue Data Catalog. A compatibilidade com a recuperação de propriedades de tabelas de integração para conexões de origem (usando o ARN da conexão) ainda não foi implementada e será adicionada em uma versão futura. + `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome da tabela a ser replicada. **Resposta** + `ResourceArn` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O nome do recurso da Amazon (ARN) da tabela de destino para a qual devem ser recuperadas as propriedades de tabelas de integração. Atualmente, essa API é compatível apenas a recuperação de propriedades de tabelas de integração para tabelas de destino, e o ARN fornecido deve ser o ARN da tabela de destino no AWS Glue Data Catalog. A compatibilidade com a recuperação de propriedades de tabelas de integração para conexões de origem (usando o ARN da conexão) ainda não foi implementada e será adicionada em uma versão futura. + `TableName` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O nome da tabela a ser replicada. + `SourceTableConfig` – Um objeto [SourceTableConfig](#aws-glue-api-integrations-SourceTableConfig). Uma estrutura para a configuração da tabela de origem. + `TargetTableConfig` – Um objeto [TargetTableConfig](#aws-glue-api-integrations-TargetTableConfig). Uma estrutura para a configuração da tabela de destino. **Erros** + `ValidationException` + `AccessDeniedException` + `ResourceNotFoundException` + `InternalServerException` + `EntityNotFoundException` + `InternalServiceException` + `InvalidInputException` ## Ação DeleteIntegrationTableProperties (Python: delete\$1integration\$1table\$1properties) Exclui as propriedades de tabela que foram criadas para as tabelas que precisam ser replicadas. **Solicitação** + `ResourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN da conexão da origem ou o ARN do banco de dados do destino. + `TableName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O nome da tabela a ser replicada. **Resposta** + *Nenhum parâmetro de resposta.* **Erros** + `ValidationException` + `AccessDeniedException` + `ResourceNotFoundException` + `InternalServerException` + `EntityNotFoundException` + `InternalServiceException` + `InvalidInputException` ## Ação CreateIntegrationResourceProperty (Python: create\$1integration\$1resource\$1property) Essa API pode ser usada para configurar a `ResourceProperty` da conexão do AWS Glue (para a origem) ou o ARN do banco de dados do AWS Glue (para o destino). Essas propriedades podem incluir o perfil para acessar a conexão ou o banco de dados. Para definir as propriedades de origem e destino, a mesma API precisa ser invocada com o ARN da conexão do AWS Glue como `ResourceArn` com `SourceProcessingProperties` e o ARN do banco de dados do AWS Glue como `ResourceArn` com `TargetProcessingProperties`, respectivamente. **Solicitação** + `ResourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN da conexão da origem ou o ARN do banco de dados do destino. + `SourceProcessingProperties` – Um objeto [SourceProcessingProperties](#aws-glue-api-integrations-SourceProcessingProperties). As propriedades do recurso associadas à origem da integração. + `TargetProcessingProperties` – Um objeto [TargetProcessingProperties](#aws-glue-api-integrations-TargetProcessingProperties). As propriedades do recurso associadas ao destino da integração. **Resposta** + `ResourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN da conexão da origem ou o ARN do banco de dados do destino. + `SourceProcessingProperties` – Um objeto [SourceProcessingProperties](#aws-glue-api-integrations-SourceProcessingProperties). As propriedades do recurso associadas à origem da integração. + `TargetProcessingProperties` – Um objeto [TargetProcessingProperties](#aws-glue-api-integrations-TargetProcessingProperties). As propriedades do recurso associadas ao destino da integração. **Erros** + `ValidationException` + `AccessDeniedException` + `ConflictException` + `InternalServerException` + `ResourceNotFoundException` + `EntityNotFoundException` + `InternalServiceException` + `InvalidInputException` ## Ação UpdateIntegrationResourceProperty (Python: update\$1integration\$1resource\$1property) Essa API pode ser usada para atualizar a `ResourceProperty` da conexão do AWS Glue (para a origem) ou o ARN do banco de dados do AWS Glue (para o destino). Essas propriedades podem incluir o perfil para acessar a conexão ou o banco de dados. Como o mesmo recurso pode ser usado em várias integrações, a atualização das propriedades do recurso afetará todas as integrações que o usam. **Solicitação** + `ResourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN da conexão da origem ou o ARN do banco de dados do destino. + `SourceProcessingProperties` – Um objeto [SourceProcessingProperties](#aws-glue-api-integrations-SourceProcessingProperties). As propriedades do recurso associadas à origem da integração. + `TargetProcessingProperties` – Um objeto [TargetProcessingProperties](#aws-glue-api-integrations-TargetProcessingProperties). As propriedades do recurso associadas ao destino da integração. **Resposta** + `ResourceArn` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O ARN da conexão da origem ou o ARN do banco de dados do destino. + `SourceProcessingProperties` – Um objeto [SourceProcessingProperties](#aws-glue-api-integrations-SourceProcessingProperties). As propriedades do recurso associadas à origem da integração. + `TargetProcessingProperties` – Um objeto [TargetProcessingProperties](#aws-glue-api-integrations-TargetProcessingProperties). As propriedades do recurso associadas ao destino da integração. **Erros** + `ValidationException` + `AccessDeniedException` + `InternalServerException` + `ResourceNotFoundException` + `EntityNotFoundException` + `InternalServiceException` + `InvalidInputException` ## Ação GetIntegrationResourceProperty (Python: get\$1integration\$1resource\$1property) Essa API é usada para atualizar a `ResourceProperty` da conexão do AWS Glue (para a origem) ou o ARN do banco de dados do AWS Glue (para o destino) **Solicitação** + `ResourceArn`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento. O ARN da conexão da origem ou o ARN do banco de dados do destino. **Resposta** + `ResourceArn` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento. O ARN da conexão da origem ou o ARN do banco de dados do destino. + `SourceProcessingProperties` – Um objeto [SourceProcessingProperties](#aws-glue-api-integrations-SourceProcessingProperties). As propriedades do recurso associadas à origem da integração. + `TargetProcessingProperties` – Um objeto [TargetProcessingProperties](#aws-glue-api-integrations-TargetProcessingProperties). As propriedades do recurso associadas ao destino da integração. **Erros** + `ValidationException` + `AccessDeniedException` + `InternalServerException` + `ResourceNotFoundException` + `EntityNotFoundException` + `InternalServiceException` + `InvalidInputException` ## Ação UntagResource (Python: untag\$1resource) Remove as tags especificadas de um recurso de integração. **Solicitação** + `ResourceArn`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50). O nome do recurso da Amazon (ARN) do recurso de integração. + `TagsToRemove`: *obrigatório:* uma matriz de strings UTF-8, no máximo 50 strings. Uma lista das tags de metadados a serem removidas do recurso. **Resposta** + *Nenhum parâmetro de resposta.* **Erros** + `ResourceNotFoundException` ## Ação ListTagsForResource (Python: list\$1tags\$1for\$1resource) Lista as tags de metadados atribuídas ao recurso especificado. **Solicitação** + `ResourceARN`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50). O ARN do recurso. **Resposta** + `Tags`: uma matriz de objetos [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag), não mais do que dez estruturas. Uma lista de tags. **Erros** + `ResourceNotFoundException` ## Exceções + [Estrutura ResourceNotFoundException](#aws-glue-api-integrations-ResourceNotFoundException) + [Estrutura InternalServiceException](#aws-glue-api-integrations-InternalServerException) + [Estrutura IntegrationAlreadyExistsFault](#aws-glue-api-integrations-IntegrationAlreadyExistsFault) + [Estrutura IntegrationConflictOperationFault](#aws-glue-api-integrations-IntegrationConflictOperationFault) + [Estrutura IntegrationQuotaExceededFault](#aws-glue-api-integrations-IntegrationQuotaExceededFault) + [Estrutura KMSKeyNotAccessibleFault](#aws-glue-api-integrations-KMSKeyNotAccessibleFault) + [Estrutura IntegrationNotFoundFault](#aws-glue-api-integrations-IntegrationNotFoundFault) + [Estrutura TargetResourceNotFound](#aws-glue-api-integrations-TargetResourceNotFound) + [Estrutura InvalidIntegrationStateFault](#aws-glue-api-integrations-InvalidIntegrationStateFault) ## Estrutura ResourceNotFoundException Não foi possível encontrar o recurso. **Campos** + `Message` – String UTF-8. Uma mensagem descrevendo o problema. ## Estrutura InternalServiceException Ocorreu um erro interno do servidor. **Campos** + `Message` – String UTF-8. Uma mensagem descrevendo o problema. ## Estrutura IntegrationAlreadyExistsFault A integração especificada já existe. **Campos** + `Message` – String UTF-8. Uma mensagem descrevendo o problema. ## Estrutura IntegrationConflictOperationFault A operação solicitada está em conflito com outra operação. **Campos** + `Message` – String UTF-8. Uma mensagem descrevendo o problema. ## Estrutura IntegrationQuotaExceededFault Os dados processados por meio da sua integração excederam sua cota. **Campos** + `Message` – String UTF-8. Uma mensagem descrevendo o problema. ## Estrutura KMSKeyNotAccessibleFault A chave do KMS especificada não está acessível. **Campos** + `Message` – String UTF-8. Uma mensagem descrevendo o problema. ## Estrutura IntegrationNotFoundFault Não foi possível encontrar a integração especificada. **Campos** + `Message` – String UTF-8. Uma mensagem descrevendo o problema. ## Estrutura TargetResourceNotFound Não foi possível encontrar o recurso de destino. **Campos** + `Message` – String UTF-8. Uma mensagem descrevendo o problema. ## Estrutura InvalidIntegrationStateFault A integração está em um estado inválido. **Campos** + `Message` – String UTF-8. Uma mensagem descrevendo o problema.