

# API AWS Glue
<a name="aws-glue-api"></a>

Esta seção descreve os tipos de dados e primitivos usados por SDKs e ferramentas do AWS Glue. Existem três maneiras gerais de interagir com o AWS Glue de modo programático fora do Console de gerenciamento da AWS, cada uma delas com sua própria documentação: 
+  As bibliotecas de SDKs de linguagens permitem que você acesse recursos do AWS nas linguagens de programação comuns. Encontre mais informações em [Ferramentas para criar na AWS](https://aws.amazon.com/tools/). 
+  O AWS CLI permite que você acesse recursos do AWS usando a linha de comando. Encontre mais informações em [Referência de comandos da AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/). 
+  O CloudFormation permite que você defina um conjunto de recursos da AWS para serem provisionados juntos de forma consistente. Encontre mais informações em [CloudFormation: referência de tipo de recurso da AWS Glue](https://docs.aws.amazon.com/en_us/AWSCloudFormation/latest/UserGuide/AWS_Glue.html). 

 Esta seção documenta os primitivos compartilhados independentemente desses SDKs e ferramentas. As ferramentas usam a [Referência de API da Web do AWS Glue](https://docs.aws.amazon.com/glue/latest/webapi/WebAPI_Welcome.html) para se comunicar com o AWS. 

**Contents**
+ [APIs de segurança no AWS Glue](aws-glue-api-jobs-security.md)
  + [Tipos de dados](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-objects)
  + [Estrutura DataCatalogEncryptionSettings](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-DataCatalogEncryptionSettings)
  + [Estrutura EncryptionAtRest](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-EncryptionAtRest)
  + [Estrutura ConnectionPasswordEncryption](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-ConnectionPasswordEncryption)
  + [Estrutura EncryptionConfiguration](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-EncryptionConfiguration)
  + [Estrutura S3Encryption](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-S3Encryption)
  + [Estrutura CloudWatchEncryption](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-CloudWatchEncryption)
  + [Estrutura JobBookmarksEncryption](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-JobBookmarksEncryption)
  + [Estrutura SecurityConfiguration](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-SecurityConfiguration)
  + [Estrutura GluePolicy](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GluePolicy)
  + [Estrutura DataQualityEncryption](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-DataQualityEncryption)
  + [Operações](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-actions)
  + [Ação GetDataCatalogEncryptionSettings (Python: get\$1data\$1catalog\$1encryption\$1settings)](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GetDataCatalogEncryptionSettings)
  + [Ação PutDataCatalogEncryptionSettings (Python: put\$1data\$1catalog\$1encryption\$1settings)](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-PutDataCatalogEncryptionSettings)
  + [Ação PutResourcePolicy (Python: put\$1resource\$1policy)](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-PutResourcePolicy)
  + [Ação GetResourcePolicy (Python: get\$1resource\$1policy)](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GetResourcePolicy)
  + [Ação DeleteResourcePolicy (Python: delete\$1resource\$1policy)](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-DeleteResourcePolicy)
  + [Ação CreateSecurityConfiguration (Python: create\$1security\$1configuration)](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-CreateSecurityConfiguration)
  + [Ação DeleteSecurityConfiguration (Python: delete\$1security\$1configuration)](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-DeleteSecurityConfiguration)
  + [Ação GetSecurityConfiguration (Python: get\$1security\$1configuration)](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GetSecurityConfiguration)
  + [Ação GetSecurityConfigurations (Python: get\$1security\$1configurations)](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GetSecurityConfigurations)
  + [Ação GetResourcePolicies (Python: get\$1resource\$1policies)](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GetResourcePolicies)
+ [API Catalogar objetos](aws-glue-api-catalog.md)
  + [API de catálogos](aws-glue-api-catalog-catalogs.md)
    + [Tipos de dados](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-objects)
    + [Estrutura do catálogo](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-Catalog)
    + [Estrutura CatalogInput](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-CatalogInput)
    + [Estrutura TargetRedshiftCatalog](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog)
    + [Estrutura CatalogPropriedades](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-CatalogProperties)
    + [Estrutura CatalogPropertiesOutput](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput)
    + [Estrutura DataLakeAccessProperties](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-DataLakeAccessProperties)
    + [Estrutura IcebergOptimizationProperties](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties)
    + [Estrutura DataLakeAccessPropertiesOutput](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput)
    + [Estrutura IcebergOptimizationPropertiesOutput](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput)
    + [Estrutura FederatedCatalog](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-FederatedCatalog)
    + [Operações](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-actions)
    + [Ação CreateCatalog (Python: create\$1catalog)](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-CreateCatalog)
    + [Ação UpdateCatalog (Python: update\$1catalog)](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-UpdateCatalog)
    + [Ação DeleteCatalog (Python: delete\$1catalog)](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-DeleteCatalog)
    + [Ação GetCatalog (Python: get\$1catalog)](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-GetCatalog)
    + [Ação GetCatalogs (Python: get\$1catalogs)](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-GetCatalogs)
  + [API de banco de dados](aws-glue-api-catalog-databases.md)
    + [Tipos de dados](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-objects)
    + [Estrutura Database](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-Database)
    + [Estrutura DatabaseInput](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-DatabaseInput)
    + [Estrutura PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions)
    + [Estrutura DataLakePrincipal](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-DataLakePrincipal)
    + [Estrutura DatabaseIdentifier](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-DatabaseIdentifier)
    + [Estrutura FederatedDatabase](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-FederatedDatabase)
    + [Operações](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-actions)
    + [Ação CreateDatabase (Python: create\$1database)](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-CreateDatabase)
    + [Ação UpdateDatabase (Python: update\$1database)](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-UpdateDatabase)
    + [Ação DeleteDatabase (Python: delete\$1database)](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-DeleteDatabase)
    + [Ação GetDatabase (Python: get\$1database)](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-GetDatabase)
    + [Ação GetDatabases (Python: get\$1databases)](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-GetDatabases)
  + [API de tabela](aws-glue-api-catalog-tables.md)
    + [Tipos de dados](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-objects)
    + [Estrutura Table](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Table)
    + [Estrutura TableInput](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-TableInput)
    + [Estrutura FederatedTable](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-FederatedTable)
    + [Estrutura da coluna](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Column)
    + [Estrutura StorageDescriptor](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-StorageDescriptor)
    + [Estrutura SchemaReference](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-SchemaReference)
    + [Estrutura SerDeInfo](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-SerDeInfo)
    + [Estrutura Order](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Order)
    + [Estrutura SkewedInfo](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-SkewedInfo)
    + [Estrutura TableVersion](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-TableVersion)
    + [Estrutura TableError](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-TableError)
    + [Estrutura TableVersionError](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-TableVersionError)
    + [Estrutura SortCriterion](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-SortCriterion)
    + [Estrutura TableIdentifier](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-TableIdentifier)
    + [Estrutura KeySchemaElement](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-KeySchemaElement)
    + [Estrutura PartitionIndex](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-PartitionIndex)
    + [Estrutura PartitionIndexDescriptor](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-PartitionIndexDescriptor)
    + [Estrutura BackfillError](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-BackfillError)
    + [Estrutura IcebergInput](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergInput)
    + [Estrutura OpenTableFormatInput](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-OpenTableFormatInput)
    + [Estrutura ViewDefinition](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-ViewDefinition)
    + [Estrutura ViewDefinitionInput](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-ViewDefinitionInput)
    + [Estrutura ViewRepresentation](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-ViewRepresentation)
    + [Estrutura ViewRepresentationInput](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-ViewRepresentationInput)
    + [Estrutura UpdateOpenTableFormatInput](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput)
    + [Estrutura UpdateIcebergInput](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-UpdateIcebergInput)
    + [Estrutura CreateIcebergTableInput](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-CreateIcebergTableInput)
    + [Estrutura UpdateIcebergTableInput](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-UpdateIcebergTableInput)
    + [Estrutura IcebergSortOrder](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergSortOrder)
    + [Estrutura IcebergSortField](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergSortField)
    + [Estrutura IcebergPartitionSpec](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergPartitionSpec)
    + [Estrutura IcebergPartitionField](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergPartitionField)
    + [Estrutura IcebergSchema](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergSchema)
    + [Estrutura IcebergStructField](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergStructField)
    + [Estrutura IcebergTableUpdate](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergTableUpdate)
    + [Esrtutura AuditContext](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-AuditContext)
    + [Operações](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-actions)
    + [Ação CreateTable (Python: create\$1table)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-CreateTable)
    + [Ação UpdateTable (Python: update\$1table)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-UpdateTable)
    + [Ação DeleteTable (Python: delete\$1table)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-DeleteTable)
    + [Ação BatchDeleteTable (Python: batch\$1delete\$1table)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-BatchDeleteTable)
    + [Ação GetTable (Python: get\$1table)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetTable)
    + [Ação GetTables (Python: get\$1tables)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetTables)
    + [Ação GetTableVersion (Python: get\$1table\$1version)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetTableVersion)
    + [Ação GetTableVersions (Python: get\$1table\$1versions)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetTableVersions)
    + [Ação DeleteTableVersion (Python: delete\$1table\$1version)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-DeleteTableVersion)
    + [Ação BatchDeleteTableVersion (Python: batch\$1delete\$1table\$1version)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-BatchDeleteTableVersion)
    + [Ação SearchTables (Python: search\$1tables)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-SearchTables)
    + [Ação GetPartitionIndexes (Python: get\$1partitions\$1indexes)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetPartitionIndexes)
    + [Ação CreatePartitionIndex (Python: create\$1partition\$1index)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-CreatePartitionIndex)
    + [Ação DeletePartitionIndex (Python: delete\$1partition\$1index)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-DeletePartitionIndex)
    + [Ação GetColumnStatisticsForTable (Python: get\$1column\$1statistics\$1for\$1table)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetColumnStatisticsForTable)
    + [Ação UpdateColumnStatisticsForTable (Python: update\$1column\$1statistics\$1for\$1table)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-UpdateColumnStatisticsForTable)
    + [Ação DeleteColumnStatisticsForTable (Python: delete\$1column\$1statistics\$1for\$1table)](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-DeleteColumnStatisticsForTable)
  + [API de partição](aws-glue-api-catalog-partitions.md)
    + [Tipos de dados](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-objects)
    + [Estrutura Partition](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-Partition)
    + [Estrutura PartitionInput](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionInput)
    + [Estrutura PartitionSpecWithSharedStorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor)
    + [Estrutura PartitionListComposingSpec](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionListComposingSpec)
    + [Estrutura PartitionSpecProxy](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionSpecProxy)
    + [Estrutura PartitionValueList](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionValueList)
    + [Estrutura Segment](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-Segment)
    + [Estrutura PartitionError](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionError)
    + [Estrutura BatchUpdatePartitionFailureEntry](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry)
    + [Estrutura BatchUpdatePartitionRequestEntry](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry)
    + [Estrutura StorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor)
    + [Estrutura SchemaReference](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SchemaReference)
    + [Estrutura SerDeInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SerDeInfo)
    + [Estrutura SkewedInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SkewedInfo)
    + [Operações](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-actions)
    + [Ação CreatePartition (Python: create\$1partition)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-CreatePartition)
    + [Ação BatchCreatePartition (Python: batch\$1create\$1partition)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchCreatePartition)
    + [Ação UpdatePartition (Python: update\$1partition)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-UpdatePartition)
    + [Ação DeletePartition (Python: delete\$1partition)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-DeletePartition)
    + [Ação BatchDeletePartition (Python: batch\$1delete\$1partition)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchDeletePartition)
    + [Ação GetPartition (Python: get\$1partition)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-GetPartition)
    + [Ação GetPartitions (Python: get\$1partitions)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-GetPartitions)
    + [Ação BatchGetPartition (Python: batch\$1get\$1partition)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchGetPartition)
    + [Ação BatchUpdatePartition (Python: batch\$1update\$1partition)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchUpdatePartition)
    + [Ação GetColumnStatisticsForPartition (Python: get\$1column\$1statistics\$1for\$1partition)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-GetColumnStatisticsForPartition)
    + [Ação UpdateColumnStatisticsForPartition (Python: update\$1column\$1statistics\$1for\$1partition)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-UpdateColumnStatisticsForPartition)
    + [Ação DeleteColumnStatisticsForPartition (Python: delete\$1column\$1statistics\$1for\$1partition)](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-DeleteColumnStatisticsForPartition)
  + [API de conexões](aws-glue-api-catalog-connections.md)
    + [API de conexão](aws-glue-api-catalog-connections-connections.md)
      + [Tipos de dados](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-objects)
      + [Estrutura Connection](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-Connection)
      + [Estrutura ConnectionInput](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-ConnectionInput)
      + [Estrutura TestConnectionInput](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-TestConnectionInput)
      + [Estrutura PhysicalConnectionRequirements](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements)
      + [Estrutura GetConnectionsFilter](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-GetConnectionsFilter)
      + [Estrutura AuthenticationConfiguration](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration)
      + [Estrutura AuthenticationConfigurationInput](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput)
      + [Estrutura OAuth2Properties](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-OAuth2Properties)
      + [Estrutura OAuth2PropertiesInput](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput)
      + [Estrutura OAuth2ClientApplication](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication)
      + [Estrutura AuthorizationCodeProperties](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties)
      + [Estrutura BasicAuthenticationCredentials](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials)
      + [Estrutura OAuth2Credentials](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-OAuth2Credentials)
      + [Operações](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-actions)
      + [Ação CreateConnection (Python: create\$1connection)](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-CreateConnection)
      + [Ação DeleteConnection (Python: delete\$1connection)](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-DeleteConnection)
      + [Ação GetConnection (Python: get\$1connection)](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-GetConnection)
      + [Ação GetConnections (Python: get\$1connections)](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-GetConnections)
      + [Ação UpdateConnection (Python: update\$1connection)](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-UpdateConnection)
      + [Ação TestConnection (Python: test\$1connection)](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-TestConnection)
      + [Ação BatchDeleteConnection (Python: batch\$1delete\$1connection)](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-BatchDeleteConnection)
    + [API de tipos de conexão](aws-glue-api-catalog-connections-connections-type.md)
      + [APIs de gerenciamento de conexões](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-connection-management)
      + [Ação DescribeConnectionType (Python: describe\$1connection\$1type)](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
      + [Ação ListConnectionTypes (Python: list\$1connection\$1types)](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes)
      + [Estrutura ConnectionTypeBrief](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief)
      + [Estrutura de ConnectionTypeVariant](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant)
      + [datatypes](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-connection-types)
      + [Estrutura Validation](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-Validation)
      + [Estrutura AuthConfiguration](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-AuthConfiguration)
      + [Estrutura de capacidades](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-Capabilities)
      + [Estrutura Property](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-Property)
      + [Estrutura AllowedValue](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-AllowedValue)
      + [Estrutura ComputeEnvironmentConfiguration](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration)
    + [Metadados de conexão e API de visualização](aws-glue-api-catalog-connections-connections-metadata.md)
      + [Tipos de dados](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-objects)
      + [Estrutura Entity](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-Entity)
      + [Estrutura Field](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-Field)
      + [Operações](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-actions)
      + [Ação ListEntities (Python: list\$1entities)](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-ListEntities)
      + [Ação DescribeEntity (Python: describe\$1entity)](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-DescribeEntity)
      + [Ação GetEntityRecords (Python: get\$1entity\$1records)](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords)
  + [API User-defined Function](aws-glue-api-catalog-functions.md)
    + [Tipos de dados](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-objects)
    + [Estrutura UserDefinedFunction](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-UserDefinedFunction)
    + [Estrutura UserDefinedFunctionInput](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-UserDefinedFunctionInput)
    + [Operações](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-actions)
    + [Ação CreateUserDefinedFunction (Python: create\$1user\$1defined\$1function)](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-CreateUserDefinedFunction)
    + [Ação UpdateUserDefinedFunction (Python: update\$1user\$1defined\$1function)](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-UpdateUserDefinedFunction)
    + [Ação DeleteUserDefinedFunction (Python: delete\$1user\$1defined\$1function)](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-DeleteUserDefinedFunction)
    + [Ação GetUserDefinedFunction (Python: get\$1user\$1defined\$1function)](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-GetUserDefinedFunction)
    + [Ação GetUserDefinedFunctions (Python: get\$1user\$1defined\$1functions)](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-GetUserDefinedFunctions)
  + [Importar um catálogo do Athena para AWS Glue](aws-glue-api-catalog-migration.md)
    + [Tipos de dados](aws-glue-api-catalog-migration.md#aws-glue-api-catalog-migration-objects)
    + [Estrutura CatalogImportStatus](aws-glue-api-catalog-migration.md#aws-glue-api-catalog-migration-CatalogImportStatus)
    + [Operações](aws-glue-api-catalog-migration.md#aws-glue-api-catalog-migration-actions)
    + [Ação ImportCatalogToGlue (Python: import\$1catalog\$1to\$1glue)](aws-glue-api-catalog-migration.md#aws-glue-api-catalog-migration-ImportCatalogToGlue)
    + [Ação GetCatalogImportStatus (Python: get\$1catalog\$1import\$1status)](aws-glue-api-catalog-migration.md#aws-glue-api-catalog-migration-GetCatalogImportStatus)
+ [API do otimizador de tabelas](aws-glue-api-table-optimizers.md)
  + [Tipos de dados](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-objects)
  + [Estrutura do TableOptimizer](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-TableOptimizer)
  + [Estrutura do TableOptimizerConfiguration](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-TableOptimizerConfiguration)
  + [Estrutura de TableOptimizerVpcConfiguration](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-TableOptimizerVpcConfiguration)
  + [Estrutura CompactionConfiguration](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-CompactionConfiguration)
  + [Estrutura IcebergCompactionConfiguration](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergCompactionConfiguration)
  + [Estrutura TableOptimizerRun](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-TableOptimizerRun)
  + [Estrutura BatchGetTableOptimizerEntry](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-BatchGetTableOptimizerEntry)
  + [Estrutura BatchTableTableOptimizer](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-BatchTableOptimizer)
  + [Estrutura BatchGetTableOptimizerError](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-BatchGetTableOptimizerError)
  + [Estrutura RetentionConfiguration](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-RetentionConfiguration)
  + [Estrutura IcebergRetentionConfiguration](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergRetentionConfiguration)
  + [Estrutura OrphanFileDeletionConfiguration](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-OrphanFileDeletionConfiguration)
  + [Estrutura IcebergOrphanFileDeletionConfiguration](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionConfiguration)
  + [Estrutura CompactionMetrics](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-CompactionMetrics)
  + [Estrutura RetentionMetrics](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-RetentionMetrics)
  + [Estrutura OrphanFileDeletionMetrics](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-OrphanFileDeletionMetrics)
  + [Estrutura IcebergCompactionMetrics](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergCompactionMetrics)
  + [Estrutura IcebergRetentionMetrics](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergRetentionMetrics)
  + [Estrutura IcebergOrphanFileDeletionMetrics](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionMetrics)
  + [Estrutura RunMetrics](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-RunMetrics)
  + [Operações](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-actions)
  + [Ação GetTableOptimizer (Python: get\$1table\$1optimizer)](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-GetTableOptimizer)
  + [Ação BatchGetTableOptimizer (Python: batch\$1get\$1table\$1optimizer)](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-BatchGetTableOptimizer)
  + [Ação ListTableOptimizerRuns (Python: list\$1table\$1optimizer\$1runs)](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-ListTableOptimizerRuns)
  + [Ação CreateTableOptimizer (Python: create\$1table\$1optimizer)](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-CreateTableOptimizer)
  + [Ação DeleteTableOptimizer (Python: delete\$1table\$1optimizer)](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-DeleteTableOptimizer)
  + [Ação UpdateTableOptimizer (Python: update\$1table\$1optimizer)](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-UpdateTableOptimizer)
+ [API de crawlers e classificadores](aws-glue-api-crawler.md)
  + [API do classificador](aws-glue-api-crawler-classifiers.md)
    + [Tipos de dados](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-objects)
    + [Estrutura Classifier](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-Classifier)
    + [Estrutura GrokClassifier](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-GrokClassifier)
    + [Estrutura XMLClassifier](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-XMLClassifier)
    + [Estrutura JsonClassifier](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-JsonClassifier)
    + [Estrutura CsvClassifier](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CsvClassifier)
    + [Estrutura CreateGrokClassifierRequest](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CreateGrokClassifierRequest)
    + [Estrutura UpdateGrokClassifierRequest](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-UpdateGrokClassifierRequest)
    + [Estrutura CreateXMLClassifierRequest](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CreateXMLClassifierRequest)
    + [Estrutura UpdateXMLClassifierRequest](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-UpdateXMLClassifierRequest)
    + [Estrutura CreateJsonClassifierRequest](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CreateJsonClassifierRequest)
    + [Estrutura UpdateJsonClassifierRequest](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-UpdateJsonClassifierRequest)
    + [Estrutura CreateCsvClassifierRequest](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CreateCsvClassifierRequest)
    + [Estrutura UpdateCsvClassifierRequest](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-UpdateCsvClassifierRequest)
    + [Operações](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-actions)
    + [Ação CreateClassifier (Python: create\$1classifier)](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CreateClassifier)
    + [Ação DeleteClassifier (Python: delete\$1classifier)](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-DeleteClassifier)
    + [Ação GetClassifier (Python: get\$1classifier)](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-GetClassifier)
    + [Ação GetClassifiers (Python: get\$1classifiers)](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-GetClassifiers)
    + [Ação UpdateClassifier (Python: update\$1classifier)](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-UpdateClassifier)
  + [API do crawler](aws-glue-api-crawler-crawling.md)
    + [Tipos de dados](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-objects)
    + [Estrutura Crawler](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-Crawler)
    + [Estrutura Schedule](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-Schedule)
    + [Estrutura CrawlerTargets](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CrawlerTargets)
    + [Estrutura S3Target](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-S3Target)
    + [Estrutura S3DeltaCatalogTarget](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-S3DeltaCatalogTarget)
    + [Estrutura S3DeltaDirectTarget](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-S3DeltaDirectTarget)
    + [Estrutura JdbcTarget](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-JdbcTarget)
    + [Estrutura MongoDBTarget](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-MongoDBTarget)
    + [Estrutura DynamoDBTarget](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-DynamoDBTarget)
    + [Estrutura DeltaTarget](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-DeltaTarget)
    + [Estrutura do IcebergTarget](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-IcebergTarget)
    + [Estrutura HudiTarget](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-HudiTarget)
    + [Estrutura CatalogTarget](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CatalogTarget)
    + [Estrutura CrawlerMetrics](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CrawlerMetrics)
    + [Estrutura de CrawlerHistory](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CrawlerHistory)
    + [Estrutura de CrawlsFilter](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CrawlsFilter)
    + [Estrutura SchemaChangePolicy](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-SchemaChangePolicy)
    + [Estrutura LastCrawlInfo](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-LastCrawlInfo)
    + [Estrutura RecrawlPolicy](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-RecrawlPolicy)
    + [Estrutura LineageConfiguration](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-LineageConfiguration)
    + [Estrutura LakeFormationConfiguration](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-LakeFormationConfiguration)
    + [Operações](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-actions)
    + [Ação CreateCrawler (Python: create\$1crawler)](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CreateCrawler)
    + [Ação DeleteCrawler (Python: delete\$1crawler)](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-DeleteCrawler)
    + [Ação GetCrawler (Python: get\$1crawler)](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-GetCrawler)
    + [Ação GetCrawlers (Python: get\$1crawlers)](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-GetCrawlers)
    + [Ação GetCrawlerMetrics (Python: get\$1crawler\$1metrics)](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-GetCrawlerMetrics)
    + [Ação UpdateCrawler (Python: update\$1crawler)](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-UpdateCrawler)
    + [Ação StartCrawler (Python: start\$1crawler)](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-StartCrawler)
    + [Ação StopCrawler (Python: stop\$1crawler)](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-StopCrawler)
    + [Ação BatchGetCrawlers (Python: batch\$1get\$1crawlers)](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-BatchGetCrawlers)
    + [Ação ListCrawlers (Python: list\$1crawlers)](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-ListCrawlers)
    + [Ação ListCrawls (Python: list\$1crawls)](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-ListCrawls)
  + [API de estatísticas de colunas](aws-glue-api-crawler-column-statistics.md)
    + [Tipos de dados](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-objects)
    + [Estrutura ColumnStatisticsTaskRun](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun)
    + [Estrutura ColumnStatisticsTaskSettings](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings)
    + [Estrutura ExecutionAttempt](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ExecutionAttempt)
    + [Operações](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-actions)
    + [Ação StartColumnStatisticsTaskRun (Python: start\$1column\$1statistics\$1task\$1run)](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRun)
    + [Ação GetColumnStatisticsTaskRun (Python: get\$1column\$1statistics\$1task\$1run)](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRun)
    + [Ação GetColumnStatisticsTaskRuns (Python: get\$1column\$1statistics\$1task\$1runs)](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRuns)
    + [Ação ListColumnStatisticsTaskRuns (Python: list\$1column\$1statistics\$1task\$1runs)](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ListColumnStatisticsTaskRuns)
    + [Ação StopColumnStatisticsTaskRun (Python: stop\$1column\$1statistics\$1task\$1run)](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRun)
    + [Ação CreateColumnStatisticsTaskSettings (Python: create\$1column\$1statistics\$1task\$1settings)](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-CreateColumnStatisticsTaskSettings)
    + [Ação UpdateColumnStatisticsTaskSettings (Python: update\$1column\$1statistics\$1task\$1settings)](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-UpdateColumnStatisticsTaskSettings)
    + [Ação GetColumnStatisticsTaskSettings (Python: get\$1column\$1statistics\$1task\$1settings)](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskSettings)
    + [Ação DeleteColumnStatisticsTaskSettings (Python: delete\$1column\$1statistics\$1task\$1settings)](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-DeleteColumnStatisticsTaskSettings)
    + [Ação StartColumnStatisticsTaskRunSchedule (Python: start\$1column\$1statistics\$1task\$1run\$1schedule)](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRunSchedule)
    + [Ação StopColumnStatisticsTaskRunSchedule (Python: stop\$1column\$1statistics\$1task\$1run\$1schedule)](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRunSchedule)
    + [Exceções](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-exceptions)
    + [Estrutura ColumnStatisticsTaskRunningException](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRunningException)
    + [Estrutura ColumnStatisticsTaskNotRunningException](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskNotRunningException)
    + [Estrutura ColumnStatisticsTaskStoppingException](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskStoppingException)
    + [Estrutura ColumnStatisticsTaskAutoConcurrencyLimitException](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskAutoConcurrencyLimitException)
    + [Estrutura InvalidCatalogSettingException](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-InvalidCatalogSettingException)
  + [API do programador do crawler](aws-glue-api-crawler-scheduler.md)
    + [Tipos de dados](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-objects)
    + [Estrutura Schedule](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-Schedule)
    + [Operações](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-actions)
    + [Ação UpdateCrawlerSchedule (Python: update\$1crawler\$1schedule)](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-UpdateCrawlerSchedule)
    + [Ação StartCrawlerSchedule (Python: start\$1crawler\$1schedule)](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-StartCrawlerSchedule)
    + [Ação StopCrawlerSchedule (Python: stop\$1crawler\$1schedule)](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-StopCrawlerSchedule)
+ [API de scripts de ETL de geração automática](aws-glue-api-etl-script-generation.md)
  + [Tipos de dados](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-objects)
  + [Estrutura CodeGenNode](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-CodeGenNode)
  + [Estrutura CodeGenNodeArg](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-CodeGenNodeArg)
  + [Estrutura CodeGenEdge](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-CodeGenEdge)
  + [Estrutura Location](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-Location)
  + [Estrutura CatalogEntry](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-CatalogEntry)
  + [Estrutura MappingEntry](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-MappingEntry)
  + [Operações](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-actions)
  + [Ação CreateScript (Python: create\$1script)](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-CreateScript)
  + [Ação GetDataflowGraph (Python: get\$1dataflow\$1graph)](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-GetDataflowGraph)
  + [Ação GetMapping (Python: get\$1mapping)](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-GetMapping)
  + [Ação GetPlan (Python: get\$1plan)](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-GetPlan)
+ [API de trabalhos visuais](aws-glue-api-visual-job-api.md)
  + [Tipos de dados](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-objects)
  + [Estrutura CodeGenConfigurationNode](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CodeGenConfigurationNode)
  + [Estrutura JDBCConnectorOptions](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-JDBCConnectorOptions)
  + [Estrutura StreamingDataPreviewOptions](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-StreamingDataPreviewOptions)
  + [Estrutura AthenaConnectorSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AthenaConnectorSource)
  + [Estrutura JDBCConnectorSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-JDBCConnectorSource)
  + [Estrutura SparkConnectorSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SparkConnectorSource)
  + [Estrutura CatalogSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogSource)
  + [Estrutura MySQLCatalogSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-MySQLCatalogSource)
  + [Estrutura PostgreSQLCatalogSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-PostgreSQLCatalogSource)
  + [Estrutura OracleSQLCatalogSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-OracleSQLCatalogSource)
  + [Estrutura MicrosoftSQLServerCatalogSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogSource)
  + [Estrutura CatalogKinesisSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogKinesisSource)
  + [Estrutura DirectKinesisSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DirectKinesisSource)
  + [Estrutura KinesisStreamingSourceOptions](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-KinesisStreamingSourceOptions)
  + [Estrutura CatalogKafkaSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogKafkaSource)
  + [Estrutura DirectKafkaSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DirectKafkaSource)
  + [Estrutura KafkaStreamingSourceOptions](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-KafkaStreamingSourceOptions)
  + [Estrutura RedshiftSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RedshiftSource)
  + [Estrutura AmazonRedshiftSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AmazonRedshiftSource)
  + [Estrutura AmazonRedshiftNodeData](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AmazonRedshiftNodeData)
  + [Estrutura AmazonRedshiftAdvancedOption](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AmazonRedshiftAdvancedOption)
  + [Estrutura Option](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Option)
  + [Estrutura S3CatalogSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CatalogSource)
  + [Estrutura S3SourceAdditionalOptions](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3SourceAdditionalOptions)
  + [Estrutura S3CsvSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CsvSource)
  + [Estrutura DirectJDBCSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DirectJDBCSource)
  + [Estrutura S3DirectSourceAdditionalOptions](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions)
  + [Estrutura S3JsonSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3JsonSource)
  + [Estrutura S3ParquetSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3ParquetSource)
  + [Estrutura S3DeltaSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3DeltaSource)
  + [Estrutura S3CatalogDeltaSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CatalogDeltaSource)
  + [Estrutura CatalogDeltaSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogDeltaSource)
  + [Estrutura S3HudiSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3HudiSource)
  + [Estrutura S3CatalogHudiSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CatalogHudiSource)
  + [Estrutura de S3ExcelSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3ExcelSource)
  + [Estrutura CatalogHudiSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogHudiSource)
  + [Estrutura DynamoDBCatalogSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DynamoDBCatalogSource)
  + [Estrutura RelationalCatalogSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RelationalCatalogSource)
  + [Estrutura JDBCConnectorTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-JDBCConnectorTarget)
  + [Estrutura SparkConnectorTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SparkConnectorTarget)
  + [Estrutura BasicCatalogTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-BasicCatalogTarget)
  + [Estrutura MySQLCatalogTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-MySQLCatalogTarget)
  + [Estrutura PostgreSQLCatalogTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-PostgreSQLCatalogTarget)
  + [Estrutura OracleSQLCatalogTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-OracleSQLCatalogTarget)
  + [Estrutura MicrosoftSQLServerCatalogTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogTarget)
  + [Estrutura RedshiftTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RedshiftTarget)
  + [Estrutura AmazonRedshiftTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AmazonRedshiftTarget)
  + [Estrutura UpsertRedshiftTargetOptions](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-UpsertRedshiftTargetOptions)
  + [Estrutura S3CatalogTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CatalogTarget)
  + [Estrutura S3GlueParquetTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3GlueParquetTarget)
  + [Estrutura CatalogSchemaChangePolicy](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy)
  + [Estrutura S3DirectTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3DirectTarget)
  + [Estrutura S3HudiCatalogTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3HudiCatalogTarget)
  + [Estrutura S3HudiDirectTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3HudiDirectTarget)
  + [Estrutura S3DeltaCatalogTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3DeltaCatalogTarget)
  + [Estrutura S3DeltaDirectTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3DeltaDirectTarget)
  + [Estrutura de S3HyperDirectTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3HyperDirectTarget)
  + [Estrutura de S3IcebergDirectTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3IcebergDirectTarget)
  + [Estrutura DirectSchemaChangePolicy](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DirectSchemaChangePolicy)
  + [Estrutura ApplyMapping](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-ApplyMapping)
  + [Estrutura Mapping](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Mapping)
  + [Estrutura SelectFields](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SelectFields)
  + [Estrutura DropFields](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DropFields)
  + [Estrutura RenameField](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RenameField)
  + [Estrutura Spigot](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Spigot)
  + [Estrutura Join](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Join)
  + [Estrutura JoinColumn](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-JoinColumn)
  + [Estrutura SplitFields](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SplitFields)
  + [Estrutura SelectFromCollection](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SelectFromCollection)
  + [Estrutura FillMissingValues](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-FillMissingValues)
  + [Estrutura Filter](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Filter)
  + [Estrutura FilterExpression](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-FilterExpression)
  + [Estrutura FilterValue](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-FilterValue)
  + [Estrutura CustomCode](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CustomCode)
  + [Estrutura SparkSQL](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SparkSQL)
  + [Estrutura SqlAlias](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SqlAlias)
  + [Estrutura DropNullFields](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DropNullFields)
  + [Estrutura NullCheckBoxList](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-NullCheckBoxList)
  + [Estrutura NullValueField](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-NullValueField)
  + [Estrutura Datatype](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Datatype)
  + [Estrutura Merge](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Merge)
  + [Estrutura Union](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Union)
  + [Estrutura PIIDetection](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-PIIDetection)
  + [Estrutura Aggregate](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Aggregate)
  + [Estrutura DropDuplicates](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DropDuplicates)
  + [Estrutura GovernedCatalogTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GovernedCatalogTarget)
  + [Estrutura GovernedCatalogSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GovernedCatalogSource)
  + [Estrutura AggregateOperation](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AggregateOperation)
  + [Estrutura GlueSchema](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GlueSchema)
  + [Estrutura GlueStudioSchemaColumn](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GlueStudioSchemaColumn)
  + [Estrutura GlueStudioColumn](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GlueStudioColumn)
  + [Estrutura DynamicTransform](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DynamicTransform)
  + [Estrutura TransformConfigParameter](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-TransformConfigParameter)
  + [Estrutura EvaluateDataQuality](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-EvaluateDataQuality)
  + [Estrutura DQResultsPublishingOptions](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DQResultsPublishingOptions)
  + [Estrutura DQStopJobOnFailureOptions](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DQStopJobOnFailureOptions)
  + [Estrutura EvaluateDataQualityMultiFrame](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-EvaluateDataQualityMultiFrame)
  + [Estrutura da fórmula](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Recipe)
  + [Estrutura SchemaReference](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RecipeReference)
  + [Estrutura SnowflakeNodeData](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SnowflakeNodeData)
  + [Estrutura SnowflakeSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SnowflakeSource)
  + [Estrutura SnowflakeTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SnowflakeTarget)
  + [Estrutura ConnectorDataSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-ConnectorDataSource)
  + [Estrutura ConnectorDataTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-ConnectorDataTarget)
  + [Estrutura RecipeStep](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RecipeStep)
  + [Estrutura RecipeAction](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RecipeAction)
  + [Estrutura ConditionExpression](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-ConditionExpression)
  + [Estrutura S3CatalogIcebergSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CatalogIcebergSource)
  + [Estrutura CatalogIcebergSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogIcebergSource)
  + [Estrutura S3IcebergCatalogTarget](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3IcebergCatalogTarget)
  + [Estrutura DynamoDBELTConnectorSource](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DynamoDBELTConnectorSource)
  + [Estrutura DDBELTConnectionOptions](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DDBELTConnectionOptions)
  + [Estrutura DDBELTCatalogAdditionalOptions](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DDBELTCatalogAdditionalOptions)
  + [Estrutura de rotas](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Route)
  + [Estrutura GroupFilters](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GroupFilters)
  + [Estrutura AutoDataQuality](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AutoDataQuality)
+ [API de trabalhos](aws-glue-api-jobs.md)
  + [Tarefas](aws-glue-api-jobs-job.md)
    + [Tipos de dados](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-objects)
    + [Estrutura do trabalho](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-Job)
    + [Estrutura ExecutionProperty](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-ExecutionProperty)
    + [Estrutura NotificationProperty](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-NotificationProperty)
    + [Estrutura JobCommand](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-JobCommand)
    + [Estrutura ConnectionsList](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-ConnectionsList)
    + [Estrutura JobUpdate](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-JobUpdate)
    + [Estrutura SourceControlDetails](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-SourceControlDetails)
    + [Operações](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-actions)
    + [Ação CreateJob (Python: create\$1job)](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-CreateJob)
    + [Ação UpdateJob (Python: update\$1job)](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-UpdateJob)
    + [Ação GetJob (Python: get\$1job)](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-GetJob)
    + [Ação GetJobs (Python: get\$1jobs)](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-GetJobs)
    + [Ação DeleteJob (Python: delete\$1job)](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-DeleteJob)
    + [Ação ListJobs (Python: list\$1jobs)](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-ListJobs)
    + [Ação BatchGetJobs (Python: batch\$1get\$1jobs)](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-BatchGetJobs)
  + [Execuções de trabalhos](aws-glue-api-jobs-runs.md)
    + [Tipos de dados](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-objects)
    + [Estrutura JobRun](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-JobRun)
    + [Estrutura Predecessor](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-Predecessor)
    + [Estrutura JobBookmarkEntry](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-JobBookmarkEntry)
    + [Estrutura BatchStopJobRunSuccessfulSubmission](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-BatchStopJobRunSuccessfulSubmission)
    + [Estrutura BatchStopJobRunError](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-BatchStopJobRunError)
    + [Estrutura NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty)
    + [Operações](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-actions)
    + [Ação StartJobRun (Python: start\$1job\$1run)](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-StartJobRun)
    + [Ação BatchStopJobRun (Python: batch\$1stop\$1job\$1run)](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-BatchStopJobRun)
    + [Ação GetJobRun (Python: get\$1job\$1run)](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-GetJobRun)
    + [Ação GetJobRuns (Python: get\$1job\$1runs)](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-GetJobRuns)
    + [Ação GetJobBookmark (Python: get\$1job\$1bookmark)](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-GetJobBookmark)
    + [Ação GetJobBookmarks (Python: get\$1job\$1bookmarks)](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-GetJobBookmarks)
    + [Ação ResetJobBookmark (Python: reset\$1job\$1bookmark)](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-ResetJobBookmark)
  + [Acionadores](aws-glue-api-jobs-trigger.md)
    + [Tipos de dados](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-objects)
    + [Estrutura de acionador](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-Trigger)
    + [Estrutura TriggerUpdate](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-TriggerUpdate)
    + [Estrutura Predicate](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-Predicate)
    + [Estrutura Condition](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-Condition)
    + [Estrutura Action](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-Action)
    + [Estrutura EventBatchingCondition](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-EventBatchingCondition)
    + [Operações](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-actions)
    + [Ação CreateTrigger (Python: create\$1trigger)](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-CreateTrigger)
    + [Ação StartTrigger (Python: start\$1trigger)](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-StartTrigger)
    + [Ação GetTrigger (Python: get\$1trigger)](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-GetTrigger)
    + [Ação GetTriggers (Python: get\$1triggers)](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-GetTriggers)
    + [Ação UpdateTrigger (Python: update\$1trigger)](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-UpdateTrigger)
    + [Ação StopTrigger (Python: stop\$1trigger)](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-StopTrigger)
    + [Ação DeleteTrigger (Python: delete\$1trigger)](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-DeleteTrigger)
    + [Ação ListTriggers (Python: list\$1triggers)](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-ListTriggers)
    + [Ação BatchGetTriggers (Python: batch\$1get\$1triggers)](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-BatchGetTriggers)
+ [APIs de integração no AWS Glue](aws-glue-api-integrations.md)
  + [Tipos de dados](aws-glue-api-integrations.md#aws-glue-api-integrations-objects)
  + [Estrutura da integração](aws-glue-api-integrations.md#aws-glue-api-integrations-Integration)
  + [Estrutura de IntegrationConfig](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationConfig)
  + [Estrutura IntegrationPartition](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationPartition)
  + [Estrutura IntegrationError](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationError)
  + [Estrutura IntegrationFilter](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationFilter)
  + [Estrutura InboundIntegration](aws-glue-api-integrations.md#aws-glue-api-integrations-InboundIntegration)
  + [Estrutura SourceProcessingProperties](aws-glue-api-integrations.md#aws-glue-api-integrations-SourceProcessingProperties)
  + [Estrutura TargetProcessingProperties](aws-glue-api-integrations.md#aws-glue-api-integrations-TargetProcessingProperties)
  + [Estrutura SourceTableConfig](aws-glue-api-integrations.md#aws-glue-api-integrations-SourceTableConfig)
  + [Estrutura TargetTableConfig](aws-glue-api-integrations.md#aws-glue-api-integrations-TargetTableConfig)
  + [Operações](aws-glue-api-integrations.md#aws-glue-api-integrations-actions)
  + [Ação CreateIntegration action (Python: create\$1integration)](aws-glue-api-integrations.md#aws-glue-api-integrations-CreateIntegration)
  + [Ação ModifyIntegration (Python: modify\$1integration)](aws-glue-api-integrations.md#aws-glue-api-integrations-ModifyIntegration)
  + [Ação DescribeIntegrations (Python: describe\$1integrations)](aws-glue-api-integrations.md#aws-glue-api-integrations-DescribeIntegrations)
  + [Ação DeleteIntegration (Python: delete\$1integration)](aws-glue-api-integrations.md#aws-glue-api-integrations-DeleteIntegration)
  + [Ação DescribeInboundIntegrations (Python: describe\$1inbound\$1integrations)](aws-glue-api-integrations.md#aws-glue-api-integrations-DescribeInboundIntegrations)
  + [Ação CreateIntegrationTableProperties (Python: create\$1integration\$1table\$1properties)](aws-glue-api-integrations.md#aws-glue-api-integrations-CreateIntegrationTableProperties)
  + [Ação UpdateIntegrationTableProperties (Python: update\$1integration\$1table\$1properties)](aws-glue-api-integrations.md#aws-glue-api-integrations-UpdateIntegrationTableProperties)
  + [Ação GetIntegrationTableProperties (Python: get\$1integration\$1table\$1properties)](aws-glue-api-integrations.md#aws-glue-api-integrations-GetIntegrationTableProperties)
  + [Ação DeleteIntegrationTableProperties (Python: delete\$1integration\$1table\$1properties)](aws-glue-api-integrations.md#aws-glue-api-integrations-DeleteIntegrationTableProperties)
  + [Ação CreateIntegrationResourceProperty (Python: create\$1integration\$1resource\$1property)](aws-glue-api-integrations.md#aws-glue-api-integrations-CreateIntegrationResourceProperty)
  + [Ação UpdateIntegrationResourceProperty (Python: update\$1integration\$1resource\$1property)](aws-glue-api-integrations.md#aws-glue-api-integrations-UpdateIntegrationResourceProperty)
  + [Ação GetIntegrationResourceProperty (Python: get\$1integration\$1resource\$1property)](aws-glue-api-integrations.md#aws-glue-api-integrations-GetIntegrationResourceProperty)
  + [Ação UntagResource (Python: untag\$1resource)](aws-glue-api-integrations.md#aws-glue-api-integrations-UntagResource)
  + [Ação ListTagsForResource (Python: list\$1tags\$1for\$1resource)](aws-glue-api-integrations.md#aws-glue-api-integrations-ListTagsForResource)
  + [Exceções](aws-glue-api-integrations.md#aws-glue-api-integrations-exceptions)
  + [Estrutura ResourceNotFoundException](aws-glue-api-integrations.md#aws-glue-api-integrations-ResourceNotFoundException)
  + [Estrutura InternalServiceException](aws-glue-api-integrations.md#aws-glue-api-integrations-InternalServerException)
  + [Estrutura IntegrationAlreadyExistsFault](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationAlreadyExistsFault)
  + [Estrutura IntegrationConflictOperationFault](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationConflictOperationFault)
  + [Estrutura IntegrationQuotaExceededFault](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationQuotaExceededFault)
  + [Estrutura KMSKeyNotAccessibleFault](aws-glue-api-integrations.md#aws-glue-api-integrations-KMSKeyNotAccessibleFault)
  + [Estrutura IntegrationNotFoundFault](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationNotFoundFault)
  + [Estrutura TargetResourceNotFound](aws-glue-api-integrations.md#aws-glue-api-integrations-TargetResourceNotFound)
  + [Estrutura InvalidIntegrationStateFault](aws-glue-api-integrations.md#aws-glue-api-integrations-InvalidIntegrationStateFault)
+ [Sessões API interativas](aws-glue-api-interactive-sessions.md)
  + [Tipos de dados](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-objects)
  + [Estrutura Session](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-Session)
  + [Estrutura SessionCommand](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-SessionCommand)
  + [Estrutura Statement](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-Statement)
  + [Estrutura StatementOutput](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-StatementOutput)
  + [Estrutura StatementOutputData](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-StatementOutputData)
  + [Estrutura ConnectionsList](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ConnectionsList)
  + [Operações](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-actions)
  + [Ação CreateSession (Python: create\$1session)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-CreateSession)
  + [Ação StopSession (Python: stop\$1session)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-StopSession)
  + [Ação DeleteSession (Python: delete\$1session)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-DeleteSession)
  + [Ação GetSession (Python: get\$1session)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-GetSession)
  + [Ação ListSessions (Python: list\$1sessions)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ListSessions)
  + [Ação RunStatement (Python: run\$1statement)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-RunStatement)
  + [Ação CancelStatement (Python: cancel\$1statement)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-CancelStatement)
  + [Ação GetStatement (Python: get\$1statement)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-GetStatement)
  + [Ação ListStatations (Python: list\$1statements)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ListStatements)
  + [Ação GetGlueIdentityCenterConfiguration (Python: get\$1glue\$1identity\$1center\$1configuration)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-GetGlueIdentityCenterConfiguration)
  + [Ação UpdateGlueIdentityCenterConfiguration (Python: update\$1glue\$1identity\$1center\$1configuration)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-UpdateGlueIdentityCenterConfiguration)
  + [Ação CreateGlueIdentityCenterConfiguration (Python: create\$1glue\$1identity\$1center\$1configuration)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-CreateGlueIdentityCenterConfiguration)
  + [Ação DeleteGlueIdentityCenterConfiguration (Python: delete\$1glue\$1identity\$1center\$1configuration)](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-DeleteGlueIdentityCenterConfiguration)
+ [API de endpoints de desenvolvimento](aws-glue-api-dev-endpoint.md)
  + [Tipos de dados](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-objects)
  + [Estrutura DevEndpoint](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-DevEndpoint)
  + [Estrutura DevEndpointCustomLibraries](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-DevEndpointCustomLibraries)
  + [Operações](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-actions)
  + [Ação CreateDevEndpoint (Python: create\$1dev\$1endpoint)](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-CreateDevEndpoint)
  + [Ação UpdateDevEndpoint (Python: update\$1dev\$1endpoint)](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-UpdateDevEndpoint)
  + [Ação DeleteDevEndpoint (Python: delete\$1dev\$1endpoint)](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-DeleteDevEndpoint)
  + [Ação GetDevEndpoint (Python: get\$1dev\$1endpoint)](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-GetDevEndpoint)
  + [Ação GetDevEndpoints (Python: get\$1dev\$1endpoints)](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-GetDevEndpoints)
  + [Ação BatchGetDevEndpoints (Python: batch\$1get\$1dev\$1endpoints)](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-BatchGetDevEndpoints)
  + [Ação ListDevEndpoints (Python: list\$1dev\$1endpoints)](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-ListDevEndpoints)
+ [Registro de esquemas](aws-glue-api-schema-registry-api.md)
  + [Tipos de dados](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-objects)
  + [Estrutura RegistryId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-RegistryId)
  + [Estrutura RegistryListItem](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-RegistryListItem)
  + [Estrutura MetadataInfo](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-MetadataInfo)
  + [Estrutura OtherMetadataValueListItem](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-OtherMetadataValueListItem)
  + [Estrutura SchemaListItem](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaListItem)
  + [Estrutura SchemaVersionListItem](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaVersionListItem)
  + [Estrutura MetadataKeyValuePair](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-MetadataKeyValuePair)
  + [Estrutura SchemaVersionErrorItem](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaVersionErrorItem)
  + [Estrutura ErrorDetails](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-ErrorDetails)
  + [Estrutura SchemaVersionNumber](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaVersionNumber)
  + [Estrutura SchemaId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId)
  + [Operações](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-actions)
  + [Ação CreateRegistry (Python: create\$1registry)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-CreateRegistry)
  + [Ação CreateSchema (Python: create\$1esquema)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-CreateSchema)
  + [Ação GetSchema (Python: get\$1schema)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-GetSchema)
  + [Ação ListSchemaVersions (Python: list\$1schema\$1versions)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-ListSchemaVersions)
  + [Ação GetSchemaVersion (Python: get\$1schema\$1version)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-GetSchemaVersion)
  + [Ação GetSchemaVersionsDiff (Python: get\$1schema\$1versions\$1diff)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-GetSchemaVersionsDiff)
  + [Ação ListRegistries (Python: list\$1registries)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-ListRegistries)
  + [Ação ListSchemas (Python: list\$1schemas)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-ListSchemas)
  + [Ação RegisterSchemaVersion (Python: register\$1schema\$1version)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-RegisterSchemaVersion)
  + [Ação UpdateSchema (Python: update\$1schema)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-UpdateSchema)
  + [Ação CheckSchemaVersionValidity (Python: check\$1schema\$1version\$1validity)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-CheckSchemaVersionValidity)
  + [Ação UpdateRegistry (Python: update\$1registry)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-UpdateRegistry)
  + [Ação GetSchemaByDefinition (Python: get\$1schema\$1by\$1definition)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-GetSchemaByDefinition)
  + [Ação GetRegistry (Python: get\$1registry)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-GetRegistry)
  + [Ação PutSchemaVersionMetadata (Python: put\$1schema\$1version\$1metadata)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-PutSchemaVersionMetadata)
  + [Ação QuerySchemaVersionMetadata (Python: query\$1schema\$1version\$1metadata)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-QuerySchemaVersionMetadata)
  + [Ação RemoveSchemaVersionMetadata (Python: remove\$1schema\$1version\$1metadata)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-RemoveSchemaVersionMetadata)
  + [Ação DeleteRegistry (Python: delete\$1registry)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-DeleteRegistry)
  + [Ação DeleteSchema (Python: delete\$1schema)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-DeleteSchema)
  + [Ação DeleteSchemaVersions (Python: delete\$1schema\$1versions)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-DeleteSchemaVersions)
+ [Fluxos de trabalho](aws-glue-api-workflow.md)
  + [Tipos de dados](aws-glue-api-workflow.md#aws-glue-api-workflow-objects)
  + [Estrutura JobNodeDetails](aws-glue-api-workflow.md#aws-glue-api-workflow-JobNodeDetails)
  + [Estrutura CrawlerNodeDetails](aws-glue-api-workflow.md#aws-glue-api-workflow-CrawlerNodeDetails)
  + [Estrutura TriggerNodeDetails](aws-glue-api-workflow.md#aws-glue-api-workflow-TriggerNodeDetails)
  + [Estrutura Crawl](aws-glue-api-workflow.md#aws-glue-api-workflow-Crawl)
  + [Estrutura Node](aws-glue-api-workflow.md#aws-glue-api-workflow-Node)
  + [Estrutura Edge](aws-glue-api-workflow.md#aws-glue-api-workflow-Edge)
  + [Estrutura Workflow](aws-glue-api-workflow.md#aws-glue-api-workflow-Workflow)
  + [Estrutura WorkflowGraph](aws-glue-api-workflow.md#aws-glue-api-workflow-WorkflowGraph)
  + [Estrutura WorkflowRun](aws-glue-api-workflow.md#aws-glue-api-workflow-WorkflowRun)
  + [Estrutura WorkflowRunStatistics](aws-glue-api-workflow.md#aws-glue-api-workflow-WorkflowRunStatistics)
  + [Estrutura StartingEventBatchCondition](aws-glue-api-workflow.md#aws-glue-api-workflow-StartingEventBatchCondition)
  + [Estrutura Blueprint](aws-glue-api-workflow.md#aws-glue-api-workflow-Blueprint)
  + [Estrutura BlueprintDetails](aws-glue-api-workflow.md#aws-glue-api-workflow-BlueprintDetails)
  + [Estrutura LastActiveDefinition](aws-glue-api-workflow.md#aws-glue-api-workflow-LastActiveDefinition)
  + [Estrutura BlueprintRun](aws-glue-api-workflow.md#aws-glue-api-workflow-BlueprintRun)
  + [Operações](aws-glue-api-workflow.md#aws-glue-api-workflow-actions)
  + [Ação CreateWorkflow (Python: create\$1workflow)](aws-glue-api-workflow.md#aws-glue-api-workflow-CreateWorkflow)
  + [Ação UpdateWorkflow (Python: update\$1workflow)](aws-glue-api-workflow.md#aws-glue-api-workflow-UpdateWorkflow)
  + [Ação DeleteWorkflow (Python: delete\$1workflow)](aws-glue-api-workflow.md#aws-glue-api-workflow-DeleteWorkflow)
  + [Ação GetWorkflow (Python: get\$1workflow)](aws-glue-api-workflow.md#aws-glue-api-workflow-GetWorkflow)
  + [Ação ListWorkflows (Python: list\$1workflows)](aws-glue-api-workflow.md#aws-glue-api-workflow-ListWorkflows)
  + [Ação BatchGetWorkflows (Python: batch\$1get\$1workflows)](aws-glue-api-workflow.md#aws-glue-api-workflow-BatchGetWorkflows)
  + [Ação GetWorkflowRun (Python: get\$1workflow\$1run)](aws-glue-api-workflow.md#aws-glue-api-workflow-GetWorkflowRun)
  + [Ação GetWorkflowRuns (Python: get\$1workflow\$1runs)](aws-glue-api-workflow.md#aws-glue-api-workflow-GetWorkflowRuns)
  + [Ação GetWorkflowRunProperties (Python: get\$1workflow\$1run\$1properties)](aws-glue-api-workflow.md#aws-glue-api-workflow-GetWorkflowRunProperties)
  + [Ação PutWorkflowRunProperties (Python: put\$1workflow\$1run\$1properties)](aws-glue-api-workflow.md#aws-glue-api-workflow-PutWorkflowRunProperties)
  + [Ação CreateBlueprint (Python: create\$1blueprint)](aws-glue-api-workflow.md#aws-glue-api-workflow-CreateBlueprint)
  + [Ação UpdateBlueprint (Python: update\$1blueprint)](aws-glue-api-workflow.md#aws-glue-api-workflow-UpdateBlueprint)
  + [Ação DeleteBlueprint (Python: delete\$1blueprint)](aws-glue-api-workflow.md#aws-glue-api-workflow-DeleteBlueprint)
  + [Ação ListBlueprints (Python: list\$1blueprints)](aws-glue-api-workflow.md#aws-glue-api-workflow-ListBlueprints)
  + [Ação BatchGetBlueprints (Python: batch\$1get\$1blueprints)](aws-glue-api-workflow.md#aws-glue-api-workflow-BatchGetBlueprints)
  + [Ação StartBlueprintRun (Python: start\$1blueprint\$1run)](aws-glue-api-workflow.md#aws-glue-api-workflow-StartBlueprintRun)
  + [Ação GetBlueprintRun (Python: get\$1blueprint\$1run)](aws-glue-api-workflow.md#aws-glue-api-workflow-GetBlueprintRun)
  + [Ação GetBlueprintRuns (Python: get\$1blueprint\$1runs)](aws-glue-api-workflow.md#aws-glue-api-workflow-GetBlueprintRuns)
  + [Ação StartWorkflowRun (Python: start\$1workflow\$1run)](aws-glue-api-workflow.md#aws-glue-api-workflow-StartWorkflowRun)
  + [Ação StopWorkflowRun (Python: stop\$1workflow\$1run)](aws-glue-api-workflow.md#aws-glue-api-workflow-StopWorkflowRun)
  + [Ação ResumeWorkflowRun (Python: resume\$1workflow\$1run)](aws-glue-api-workflow.md#aws-glue-api-workflow-ResumeWorkflowRun)
+ [Perfis de uso](aws-glue-api-usage-profiles.md)
  + [Tipos de dados](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-objects)
  + [Estrutura ProfileConfiguration](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-ProfileConfiguration)
  + [Estrutura ConfigurationObject](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-ConfigurationObject)
  + [Estrutura UsageProfileDefinition](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-UsageProfileDefinition)
  + [Operações](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-actions)
  + [Ação CreateUsageProfile (Python: create\$1usage\$1profile)](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-CreateUsageProfile)
  + [Ação GetUsageProfile (Python: get\$1usage\$1profile)](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-GetUsageProfile)
  + [Ação UpdateUsageProfile (Python: update\$1usage\$1profile)](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-UpdateUsageProfile)
  + [Ação DeleteUsageProfile (Python: delete\$1usage\$1profile)](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-DeleteUsageProfile)
  + [Ação ListUsageProfiles (Python: list\$1usage\$1profiles)](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-ListUsageProfiles)
+ [API de machine learning](aws-glue-api-machine-learning-api.md)
  + [Tipos de dados](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-objects)
  + [Estrutura TransformParameters](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TransformParameters)
  + [Estrutura EvaluationMetrics](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-EvaluationMetrics)
  + [Estrutura MLTransform](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-MLTransform)
  + [Estrutura FindMatchesParameters](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-FindMatchesParameters)
  + [Estrutura FindMatchesMetrics](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-FindMatchesMetrics)
  + [Estrutura ConfusionMatrix](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-ConfusionMatrix)
  + [Estrutura GlueTable](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GlueTable)
  + [Estrutura TaskRun](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TaskRun)
  + [Estrutura TransformFilterCriteria](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TransformFilterCriteria)
  + [Estrutura TransformSortCriteria](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TransformSortCriteria)
  + [Estrutura TaskRunFilterCriteria](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TaskRunFilterCriteria)
  + [Estrutura TaskRunSortCriteria](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TaskRunSortCriteria)
  + [Estrutura TaskRunProperties](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TaskRunProperties)
  + [Estrutura FindMatchesTaskRunProperties](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-FindMatchesTaskRunProperties)
  + [Estrutura ImportLabelsTaskRunProperties](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-ImportLabelsTaskRunProperties)
  + [Estrutura ExportLabelsTaskRunProperties](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-ExportLabelsTaskRunProperties)
  + [Estrutura LabelingSetGenerationTaskRunProperties](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-LabelingSetGenerationTaskRunProperties)
  + [Estrutura SchemaColumn](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-SchemaColumn)
  + [Estrutura TransformEncryption](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TransformEncryption)
  + [Estrutura MLUserDataEncryption](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-MLUserDataEncryption)
  + [Estrutura ColumnImportance](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-ColumnImportance)
  + [Operações](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-actions)
  + [Ação CreateMLTransform (Python: create\$1ml\$1transform)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-CreateMLTransform)
  + [Ação UpdateMLTransform (Python: update\$1ml\$1transform)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-UpdateMLTransform)
  + [Ação DeleteMLTransform (Python: delete\$1ml\$1transform)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-DeleteMLTransform)
  + [Ação GetMLTransform (Python: get\$1ml\$1transform)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GetMLTransform)
  + [Ação GetMLTransforms (Python: get\$1ml\$1transforms)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GetMLTransforms)
  + [Ação ListMLTransforms (Python: list\$1ml\$1transforms)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-ListMLTransforms)
  + [Ação StartMLEvaluationTaskRun (Python: start\$1ml\$1evaluation\$1task\$1run)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-StartMLEvaluationTaskRun)
  + [Ação StartMLLabelingSetGenerationTaskRun (Python: start\$1ml\$1labeling\$1set\$1generation\$1task\$1run)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-StartMLLabelingSetGenerationTaskRun)
  + [Ação GetMLTaskRun (Python: get\$1ml\$1task\$1run)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GetMLTaskRun)
  + [Ação GetMLTaskRuns (Python: get\$1ml\$1task\$1runs)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GetMLTaskRuns)
  + [Ação CancelMLTaskRun (Python: cancel\$1ml\$1task\$1run)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-CancelMLTaskRun)
  + [Ação StartExportLabelsTaskRun (Python: start\$1export\$1labels\$1task\$1run)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-StartExportLabelsTaskRun)
  + [Ação StartImportLabelsTaskRun (Python: start\$1import\$1labels\$1task\$1run)](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-StartImportLabelsTaskRun)
+ [API Data Quality API](aws-glue-api-data-quality-api.md)
  + [Tipos de dados](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-objects)
  + [Estrutura DataSource](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataSource)
  + [Estrutura DataQualityRulesetListDetails](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRulesetListDetails)
  + [Estrutura DataQualityTargetTable](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityTargetTable)
  + [Estrutura DataQualityRulesetEvaluationRunDescription](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription)
  + [Estrutura DataQualityRulesetEvaluationRunFilter](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter)
  + [Estrutura DataQualityEvaluationRunAdditionalRunOptions](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions)
  + [Estrutura DataQualityRuleRecommendationRunDescription](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription)
  + [Estrutura DataQualityRuleRecommendationRunFilter](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter)
  + [Estrutura DataQualityResult](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityResult)
  + [Estrutura DataQualityAnalyzerResult](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityAnalyzerResult)
  + [Estrutura DataQualityObservation](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityObservation)
  + [Estrutura MetricBasedObservation](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-MetricBasedObservation)
  + [Estrutura DataQualityMetricValues](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityMetricValues)
  + [Estrutura DataQualityRuleResult](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRuleResult)
  + [Estrutura DataQualityResultDescription](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityResultDescription)
  + [Estrutura DataQualityResultFilterCriteria](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityResultFilterCriteria)
  + [Estrutura DataQualityRulesetFilterCriteria](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria)
  + [Estrutura DataQualityAggregatedMetrics](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics)
  + [Estrutura StatisticAnotation](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StatisticAnnotation)
  + [Estrutura TimestampedInclusionAnnotation](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation)
  + [Estrutura AnnotationError](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-AnnotationError)
  + [Estrutura DatapointInclusionAnnotation](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DatapointInclusionAnnotation)
  + [Lista StatisticSummaryList](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StatisticSummaryList)
  + [Estrutura StatisticSummary](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StatisticSummary)
  + [Estrutura RunIdentifier](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-RunIdentifier)
  + [Estrutura StatisticModelResult](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StatisticModelResult)
  + [Estrutura DataQualityGlueTable](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityGlueTable)
  + [Operações](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-actions)
  + [Ação StartDataQualityRulesetEvaluationRun (Python: start\$1data\$1quality\$1ruleset\$1evaluation\$1run)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StartDataQualityRulesetEvaluationRun)
  + [Ação CancelDataQualityRulesetEvaluationRun (Python: cancel\$1data\$1quality\$1ruleset\$1evaluation\$1run)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-CancelDataQualityRulesetEvaluationRun)
  + [Ação GetDataQualityRulesetEvaluationRun (Python: get\$1data\$1quality\$1ruleset\$1evaluation\$1run)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityRulesetEvaluationRun)
  + [Ação ListDataQualityRulesetEvaluationRuns (Python: list\$1data\$1quality\$1ruleset\$1evaluation\$1runs)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityRulesetEvaluationRuns)
  + [Ação StartDataQualityRuleRecommendationRun (Python: start\$1data\$1quality\$1rule\$1recommendation\$1run)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRun)
  + [Ação CancelDataQualityRuleRecommendationRun (Python: cancel\$1data\$1quality\$1rule\$1recommendation\$1run)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-CancelDataQualityRuleRecommendationRun)
  + [Ação GetDataQualityRuleRecommendationRun (Python: get\$1data\$1quality\$1rule\$1recommendation\$1run)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRun)
  + [Ação ListDataQualityRuleRecommendationRuns (Python: list\$1data\$1quality\$1rule\$1recommendation\$1runs)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityRuleRecommendationRuns)
  + [Ação GetDataQualityResult (Python: get\$1data\$1quality\$1result)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityResult)
  + [Ação BatchGetDataQualityResult (Python: batch\$1get\$1data\$1quality\$1result)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-BatchGetDataQualityResult)
  + [Ação ListDataQualityResults (Python: list\$1data\$1quality\$1results)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityResults)
  + [Ação CreateDataQualityRuleset (Python: create\$1data\$1quality\$1ruleset)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-CreateDataQualityRuleset)
  + [Ação DeleteDataQualityRuleset (Python: delete\$1data\$1quality\$1ruleset)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DeleteDataQualityRuleset)
  + [Ação GetDataQualityRuleset (Python: get\$1data\$1quality\$1ruleset)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityRuleset)
  + [Ação ListDataQualityRulesets (Python: list\$1data\$1quality\$1rulesets)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityRulesets)
  + [Ação UpdateDataQualityRuleset (Python: update\$1data\$1quality\$1ruleset)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-UpdateDataQualityRuleset)
  + [Ação ListDataQualityStatistics (Python: list\$1data\$1quality\$1statistics)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityStatistics)
  + [Estrutura TimestampFilter](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-TimestampFilter)
  + [Estrutura CreateDataQualityRulesetRequest](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-CreateDataQualityRulesetRequest)
  + [Estrutura GetDataQualityRulesetResponse](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityRulesetResponse)
  + [Estrutura GetDataQualityResultResponse](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityResultResponse)
  + [Estrutura StartDataQualityRuleRecommendationRunRequest](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRunRequest)
  + [Estrutura GetDataQualityRuleRecommendationRunResponse](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRunResponse)
  + [Ação BatchPutDataQualityStatisticAnnotation (Python: batch\$1put\$1data\$1quality\$1statistic\$1annotation)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-BatchPutDataQualityStatisticAnnotation)
  + [Ação GetDataQualityModel (Python: get\$1data\$1quality\$1model)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityModel)
  + [Ação GetDataQualityModelResult (Python: get\$1data\$1quality\$1model\$1result)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityModelResult)
  + [Ação ListDataQualityStatisticAnnotations (Python: list\$1data\$1quality\$1statistic\$1annotations)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityStatisticAnnotations)
  + [Ação PutDataQualityProfileAnnotation (Python: put\$1data\$1quality\$1profile\$1annotation)](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-PutDataQualityProfileAnnotation)
+ [API de detecção de dados sigilosos](aws-glue-api-sensitive-data-api.md)
  + [Tipos de dados](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-objects)
  + [Estrutura CustomEntityType](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-CustomEntityType)
  + [Operações](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-actions)
  + [Ação CreateCustomEntityType (Python: create\$1custom\$1entity\$1type)](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-CreateCustomEntityType)
  + [Ação DeleteCustomEntityType (Python: delete\$1custom\$1entity\$1type)](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-DeleteCustomEntityType)
  + [Ação GetCustomEntityType (Python: get\$1custom\$1entity\$1type)](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-GetCustomEntityType)
  + [Ação BatchGetCustomEntityTypes (Python: batch\$1get\$1custom\$1entity\$1types)](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-BatchGetCustomEntityTypes)
  + [Ação ListCustomEntityTypes (Python: list\$1custom\$1entity\$1types)](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-ListCustomEntityTypes)
+ [Marcação de APIs no AWS Glue](aws-glue-api-tags.md)
  + [Tipos de dados](aws-glue-api-tags.md#aws-glue-api-tags-objects)
  + [Estrutura Tag](aws-glue-api-tags.md#aws-glue-api-tags-Tag)
  + [Operações](aws-glue-api-tags.md#aws-glue-api-tags-actions)
  + [Ação TagResource (Python: tag\$1resource)](aws-glue-api-tags.md#aws-glue-api-tags-TagResource)
  + [Ação UntagResource (Python: untag\$1resource)](aws-glue-api-tags.md#aws-glue-api-tags-UntagResource)
  + [Ação GetTags (Python: get\$1tags)](aws-glue-api-tags.md#aws-glue-api-tags-GetTags)
+ [Tipos de dados comuns](aws-glue-api-common.md)
  + [Estrutura Tag](aws-glue-api-common.md#aws-glue-api-common-Tag)
  + [Estrutura DecimalNumber](aws-glue-api-common.md#aws-glue-api-common-DecimalNumber)
  + [Estrutura ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail)
  + [Estrutura PropertyPredicate](aws-glue-api-common.md#aws-glue-api-common-PropertyPredicate)
  + [Estrutura ResourceUri](aws-glue-api-common.md#aws-glue-api-common-ResourceUri)
  + [Estrutura ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics)
  + [Estrutura ColumnStatisticsError](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError)
  + [Estrutura ColumnError](aws-glue-api-common.md#aws-glue-api-common-ColumnError)
  + [Estrutura ColumnStatisticsData](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsData)
  + [Estrutura BooleanColumnStatisticsData](aws-glue-api-common.md#aws-glue-api-common-BooleanColumnStatisticsData)
  + [Estrutura DateColumnStatisticsData](aws-glue-api-common.md#aws-glue-api-common-DateColumnStatisticsData)
  + [Estrutura DecimalColumnStatisticsData](aws-glue-api-common.md#aws-glue-api-common-DecimalColumnStatisticsData)
  + [Estrutura DoubleColumnStatisticsData](aws-glue-api-common.md#aws-glue-api-common-DoubleColumnStatisticsData)
  + [Estrutura LongColumnStatisticsData](aws-glue-api-common.md#aws-glue-api-common-LongColumnStatisticsData)
  + [Estrutura StringColumnStatisticsData](aws-glue-api-common.md#aws-glue-api-common-StringColumnStatisticsData)
  + [Estrutura BinaryColumnStatisticsData](aws-glue-api-common.md#aws-glue-api-common-BinaryColumnStatisticsData)
  + [Padrões de string](aws-glue-api-common.md#aws-glue-api-common-_string-patterns)
+ [Exceções](aws-glue-api-exceptions.md)
  + [Estrutura AccessDeniedException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-AccessDeniedException)
  + [Estrutura AlreadyExistsException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-AlreadyExistsException)
  + [Estrutura ConcurrentModificationException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-ConcurrentModificationException)
  + [Estrutura ConcurrentRunsExceededException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-ConcurrentRunsExceededException)
  + [Estrutura CrawlerNotRunningException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-CrawlerNotRunningException)
  + [Estrutura CrawlerRunningException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-CrawlerRunningException)
  + [Estrutura CrawlerStoppingException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-CrawlerStoppingException)
  + [Estrutura EntityNotFoundException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-EntityNotFoundException)
  + [Estrutura FederationSourceException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-FederationSourceException)
  + [Estrutura FederationSourceRetryableException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-FederationSourceRetryableException)
  + [Estrutura de GlueEncryptionException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-GlueEncryptionException)
  + [Estrutura IdempotentParameterMismatchException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-IdempotentParameterMismatchException)
  + [Estrutura IllegalWorkflowStateException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-IllegalWorkflowStateException)
  + [Estrutura InternalServiceException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-InternalServiceException)
  + [Estrutura InvalidExecutionEngineException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-InvalidExecutionEngineException)
  + [Estrutura InvalidInputException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-InvalidInputException)
  + [Estrutura InvalidStateException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-InvalidStateException)
  + [Estrutura InvalidTaskStatusTransitionException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-InvalidTaskStatusTransitionException)
  + [Estrutura JobDefinitionErrorException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-JobDefinitionErrorException)
  + [Estrutura JobRunInTerminalStateException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-JobRunInTerminalStateException)
  + [Estrutura JobRunInvalidStateTransitionException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-JobRunInvalidStateTransitionException)
  + [Estrutura JobRunNotInTerminalStateException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-JobRunNotInTerminalStateException)
  + [Estrutura LateRunnerException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-LateRunnerException)
  + [Estrutura NoScheduleException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-NoScheduleException)
  + [Estrutura OperationTimeoutException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-OperationTimeoutException)
  + [Estrutura ResourceNotReadyException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-ResourceNotReadyException)
  + [Estrutura ResourceNumberLimitExceededException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-ResourceNumberLimitExceededException)
  + [Estrutura SchedulerNotRunningException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-SchedulerNotRunningException)
  + [Estrutura SchedulerRunningException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-SchedulerRunningException)
  + [Estrutura SchedulerTransitioningException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-SchedulerTransitioningException)
  + [Estrutura UnrecognizedRunnerException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-UnrecognizedRunnerException)
  + [Estrutura ValidationException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-ValidationException)
  + [Estrutura VersionMismatchException](aws-glue-api-exceptions.md#aws-glue-api-exceptions-VersionMismatchException)

# APIs de segurança no AWS Glue
<a name="aws-glue-api-jobs-security"></a>

A API de segurança descreve os tipos de dados de segurança e a API relacionada à segurança no AWS Glue.

## Tipos de dados
<a name="aws-glue-api-jobs-security-objects"></a>
+ [Estrutura DataCatalogEncryptionSettings](#aws-glue-api-jobs-security-DataCatalogEncryptionSettings)
+ [Estrutura EncryptionAtRest](#aws-glue-api-jobs-security-EncryptionAtRest)
+ [Estrutura ConnectionPasswordEncryption](#aws-glue-api-jobs-security-ConnectionPasswordEncryption)
+ [Estrutura EncryptionConfiguration](#aws-glue-api-jobs-security-EncryptionConfiguration)
+ [Estrutura S3Encryption](#aws-glue-api-jobs-security-S3Encryption)
+ [Estrutura CloudWatchEncryption](#aws-glue-api-jobs-security-CloudWatchEncryption)
+ [Estrutura JobBookmarksEncryption](#aws-glue-api-jobs-security-JobBookmarksEncryption)
+ [Estrutura SecurityConfiguration](#aws-glue-api-jobs-security-SecurityConfiguration)
+ [Estrutura GluePolicy](#aws-glue-api-jobs-security-GluePolicy)
+ [Estrutura DataQualityEncryption](#aws-glue-api-jobs-security-DataQualityEncryption)

## Estrutura DataCatalogEncryptionSettings
<a name="aws-glue-api-jobs-security-DataCatalogEncryptionSettings"></a>

Contém informações de configuração para manter a segurança do Catálogo de dados.

**Campos**
+ `EncryptionAtRest` – Um objeto [EncryptionAtRest](#aws-glue-api-jobs-security-EncryptionAtRest).

  Especifica a configuração de criptografia em repouso para o Catálogo de dados.
+ `ConnectionPasswordEncryption` – Um objeto [ConnectionPasswordEncryption](#aws-glue-api-jobs-security-ConnectionPasswordEncryption).

  Quando a proteção por senha de conexão é habilitada, o Catálogo de dados usa uma chave fornecida pelo cliente para criptografar a senha como parte do `CreateConnection` ou `UpdateConnection` armazená-la no `ENCRYPTED_PASSWORD` campo nas propriedades da conexão. Você pode habilitar a criptografia de catálogo ou apenas a criptografia de senha.

## Estrutura EncryptionAtRest
<a name="aws-glue-api-jobs-security-EncryptionAtRest"></a>

Especifica a configuração de criptografia em repouso para o Catálogo de dados.

**Campos**
+ `CatalogEncryptionMode` – *Obrigatório:* string UTF-8 (valores válidos: `DISABLED` \$1 `SSE-KMS="SSEKMS"` \$1 `SSE-KMS-WITH-SERVICE-ROLE="SSEKMSWITHSERVICEROLE"`).

  O modo de criptografia em repouso para a configuração de dados do Catálogo de dados.
+ `SseAwsKmsKeyId` – 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 chave do AWS KMS a ser usada para a criptografia em repouso.
+ `CatalogEncryptionServiceRole` – String UTF-8 correspondente a [Custom string pattern #53](aws-glue-api-common.md#regex_53).

  O perfil assumido pelo AWS Glue para criptografar e descriptografar os objetos do Catálogo de Dados em nome do chamador.

## Estrutura ConnectionPasswordEncryption
<a name="aws-glue-api-jobs-security-ConnectionPasswordEncryption"></a>

A estrutura de dados usada pelo Catálogo de dados para criptografar a senha como parte do `CreateConnection` ou `UpdateConnection` e armazená-la no `ENCRYPTED_PASSWORD` campo nas propriedades da conexão. Você pode habilitar a criptografia de catálogo ou apenas a criptografia de senha.

Quando uma solicitação `CreationConnection` chega contendo uma senha, o Data Catalog primeiro criptografa a senha usando a sua chave do AWS KMS. Em seguida, criptografa todo o objeto de conexão novamente se a criptografia do catálogo também estiver habilitada.

Essa criptografia requer que as permissões de chave do AWS KMS sejam definidas para habilitar ou restringir o acesso à chave da senha de acordo com os seus requisitos de segurança. Por exemplo, você pode querer que apenas administradores tenham permissão para descriptografar a chave da senha.

**Campos**
+ `ReturnConnectionPasswordEncrypted`: *obrigatório:* booleano.

  Quando o `ReturnConnectionPasswordEncrypted` sinalizador estiver definido como "verdadeiro", as senhas permanecem criptografadas nas respostas de `GetConnection` e `GetConnections`. Esta criptografia entra em vigor independentemente da criptografia de catálogo. 
+ `AwsKmsKeyId` – 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 chave do AWS KMS usada para criptografar a senha de conexão. 

  Se a proteção por senha da conexão estiver habilitada, o autor da chamada de `CreateConnection` e `UpdateConnection` precisará, pelo menos, da permissão `kms:Encrypt` na chave do AWS KMS especificada para criptografar as senhas antes de armazená-las no Data Catalog. 

  Você pode definir a permissão de descriptografia para habilitar ou restringir o acesso à chave de senha, de acordo com os seus requisitos de segurança.

## Estrutura EncryptionConfiguration
<a name="aws-glue-api-jobs-security-EncryptionConfiguration"></a>

Especifica uma configuração de criptografia.

**Campos**
+ `S3Encryption`: um array de objetos [S3Encryption](#aws-glue-api-jobs-security-S3Encryption).

  A configuração da criptografia para os dados do Amazon Simple Storage Service (Amazon S3).
+ `CloudWatchEncryption` – Um objeto [CloudWatchEncryption](#aws-glue-api-jobs-security-CloudWatchEncryption).

  A configuração da criptografia para o Amazon CloudWatch.
+ `JobBookmarksEncryption` – Um objeto [JobBookmarksEncryption](#aws-glue-api-jobs-security-JobBookmarksEncryption).

  A configuração da criptografia para marcadores de trabalho.
+ `DataQualityEncryption` – Um objeto [DataQualityEncryption](#aws-glue-api-jobs-security-DataQualityEncryption).

  A configuração de criptografia para os ativos do AWS Glue Data Quality.

## Estrutura S3Encryption
<a name="aws-glue-api-jobs-security-S3Encryption"></a>

Especifica como os dados do Amazon Simple Storage Service (Amazon S3) devem ser criptografados.

**Campos**
+ `S3EncryptionMode` – string UTF-8 (valores válidos: `DISABLED` \$1 `SSE-KMS="SSEKMS"` \$1 `SSE-S3="SSES3"`).

  O modo de criptografia a ser usado para dados do Amazon S3.
+ `KmsKeyArn` – String UTF-8 correspondente a [Custom string pattern #42](aws-glue-api-common.md#regex_42).

  O nome de recurso da Amazon (ARN) da chave do KMS a ser usada para criptografar os dados.

## Estrutura CloudWatchEncryption
<a name="aws-glue-api-jobs-security-CloudWatchEncryption"></a>

Especifica como os dados do Amazon CloudWatch devem ser criptografados.

**Campos**
+ `CloudWatchEncryptionMode` – string UTF-8 (valores válidos: `DISABLED` \$1 `SSE-KMS="SSEKMS"`).

  O modo de criptografia a ser usado para dados do CloudWatch.
+ `KmsKeyArn` – String UTF-8 correspondente a [Custom string pattern #42](aws-glue-api-common.md#regex_42).

  O nome de recurso da Amazon (ARN) da chave do KMS a ser usada para criptografar os dados.

## Estrutura JobBookmarksEncryption
<a name="aws-glue-api-jobs-security-JobBookmarksEncryption"></a>

Especifica como os dados de marcadores de trabalho devem ser criptografados.

**Campos**
+ `JobBookmarksEncryptionMode` – string UTF-8 (valores válidos: `DISABLED` \$1 `CSE-KMS="CSEKMS"`).

  O modo de criptografia a ser usado para dados de marcadores de trabalho.
+ `KmsKeyArn` – String UTF-8 correspondente a [Custom string pattern #42](aws-glue-api-common.md#regex_42).

  O nome de recurso da Amazon (ARN) da chave do KMS a ser usada para criptografar os dados.

## Estrutura SecurityConfiguration
<a name="aws-glue-api-jobs-security-SecurityConfiguration"></a>

Especifica uma configuração de segurança.

**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 configuração de segurança.
+ `CreatedTimeStamp` – Timestamp.

  O momento em que esta configuração de segurança foi criada.
+ `EncryptionConfiguration` – Um objeto [EncryptionConfiguration](#aws-glue-api-jobs-security-EncryptionConfiguration).

  A configuração de criptografia associada a essa configuração de segurança.

## Estrutura GluePolicy
<a name="aws-glue-api-jobs-security-GluePolicy"></a>

Uma estrutura para retornar uma política de recursos.

**Campos**
+ `PolicyInJson` – String UTF-8, com pelo menos 2 bytes de comprimento.

  Contém o documento da política solicitada no formato JSON.
+ `PolicyHash` – 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).

  Contém o valor de hash associado a essa política.
+ `CreateTime` – Timestamp.

  A data e hora em que a política foi criada.
+ `UpdateTime` – Timestamp.

  A data e hora em que a política foi atualizada pela última vez.

## Estrutura DataQualityEncryption
<a name="aws-glue-api-jobs-security-DataQualityEncryption"></a>

Especifica como os ativos do Data Quality em sua conta devem ser criptografados.

**Campos**
+ `DataQualityEncryptionMode` – string UTF-8 (valores válidos: `DISABLED` \$1 `SSE-KMS="SSEKMS"`).

  O modo de criptografia a ser usado para a criptografia dos ativos do Data Quality. Esses ativos incluem conjuntos de regras de qualidade de dados, resultados, estatísticas, modelos de detecção de anomalias e observações.

  Os valores válidos são `SSEKMS`, para a criptografia com uma chave do KMS gerenciada pelo cliente, ou `DISABLED`.
+ `KmsKeyArn` – String UTF-8 correspondente a [Custom string pattern #42](aws-glue-api-common.md#regex_42).

  O nome de recurso da Amazon (ARN) da chave do KMS a ser usada para criptografar os dados.

## Operações
<a name="aws-glue-api-jobs-security-actions"></a>
+ [Ação GetDataCatalogEncryptionSettings (Python: get\$1data\$1catalog\$1encryption\$1settings)](#aws-glue-api-jobs-security-GetDataCatalogEncryptionSettings)
+ [Ação PutDataCatalogEncryptionSettings (Python: put\$1data\$1catalog\$1encryption\$1settings)](#aws-glue-api-jobs-security-PutDataCatalogEncryptionSettings)
+ [Ação PutResourcePolicy (Python: put\$1resource\$1policy)](#aws-glue-api-jobs-security-PutResourcePolicy)
+ [Ação GetResourcePolicy (Python: get\$1resource\$1policy)](#aws-glue-api-jobs-security-GetResourcePolicy)
+ [Ação DeleteResourcePolicy (Python: delete\$1resource\$1policy)](#aws-glue-api-jobs-security-DeleteResourcePolicy)
+ [Ação CreateSecurityConfiguration (Python: create\$1security\$1configuration)](#aws-glue-api-jobs-security-CreateSecurityConfiguration)
+ [Ação DeleteSecurityConfiguration (Python: delete\$1security\$1configuration)](#aws-glue-api-jobs-security-DeleteSecurityConfiguration)
+ [Ação GetSecurityConfiguration (Python: get\$1security\$1configuration)](#aws-glue-api-jobs-security-GetSecurityConfiguration)
+ [Ação GetSecurityConfigurations (Python: get\$1security\$1configurations)](#aws-glue-api-jobs-security-GetSecurityConfigurations)
+ [Ação GetResourcePolicies (Python: get\$1resource\$1policies)](#aws-glue-api-jobs-security-GetResourcePolicies)

## Ação GetDataCatalogEncryptionSettings (Python: get\$1data\$1catalog\$1encryption\$1settings)
<a name="aws-glue-api-jobs-security-GetDataCatalogEncryptionSettings"></a>

Recupera a configuração de segurança de um determinado catálogo.

**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 para o qual recuperar a configuração de segurança. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.

**Resposta**
+ `DataCatalogEncryptionSettings` – Um objeto [DataCatalogEncryptionSettings](#aws-glue-api-jobs-security-DataCatalogEncryptionSettings).

  A configuração de segurança solicitada.

**Erros**
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## Ação PutDataCatalogEncryptionSettings (Python: put\$1data\$1catalog\$1encryption\$1settings)
<a name="aws-glue-api-jobs-security-PutDataCatalogEncryptionSettings"></a>

Define a configuração de segurança de um determinado catálogo. Depois que a configuração tiver sido definida, a criptografia especificada será aplicada a cada gravação de catálogo a partir de entã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 para o qual definir a configuração de segurança. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.
+ `DataCatalogEncryptionSettings` – *Obrigatório:* um objeto [DataCatalogEncryptionSettings](#aws-glue-api-jobs-security-DataCatalogEncryptionSettings).

  A configuração de segurança a ser definida.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## Ação PutResourcePolicy (Python: put\$1resource\$1policy)
<a name="aws-glue-api-jobs-security-PutResourcePolicy"></a>

Define a política de recurso de catálogo de dados para controle de acesso.

**Solicitação**
+ `PolicyInJson` – *Obrigatório:* String UTF-8, com pelo menos 2 bytes de comprimento.

  Contém o documento de política a ser definido, no formato JSON.
+ `ResourceArn` – 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).

  Não use. Apenas para uso interno.
+ `PolicyHashCondition` – 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 hash retornado quando a política anterior foi definida usando `PutResourcePolicy`. O objetivo é impedir modificações simultâneas de uma política. Não use esse parâmetro se nenhuma política anterior tiver sido definida.
+ `PolicyExistsCondition` – string UTF-8 (valores válidos: `MUST_EXIST` \$1 `NOT_EXIST` \$1 `NONE`).

  Um valor de `MUST_EXIST` é usado para atualizar uma política. Um valor de `NOT_EXIST` é usado para criar uma nova política. Se um valor de `NONE` ou um valor nulo for usado, a chamada não dependerá da existência de uma política.
+ `EnableHybrid` – string UTF-8 (valores válidos: `TRUE` \$1 `FALSE`).

  Se for `'TRUE'`, indica que você está usando os dois métodos para conceder acesso entre contas aos recursos do Data Catalog:
  + Atualizando diretamente a política de recursos com `PutResourePolicy`
  + Usando a opção **Grant permissions** (Conceder permissões) no Console de gerenciamento da AWS.

  Deve ser definida como `'TRUE'` se você já tiver usado o Console de Gerenciamento para conceder acesso entre contas, caso contrário, a chamada falhará. O padrão é “FALSE” (FALSO).

**Resposta**
+ `PolicyHash` – 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 hash da política que acabou de ser definida. Isso deve ser incluído em uma chamada subsequente que substitui ou atualiza essa política.

**Erros**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ConditionCheckFailureException`

## Ação GetResourcePolicy (Python: get\$1resource\$1policy)
<a name="aws-glue-api-jobs-security-GetResourcePolicy"></a>

Recupera uma política de recurso especificada.

**Solicitação**
+ `ResourceArn` – 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 do AWS Glue para o qual se deseja recuperar a política de recurso. Se não for fornecido, a política de recurso do Data Catalog será retornada. Use `GetResourcePolicies` para exibir todas as políticas de recursos existentes. Para obter mais informações, consulte [Especificar ARNs de recurso do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html). 

**Resposta**
+ `PolicyInJson` – String UTF-8, com pelo menos 2 bytes de comprimento.

  Contém o documento da política solicitada no formato JSON.
+ `PolicyHash` – 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).

  Contém o valor de hash associado a essa política.
+ `CreateTime` – Timestamp.

  A data e hora em que a política foi criada.
+ `UpdateTime` – Timestamp.

  A data e hora em que a política foi atualizada pela última vez.

**Erros**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## Ação DeleteResourcePolicy (Python: delete\$1resource\$1policy)
<a name="aws-glue-api-jobs-security-DeleteResourcePolicy"></a>

Exclui uma política especificada.

**Solicitação**
+ `PolicyHashCondition` – 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 hash retornado quando essa política foi definida.
+ `ResourceArn` – 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 do AWS Glue para a política de recursos a ser excluída.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ConditionCheckFailureException`

## Ação CreateSecurityConfiguration (Python: create\$1security\$1configuration)
<a name="aws-glue-api-jobs-security-CreateSecurityConfiguration"></a>

Cria uma nova configuração de segurança; Uma configuração de segurança é um conjunto de propriedades de segurança que pode ser usado pelo AWS Glue. Você pode usar uma configuração de segurança para criptografar dados em repouso. Para obter informações sobre como usar as configurações de segurança no AWS Glue, consulte [Criptografar dados gravados por crawlers, trabalhos e endpoints de desenvolvimento](https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html).

**Solicitaçã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 nova configuração de segurança.
+ `EncryptionConfiguration` – *Obrigatório:* um objeto [EncryptionConfiguration](#aws-glue-api-jobs-security-EncryptionConfiguration).

  A configuração de criptografia da nova configuração de segurança.

**Resposta**
+ `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 atribuído à nova configuração de segurança.
+ `CreatedTimestamp` – Timestamp.

  O momento em que a nova configuração de segurança foi criada.

**Erros**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`

## Ação DeleteSecurityConfiguration (Python: delete\$1security\$1configuration)
<a name="aws-glue-api-jobs-security-DeleteSecurityConfiguration"></a>

Exclui uma configuração de segurança especificada.

**Solicitaçã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 configuração de segurança a ser excluída.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetSecurityConfiguration (Python: get\$1security\$1configuration)
<a name="aws-glue-api-jobs-security-GetSecurityConfiguration"></a>

Recupera uma configuração de segurança especificada.

**Solicitaçã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 configuração de segurança a ser recuperada.

**Resposta**
+ `SecurityConfiguration` – Um objeto [SecurityConfiguration](#aws-glue-api-jobs-security-SecurityConfiguration).

  A configuração de segurança solicitada.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetSecurityConfigurations (Python: get\$1security\$1configurations)
<a name="aws-glue-api-jobs-security-GetSecurityConfigurations"></a>

Recupera uma lista de todas as configurações de segurança.

**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.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `SecurityConfigurations`: um array de objetos [SecurityConfiguration](#aws-glue-api-jobs-security-SecurityConfiguration).

  Uma lista de configurações de segurança.
+ `NextToken` – String UTF-8.

  Um token de continuação, se houver mais configurações de segurança para retornar.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetResourcePolicies (Python: get\$1resource\$1policies)
<a name="aws-glue-api-jobs-security-GetResourcePolicies"></a>

Recupera as políticas de recursos definidas em recursos individuais pelo AWS Resource Access Manager durante concessões de permissões entre contas. Recupera também a política de recurso do Data Catalog.

Se você tiver ativado a criptografia de metadados nas definições do Data Catalog e não tiver permissão na chave do AWS KMS, a operação não poderá retornar a política de recurso do Data Catalog.

**Solicitação**
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma solicitação de continuação.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O tamanho máximo de uma lista a ser retornada.

**Resposta**
+ `GetResourcePoliciesResponseList`: um array de objetos [GluePolicy](#aws-glue-api-jobs-security-GluePolicy).

  Uma lista das políticas de recursos individuais e a política de recursos de nível de conta.
+ `NextToken` – String UTF-8.

  Um token de continuação, se a lista retornada não contiver a política de recurso mais recente disponível.

**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

# API Catalogar objetos
<a name="aws-glue-api-catalog"></a>

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 name="aws-glue-api-catalog-catalogs"></a>

A API de catálogos descreve as APIs para criar, excluir, localizar, atualizar e listar catálogos.

## Tipos de dados
<a name="aws-glue-api-catalog-catalogs-objects"></a>
+ [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
<a name="aws-glue-api-catalog-catalogs-Catalog"></a>

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
<a name="aws-glue-api-catalog-catalogs-CatalogInput"></a>

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
<a name="aws-glue-api-catalog-catalogs-TargetRedshiftCatalog"></a>

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
<a name="aws-glue-api-catalog-catalogs-CatalogProperties"></a>

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
<a name="aws-glue-api-catalog-catalogs-CatalogPropertiesOutput"></a>

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
<a name="aws-glue-api-catalog-catalogs-DataLakeAccessProperties"></a>

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
<a name="aws-glue-api-catalog-catalogs-IcebergOptimizationProperties"></a>

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
<a name="aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput"></a>

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
<a name="aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput"></a>

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
<a name="aws-glue-api-catalog-catalogs-FederatedCatalog"></a>

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 name="aws-glue-api-catalog-catalogs-actions"></a>
+ [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)
<a name="aws-glue-api-catalog-catalogs-CreateCatalog"></a>

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)
<a name="aws-glue-api-catalog-catalogs-UpdateCatalog"></a>

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)
<a name="aws-glue-api-catalog-catalogs-DeleteCatalog"></a>

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)
<a name="aws-glue-api-catalog-catalogs-GetCatalog"></a>

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)
<a name="aws-glue-api-catalog-catalogs-GetCatalogs"></a>

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
<a name="aws-glue-api-catalog-databases"></a>

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
<a name="aws-glue-api-catalog-databases-objects"></a>
+ [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
<a name="aws-glue-api-catalog-databases-Database"></a>

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 name="aws-glue-api-catalog-databases-DatabaseInput"></a>

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
<a name="aws-glue-api-catalog-databases-PrincipalPermissions"></a>

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 name="aws-glue-api-catalog-databases-DataLakePrincipal"></a>

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
<a name="aws-glue-api-catalog-databases-DatabaseIdentifier"></a>

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
<a name="aws-glue-api-catalog-databases-FederatedDatabase"></a>

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 name="aws-glue-api-catalog-databases-actions"></a>
+ [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)
<a name="aws-glue-api-catalog-databases-CreateDatabase"></a>

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)
<a name="aws-glue-api-catalog-databases-UpdateDatabase"></a>

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)
<a name="aws-glue-api-catalog-databases-DeleteDatabase"></a>

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)
<a name="aws-glue-api-catalog-databases-GetDatabase"></a>

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)
<a name="aws-glue-api-catalog-databases-GetDatabases"></a>

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 name="aws-glue-api-catalog-tables"></a>

A Tabela da API descreve os tipos de dados e operações associadas a tabelas.

## Tipos de dados
<a name="aws-glue-api-catalog-tables-objects"></a>
+ [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
<a name="aws-glue-api-catalog-tables-Table"></a>

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
<a name="aws-glue-api-catalog-tables-TableInput"></a>

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
<a name="aws-glue-api-catalog-tables-FederatedTable"></a>

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
<a name="aws-glue-api-catalog-tables-Column"></a>

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
<a name="aws-glue-api-catalog-tables-StorageDescriptor"></a>

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
<a name="aws-glue-api-catalog-tables-SchemaReference"></a>

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
<a name="aws-glue-api-catalog-tables-SerDeInfo"></a>

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
<a name="aws-glue-api-catalog-tables-Order"></a>

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
<a name="aws-glue-api-catalog-tables-SkewedInfo"></a>

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
<a name="aws-glue-api-catalog-tables-TableVersion"></a>

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
<a name="aws-glue-api-catalog-tables-TableError"></a>

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
<a name="aws-glue-api-catalog-tables-TableVersionError"></a>

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
<a name="aws-glue-api-catalog-tables-SortCriterion"></a>

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
<a name="aws-glue-api-catalog-tables-TableIdentifier"></a>

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
<a name="aws-glue-api-catalog-tables-KeySchemaElement"></a>

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
<a name="aws-glue-api-catalog-tables-PartitionIndex"></a>

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
<a name="aws-glue-api-catalog-tables-PartitionIndexDescriptor"></a>

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
<a name="aws-glue-api-catalog-tables-BackfillError"></a>

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
<a name="aws-glue-api-catalog-tables-IcebergInput"></a>

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
<a name="aws-glue-api-catalog-tables-OpenTableFormatInput"></a>

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
<a name="aws-glue-api-catalog-tables-ViewDefinition"></a>

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
<a name="aws-glue-api-catalog-tables-ViewDefinitionInput"></a>

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
<a name="aws-glue-api-catalog-tables-ViewRepresentation"></a>

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
<a name="aws-glue-api-catalog-tables-ViewRepresentationInput"></a>

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
<a name="aws-glue-api-catalog-tables-UpdateOpenTableFormatInput"></a>

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
<a name="aws-glue-api-catalog-tables-UpdateIcebergInput"></a>

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
<a name="aws-glue-api-catalog-tables-CreateIcebergTableInput"></a>

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
<a name="aws-glue-api-catalog-tables-UpdateIcebergTableInput"></a>

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
<a name="aws-glue-api-catalog-tables-IcebergSortOrder"></a>

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
<a name="aws-glue-api-catalog-tables-IcebergSortField"></a>

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
<a name="aws-glue-api-catalog-tables-IcebergPartitionSpec"></a>

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
<a name="aws-glue-api-catalog-tables-IcebergPartitionField"></a>

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
<a name="aws-glue-api-catalog-tables-IcebergSchema"></a>

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
<a name="aws-glue-api-catalog-tables-IcebergStructField"></a>

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
<a name="aws-glue-api-catalog-tables-IcebergTableUpdate"></a>

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
<a name="aws-glue-api-catalog-tables-AuditContext"></a>

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 name="aws-glue-api-catalog-tables-actions"></a>
+ [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)
<a name="aws-glue-api-catalog-tables-CreateTable"></a>

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)
<a name="aws-glue-api-catalog-tables-UpdateTable"></a>

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)
<a name="aws-glue-api-catalog-tables-DeleteTable"></a>

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)
<a name="aws-glue-api-catalog-tables-BatchDeleteTable"></a>

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)
<a name="aws-glue-api-catalog-tables-GetTable"></a>

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)
<a name="aws-glue-api-catalog-tables-GetTables"></a>

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)
<a name="aws-glue-api-catalog-tables-GetTableVersion"></a>

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)
<a name="aws-glue-api-catalog-tables-GetTableVersions"></a>

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)
<a name="aws-glue-api-catalog-tables-DeleteTableVersion"></a>

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)
<a name="aws-glue-api-catalog-tables-BatchDeleteTableVersion"></a>

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)
<a name="aws-glue-api-catalog-tables-SearchTables"></a>

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)
<a name="aws-glue-api-catalog-tables-GetPartitionIndexes"></a>

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)
<a name="aws-glue-api-catalog-tables-CreatePartitionIndex"></a>

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)
<a name="aws-glue-api-catalog-tables-DeletePartitionIndex"></a>

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)
<a name="aws-glue-api-catalog-tables-GetColumnStatisticsForTable"></a>

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)
<a name="aws-glue-api-catalog-tables-UpdateColumnStatisticsForTable"></a>

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)
<a name="aws-glue-api-catalog-tables-DeleteColumnStatisticsForTable"></a>

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 name="aws-glue-api-catalog-partitions"></a>

A Partição da API descreve os tipos de dados e operações usadas para trabalhar com partições.

## Tipos de dados
<a name="aws-glue-api-catalog-partitions-objects"></a>
+ [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
<a name="aws-glue-api-catalog-partitions-Partition"></a>

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 name="aws-glue-api-catalog-partitions-PartitionInput"></a>

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
<a name="aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor"></a>

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
<a name="aws-glue-api-catalog-partitions-PartitionListComposingSpec"></a>

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
<a name="aws-glue-api-catalog-partitions-PartitionSpecProxy"></a>

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
<a name="aws-glue-api-catalog-partitions-PartitionValueList"></a>

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
<a name="aws-glue-api-catalog-partitions-Segment"></a>

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
<a name="aws-glue-api-catalog-partitions-PartitionError"></a>

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
<a name="aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry"></a>

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
<a name="aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry"></a>

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
<a name="aws-glue-api-catalog-partitions-StorageDescriptor"></a>

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
<a name="aws-glue-api-catalog-partitions-SchemaReference"></a>

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
<a name="aws-glue-api-catalog-partitions-SerDeInfo"></a>

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
<a name="aws-glue-api-catalog-partitions-SkewedInfo"></a>

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 name="aws-glue-api-catalog-partitions-actions"></a>
+ [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)
<a name="aws-glue-api-catalog-partitions-CreatePartition"></a>

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)
<a name="aws-glue-api-catalog-partitions-BatchCreatePartition"></a>

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)
<a name="aws-glue-api-catalog-partitions-UpdatePartition"></a>

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)
<a name="aws-glue-api-catalog-partitions-DeletePartition"></a>

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)
<a name="aws-glue-api-catalog-partitions-BatchDeletePartition"></a>

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)
<a name="aws-glue-api-catalog-partitions-GetPartition"></a>

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)
<a name="aws-glue-api-catalog-partitions-GetPartitions"></a>

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)
<a name="aws-glue-api-catalog-partitions-BatchGetPartition"></a>

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)
<a name="aws-glue-api-catalog-partitions-BatchUpdatePartition"></a>

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)
<a name="aws-glue-api-catalog-partitions-GetColumnStatisticsForPartition"></a>

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)
<a name="aws-glue-api-catalog-partitions-UpdateColumnStatisticsForPartition"></a>

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)
<a name="aws-glue-api-catalog-partitions-DeleteColumnStatisticsForPartition"></a>

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 name="aws-glue-api-catalog-connections"></a>

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 name="aws-glue-api-catalog-connections-connections"></a>

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
<a name="aws-glue-api-catalog-connections-connections-objects"></a>
+ [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
<a name="aws-glue-api-catalog-connections-connections-Connection"></a>

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
<a name="aws-glue-api-catalog-connections-connections-ConnectionInput"></a>

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
<a name="aws-glue-api-catalog-connections-connections-TestConnectionInput"></a>

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
<a name="aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements"></a>

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
<a name="aws-glue-api-catalog-connections-connections-GetConnectionsFilter"></a>

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
<a name="aws-glue-api-catalog-connections-connections-AuthenticationConfiguration"></a>

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
<a name="aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput"></a>

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
<a name="aws-glue-api-catalog-connections-connections-OAuth2Properties"></a>

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
<a name="aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput"></a>

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 name="aws-glue-api-catalog-connections-connections-OAuth2ClientApplication"></a>

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
<a name="aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties"></a>

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
<a name="aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials"></a>

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
<a name="aws-glue-api-catalog-connections-connections-OAuth2Credentials"></a>

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 name="aws-glue-api-catalog-connections-connections-actions"></a>
+ [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)
<a name="aws-glue-api-catalog-connections-connections-CreateConnection"></a>

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)
<a name="aws-glue-api-catalog-connections-connections-DeleteConnection"></a>

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)
<a name="aws-glue-api-catalog-connections-connections-GetConnection"></a>

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)
<a name="aws-glue-api-catalog-connections-connections-GetConnections"></a>

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)
<a name="aws-glue-api-catalog-connections-connections-UpdateConnection"></a>

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)
<a name="aws-glue-api-catalog-connections-connections-TestConnection"></a>

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)
<a name="aws-glue-api-catalog-connections-connections-BatchDeleteConnection"></a>

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 name="aws-glue-api-catalog-connections-connections-type"></a>

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 name="aws-glue-api-catalog-connections-connections-type-connection-management"></a>
+ [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 name="aws-glue-api-catalog-connections-connections-type-DescribeConnectionType"></a>

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 name="aws-glue-api-catalog-connections-connections-type-ListConnectionTypes"></a>

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
<a name="aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief"></a>

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
<a name="aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant"></a>

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
<a name="aws-glue-api-catalog-connections-connections-type-connection-types"></a>
+ [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
<a name="aws-glue-api-catalog-connections-connections-type-Validation"></a>

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 name="aws-glue-api-catalog-connections-connections-type-AuthConfiguration"></a>

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
<a name="aws-glue-api-catalog-connections-connections-type-Capabilities"></a>

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
<a name="aws-glue-api-catalog-connections-connections-type-Property"></a>

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
<a name="aws-glue-api-catalog-connections-connections-type-AllowedValue"></a>

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
<a name="aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration"></a>

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
<a name="aws-glue-api-catalog-connections-connections-metadata"></a>

As APIs de conexão a seguir descrevem as operações necessárias para descrever os metadados da conexão.

## Tipos de dados
<a name="aws-glue-api-catalog-connections-connections-metadata-objects"></a>
+ [Estrutura Entity](#aws-glue-api-catalog-connections-connections-metadata-Entity)
+ [Estrutura Field](#aws-glue-api-catalog-connections-connections-metadata-Field)

## Estrutura Entity
<a name="aws-glue-api-catalog-connections-connections-metadata-Entity"></a>

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
<a name="aws-glue-api-catalog-connections-connections-metadata-Field"></a>

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 name="aws-glue-api-catalog-connections-connections-metadata-actions"></a>
+ [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)
<a name="aws-glue-api-catalog-connections-connections-metadata-ListEntities"></a>

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)
<a name="aws-glue-api-catalog-connections-connections-metadata-DescribeEntity"></a>

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)
<a name="aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords"></a>

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 name="aws-glue-api-catalog-functions"></a>

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
<a name="aws-glue-api-catalog-functions-objects"></a>
+ [Estrutura UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction)
+ [Estrutura UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput)

## Estrutura UserDefinedFunction
<a name="aws-glue-api-catalog-functions-UserDefinedFunction"></a>

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
<a name="aws-glue-api-catalog-functions-UserDefinedFunctionInput"></a>

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 name="aws-glue-api-catalog-functions-actions"></a>
+ [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)
<a name="aws-glue-api-catalog-functions-CreateUserDefinedFunction"></a>

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)
<a name="aws-glue-api-catalog-functions-UpdateUserDefinedFunction"></a>

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)
<a name="aws-glue-api-catalog-functions-DeleteUserDefinedFunction"></a>

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)
<a name="aws-glue-api-catalog-functions-GetUserDefinedFunction"></a>

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)
<a name="aws-glue-api-catalog-functions-GetUserDefinedFunctions"></a>

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 name="aws-glue-api-catalog-migration"></a>

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
<a name="aws-glue-api-catalog-migration-objects"></a>
+ [Estrutura CatalogImportStatus](#aws-glue-api-catalog-migration-CatalogImportStatus)

## Estrutura CatalogImportStatus
<a name="aws-glue-api-catalog-migration-CatalogImportStatus"></a>

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 name="aws-glue-api-catalog-migration-actions"></a>
+ [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)
<a name="aws-glue-api-catalog-migration-ImportCatalogToGlue"></a>

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)
<a name="aws-glue-api-catalog-migration-GetCatalogImportStatus"></a>

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`

# API do otimizador de tabelas
<a name="aws-glue-api-table-optimizers"></a>

A API do otimizador de tabelas descreve a API do AWS Glue para habilitar a compactação a fim de melhorar a performance de leitura.

## Tipos de dados
<a name="aws-glue-api-table-optimizers-objects"></a>
+ [Estrutura do TableOptimizer](#aws-glue-api-table-optimizers-TableOptimizer)
+ [Estrutura do TableOptimizerConfiguration](#aws-glue-api-table-optimizers-TableOptimizerConfiguration)
+ [Estrutura de TableOptimizerVpcConfiguration](#aws-glue-api-table-optimizers-TableOptimizerVpcConfiguration)
+ [Estrutura CompactionConfiguration](#aws-glue-api-table-optimizers-CompactionConfiguration)
+ [Estrutura IcebergCompactionConfiguration](#aws-glue-api-table-optimizers-IcebergCompactionConfiguration)
+ [Estrutura TableOptimizerRun](#aws-glue-api-table-optimizers-TableOptimizerRun)
+ [Estrutura BatchGetTableOptimizerEntry](#aws-glue-api-table-optimizers-BatchGetTableOptimizerEntry)
+ [Estrutura BatchTableTableOptimizer](#aws-glue-api-table-optimizers-BatchTableOptimizer)
+ [Estrutura BatchGetTableOptimizerError](#aws-glue-api-table-optimizers-BatchGetTableOptimizerError)
+ [Estrutura RetentionConfiguration](#aws-glue-api-table-optimizers-RetentionConfiguration)
+ [Estrutura IcebergRetentionConfiguration](#aws-glue-api-table-optimizers-IcebergRetentionConfiguration)
+ [Estrutura OrphanFileDeletionConfiguration](#aws-glue-api-table-optimizers-OrphanFileDeletionConfiguration)
+ [Estrutura IcebergOrphanFileDeletionConfiguration](#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionConfiguration)
+ [Estrutura CompactionMetrics](#aws-glue-api-table-optimizers-CompactionMetrics)
+ [Estrutura RetentionMetrics](#aws-glue-api-table-optimizers-RetentionMetrics)
+ [Estrutura OrphanFileDeletionMetrics](#aws-glue-api-table-optimizers-OrphanFileDeletionMetrics)
+ [Estrutura IcebergCompactionMetrics](#aws-glue-api-table-optimizers-IcebergCompactionMetrics)
+ [Estrutura IcebergRetentionMetrics](#aws-glue-api-table-optimizers-IcebergRetentionMetrics)
+ [Estrutura IcebergOrphanFileDeletionMetrics](#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionMetrics)
+ [Estrutura RunMetrics](#aws-glue-api-table-optimizers-RunMetrics)

## Estrutura do TableOptimizer
<a name="aws-glue-api-table-optimizers-TableOptimizer"></a>

Contém detalhes sobre um otimizador associado a uma tabela.

**Campos**
+ `type` – String UTF-8 (valores válidos: `compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`).

  O tipo de otimizador de tabelas. Os valores válidos são:
  + `compaction`: para gerenciar a compactação com um otimizador de tabela.
  + `retention`: para gerenciar a retenção de snapshots com um otimizador de tabela.
  + `orphan_file_deletion`: para gerenciar a exclusão de arquivos órfãos com um otimizador de tabela.
+ `configuration` – Um objeto [TableOptimizerConfiguration](#aws-glue-api-table-optimizers-TableOptimizerConfiguration).

  Um objeto `TableOptimizerConfiguration` que foi especificado ao criar ou atualizar um otimizador de tabelas.
+ `lastRun` – Um objeto [TableOptimizerRun](#aws-glue-api-table-optimizers-TableOptimizerRun).

  Um objeto `TableOptimizerRun` que representa a última execução do otimizador de tabelas.
+ `configurationSource`: string UTF-8 (valores válidos: `catalog="CATALOG"` \$1 `table="TABLE"`).

   Especifica a fonte da configuração do otimizador. Indica como o otimizador de tabelas foi configurado e qual entidade ou serviço iniciou a configuração. 

## Estrutura do TableOptimizerConfiguration
<a name="aws-glue-api-table-optimizers-TableOptimizerConfiguration"></a>

Contém detalhes sobre a configuração de um otimizador de tabelas. Você passa essa configuração ao criar ou atualizar um otimizador de tabelas.

**Campos**
+ `roleArn` – 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).

  Uma função passada pelo chamador que concede ao serviço permissão para atualizar os recursos associados ao otimizador em nome do chamador.
+ `enabled` – Booleano.

  Se a otimização da tabela está habilitada.
+ `vpcConfiguration` – Um objeto [TableOptimizerVpcConfiguration](#aws-glue-api-table-optimizers-TableOptimizerVpcConfiguration).

  Um objeto `TableOptimizerVpcConfiguration` que representa a configuração da VPC de um otimizador de tabela.

  Essa configuração é necessária para a execução da otimização de tabelas que estão na VPC de um cliente.
+ `compactionConfiguration` – Um objeto [CompactionConfiguration](#aws-glue-api-table-optimizers-CompactionConfiguration).

  A configuração de um otimizador de compactação. Essa configuração define como os arquivos de dados em sua tabela serão compactados para melhorar o desempenho das consultas e reduzir os custos de armazenamento.
+ `retentionConfiguration` – Um objeto [RetentionConfiguration](#aws-glue-api-table-optimizers-RetentionConfiguration).

  A configuração de um otimizador de retenção de snapshots.
+ `orphanFileDeletionConfiguration` – Um objeto [OrphanFileDeletionConfiguration](#aws-glue-api-table-optimizers-OrphanFileDeletionConfiguration).

  A configuração de um otimizador de exclusão de arquivos órfãos.

## Estrutura de TableOptimizerVpcConfiguration
<a name="aws-glue-api-table-optimizers-TableOptimizerVpcConfiguration"></a>

Um objeto que descreve a configuração da VPC de um otimizador de tabela.

Essa configuração é necessária para a execução da otimização de tabelas que estão na VPC de um cliente.

**Campos**
+ `glueConnectionName`: string UTF-8 com pelo menos 1 byte de comprimento.

  O nome da conexão do AWS Glue usada para a VPC do otimizador de tabelas.

## Estrutura CompactionConfiguration
<a name="aws-glue-api-table-optimizers-CompactionConfiguration"></a>

A configuração de um otimizador de compactação. Essa configuração define como os arquivos de dados em sua tabela serão compactados para melhorar o desempenho das consultas e reduzir os custos de armazenamento.

**Campos**
+ `icebergConfiguration` – Um objeto [IcebergCompactionConfiguration](#aws-glue-api-table-optimizers-IcebergCompactionConfiguration).

  A configuração de um otimizador de compactação do Iceberg.

## Estrutura IcebergCompactionConfiguration
<a name="aws-glue-api-table-optimizers-IcebergCompactionConfiguration"></a>

A configuração de um otimizador de compactação do Iceberg. Essa configuração define parâmetros para otimizar o layout dos arquivos de dados nas tabelas do Iceberg.

**Campos**
+ `strategy` – String UTF-8 (valores válidos: `binpack="BINPACK"` \$1 `sort="SORT"` \$1 `z-order="ZORDER"`).

  A estratégia a ser usada para compactação. Os valores válidos são:
  +  `binpack`: combina arquivos pequenos em arquivos maiores, geralmente direcionado a tamanhos acima de 100 MB, enquanto aplica todas as exclusões pendentes. Essa é a estratégia de compactação recomendada para a maioria dos casos de uso. 
  +  `sort`: organiza os dados com base em colunas especificadas que são classificadas hierarquicamente durante a compactação, melhorando o desempenho da consulta para operações filtradas. Essa estratégia é recomendada quando suas consultas filtram frequentemente colunas específicas. Para usar essa estratégia, primeiro você precisará definir uma ordem de classificação nas propriedades da tabela do Iceberg usando a propriedade de tabela `sort_order`.
  +  `z-order`: otimiza a organização de dados combinando vários atributos em um único valor escalar que pode ser usado para classificação, permitindo consultas eficientes em várias dimensões. Essa estratégia é recomendada quando você precisa consultar dados em várias dimensões simultaneamente. Para usar essa estratégia, primeiro você precisará definir uma ordem de classificação nas propriedades da tabela do Iceberg usando a propriedade de tabela `sort_order`. 

  Se uma entrada não for fornecida, o valor padrão “binpack” será usado.
+ `minInputFiles` – Número (íntegro).

  O número mínimo de arquivos de dados que devem estar presentes em uma partição antes que a compactação realmente compacte os arquivos. Esse parâmetro ajuda a controlar quando a compactação é acionada, evitando operações desnecessárias em partições com poucos arquivos. Se uma entrada de não for fornecida, o valor padrão 100 será usado.
+ `deleteFileThreshold` – Número (íntegro).

  O número mínimo de exclusões que devem estar presentes em um arquivo de dados para que ele seja elegível para compactação. Esse parâmetro ajuda a otimizar a compactação, concentrando-se em arquivos que contêm um número significativo de operações de exclusão, podendo então melhorar o desempenho da consulta ao remover registros excluídos. Se uma entrada de não for fornecida, o valor padrão de 1 será usado.

## Estrutura TableOptimizerRun
<a name="aws-glue-api-table-optimizers-TableOptimizerRun"></a>

Contém detalhes para a execução de um otimizador de tabelas.

**Campos**
+ `eventType` – String UTF-8 (valores válidos: `starting="STARTING"` \$1 `completed="COMPLETED"` \$1 `failed="FAILED"` \$1 `in_progress="IN_PROGRESS"`).

  Um tipo de evento que representa o status da execução do otimizador de tabelas.
+ `startTimestamp` – Timestamp.

  Representa a marca de data e hora do epoch em que o trabalho de compactação foi iniciado no Lake Formation.
+ `endTimestamp` – Timestamp.

  Representa a marca de data e hora do epoch em que o trabalho de compactação terminou.
+ `metrics` – Um objeto [RunMetrics](#aws-glue-api-table-optimizers-RunMetrics).

  Um objeto `RunMetrics` que contém métricas para a execução do otimizador.

  Esse membro é obsoleto. Veja os membros individuais da métrica para compactação, retenção e exclusão de arquivos órfãos.
+ `error` – String UTF-8.

  Um erro que ocorreu durante a execução do otimizador.
+ `compactionMetrics` – Um objeto [CompactionMetrics](#aws-glue-api-table-optimizers-CompactionMetrics).

  Um objeto `CompactionMetrics` que contém métricas para a execução do otimizador.
+ `compactionStrategy` – String UTF-8 (valores válidos: `binpack="BINPACK"` \$1 `sort="SORT"` \$1 `z-order="ZORDER"`).

  A estratégia usada para a execução da compactação. Indica qual algoritmo foi aplicado para determinar como os arquivos foram selecionados e combinados durante o processo de compactação. Os valores válidos são:
  +  `binpack`: combina arquivos pequenos em arquivos maiores, geralmente direcionado a tamanhos acima de 100 MB, enquanto aplica todas as exclusões pendentes. Essa é a estratégia de compactação recomendada para a maioria dos casos de uso. 
  +  `sort`: organiza os dados com base em colunas especificadas que são classificadas hierarquicamente durante a compactação, melhorando o desempenho da consulta para operações filtradas. Essa estratégia é recomendada quando suas consultas filtram frequentemente colunas específicas. Para usar essa estratégia, primeiro você precisará definir uma ordem de classificação nas propriedades da tabela do Iceberg usando a propriedade de tabela `sort_order`.
  +  `z-order`: otimiza a organização de dados combinando vários atributos em um único valor escalar que pode ser usado para classificação, permitindo consultas eficientes em várias dimensões. Essa estratégia é recomendada quando você precisa consultar dados em várias dimensões simultaneamente. Para usar essa estratégia, primeiro você precisará definir uma ordem de classificação nas propriedades da tabela do Iceberg usando a propriedade de tabela `sort_order`. 
+ `retentionMetrics` – Um objeto [RetentionMetrics](#aws-glue-api-table-optimizers-RetentionMetrics).

  Um objeto `RetentionMetrics` que contém métricas para a execução do otimizador.
+ `orphanFileDeletionMetrics` – Um objeto [OrphanFileDeletionMetrics](#aws-glue-api-table-optimizers-OrphanFileDeletionMetrics).

  Um objeto `OrphanFileDeletionMetrics` que contém métricas para a execução do otimizador.

## Estrutura BatchGetTableOptimizerEntry
<a name="aws-glue-api-table-optimizers-BatchGetTableOptimizerEntry"></a>

Representa um otimizador de tabelas a ser recuperado na operação `BatchGetTableOptimizer`.

**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 de catálogo da tabela.
+ `databaseName`: string UTF-8 com pelo menos 1 byte de comprimento.

  O nome do banco de dados no catálogo em que a tabela reside.
+ `tableName`: string UTF-8 com pelo menos 1 byte de comprimento.

  O nome da tabela.
+ `type` – String UTF-8 (valores válidos: `compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`).

  O tipo de otimizador de tabelas.

## Estrutura BatchTableTableOptimizer
<a name="aws-glue-api-table-optimizers-BatchTableOptimizer"></a>

Contém detalhes de um dos otimizadores de tabela retornados pela operação `BatchGetTableOptimizer`.

**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 de catálogo da tabela.
+ `databaseName`: string UTF-8 com pelo menos 1 byte de comprimento.

  O nome do banco de dados no catálogo em que a tabela reside.
+ `tableName`: string UTF-8 com pelo menos 1 byte de comprimento.

  O nome da tabela.
+ `tableOptimizer` – Um objeto [TableOptimizer](#aws-glue-api-table-optimizers-TableOptimizer).

  Um objeto `TableOptimizer` que contém detalhes da configuração e da última execução de um otimizador de tabelas.

## Estrutura BatchGetTableOptimizerError
<a name="aws-glue-api-table-optimizers-BatchGetTableOptimizerError"></a>

Contém detalhes sobre um dos erros na lista de erros retornada pela operação `BatchGetTableOptimizer`.

**Campos**
+ `error` – Um objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).

  Um objeto `ErrorDetail` que contém detalhes de código e mensagens sobre o erro.
+ `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 da tabela.
+ `databaseName`: string UTF-8 com pelo menos 1 byte de comprimento.

  O nome do banco de dados no catálogo em que a tabela reside.
+ `tableName`: string UTF-8 com pelo menos 1 byte de comprimento.

  O nome da tabela.
+ `type` – String UTF-8 (valores válidos: `compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`).

  O tipo de otimizador de tabelas.

## Estrutura RetentionConfiguration
<a name="aws-glue-api-table-optimizers-RetentionConfiguration"></a>

A configuração de um otimizador de retenção de snapshots.

**Campos**
+ `icebergConfiguration` – Um objeto [IcebergRetentionConfiguration](#aws-glue-api-table-optimizers-IcebergRetentionConfiguration).

  A configuração de um otimizador de retenção de snapshots do Iceberg.

## Estrutura IcebergRetentionConfiguration
<a name="aws-glue-api-table-optimizers-IcebergRetentionConfiguration"></a>

A configuração de um otimizador de retenção de snapshots do Iceberg.

**Campos**
+ `snapshotRetentionPeriodInDays` – Número (íntegro).

  O número de dias para reter os snapshots do Iceberg. Se uma entrada não for fornecida, o campo de configuração da tabela Iceberg correspondente será usado ou, se não estiver presente, o valor padrão 5 será usado.
+ `numberOfSnapshotsToRetain` – Número (íntegro).

  O número de snapshots do Iceberg a serem retidos no período de retenção. Se uma entrada não for fornecida, o campo de configuração da tabela Iceberg correspondente será usado ou, se não estiver presente, o valor padrão 1 será usado.
+ `cleanExpiredFiles` – Booleano.

  Se definido como false, os snapshots são excluídos somente dos metadados da tabela, e os arquivos de dados e metadados subjacentes não são excluídos.
+ `runRateInHours` – Número (íntegro).

  O intervalo em horas entre as execuções de trabalhos de retenção. Este parâmetro controla a frequência com que o otimizador de retenção será executado para limpar snapshots expirados. O valor deve estar entre 3 e 168 horas (7 dias). Se uma entrada de não for fornecida, o valor padrão de 24 será usado.

## Estrutura OrphanFileDeletionConfiguration
<a name="aws-glue-api-table-optimizers-OrphanFileDeletionConfiguration"></a>

A configuração de um otimizador de exclusão de arquivos órfãos.

**Campos**
+ `icebergConfiguration` – Um objeto [IcebergOrphanFileDeletionConfiguration](#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionConfiguration).

  A configuração de um otimizador de exclusão de arquivos órfãos do Iceberg.

## Estrutura IcebergOrphanFileDeletionConfiguration
<a name="aws-glue-api-table-optimizers-IcebergOrphanFileDeletionConfiguration"></a>

A configuração de um otimizador de exclusão de arquivos órfãos do Iceberg.

**Campos**
+ `orphanFileRetentionPeriodInDays` – Número (íntegro).

  O número de dias que os arquivos órfãos devem ser retidos antes da exclusão do arquivo. Se uma entrada de não for fornecida, o valor padrão 3 será usado.
+ `location` – String UTF-8.

  Especifica um diretório no qual procurar arquivos (o padrão é a localização da tabela). Você pode escolher um subdiretório em vez da localização da tabela de nível superior.
+ `runRateInHours` – Número (íntegro).

  O intervalo em horas entre execuções do trabalho de exclusão de arquivos órfãos. Esse parâmetro controla com que frequência o otimizador de exclusão de arquivos órfãos será executado para limpar arquivos órfãos. O valor deve estar entre 3 e 168 horas (7 dias). Se uma entrada de não for fornecida, o valor padrão de 24 será usado.

## Estrutura CompactionMetrics
<a name="aws-glue-api-table-optimizers-CompactionMetrics"></a>

Uma estrutura que contém as métricas de compactação para a execução do otimizador.

**Campos**
+ `IcebergMetrics` – Um objeto [IcebergCompactionMetrics](#aws-glue-api-table-optimizers-IcebergCompactionMetrics).

  Uma estrutura que contém as métricas de compactação do Iceberg para a execução do otimizador.

## Estrutura RetentionMetrics
<a name="aws-glue-api-table-optimizers-RetentionMetrics"></a>

Uma estrutura que contém as métricas de retenção para a execução do otimizador.

**Campos**
+ `IcebergMetrics` – Um objeto [IcebergRetentionMetrics](#aws-glue-api-table-optimizers-IcebergRetentionMetrics).

  Uma estrutura que contém as métricas de retenção do Iceberg para a execução do otimizador.

## Estrutura OrphanFileDeletionMetrics
<a name="aws-glue-api-table-optimizers-OrphanFileDeletionMetrics"></a>

Uma estrutura que contém as métricas de exclusão de arquivos órfãos para a execução do otimizador.

**Campos**
+ `IcebergMetrics` – Um objeto [IcebergOrphanFileDeletionMetrics](#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionMetrics).

  Uma estrutura que contém as métricas de exclusão de arquivos órfãos do Iceberg para a execução do otimizador.

## Estrutura IcebergCompactionMetrics
<a name="aws-glue-api-table-optimizers-IcebergCompactionMetrics"></a>

Métricas de compactação do Iceberg para a execução do otimizador.

**Campos**
+ `DpuHours` – Número (duplo).

  O número de horas de DPU consumidas pelo trabalho.
+ `NumberOfDpus`: número (inteiro).

  O número de DPUs consumidas pela tarefa, arredondado para o número inteiro mais próximo.
+ `JobDurationInHour` – Número (duplo).

  A duração do trabalho, em horas.

## Estrutura IcebergRetentionMetrics
<a name="aws-glue-api-table-optimizers-IcebergRetentionMetrics"></a>

Métricas de retenção de snapshots do Iceberg para a execução do otimizador.

**Campos**
+ `DpuHours` – Número (duplo).

  O número de horas de DPU consumidas pelo trabalho.
+ `NumberOfDpus`: número (inteiro).

  O número de DPUs consumidas pela tarefa, arredondado para o número inteiro mais próximo.
+ `JobDurationInHour` – Número (duplo).

  A duração do trabalho, em horas.

## Estrutura IcebergOrphanFileDeletionMetrics
<a name="aws-glue-api-table-optimizers-IcebergOrphanFileDeletionMetrics"></a>

Métricas de exclusão de arquivos órfãos do Iceberg para a execução do otimizador.

**Campos**
+ `DpuHours` – Número (duplo).

  O número de horas de DPU consumidas pelo trabalho.
+ `NumberOfDpus`: número (inteiro).

  O número de DPUs consumidas pela tarefa, arredondado para o número inteiro mais próximo.
+ `JobDurationInHour` – Número (duplo).

  A duração do trabalho, em horas.

## Estrutura RunMetrics
<a name="aws-glue-api-table-optimizers-RunMetrics"></a>

Métricas para a execução do otimizador.

Esta estrutura está obsoleta. Veja os membros individuais da métrica para compactação, retenção e exclusão de arquivos órfãos.

**Campos**
+ `NumberOfBytesCompacted` – String UTF-8.

  O número de bytes removidos pela execução do trabalho de compactação.
+ `NumberOfFilesCompacted` – String UTF-8.

  O número de arquivos removidos pela execução do trabalho de compactação.
+ `NumberOfDpus` – String UTF-8.

  O número de DPUs consumidas pela tarefa, arredondado para o número inteiro mais próximo.
+ `JobDurationInHour` – String UTF-8.

  A duração do trabalho, em horas.

## Operações
<a name="aws-glue-api-table-optimizers-actions"></a>
+ [Ação GetTableOptimizer (Python: get\$1table\$1optimizer)](#aws-glue-api-table-optimizers-GetTableOptimizer)
+ [Ação BatchGetTableOptimizer (Python: batch\$1get\$1table\$1optimizer)](#aws-glue-api-table-optimizers-BatchGetTableOptimizer)
+ [Ação ListTableOptimizerRuns (Python: list\$1table\$1optimizer\$1runs)](#aws-glue-api-table-optimizers-ListTableOptimizerRuns)
+ [Ação CreateTableOptimizer (Python: create\$1table\$1optimizer)](#aws-glue-api-table-optimizers-CreateTableOptimizer)
+ [Ação DeleteTableOptimizer (Python: delete\$1table\$1optimizer)](#aws-glue-api-table-optimizers-DeleteTableOptimizer)
+ [Ação UpdateTableOptimizer (Python: update\$1table\$1optimizer)](#aws-glue-api-table-optimizers-UpdateTableOptimizer)

## Ação GetTableOptimizer (Python: get\$1table\$1optimizer)
<a name="aws-glue-api-table-optimizers-GetTableOptimizer"></a>

Retorna a configuração de todos os otimizadores associados a uma tabela especificada.

**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 de catálogo da 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).

  O nome do banco de dados no catálogo em que a tabela 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.
+ `Type` – *Obrigatório:* string UTF-8 (valores válidos: `compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`).

  O tipo de otimizador de tabelas.

**Resposta**
+ `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 da tabela.
+ `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 catálogo em que a tabela reside.
+ `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.
+ `TableOptimizer` – Um objeto [TableOptimizer](#aws-glue-api-table-optimizers-TableOptimizer).

  O otimizador associado à tabela especificada.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `ThrottlingException`

## Ação BatchGetTableOptimizer (Python: batch\$1get\$1table\$1optimizer)
<a name="aws-glue-api-table-optimizers-BatchGetTableOptimizer"></a>

Retorna a configuração para os otimizadores de tabela especificados.

**Solicitação**
+ `Entries` – *Obrigatório:* uma matriz de objetos [BatchGetTableOptimizerEntry](#aws-glue-api-table-optimizers-BatchGetTableOptimizerEntry).

  Uma lista de objetos `BatchGetTableOptimizerEntry` que especifica os otimizadores de tabelas a serem recuperados.

**Resposta**
+ `TableOptimizers`: um array de objetos [BatchTableOptimizer](#aws-glue-api-table-optimizers-BatchTableOptimizer).

  Uma lista dos objetos `BatchTableOptimizer`.
+ `Failures`: um array de objetos [BatchGetTableOptimizerError](#aws-glue-api-table-optimizers-BatchGetTableOptimizerError).

  Uma lista de erros da operação.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `ThrottlingException`

## Ação ListTableOptimizerRuns (Python: list\$1table\$1optimizer\$1runs)
<a name="aws-glue-api-table-optimizers-ListTableOptimizerRuns"></a>

Lista o histórico de execuções anteriores do otimizador para uma tabela específica.

**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 de catálogo da 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).

  O nome do banco de dados no catálogo em que a tabela 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.
+ `Type` – *Obrigatório:* string UTF-8 (valores válidos: `compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`).

  O tipo de otimizador de tabelas.
+ `MaxResults` – Número (íntegro).

  O número máximo de execuções do otimizador a serem retornadas em cada chamada.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `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 da tabela.
+ `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 catálogo em que a tabela reside.
+ `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.
+ `NextToken` – String UTF-8.

  Um token de continuação para paginação da lista de execuções do otimizador retornada, retornado se o segmento atual da lista não for o último.
+ `TableOptimizerRuns`: um array de objetos [TableOptimizerRun](#aws-glue-api-table-optimizers-TableOptimizerRun).

  Uma lista das execuções de otimizador associadas a uma tabela.

**Erros**
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `InvalidInputException`
+ `ValidationException`
+ `InternalServiceException`
+ `ThrottlingException`

## Ação CreateTableOptimizer (Python: create\$1table\$1optimizer)
<a name="aws-glue-api-table-optimizers-CreateTableOptimizer"></a>

Cria um novo otimizador de tabela para uma função específica. 

**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 de catálogo da 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).

  O nome do banco de dados no catálogo em que a tabela 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.
+ `Type` – *Obrigatório:* string UTF-8 (valores válidos: `compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`).

  O tipo de otimizador de tabelas.
+ `TableOptimizerConfiguration` – *Obrigatório:* um objeto [TableOptimizerConfiguration](#aws-glue-api-table-optimizers-TableOptimizerConfiguration).

  Um `TableOptimizerConfiguration` objeto que representa a configuração de um otimizador de tabela.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `ValidationException`
+ `InvalidInputException`
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `InternalServiceException`
+ `ThrottlingException`

## Ação DeleteTableOptimizer (Python: delete\$1table\$1optimizer)
<a name="aws-glue-api-table-optimizers-DeleteTableOptimizer"></a>

Exclui um otimizador e todos os metadados associados de uma tabela. A otimização não será mais executada na 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 de catálogo da 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).

  O nome do banco de dados no catálogo em que a tabela 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.
+ `Type` – *Obrigatório:* string UTF-8 (valores válidos: `compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`).

  O tipo de otimizador de tabelas.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `ThrottlingException`

## Ação UpdateTableOptimizer (Python: update\$1table\$1optimizer)
<a name="aws-glue-api-table-optimizers-UpdateTableOptimizer"></a>

Atualiza a configuração de um otimizador de tabela existente.

**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 de catálogo da 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).

  O nome do banco de dados no catálogo em que a tabela 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.
+ `Type` – *Obrigatório:* string UTF-8 (valores válidos: `compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`).

  O tipo de otimizador de tabelas.
+ `TableOptimizerConfiguration` – *Obrigatório:* um objeto [TableOptimizerConfiguration](#aws-glue-api-table-optimizers-TableOptimizerConfiguration).

  Um `TableOptimizerConfiguration` objeto que representa a configuração de um otimizador de tabela.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ValidationException`
+ `InternalServiceException`
+ `ThrottlingException`
+ `ConcurrentModificationException`

# API de crawlers e classificadores
<a name="aws-glue-api-crawler"></a>

A API Crawler and classifiers descreve os tipos de dados de crawler e de classificador do AWS Glue e inclui a API para criar, excluir, atualizar e listar crawlers ou classificadores.

**Topics**
+ [API do classificador](aws-glue-api-crawler-classifiers.md)
+ [API do crawler](aws-glue-api-crawler-crawling.md)
+ [API de estatísticas de colunas](aws-glue-api-crawler-column-statistics.md)
+ [API do programador do crawler](aws-glue-api-crawler-scheduler.md)

# API do classificador
<a name="aws-glue-api-crawler-classifiers"></a>

A API de classificador descreve os tipos de dados de classificador do AWS Glue e inclui a API para criar, excluir, atualizar e listar classificadores.

## Tipos de dados
<a name="aws-glue-api-crawler-classifiers-objects"></a>
+ [Estrutura Classifier](#aws-glue-api-crawler-classifiers-Classifier)
+ [Estrutura GrokClassifier](#aws-glue-api-crawler-classifiers-GrokClassifier)
+ [Estrutura XMLClassifier](#aws-glue-api-crawler-classifiers-XMLClassifier)
+ [Estrutura JsonClassifier](#aws-glue-api-crawler-classifiers-JsonClassifier)
+ [Estrutura CsvClassifier](#aws-glue-api-crawler-classifiers-CsvClassifier)
+ [Estrutura CreateGrokClassifierRequest](#aws-glue-api-crawler-classifiers-CreateGrokClassifierRequest)
+ [Estrutura UpdateGrokClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateGrokClassifierRequest)
+ [Estrutura CreateXMLClassifierRequest](#aws-glue-api-crawler-classifiers-CreateXMLClassifierRequest)
+ [Estrutura UpdateXMLClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateXMLClassifierRequest)
+ [Estrutura CreateJsonClassifierRequest](#aws-glue-api-crawler-classifiers-CreateJsonClassifierRequest)
+ [Estrutura UpdateJsonClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateJsonClassifierRequest)
+ [Estrutura CreateCsvClassifierRequest](#aws-glue-api-crawler-classifiers-CreateCsvClassifierRequest)
+ [Estrutura UpdateCsvClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateCsvClassifierRequest)

## Estrutura Classifier
<a name="aws-glue-api-crawler-classifiers-Classifier"></a>

Os classificadores são acionados durante um trabalho de rastreamento. Um classificador verifica se determinado arquivo está em um formato que pode ser processado. Se estiver, o classificador cria um esquema na forma de um objeto `StructType` que corresponde a esse formato de dados.

Você pode usar os classificadores padrão fornecidos pelo AWS Glue ou gravar seus próprios classificadores para categorizar melhor suas fontes de dados e especificar os esquemas apropriados a serem usados para eles. Ele pode ser um classificador `grok`, `XML` ou `JSON`, ou um `CSV` personalizado, conforme especificado em um dos campos no objeto `Classifier`.

**Campos**
+ `GrokClassifier` – Um objeto [GrokClassifier](#aws-glue-api-crawler-classifiers-GrokClassifier).

  Um classificador que usa `grok`.
+ `XMLClassifier` – Um objeto [XMLClassifier](#aws-glue-api-crawler-classifiers-XMLClassifier).

  Um classificador para o conteúdo XML.
+ `JsonClassifier` – Um objeto [JsonClassifier](#aws-glue-api-crawler-classifiers-JsonClassifier).

  Um classificador para o conteúdo JSON.
+ `CsvClassifier` – Um objeto [CsvClassifier](#aws-glue-api-crawler-classifiers-CsvClassifier).

  Um classificador para valores separados por vírgula (CSV, comma-separated values).

## Estrutura GrokClassifier
<a name="aws-glue-api-crawler-classifiers-GrokClassifier"></a>

Um classificador que usa padrões `grok`.

**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 classificador.
+ `Classification` – *Obrigatório:* string UTF-8.

  Um identificador do formato de dados com o qual o classificador corresponde, como Twitter, JSON, logs da Omniture, e assim por diante.
+ `CreationTime` – Timestamp.

  A hora em que o classificador foi registrado.
+ `LastUpdated` – Timestamp.

  A hora em que o classificador foi atualizado pela última vez.
+ `Version` – Número (extenso).

  A versão do classificador.
+ `GrokPattern` – *Obrigatório:* string UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [A Logstash Grok string pattern](aws-glue-api-common.md#aws-glue-api-grok-pattern).

  O padrão grok aplicado a um armazenamento de dados por este classificador. Para obter mais informações, consulte os padrões integrados em [Escrever classificadores personalizados](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html).
+ `CustomPatterns` – String UTF-8 com comprimento não superior a 16.000 bytes, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Padrões grok personalizados opcionais definidos por este classificador. Para obter mais informações, consulte os padrões personalizados em [Escrever classificadores personalizados](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html).

## Estrutura XMLClassifier
<a name="aws-glue-api-crawler-classifiers-XMLClassifier"></a>

Um classificador para o conteúdo `XML`.

**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 classificador.
+ `Classification` – *Obrigatório:* string UTF-8.

  Um identificador do formato de dados aos quais o classificador corresponde.
+ `CreationTime` – Timestamp.

  A hora em que o classificador foi registrado.
+ `LastUpdated` – Timestamp.

  A hora em que o classificador foi atualizado pela última vez.
+ `Version` – Número (extenso).

  A versão do classificador.
+ `RowTag` – String UTF-8.

  A tag XML que designa o elemento que contém cada registro em um documento XML sendo analisado. Isso não pode identificar um elemento de fechamento automático (fechado por `/>`). Um elemento de linha vazio que contém somente atributos pode ser analisado desde que ele termine com uma tag de fechamento (por exemplo, `<row item_a="A" item_b="B"></row>` ok, mas `<row item_a="A" item_b="B" />` não).

## Estrutura JsonClassifier
<a name="aws-glue-api-crawler-classifiers-JsonClassifier"></a>

Um classificador para o conteúdo `JSON`.

**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 classificador.
+ `CreationTime` – Timestamp.

  A hora em que o classificador foi registrado.
+ `LastUpdated` – Timestamp.

  A hora em que o classificador foi atualizado pela última vez.
+ `Version` – Número (extenso).

  A versão do classificador.
+ `JsonPath` – *Obrigatório:* string UTF-8.

  Uma string `JsonPath` define os dados JSON para o classificador classificar. O AWS Glue oferece suporte a um subconjunto de JsonPath, conforme descrito em [Gravar classificadores personalizados JsonPath](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json).

## Estrutura CsvClassifier
<a name="aws-glue-api-crawler-classifiers-CsvClassifier"></a>

Um classificador para conteúdo `CSV` personalizado.

**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 classificador.
+ `CreationTime` – Timestamp.

  A hora em que o classificador foi registrado.
+ `LastUpdated` – Timestamp.

  A hora em que o classificador foi atualizado pela última vez.
+ `Version` – Número (extenso).

  A versão do classificador.
+ `Delimiter`: string UTF-8, não menos do que 1 ou superior a 1 byte de comprimento, correspondente a [Custom string pattern #26](aws-glue-api-common.md#regex_26).

  Um símbolo personalizado para indicar o que separa cada entrada de coluna na linha.
+ `QuoteSymbol`: string UTF-8, não menos do que 1 ou superior a 1 byte de comprimento, correspondente a [Custom string pattern #26](aws-glue-api-common.md#regex_26).

  Um símbolo personalizado para indicar o que combina o conteúdo em um único valor da coluna. Deve ser diferente do delimitador de coluna.
+ `ContainsHeader` – String UTF-8 (valores válidos: `UNKNOWN` \$1 `PRESENT` \$1 `ABSENT`).

  Indica se o arquivo CSV contém um cabeçalho.
+ `Header` – Uma matriz de strings UTF-8.

  Uma lista de strings que representam nomes de coluna.
+ `DisableValueTrimming` – Booleano.

  Especifica para não remover valores antes de identificar o tipo dos valores de coluna. O valor padrão é `true`.
+ `AllowSingleColumn` – Booleano.

  Habilita o processamento de arquivos que contêm apenas uma coluna.
+ `CustomDatatypeConfigured` – Booleano.

  Permite que o tipo de dados personalizado seja configurado.
+ `CustomDatatypes` – Uma matriz de strings UTF-8.

  Uma lista de tipos de dados personalizados, incluindo “BINARY”, “BOOLEAN”, “DATE”, “DECIMAL”, “DOUBLE”, “FLOAT”, “INT”, “LONG”, “SHORT”, “STRING”, “TIMESTAMP”.
+ `Serde` – String UTF-8 (valores válidos: `OpenCSVSerDe` \$1 `LazySimpleSerDe` \$1 `None`).

  Define o SerDe para processamento de CSV no classificador, que será aplicado no catálogo de dados. Os valores válidos são `OpenCSVSerDe`, `LazySimpleSerDe` e `None`. Você pode especificar o valor `None` quando quiser que o crawler faça a detecção.

## Estrutura CreateGrokClassifierRequest
<a name="aws-glue-api-crawler-classifiers-CreateGrokClassifierRequest"></a>

Especifica um classificador `grok` a ser criado por `CreateClassifier`.

**Campos**
+ `Classification` – *Obrigatório:* string UTF-8.

  Um identificador do formato de dados com o qual o classificador corresponde, como Twitter, JSON, logs da Omniture, Amazon CloudWatch Logs e assim por diante.
+ `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 novo classificador.
+ `GrokPattern` – *Obrigatório:* string UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [A Logstash Grok string pattern](aws-glue-api-common.md#aws-glue-api-grok-pattern).

  O padrão grok que é usado por este classificador.
+ `CustomPatterns` – String UTF-8 com comprimento não superior a 16.000 bytes, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Padrões grok personalizados opcionais usados por este classificador.

## Estrutura UpdateGrokClassifierRequest
<a name="aws-glue-api-crawler-classifiers-UpdateGrokClassifierRequest"></a>

Especifica um classificador grok a ser atualizado quando transmitido para `UpdateClassifier`.

**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 `GrokClassifier`.
+ `Classification` – String UTF-8.

  Um identificador do formato de dados com o qual o classificador corresponde, como Twitter, JSON, logs da Omniture, Amazon CloudWatch Logs e assim por diante.
+ `GrokPattern` – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [A Logstash Grok string pattern](aws-glue-api-common.md#aws-glue-api-grok-pattern).

  O padrão grok que é usado por este classificador.
+ `CustomPatterns` – String UTF-8 com comprimento não superior a 16.000 bytes, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Padrões grok personalizados opcionais usados por este classificador.

## Estrutura CreateXMLClassifierRequest
<a name="aws-glue-api-crawler-classifiers-CreateXMLClassifierRequest"></a>

Especifica um classificador XML a ser criado por `CreateClassifier`.

**Campos**
+ `Classification` – *Obrigatório:* string UTF-8.

  Um identificador do formato de dados aos quais o classificador corresponde.
+ `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 classificador.
+ `RowTag` – String UTF-8.

  A tag XML que designa o elemento que contém cada registro em um documento XML sendo analisado. Isso não pode identificar um elemento de fechamento automático (fechado por `/>`). Um elemento de linha vazio que contém somente atributos pode ser analisado desde que ele termine com uma tag de fechamento (por exemplo, `<row item_a="A" item_b="B"></row>` ok, mas `<row item_a="A" item_b="B" />` não).

## Estrutura UpdateXMLClassifierRequest
<a name="aws-glue-api-crawler-classifiers-UpdateXMLClassifierRequest"></a>

Especifica um classificador XML a ser atualizado.

**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 classificador.
+ `Classification` – String UTF-8.

  Um identificador do formato de dados aos quais o classificador corresponde.
+ `RowTag` – String UTF-8.

  A tag XML que designa o elemento que contém cada registro em um documento XML sendo analisado. Ela não pode identificar um elemento de fechamento automático (fechado por `/>`). Um elemento de linha vazio que contém somente atributos pode ser analisado desde que ele termine com uma tag de fechamento (por exemplo, `<row item_a="A" item_b="B"></row>` ok, mas `<row item_a="A" item_b="B" />` não).

## Estrutura CreateJsonClassifierRequest
<a name="aws-glue-api-crawler-classifiers-CreateJsonClassifierRequest"></a>

Especifica um classificador JSON a ser criado por `CreateClassifier`.

**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 classificador.
+ `JsonPath` – *Obrigatório:* string UTF-8.

  Uma string `JsonPath` define os dados JSON para o classificador classificar. O AWS Glue oferece suporte a um subconjunto de JsonPath, conforme descrito em [Gravar classificadores personalizados JsonPath](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json).

## Estrutura UpdateJsonClassifierRequest
<a name="aws-glue-api-crawler-classifiers-UpdateJsonClassifierRequest"></a>

Especifica um classificador JSON a ser atualizado.

**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 classificador.
+ `JsonPath` – String UTF-8.

  Uma string `JsonPath` define os dados JSON para o classificador classificar. O AWS Glue oferece suporte a um subconjunto de JsonPath, conforme descrito em [Gravar classificadores personalizados JsonPath](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json).

## Estrutura CreateCsvClassifierRequest
<a name="aws-glue-api-crawler-classifiers-CreateCsvClassifierRequest"></a>

Especifica um classificador CSV personalizado a ser criado por `CreateClassifier`.

**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 classificador.
+ `Delimiter`: string UTF-8, não menos do que 1 ou superior a 1 byte de comprimento, correspondente a [Custom string pattern #26](aws-glue-api-common.md#regex_26).

  Um símbolo personalizado para indicar o que separa cada entrada de coluna na linha.
+ `QuoteSymbol`: string UTF-8, não menos do que 1 ou superior a 1 byte de comprimento, correspondente a [Custom string pattern #26](aws-glue-api-common.md#regex_26).

  Um símbolo personalizado para indicar o que combina o conteúdo em um único valor da coluna. Deve ser diferente do delimitador de coluna.
+ `ContainsHeader` – String UTF-8 (valores válidos: `UNKNOWN` \$1 `PRESENT` \$1 `ABSENT`).

  Indica se o arquivo CSV contém um cabeçalho.
+ `Header` – Uma matriz de strings UTF-8.

  Uma lista de strings que representam nomes de coluna.
+ `DisableValueTrimming` – Booleano.

  Especifica para não remover valores antes de identificar o tipo dos valores de coluna. O valor padrão é true.
+ `AllowSingleColumn` – Booleano.

  Habilita o processamento de arquivos que contêm apenas uma coluna.
+ `CustomDatatypeConfigured` – Booleano.

  Permite a configuração de tipos de dados personalizados.
+ `CustomDatatypes` – Uma matriz de strings UTF-8.

  Cria uma lista de tipos de dados personalizados válidos.
+ `Serde` – String UTF-8 (valores válidos: `OpenCSVSerDe` \$1 `LazySimpleSerDe` \$1 `None`).

  Define o SerDe para processamento de CSV no classificador, que será aplicado no catálogo de dados. Os valores válidos são `OpenCSVSerDe`, `LazySimpleSerDe` e `None`. Você pode especificar o valor `None` quando quiser que o crawler faça a detecção.

## Estrutura UpdateCsvClassifierRequest
<a name="aws-glue-api-crawler-classifiers-UpdateCsvClassifierRequest"></a>

Especifica um classificador CSV personalizado a ser atualizado.

**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 classificador.
+ `Delimiter`: string UTF-8, não menos do que 1 ou superior a 1 byte de comprimento, correspondente a [Custom string pattern #26](aws-glue-api-common.md#regex_26).

  Um símbolo personalizado para indicar o que separa cada entrada de coluna na linha.
+ `QuoteSymbol`: string UTF-8, não menos do que 1 ou superior a 1 byte de comprimento, correspondente a [Custom string pattern #26](aws-glue-api-common.md#regex_26).

  Um símbolo personalizado para indicar o que combina o conteúdo em um único valor da coluna. Deve ser diferente do delimitador de coluna.
+ `ContainsHeader` – String UTF-8 (valores válidos: `UNKNOWN` \$1 `PRESENT` \$1 `ABSENT`).

  Indica se o arquivo CSV contém um cabeçalho.
+ `Header` – Uma matriz de strings UTF-8.

  Uma lista de strings que representam nomes de coluna.
+ `DisableValueTrimming` – Booleano.

  Especifica para não remover valores antes de identificar o tipo dos valores de coluna. O valor padrão é true.
+ `AllowSingleColumn` – Booleano.

  Habilita o processamento de arquivos que contêm apenas uma coluna.
+ `CustomDatatypeConfigured` – Booleano.

  Especifica a configuração de tipos de dados personalizados.
+ `CustomDatatypes` – Uma matriz de strings UTF-8.

  Especifica uma lista de tipos de dados personalizados válidos.
+ `Serde` – String UTF-8 (valores válidos: `OpenCSVSerDe` \$1 `LazySimpleSerDe` \$1 `None`).

  Define o SerDe para processamento de CSV no classificador, que será aplicado no catálogo de dados. Os valores válidos são `OpenCSVSerDe`, `LazySimpleSerDe` e `None`. Você pode especificar o valor `None` quando quiser que o crawler faça a detecção.

## Operações
<a name="aws-glue-api-crawler-classifiers-actions"></a>
+ [Ação CreateClassifier (Python: create\$1classifier)](#aws-glue-api-crawler-classifiers-CreateClassifier)
+ [Ação DeleteClassifier (Python: delete\$1classifier)](#aws-glue-api-crawler-classifiers-DeleteClassifier)
+ [Ação GetClassifier (Python: get\$1classifier)](#aws-glue-api-crawler-classifiers-GetClassifier)
+ [Ação GetClassifiers (Python: get\$1classifiers)](#aws-glue-api-crawler-classifiers-GetClassifiers)
+ [Ação UpdateClassifier (Python: update\$1classifier)](#aws-glue-api-crawler-classifiers-UpdateClassifier)

## Ação CreateClassifier (Python: create\$1classifier)
<a name="aws-glue-api-crawler-classifiers-CreateClassifier"></a>

Cria um classificador na conta do usuário. Pode ser um `GrokClassifier`, um `XMLClassifier`, um `JsonClassifier` ou um `CsvClassifier`, dependendo de qual campo da solicitação está presente.

**Solicitação**
+ `GrokClassifier` – Um objeto [CreateGrokClassifierRequest](#aws-glue-api-crawler-classifiers-CreateGrokClassifierRequest).

  Um objeto `GrokClassifier` que especifica o classificador a ser criado.
+ `XMLClassifier` – Um objeto [CreateXMLClassifierRequest](#aws-glue-api-crawler-classifiers-CreateXMLClassifierRequest).

  Um objeto `XMLClassifier` que especifica o classificador a ser criado.
+ `JsonClassifier` – Um objeto [CreateJsonClassifierRequest](#aws-glue-api-crawler-classifiers-CreateJsonClassifierRequest).

  Um objeto `JsonClassifier` que especifica o classificador a ser criado.
+ `CsvClassifier` – Um objeto [CreateCsvClassifierRequest](#aws-glue-api-crawler-classifiers-CreateCsvClassifierRequest).

  Um objeto `CsvClassifier` que especifica o classificador a ser criado.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## Ação DeleteClassifier (Python: delete\$1classifier)
<a name="aws-glue-api-crawler-classifiers-DeleteClassifier"></a>

Remove uma classificador do catálogo de dados.

**Solicitaçã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).

  Nome do classificador a ser removido.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## Ação GetClassifier (Python: get\$1classifier)
<a name="aws-glue-api-crawler-classifiers-GetClassifier"></a>

Recuperar um classificador por nome.

**Solicitaçã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).

  Nome do classificador a ser recuperado.

**Resposta**
+ `Classifier` – Um objeto [Classificador](#aws-glue-api-crawler-classifiers-Classifier).

  O classificador solicitado.

**Erros**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## Ação GetClassifiers (Python: get\$1classifiers)
<a name="aws-glue-api-crawler-classifiers-GetClassifiers"></a>

Lista todos os objetos de classificador no catálogo de dados.

**Solicitação**
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O tamanho da lista a ser retornada (opcional).
+ `NextToken` – String UTF-8.

  Um token de continuação opcional.

**Resposta**
+ `Classifiers`: um array de objetos [Classificador](#aws-glue-api-crawler-classifiers-Classifier).

  A lista solicitada de objetos do classificador.
+ `NextToken` – String UTF-8.

  Um token de continuação.

**Erros**
+ `OperationTimeoutException`

## Ação UpdateClassifier (Python: update\$1classifier)
<a name="aws-glue-api-crawler-classifiers-UpdateClassifier"></a>

Modifica um classificador existente (`GrokClassifier`, `XMLClassifier`, `JsonClassifier` ou `CsvClassifier`, dependendo de qual campo estiver presente).

**Solicitação**
+ `GrokClassifier` – Um objeto [UpdateGrokClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateGrokClassifierRequest).

  Um objeto `GrokClassifier` com campos atualizados.
+ `XMLClassifier` – Um objeto [UpdateXMLClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateXMLClassifierRequest).

  Um objeto `XMLClassifier` com campos atualizados.
+ `JsonClassifier` – Um objeto [UpdateJsonClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateJsonClassifierRequest).

  Um objeto `JsonClassifier` com campos atualizados.
+ `CsvClassifier` – Um objeto [UpdateCsvClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateCsvClassifierRequest).

  Um objeto `CsvClassifier` com campos atualizados.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `InvalidInputException`
+ `VersionMismatchException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`

# API do crawler
<a name="aws-glue-api-crawler-crawling"></a>

A API de crawler descreve os tipos de dados de crawler do AWS Glue, juntamente com a API para criar, excluir, atualizar e listar crawlers.

## Tipos de dados
<a name="aws-glue-api-crawler-crawling-objects"></a>
+ [Estrutura Crawler](#aws-glue-api-crawler-crawling-Crawler)
+ [Estrutura Schedule](#aws-glue-api-crawler-crawling-Schedule)
+ [Estrutura CrawlerTargets](#aws-glue-api-crawler-crawling-CrawlerTargets)
+ [Estrutura S3Target](#aws-glue-api-crawler-crawling-S3Target)
+ [Estrutura S3DeltaCatalogTarget](#aws-glue-api-crawler-crawling-S3DeltaCatalogTarget)
+ [Estrutura S3DeltaDirectTarget](#aws-glue-api-crawler-crawling-S3DeltaDirectTarget)
+ [Estrutura JdbcTarget](#aws-glue-api-crawler-crawling-JdbcTarget)
+ [Estrutura MongoDBTarget](#aws-glue-api-crawler-crawling-MongoDBTarget)
+ [Estrutura DynamoDBTarget](#aws-glue-api-crawler-crawling-DynamoDBTarget)
+ [Estrutura DeltaTarget](#aws-glue-api-crawler-crawling-DeltaTarget)
+ [Estrutura do IcebergTarget](#aws-glue-api-crawler-crawling-IcebergTarget)
+ [Estrutura HudiTarget](#aws-glue-api-crawler-crawling-HudiTarget)
+ [Estrutura CatalogTarget](#aws-glue-api-crawler-crawling-CatalogTarget)
+ [Estrutura CrawlerMetrics](#aws-glue-api-crawler-crawling-CrawlerMetrics)
+ [Estrutura de CrawlerHistory](#aws-glue-api-crawler-crawling-CrawlerHistory)
+ [Estrutura de CrawlsFilter](#aws-glue-api-crawler-crawling-CrawlsFilter)
+ [Estrutura SchemaChangePolicy](#aws-glue-api-crawler-crawling-SchemaChangePolicy)
+ [Estrutura LastCrawlInfo](#aws-glue-api-crawler-crawling-LastCrawlInfo)
+ [Estrutura RecrawlPolicy](#aws-glue-api-crawler-crawling-RecrawlPolicy)
+ [Estrutura LineageConfiguration](#aws-glue-api-crawler-crawling-LineageConfiguration)
+ [Estrutura LakeFormationConfiguration](#aws-glue-api-crawler-crawling-LakeFormationConfiguration)

## Estrutura Crawler
<a name="aws-glue-api-crawler-crawling-Crawler"></a>

Especifica um programa de crawler que examina uma fonte de dados e usa classificadores para tentar determinar seu esquema. Se for bem-sucedido, o crawler registrará metadados da fonte de dados no AWS Glue Data Catalog.

**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 do crawler.
+ `Role` – String UTF-8.

  O nome do recurso da Amazon (ARN) de um perfil do IAM que é usada para acessar os recursos do cliente, como o Amazon Simple Storage Service (Amazon S3).
+ `Targets` – Um objeto [CrawlerTargets](#aws-glue-api-crawler-crawling-CrawlerTargets).

  Uma coleção de destinos a serem rastreados.
+ `DatabaseName` – String UTF-8.

  O nome do banco de dados no qual a saída do crawler é 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 crawler.
+ `Classifiers` – Uma matriz de strings UTF-8.

  Uma lista de strings UTF-8 que especificam os classificadores personalizados associados ao crawler.
+ `RecrawlPolicy` – Um objeto [RecrawlPolicy](#aws-glue-api-crawler-crawling-RecrawlPolicy).

  Uma política que especifica se deseja rastrear todo o conjunto de dados novamente ou rastrear somente pastas que foram adicionadas desde a última execução do crawler.
+ `SchemaChangePolicy` – Um objeto [SchemaChangePolicy](#aws-glue-api-crawler-crawling-SchemaChangePolicy).

  A política que especifica os comportamentos de atualização e exclusão do crawler.
+ `LineageConfiguration` – Um objeto [LineageConfiguration](#aws-glue-api-crawler-crawling-LineageConfiguration).

  Uma configuração que especifica se a linhagem de dados está habilitada para o crawler.
+ `State` – string UTF-8 (valores válidos: `READY` \$1 `RUNNING` \$1 `STOPPING`).

  Indica se o crawler está em execução ou se uma execução está pendente.
+ `TablePrefix` – String UTF-8 com comprimento não superior a 128 bytes.

  O prefixo adicionado aos nomes das tabelas criadas.
+ `Schedule` – Um objeto [Programação](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-Schedule).

  Para crawlers programados, a programação quando o crawler é executado.
+ `CrawlElapsedTime` – Número (extenso).

  Se o crawler estiver em execução, conterá o tempo decorrido total desde o início do rastreamento.
+ `CreationTime` – Timestamp.

  A hora em que o crawler foi criado.
+ `LastUpdated` – Timestamp.

  A hora em que o crawler foi atualizado pela última vez.
+ `LastCrawl` – Um objeto [LastCrawlInfo](#aws-glue-api-crawler-crawling-LastCrawlInfo).

  O status do último rastreamento e informações de erro (se houver algum).
+ `Version` – Número (extenso).

  A versão do crawler.
+ `Configuration` – String UTF-8.

  Informações de configuração do crawler. Esta string JSON com versionamento permite que os usuários especifiquem os aspectos do comportamento de um crawler. Para obter mais informações, consulte [Definir opções de configuração do crawler](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html).
+ `CrawlerSecurityConfiguration` – String UTF-8 com comprimento não superior a 128 bytes.

  O nome da estrutura `SecurityConfiguration` a ser usada por este crawler.
+ `LakeFormationConfiguration` – Um objeto [LakeFormationConfiguration](#aws-glue-api-crawler-crawling-LakeFormationConfiguration).

  Especifica se o crawler deve usar credenciais AWS Lake Formation para o crawler em vez das credenciais de função do IAM.

## Estrutura Schedule
<a name="aws-glue-api-crawler-crawling-Schedule"></a>

Um objeto de programação que usa uma instrução `cron` para programar um evento.

**Campos**
+ `ScheduleExpression` – String UTF-8.

  Uma expressão `cron` usada para especificar a programação (consulte [Programações baseadas em hora para tarefas e crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). Por exemplo, para executar algo todos os dias às 12h15 UTC, especifique: `cron(15 12 * * ? *)`.
+ `State` – string UTF-8 (valores válidos: `SCHEDULED` \$1 `NOT_SCHEDULED` \$1 `TRANSITIONING`).

  O estado da programação.

## Estrutura CrawlerTargets
<a name="aws-glue-api-crawler-crawling-CrawlerTargets"></a>

Especifica os armazenamentos de dados a serem rastreados.

**Campos**
+ `S3Targets`: um array de objetos [S3Target](#aws-glue-api-crawler-crawling-S3Target).

  Especifica os destinos do Amazon Simple Storage Service (Amazon S3).
+ `JdbcTargets`: um array de objetos [JdbcTarget](#aws-glue-api-crawler-crawling-JdbcTarget).

  Especifica destinos JDBC.
+ `MongoDBTargets`: um array de objetos [MongoDBTarget](#aws-glue-api-crawler-crawling-MongoDBTarget).

  Especifica destinos do Amazon DocumentDB ou MongoDB.
+ `DynamoDBTargets`: um array de objetos [DynamoDBTarget](#aws-glue-api-crawler-crawling-DynamoDBTarget).

  Especifica os destinos do Amazon DynamoDB.
+ `CatalogTargets`: um array de objetos [CatalogTarget](#aws-glue-api-crawler-crawling-CatalogTarget).

  Especifica destinos do AWS Glue Data Catalog.
+ `DeltaTargets`: um array de objetos [DeltaTarget](#aws-glue-api-crawler-crawling-DeltaTarget).

  Especifica os destinos do armazenamento de dados Delta.
+ `IcebergTargets`: um array de objetos [IcebergTarget](#aws-glue-api-crawler-crawling-IcebergTarget).

  Especifica os destinos do armazenamento de dados do Apache Iceberg.
+ `HudiTargets`: um array de objetos [HudiTarget](#aws-glue-api-crawler-crawling-HudiTarget).

  Especifica os destinos do armazenamento de dados do Apache Hudi.

## Estrutura S3Target
<a name="aws-glue-api-crawler-crawling-S3Target"></a>

Especifica um armazenamento de dados no Amazon Simple Storage Service (Amazon S3).

**Campos**
+ `Path` – String UTF-8.

  O caminho do destino do Amazon S3.
+ `Exclusions` – Uma matriz de strings UTF-8.

  Uma lista de padrões glob utilizados para a exclusão do rastreamento. Para obter mais informações, consulte [Catalogar tabelas com um crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html).
+ `ConnectionName`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  O nome de uma conexão que permite que um trabalho ou crawler acesse dados no Amazon S3 em um ambiente do Amazon Virtual Private Cloud (Amazon VPC).
+ `SampleSize` – Número (íntegro).

  Define o número de arquivos em cada pasta de folha a serem rastreados ao realizar crawling de arquivos de amostra em um conjunto de dados. Se não for definido, todos os arquivos serão rastreados. Um valor válido é um número inteiro entre 1 e 249.
+ `EventQueueArn` – String UTF-8.

  Um ARN válido do Amazon SQS. Por exemplo, `arn:aws:sqs:region:account:sqs`.
+ `DlqEventQueueArn` – String UTF-8.

  Um ARN do SQS de mensagem morta válida da Amazon. Por exemplo, `arn:aws:sqs:region:account:deadLetterQueue`.

## Estrutura S3DeltaCatalogTarget
<a name="aws-glue-api-crawler-crawling-S3DeltaCatalogTarget"></a>

Especifica um destino que grava em uma fonte de dados do Delta Lake no catálogo de dados do AWS Glue.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Especifica o particionamento nativo usando uma sequência de chaves.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados na qual gravar.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados no qual gravar.
+ `AdditionalOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica as opções de conexão adicionais para o conector.
+ `SchemaChangePolicy` – Um objeto [CatalogSchemaChangePolicy](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy).

  Uma política que especifica o comportamentos de atualização do crawler.
+ `AutoDataQuality` – Um objeto [AutoDataQuality](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AutoDataQuality).

  Especifica se a avaliação da qualidade dos dados deve ser habilitada automaticamente para o destino do catálogo Delta do S3. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente durante a operação de gravação.
+ `OutputSchemas`: um array de objetos [GlueSchema](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para o destino do catálogo Delta do S3.

## Estrutura S3DeltaDirectTarget
<a name="aws-glue-api-crawler-crawling-S3DeltaDirectTarget"></a>

Especifica um destino que grava em uma fonte de dados do Delta Lake no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Especifica o particionamento nativo usando uma sequência de chaves.
+ `Path` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O caminho do Amazon S3 da fonte de dados do Delta Lake na qual gravar.
+ `Compression` – *Obrigatório:* string UTF-8 (valores válidos: `uncompressed="UNCOMPRESSED"` \$1 `snappy="SNAPPY"`).

  Especifica como os dados são compactados. Isso geralmente não é necessário se os dados tem uma extensão de arquivo padrão. Os possíveis valores são `"gzip"` e `"bzip"`).
+ `NumberTargetPartitions` – String UTF-8.

  Especifica o número de partições de destino para distribuição dos arquivos do conjunto de dados do Data Lake no Amazon S3.
+ `Format`: *obrigatório:* string UTF-8 (valores válidos: `json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`).

  Especifica o formato de saída de dados para o destino.
+ `AdditionalOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica as opções de conexão adicionais para o conector.
+ `SchemaChangePolicy` – Um objeto [DirectSchemaChangePolicy](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DirectSchemaChangePolicy).

  Uma política que especifica o comportamentos de atualização do crawler.
+ `AutoDataQuality` – Um objeto [AutoDataQuality](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AutoDataQuality).

  Especifica se a avaliação da qualidade dos dados deve ser habilitada automaticamente para o destino direto Delta do S3. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente durante a operação de gravação.

## Estrutura JdbcTarget
<a name="aws-glue-api-crawler-crawling-JdbcTarget"></a>

Especifica um armazenamento de dados JDBC a ser rastreado.

**Campos**
+ `ConnectionName`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  O nome da conexão a ser usada para se conectar com o destino JDBC.
+ `Path` – String UTF-8.

  O caminho do destino do JDBC.
+ `Exclusions` – Uma matriz de strings UTF-8.

  Uma lista de padrões glob utilizados para a exclusão do rastreamento. Para obter mais informações, consulte [Catalogar tabelas com um crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html).
+ `EnableAdditionalMetadata` – Uma matriz de strings UTF-8.

  Especifique um valor de `RAWTYPES` ou `COMMENTS` para habilitar metadados adicionais nas respostas da tabela. O `RAWTYPES` fornece o tipo de dados de nível nativo. O `COMMENTS` fornece comentários associados a uma coluna ou tabela no banco de dados.

  Se você não precisar de metadados adicionais, deixe o campo vazio.

## Estrutura MongoDBTarget
<a name="aws-glue-api-crawler-crawling-MongoDBTarget"></a>

Especifica um armazenamento de dados do Amazon DocumentDB ou MongoDB a ser rastreado.

**Campos**
+ `ConnectionName`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  O nome da conexão a ser usada para se conectar com o destino do Amazon DocumentDB ou MongoDB.
+ `Path` – String UTF-8.

  O caminho do destino do Amazon DocumentDB ou MongoDB (banco de dados/coleção).
+ `ScanAll` – Booleano.

  Indica se deseja verificar todos os registros ou amostras de linhas da tabela. A verificação de todos os registros pode levar muito tempo quando a tabela não é de throughput alto.

  Um valor de `true` indica para verificar todos os registros, enquanto um valor de `false` indica para criar amostra dos registros. Se nenhum valor for especificado, o valor será assumido como padrão `true`.

## Estrutura DynamoDBTarget
<a name="aws-glue-api-crawler-crawling-DynamoDBTarget"></a>

Especifica uma tabela do Amazon DynamoDB para ser rastreada.

**Campos**
+ `Path` – String UTF-8.

  O nome da tabela do DynamoDB a ser rastreada.
+ `scanAll` – Booleano.

  Indica se deseja verificar todos os registros ou amostras de linhas da tabela. A verificação de todos os registros pode levar muito tempo quando a tabela não é de throughput alto.

  Um valor de `true` indica para verificar todos os registros, enquanto um valor de `false` indica para criar amostra dos registros. Se nenhum valor for especificado, o valor será assumido como padrão `true`.
+ `scanRate` – Número (duplo).

  A porcentagem das unidades de capacidade de leitura configuradas a serem usadas pelo crawler do AWS Glue. Unidades de capacidade de leitura é um termo definido pelo DynamoDB e é um valor numérico que atua como limitador de taxa para o número de leituras que podem ser executadas nessa tabela por segundo.

  Os valores válidos são nulos ou um valor entre 0,1 e 1,5. Um valor nulo é usado quando o usuário não fornece um valor e é usado como padrão 0,5 da unidade de capacidade de leitura configurada (para tabelas provisionadas) ou 0,25 da unidade de capacidade de leitura máxima configurada (para tabelas que usam o modo sob demanda).

## Estrutura DeltaTarget
<a name="aws-glue-api-crawler-crawling-DeltaTarget"></a>

Especifica um armazenamento de dados Delta para rastrear uma ou mais tabelas Delta.

**Campos**
+ `DeltaTables` – Uma matriz de strings UTF-8.

  Uma lista de caminhos do Amazon S3 para as tabelas Delta.
+ `ConnectionName`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  O nome da conexão a ser usada para se conectar ao destino da tabela Delta.
+ `WriteManifest` – Booleano.

  Especifica se os arquivos de manifesto devem ser gravados no caminho da tabela Delta.
+ `CreateNativeDeltaTable` – Booleano.

  Especifica se o crawler criará tabelas nativas para permitir a integração com mecanismos de consulta compatíveis consulta direta ao log de transações do Delta.

## Estrutura do IcebergTarget
<a name="aws-glue-api-crawler-crawling-IcebergTarget"></a>

Especifica uma fonte de dados do Apache Iceberg na qual as tabelas do Iceberg são armazenadas no Amazon S3.

**Campos**
+ `Paths` – Uma matriz de strings UTF-8.

  Um ou mais caminhos do Amazon S3 que contêm pastas de metadados do Iceberg como `s3://bucket/prefix`.
+ `ConnectionName`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  O nome da conexão a ser usada para se conectar com o destino do Iceberg.
+ `Exclusions` – Uma matriz de strings UTF-8.

  Uma lista de padrões glob utilizados para a exclusão do rastreamento. Para obter mais informações, consulte [Catalogar tabelas com um crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html).
+ `MaximumTraversalDepth` – Número (íntegro).

  A profundidade máxima de caminhos do Amazon S3 que o crawler pode percorrer para descobrir a pasta de metadados do Iceberg no caminho do Amazon S3. Usado para limitar o runtime do crawler.

## Estrutura HudiTarget
<a name="aws-glue-api-crawler-crawling-HudiTarget"></a>

Especifica uma fonte de dados do Apache Hudi.

**Campos**
+ `Paths` – Uma matriz de strings UTF-8.

  Uma matriz de strings de localização do Amazon S3 para o Hudi, cada uma indicando a pasta raiz na qual residem os arquivos de metadados de uma tabela do Hudi. A pasta do Hudi pode estar localizada em uma pasta secundária da pasta raiz.

  O crawler examinará todas as pastas abaixo de um caminho para uma pasta do Hudi.
+ `ConnectionName`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  O nome da conexão a ser usada para se conectar com o destino do Hudi. Se seus arquivos do Hudi estiverem armazenados em buckets que exigem autorização de VPC, você pode definir suas propriedades de conexão aqui.
+ `Exclusions` – Uma matriz de strings UTF-8.

  Uma lista de padrões glob utilizados para a exclusão do rastreamento. Para obter mais informações, consulte [Catalogar tabelas com um crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html).
+ `MaximumTraversalDepth` – Número (íntegro).

  A profundidade máxima de caminhos do Amazon S3 que o crawler pode percorrer para descobrir a pasta de metadados do Hudi no caminho do Amazon S3. Usado para limitar o runtime do crawler.

## Estrutura CatalogTarget
<a name="aws-glue-api-crawler-crawling-CatalogTarget"></a>

Especifica um destino do AWS Glue Data Catalog.

**Campos**
+ `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 a ser sincronizado.
+ `Tables` – *Obrigatório:* uma matriz de strings UTF-8, pelo menos 1 string.

  Uma lista de tabelas a serem sincronizadas.
+ `ConnectionName`: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  O nome da conexão de uma tabela de catálogo de dados baseada no Amazon S3 é um destino do crawl quando um tipo de conexão `Catalog` pareado a um tipo de conexão `NETWORK` é usado.
+ `EventQueueArn` – String UTF-8.

  Um ARN válido do Amazon SQS. Por exemplo, `arn:aws:sqs:region:account:sqs`.
+ `DlqEventQueueArn` – String UTF-8.

  Um ARN do SQS de mensagem morta válida da Amazon. Por exemplo, `arn:aws:sqs:region:account:deadLetterQueue`.

## Estrutura CrawlerMetrics
<a name="aws-glue-api-crawler-crawling-CrawlerMetrics"></a>

Métricas para um crawler especificado.

**Campos**
+ `CrawlerName` – 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 crawler.
+ `TimeLeftSeconds` – Número (dobro), não mais do que None (Nenhum).

  O tempo estimado restante para concluir um rastreamento em execução.
+ `StillEstimating` – Booleano.

  True se o crawler ainda estiver estimando quanto tempo demorará para concluir a execução.
+ `LastRuntimeSeconds` – Número (dobro), não mais do que None (Nenhum).

  A duração da execução mais recente do crawler em segundos.
+ `MedianRuntimeSeconds` – Número (dobro), não mais do que None (Nenhum).

  A duração média da execução do crawler em segundos.
+ `TablesCreated` – Número (inteiro), não mais do que None (Nenhum).

  O número de tabelas criadas por este crawler.
+ `TablesUpdated` – Número (inteiro), não mais do que None (Nenhum).

  O número de tabelas atualizadas por este crawler.
+ `TablesDeleted` – Número (inteiro), não mais do que None (Nenhum).

  O número de tabelas excluídas por este crawler.

## Estrutura de CrawlerHistory
<a name="aws-glue-api-crawler-crawling-CrawlerHistory"></a>

Contém as informações sobre uma execução de um crawler.

**Campos**
+ `CrawlId` – String UTF-8.

  Um identificador UUID para cada crawl.
+ `State` – string UTF-8 (valores válidos: `RUNNING` \$1 `COMPLETED` \$1 `FAILED` \$1 `STOPPED`).

  O estado do crawl.
+ `StartTime` – Timestamp.

  A data e a hora em que o monitoramento foi iniciado.
+ `EndTime` – Timestamp.

  A data e a hora em que o crawl terminou.
+ `Summary` – 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 resumo da execução para o crawl específico em JSON. Contém as partições e tabelas de catálogo que foram adicionadas, atualizadas ou excluídas.
+ `ErrorMessage` – 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).

  Em caso de erro, a mensagem de erro associada ao crawl.
+ `LogGroup` – string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a [Log group string pattern](aws-glue-api-common.md#aws-glue-api-regex-logGroup-id).

  O grupo de logs associado ao crawl.
+ `LogStream` – string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a [Log-stream string pattern](aws-glue-api-common.md#aws-glue-api-regex-logStream-id).

  O fluxo de logs associado ao rastreamento.
+ `MessagePrefix` – 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 prefixo de uma mensagem do CloudWatch sobre este crawl.
+ `DPUHour` – Número (dobro), não mais do que None (Nenhum).

  O número de data processing units (DPU – Unidades de processamento de dados) usadas para o crawl em horas.

## Estrutura de CrawlsFilter
<a name="aws-glue-api-crawler-crawling-CrawlsFilter"></a>

Uma lista de campos, comparadores e valores que você pode usar para filtrar as execuções de crawler para um crawler especificado.

**Campos**
+ `FieldName` – string UTF-8 (valores válidos: `CRAWL_ID` \$1 `STATE` \$1 `START_TIME` \$1 `END_TIME` \$1 `DPU_HOUR`).

  Uma chave usada para filtrar as execuções de crawler para um crawler especificado. Os valores válidos para cada um dos nomes de campo são:
  + `CRAWL_ID`: uma string que representa o identificador UUID para um crawl.
  + `STATE`: uma string que representa o estado do crawl.
  + `START_TIME` e `END_TIME`: o carimbo de data e hora de época em milissegundos.
  + `DPU_HOUR`: O número de horas de DPU usadas para o crawl.
+ `FilterOperator` – string UTF-8 (valores válidos: `GT` \$1 `GE` \$1 `LT` \$1 `LE` \$1 `EQ` \$1 `NE`).

  Um comparador definido que opera no valor. Os operadores disponíveis são:
  + `GT`: maior que.
  + `GE`: maior ou igual a.
  + `LT`: menor que.
  + `LE`: menor ou igual a.
  + `EQ`: igual a.
  + `NE`: não é igual a.
+ `FieldValue` – String UTF-8.

  O valor fornecido para comparação no campo de crawl. 

## Estrutura SchemaChangePolicy
<a name="aws-glue-api-crawler-crawling-SchemaChangePolicy"></a>

Uma política que especifica os comportamentos de atualização e exclusão do crawler.

**Campos**
+ `UpdateBehavior` – string UTF-8 (valores válidos: `LOG` \$1 `UPDATE_IN_DATABASE`).

  O comportamento de atualização quando o crawler encontra um esquema alterado.
+ `DeleteBehavior` – string UTF-8 (valores válidos: `LOG` \$1 `DELETE_FROM_DATABASE` \$1 `DEPRECATE_IN_DATABASE`).

  O comportamento de exclusão quando o crawler encontra um objeto excluído.

## Estrutura LastCrawlInfo
<a name="aws-glue-api-crawler-crawling-LastCrawlInfo"></a>

Informações de status e erro do rastreamento mais recente.

**Campos**
+ `Status` – string UTF-8 (valores válidos: `SUCCEEDED` \$1 `CANCELLED` \$1 `FAILED`).

  Status do último rastreamento.
+ `ErrorMessage` – 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).

  Se ocorrer um erro, as informações de erro do último rastreamento.
+ `LogGroup` – string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a [Log group string pattern](aws-glue-api-common.md#aws-glue-api-regex-logGroup-id).

  O grupo de logs do último rastreamento.
+ `LogStream` – string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a [Log-stream string pattern](aws-glue-api-common.md#aws-glue-api-regex-logStream-id).

  O stream de logs do último rastreamento.
+ `MessagePrefix` – 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 prefixo de uma mensagem sobre este rastreamento.
+ `StartTime` – Timestamp.

  A hora em que o rastreamento foi iniciado.

## Estrutura RecrawlPolicy
<a name="aws-glue-api-crawler-crawling-RecrawlPolicy"></a>

Ao realizar o crawling de uma fonte de dados do Amazon S3 após a conclusão do primeiro rastreamento, especifica se deseja rastrear todo o conjunto de dados novamente ou somente pastas que foram adicionadas desde a última execução do crawler. Para obter mais informações, consulte [Crawls incrementais no AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/incremental-crawls.html) no guia do desenvolvedor.

**Campos**
+ `RecrawlBehavior` – string UTF-8 (valores válidos: `CRAWL_EVERYTHING` \$1 `CRAWL_NEW_FOLDERS_ONLY` \$1 `CRAWL_EVENT_MODE`).

  Especifica se deseja rastrear todo o conjunto de dados novamente ou somente as pastas que foram adicionadas desde a última execução do crawler.

  Um valor de `CRAWL_EVERYTHING` especifica o crawling de todo o conjunto de dados novamente.

  Um valor de `CRAWL_NEW_FOLDERS_ONLY` especifica o crawling de somente as pastas que foram adicionadas desde a última execução do crawler.

  Um valor de `CRAWL_EVENT_MODE` especifica o crawling somente das alterações identificadas pelos eventos do Amazon S3.

## Estrutura LineageConfiguration
<a name="aws-glue-api-crawler-crawling-LineageConfiguration"></a>

Especifica as definições de configuração de linhagem de dados para o crawler.

**Campos**
+ `CrawlerLineageSettings` – string UTF-8 (valores válidos: `ENABLE` \$1 `DISABLE`).

  Especifica se a linhagem de dados está habilitada para o crawler. Os valores válidos são:
  + ENABLE (Habilitar): habilita a linhagem de dados para o crawler
  + DISABLE (Desabilitar): desabilita a linhagem de dados para o crawler

## Estrutura LakeFormationConfiguration
<a name="aws-glue-api-crawler-crawling-LakeFormationConfiguration"></a>

Especifica as definições de configuração do AWS Lake Formation para o crawler.

**Campos**
+ `UseLakeFormationCredentials` – Booleano.

  Especifica se as credenciais AWS Lake Formation devem ser usadas para o crawler em vez das credenciais de função do IAM.
+ `AccountId` – String UTF-8, não mais de 12 bytes.

  Obrigatório para rastreamentos de conta cruzada. Para os mesmos rastreamentos de conta que os dados de destino, isso pode ser deixado como nulo.

## Operações
<a name="aws-glue-api-crawler-crawling-actions"></a>
+ [Ação CreateCrawler (Python: create\$1crawler)](#aws-glue-api-crawler-crawling-CreateCrawler)
+ [Ação DeleteCrawler (Python: delete\$1crawler)](#aws-glue-api-crawler-crawling-DeleteCrawler)
+ [Ação GetCrawler (Python: get\$1crawler)](#aws-glue-api-crawler-crawling-GetCrawler)
+ [Ação GetCrawlers (Python: get\$1crawlers)](#aws-glue-api-crawler-crawling-GetCrawlers)
+ [Ação GetCrawlerMetrics (Python: get\$1crawler\$1metrics)](#aws-glue-api-crawler-crawling-GetCrawlerMetrics)
+ [Ação UpdateCrawler (Python: update\$1crawler)](#aws-glue-api-crawler-crawling-UpdateCrawler)
+ [Ação StartCrawler (Python: start\$1crawler)](#aws-glue-api-crawler-crawling-StartCrawler)
+ [Ação StopCrawler (Python: stop\$1crawler)](#aws-glue-api-crawler-crawling-StopCrawler)
+ [Ação BatchGetCrawlers (Python: batch\$1get\$1crawlers)](#aws-glue-api-crawler-crawling-BatchGetCrawlers)
+ [Ação ListCrawlers (Python: list\$1crawlers)](#aws-glue-api-crawler-crawling-ListCrawlers)
+ [Ação ListCrawls (Python: list\$1crawls)](#aws-glue-api-crawler-crawling-ListCrawls)

## Ação CreateCrawler (Python: create\$1crawler)
<a name="aws-glue-api-crawler-crawling-CreateCrawler"></a>

Cria um novo crawler com destinos específicos, função, configuração e programação opcional. Pelo menos um destino de rastreamento deve ser especificado no campos `s3Targets`, `jdbcTargets` ou `DynamoDBTargets`.

**Solicitaçã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).

  Nome do novo crawler.
+ `Role` – *Obrigatório:* string UTF-8.

  A função do IAM ou o nome do recurso da Amazon (ARN) de um perfil do IAM usada pelo novo crawler para acessar os recursos do cliente.
+ `DatabaseName` – String UTF-8.

  O banco de dados do AWS Glue em que os resultados são gravados, como: `arn:aws:daylight:us-east-1::database/sometable/*`.
+ `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 novo crawler.
+ `Targets` – *Obrigatório:* um objeto [CrawlerTargets](#aws-glue-api-crawler-crawling-CrawlerTargets).

  Uma lista da coleção de destinos a serem rastreados.
+ `Schedule` – String UTF-8.

  Uma expressão `cron` usada para especificar a programação (consulte [Programações baseadas em hora para tarefas e crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). Por exemplo, para executar algo todos os dias às 12h15 UTC, especifique: `cron(15 12 * * ? *)`.
+ `Classifiers` – Uma matriz de strings UTF-8.

  Uma lista de classificadores personalizados que o usuário registrou. Por padrão, todos os classificadores integrados são incluídos em um rastreamento. No entanto, esses classificadores personalizados sempre substituem os classificadores padrão de uma determinada classificação.
+ `TablePrefix` – String UTF-8 com comprimento não superior a 128 bytes.

  O prefixo que é usado para tabelas de catálogo criadas.
+ `SchemaChangePolicy` – Um objeto [SchemaChangePolicy](#aws-glue-api-crawler-crawling-SchemaChangePolicy).

  A política do comportamento de atualização e exclusão do crawler.
+ `RecrawlPolicy` – Um objeto [RecrawlPolicy](#aws-glue-api-crawler-crawling-RecrawlPolicy).

  Uma política que especifica se deseja rastrear todo o conjunto de dados novamente ou rastrear somente pastas que foram adicionadas desde a última execução do crawler.
+ `LineageConfiguration` – Um objeto [LineageConfiguration](#aws-glue-api-crawler-crawling-LineageConfiguration).

  Especifica as definições de configuração de linhagem de dados para o crawler.
+ `LakeFormationConfiguration` – Um objeto [LakeFormationConfiguration](#aws-glue-api-crawler-crawling-LakeFormationConfiguration).

  Especifica as definições de configuração do AWS Lake Formation para o crawler.
+ `Configuration` – String UTF-8.

  Informações de configuração do crawler. Esta string JSON com versionamento permite que os usuários especifiquem os aspectos do comportamento de um crawler. Para obter mais informações, consulte [Definir opções de configuração do crawler](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html).
+ `CrawlerSecurityConfiguration` – String UTF-8 com comprimento não superior a 128 bytes.

  O nome da estrutura `SecurityConfiguration` a ser usada por este crawler.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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 a serem usadas com essa solicitação de crawler. Você pode usar tags para limitar o acesso ao crawler. Para obter mais informações sobre tags no AWS Glue, consulte [Tags da AWS no AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) no guia do desenvolvedor.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`

## Ação DeleteCrawler (Python: delete\$1crawler)
<a name="aws-glue-api-crawler-crawling-DeleteCrawler"></a>

Remove um crawler especificado do AWS Glue Data Catalog, a menos que o estado do crawler seja `RUNNING`.

**Solicitaçã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 crawler a ser removido.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `CrawlerRunningException`
+ `SchedulerTransitioningException`
+ `OperationTimeoutException`

## Ação GetCrawler (Python: get\$1crawler)
<a name="aws-glue-api-crawler-crawling-GetCrawler"></a>

Recupera metadados para um crawler especificado.

**Solicitaçã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 crawler para o qual recuperar os metadados.

**Resposta**
+ `Crawler` – Um objeto [Crawler](#aws-glue-api-crawler-crawling-Crawler).

  Os metadados para o crawler especificado.

**Erros**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## Ação GetCrawlers (Python: get\$1crawlers)
<a name="aws-glue-api-crawler-crawling-GetCrawlers"></a>

Recupera metadados para todos os crawlers definidos na conta do cliente.

**Solicitação**
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número de crawlers a ser retornado em cada chamada.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma solicitação de continuação.

**Resposta**
+ `Crawlers`: um array de objetos [Crawler](#aws-glue-api-crawler-crawling-Crawler).

  Uma lista de metadados do crawler.
+ `NextToken` – String UTF-8.

  Um token de continuação, se a lista retornada não tiver chegado ao final conforme definido nesta conta de cliente.

**Erros**
+ `OperationTimeoutException`

## Ação GetCrawlerMetrics (Python: get\$1crawler\$1metrics)
<a name="aws-glue-api-crawler-crawling-GetCrawlerMetrics"></a>

Recupera métricas dos crawlers especificados.

**Solicitação**
+ `CrawlerNameList` – Uma matriz de strings UTF-8, no máximo 100 strings.

  Uma lista dos nomes dos crawlers de onde as métricas serão recuperadas.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O tamanho máximo de uma lista a ser retornada.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `CrawlerMetricsList`: um array de objetos [CrawlerMetrics](#aws-glue-api-crawler-crawling-CrawlerMetrics).

  Uma lista de métricas para o crawler especificado.
+ `NextToken` – String UTF-8.

  Um token de continuação, se a lista retornada não contiver a métrica mais recente disponível.

**Erros**
+ `OperationTimeoutException`

## Ação UpdateCrawler (Python: update\$1crawler)
<a name="aws-glue-api-crawler-crawling-UpdateCrawler"></a>

Atualiza um crawler. Se um crawler estiver em execução, você precisará interrompê-lo usando `StopCrawler` antes de fazer a atualização.

**Solicitaçã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).

  Nome do novo crawler.
+ `Role` – String UTF-8.

  A função do IAM ou o nome do recurso da Amazon (ARN) de um perfil do IAM que é usada pelo novo crawler para acessar os recursos do cliente.
+ `DatabaseName` – String UTF-8.

  O banco de dados do AWS Glue em que os resultados são armazenados, como: `arn:aws:daylight:us-east-1::database/sometable/*`.
+ `Description`: string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma descrição do novo crawler.
+ `Targets` – Um objeto [CrawlerTargets](#aws-glue-api-crawler-crawling-CrawlerTargets).

  Uma lista de destinos a serem rastreados.
+ `Schedule` – String UTF-8.

  Uma expressão `cron` usada para especificar a programação (consulte [Programações baseadas em hora para tarefas e crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). Por exemplo, para executar algo todos os dias às 12h15 UTC, especifique: `cron(15 12 * * ? *)`.
+ `Classifiers` – Uma matriz de strings UTF-8.

  Uma lista de classificadores personalizados que o usuário registrou. Por padrão, todos os classificadores integrados são incluídos em um rastreamento. No entanto, esses classificadores personalizados sempre substituem os classificadores padrão de uma determinada classificação.
+ `TablePrefix` – String UTF-8 com comprimento não superior a 128 bytes.

  O prefixo que é usado para tabelas de catálogo criadas.
+ `SchemaChangePolicy` – Um objeto [SchemaChangePolicy](#aws-glue-api-crawler-crawling-SchemaChangePolicy).

  A política do comportamento de atualização e exclusão do crawler.
+ `RecrawlPolicy` – Um objeto [RecrawlPolicy](#aws-glue-api-crawler-crawling-RecrawlPolicy).

  Uma política que especifica se deseja rastrear todo o conjunto de dados novamente ou rastrear somente pastas que foram adicionadas desde a última execução do crawler.
+ `LineageConfiguration` – Um objeto [LineageConfiguration](#aws-glue-api-crawler-crawling-LineageConfiguration).

  Especifica as definições de configuração de linhagem de dados para o crawler.
+ `LakeFormationConfiguration` – Um objeto [LakeFormationConfiguration](#aws-glue-api-crawler-crawling-LakeFormationConfiguration).

  Especifica as definições de configuração do AWS Lake Formation para o crawler.
+ `Configuration` – String UTF-8.

  Informações de configuração do crawler. Esta string JSON com versionamento permite que os usuários especifiquem os aspectos do comportamento de um crawler. Para obter mais informações, consulte [Definir opções de configuração do crawler](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html).
+ `CrawlerSecurityConfiguration` – String UTF-8 com comprimento não superior a 128 bytes.

  O nome da estrutura `SecurityConfiguration` a ser usada por este crawler.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `InvalidInputException`
+ `VersionMismatchException`
+ `EntityNotFoundException`
+ `CrawlerRunningException`
+ `OperationTimeoutException`

## Ação StartCrawler (Python: start\$1crawler)
<a name="aws-glue-api-crawler-crawling-StartCrawler"></a>

Inicia um rastreamento usando o crawler especificado, independentemente do que estiver programado. Se o crawler já está em execução, ele retorna um [CrawlerRunningException](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-exceptions.html#aws-glue-api-exceptions-CrawlerRunningException).

**Solicitaçã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).

  Nome do crawler a ser iniciado.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `CrawlerRunningException`
+ `OperationTimeoutException`

## Ação StopCrawler (Python: stop\$1crawler)
<a name="aws-glue-api-crawler-crawling-StopCrawler"></a>

Se o crawler especificado estiver em execução, o rastreamento será interrompido.

**Solicitaçã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).

  Nome do crawler a ser interrompido.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `CrawlerNotRunningException`
+ `CrawlerStoppingException`
+ `OperationTimeoutException`

## Ação BatchGetCrawlers (Python: batch\$1get\$1crawlers)
<a name="aws-glue-api-crawler-crawling-BatchGetCrawlers"></a>

Retorna uma lista de metadados do recurso para uma lista de nomes de crawler. Depois de chamar a operação `ListCrawlers`, você pode chamar essa operação para acessar os dados aos quais você recebeu permissões. Essa operação oferece suporte a todas as permissões do IAM, incluindo condições de permissão que usam tags.

**Solicitação**
+ `CrawlerNames` – *Obrigatório:* uma matriz de strings UTF-8, no máximo 100 strings.

  Uma lista de nomes de crawler, que podem ser os nomes retornados da operação `ListCrawlers`.

**Resposta**
+ `Crawlers`: um array de objetos [Crawler](#aws-glue-api-crawler-crawling-Crawler).

  Uma lista de definições do crawler.
+ `CrawlersNotFound` – Uma matriz de strings UTF-8, no máximo 100 strings.

  Uma lista de nomes de crawlers que não foram encontrados.

**Erros**
+ `InvalidInputException`
+ `OperationTimeoutException`

## Ação ListCrawlers (Python: list\$1crawlers)
<a name="aws-glue-api-crawler-crawling-ListCrawlers"></a>

Recupera os nomes de todos os recursos do crawler nessa conta da AWS ou os recursos com a tag especificada. Essa operação permite que você veja quais recursos estão disponíveis em sua conta e seus nomes.

Essa operação aceita o campo `Tags` opcional, que pode ser usado como um filtro na resposta, para que recursos com tags possam ser recuperados como um grupo. Se você optar por usar a filtragem por tags, apenas os recursos com a tag serão recuperados.

**Solicitação**
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O tamanho máximo de uma lista a ser retornada.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma solicitação de continuação.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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.

  Especifica apenas o retorno desses recursos com tags.

**Resposta**
+ `CrawlerNames` – Uma matriz de strings UTF-8, no máximo 100 strings.

  Os nomes de todos os crawlers na conta ou os crawlers com as tags especificadas.
+ `NextToken` – String UTF-8.

  Um token de continuação, se a lista retornada não contiver a métrica mais recente disponível.

**Erros**
+ `OperationTimeoutException`

## Ação ListCrawls (Python: list\$1crawls)
<a name="aws-glue-api-crawler-crawling-ListCrawls"></a>

Retorna todos os crawls de um crawler especificado. Retorna apenas os crawls que ocorreram desde a data de execução do recurso de histórico do crawler e retém apenas até 12 meses de crawls. Crawls mais antigos não serão retornados.

Você pode usar essa API para:
+ Recuperar todos os crawls de um crawler especificado.
+ Recuperar todos os crawls de um crawler especificado dentro de uma contagem limitada.
+ Recuperar todos os crawls de um crawler especificado em um intervalo de tempo específico.
+ Recuperar todos os crawls de um crawler especificado com um determinado estado, ID de crawl ou valor de hora de DPU.

**Solicitação**
+ `CrawlerName`: *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 crawler cujas execuções você deseja recuperar.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados. O padrão é 20 e o máximo é 100.
+ `Filters`: um array de objetos [CrawlsFilter](#aws-glue-api-crawler-crawling-CrawlsFilter).

  Filtra os crawls de acordo com os critérios especificados em uma lista de objetos de `CrawlsFilter`.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `Crawls`: um array de objetos [CrawlerHistory](#aws-glue-api-crawler-crawling-CrawlerHistory).

  Uma lista de objetos de `CrawlerHistory` que representam as execuções de crawl que satisfazem seus critérios.
+ `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**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`

# API de estatísticas de colunas
<a name="aws-glue-api-crawler-column-statistics"></a>

A API de estatísticas de colunas descreve as APIs do AWS Glue para retornar estatísticas em colunas em uma tabela.

## Tipos de dados
<a name="aws-glue-api-crawler-column-statistics-objects"></a>
+ [Estrutura ColumnStatisticsTaskRun](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun)
+ [Estrutura ColumnStatisticsTaskSettings](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings)
+ [Estrutura ExecutionAttempt](#aws-glue-api-crawler-column-statistics-ExecutionAttempt)

## Estrutura ColumnStatisticsTaskRun
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun"></a>

O objeto que mostra os detalhes da execução das estatísticas da coluna.

**Campos**
+ `CustomerId` – String UTF-8, não mais de 12 bytes.

  O ID da conta da AWS.
+ `ColumnStatisticsTaskRunId` – 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 para a execução da tarefa de estatísticas de coluna específica.
+ `DatabaseName` – String UTF-8.

  O banco de dados em que a tabela reside.
+ `TableName` – String UTF-8.

  O nome da tabela para a qual as estatísticas da coluna são geradas.
+ `ColumnNameList` – Uma matriz de strings UTF-8.

  Uma lista de nomes de coluna. Se nenhum valor for fornecido, todos os nomes de colunas da tabela serão usados por padrã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 valor for fornecido, o ID da conta da AWS será usado por padrão.
+ `Role` – String UTF-8.

  O perfil do IAM assumido pelo serviço para gerar estatísticas.
+ `SampleSize`: número (double), no máximo 100.

  O percentual de linhas usadas para gerar estatísticas. Se nenhum valor for fornecido, a tabela inteira será usada para gerar estatísticas.
+ `SecurityConfiguration` – String UTF-8 com comprimento não superior a 128 bytes.

  Nome da configuração de segurança usada para criptografar os logs do CloudWatch para a execução da tarefa de estatísticas da coluna.
+ `NumberOfWorkers` – Número (inteiro), pelo menos 1.

  O número de operadores usados para gerar estatísticas de coluna. O trabalho é pré-configurado para escalar automaticamente para até 25 instâncias.
+ `WorkerType` – 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 dos operadores usados para gerar estatísticas. O padrão é `g.1x`.
+ `ComputationType`: string UTF-8 (valores válidos: `FULL` \$1 `INCREMENTAL`).

  O tipo de cálculo de estatísticas de coluna.
+ `Status` – String UTF-8 (valores válidos: `STARTING` \$1 `RUNNING` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `STOPPED`).

  O status da execução da tarefa.
+ `CreationTime` – Timestamp.

  O horário em que a tarefa foi criada.
+ `LastUpdated` – Timestamp.

  O momento em que a tarefa foi modificada pela última vez.
+ `StartTime` – Timestamp.

  A hora de início da tarefa.
+ `EndTime` – Timestamp.

  A hora de término da tarefa.
+ `ErrorMessage`: 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 mensagem de erro para o trabalho.
+ `DPUSeconds` – Número (dobro), não mais do que None (Nenhum).

  O uso calculado da DPU em segundos para todos os operadores com escalonamento automático.

## Estrutura ColumnStatisticsTaskSettings
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings"></a>

As configurações para uma tarefa de estatísticas de coluna.

**Campos**
+ `DatabaseName` – String UTF-8.

  O nome do banco de dados no qual a tabela reside.
+ `TableName` – String UTF-8.

  O nome da tabela para a qual as estatísticas de coluna serão geradas.
+ `Schedule` – Um objeto [Programação](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-Schedule).

  Uma programação para executar as estatísticas de coluna especificada na sintaxe CRON.
+ `ColumnNameList` – Uma matriz de strings UTF-8.

  Uma lista de nomes de colunas para as quais estatísticas devem ser executadas.
+ `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.
+ `Role` – String UTF-8.

  O perfil usado para executar as estatísticas de coluna.
+ `SampleSize`: número (double), no máximo 100.

  O percentual de dados para amostrar.
+ `SecurityConfiguration` – String UTF-8 com comprimento não superior a 128 bytes.

  Nome da configuração de segurança usada para criptografar os logs do CloudWatch.
+ `ScheduleType`: string UTF-8 (valores válidos: `CRON` \$1 `AUTO`).

  O tipo de programação para uma tarefa de estatísticas de coluna. Os valores possíveis podem ser `CRON` ou `AUTO`.
+ `SettingSource`: string UTF-8 (valores válidos: `CATALOG` \$1 `TABLE`).

  A fonte de configuração da tarefa de estatísticas de coluna. Os valores possíveis podem ser `CATALOG` ou `TABLE`.
+ `LastExecutionAttempt` – Um objeto [ExecutionAttempt](#aws-glue-api-crawler-column-statistics-ExecutionAttempt).

  A última `ExecutionAttempt` da execução da tarefa de estatísticas de coluna.

## Estrutura ExecutionAttempt
<a name="aws-glue-api-crawler-column-statistics-ExecutionAttempt"></a>

Uma tentativa de execução de uma tarefa de estatísticas de coluna.

**Campos**
+ `Status`: string UTF-8 (valores válidos: `FAILED` \$1 `STARTED`).

  O status da última execução da tarefa de estatísticas de coluna.
+ `ColumnStatisticsTaskRunId` – 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 ID de execução de tarefa para a última execução da tarefa de estatísticas de coluna.
+ `ExecutionTimestamp` – Timestamp.

  Um timestamp em que a última execução da tarefa de estatísticas de coluna ocorreu.
+ `ErrorMessage`: 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 mensagem de erro associada à última execução da tarefa de estatísticas de coluna.

## Operações
<a name="aws-glue-api-crawler-column-statistics-actions"></a>
+ [Ação StartColumnStatisticsTaskRun (Python: start\$1column\$1statistics\$1task\$1run)](#aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRun)
+ [Ação GetColumnStatisticsTaskRun (Python: get\$1column\$1statistics\$1task\$1run)](#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRun)
+ [Ação GetColumnStatisticsTaskRuns (Python: get\$1column\$1statistics\$1task\$1runs)](#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRuns)
+ [Ação ListColumnStatisticsTaskRuns (Python: list\$1column\$1statistics\$1task\$1runs)](#aws-glue-api-crawler-column-statistics-ListColumnStatisticsTaskRuns)
+ [Ação StopColumnStatisticsTaskRun (Python: stop\$1column\$1statistics\$1task\$1run)](#aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRun)
+ [Ação CreateColumnStatisticsTaskSettings (Python: create\$1column\$1statistics\$1task\$1settings)](#aws-glue-api-crawler-column-statistics-CreateColumnStatisticsTaskSettings)
+ [Ação UpdateColumnStatisticsTaskSettings (Python: update\$1column\$1statistics\$1task\$1settings)](#aws-glue-api-crawler-column-statistics-UpdateColumnStatisticsTaskSettings)
+ [Ação GetColumnStatisticsTaskSettings (Python: get\$1column\$1statistics\$1task\$1settings)](#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskSettings)
+ [Ação DeleteColumnStatisticsTaskSettings (Python: delete\$1column\$1statistics\$1task\$1settings)](#aws-glue-api-crawler-column-statistics-DeleteColumnStatisticsTaskSettings)
+ [Ação StartColumnStatisticsTaskRunSchedule (Python: start\$1column\$1statistics\$1task\$1run\$1schedule)](#aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRunSchedule)
+ [Ação StopColumnStatisticsTaskRunSchedule (Python: stop\$1column\$1statistics\$1task\$1run\$1schedule)](#aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRunSchedule)

## Ação StartColumnStatisticsTaskRun (Python: start\$1column\$1statistics\$1task\$1run)
<a name="aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRun"></a>

Inicia a execução de uma tarefa de estatísticas de colunas para uma tabela e colunas especificadas.

**Solicitaçã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 qual a tabela 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 para gerar estatísticas.
+ `ColumnNameList` – Uma matriz de strings UTF-8.

  Uma lista de nomes de colunas para gerar estatísticas. Se nenhum valor for fornecido, todos os nomes de colunas da tabela serão usados por padrão.
+ `Role`: *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 perfil do IAM assumido pelo serviço para gerar estatísticas.
+ `SampleSize`: número (double), no máximo 100.

  O percentual de linhas usadas para gerar estatísticas. Se nenhum valor for fornecido, a tabela inteira será usada para gerar estatísticas.
+ `CatalogID` – 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 do catálogo de dados no qual a tabela reside. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.
+ `SecurityConfiguration` – 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 configuração de segurança usada para criptografar os logs do CloudWatch para a execução da tarefa de estatísticas da coluna.

**Resposta**
+ `ColumnStatisticsTaskRunId` – 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 para a execução da tarefa de estatísticas de colunas.

**Erros**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ColumnStatisticsTaskRunningException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `InvalidInputException`

## Ação GetColumnStatisticsTaskRun (Python: get\$1column\$1statistics\$1task\$1run)
<a name="aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRun"></a>

Obtenha os metadados/informações associados para a execução de uma tarefa com um ID de execução de tarefa específico.

**Solicitação**
+ `ColumnStatisticsTaskRunId`: *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 identificador para a execução da tarefa de estatísticas de coluna específica.

**Resposta**
+ `ColumnStatisticsTaskRun` – Um objeto [ColumnStatisticsTaskRun](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun).

  Um `ColumnStatisticsTaskRun` objeto que representa os detalhes da execução de estatísticas de colunas.

**Erros**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## Ação GetColumnStatisticsTaskRuns (Python: get\$1column\$1statistics\$1task\$1runs)
<a name="aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRuns"></a>

Recupera informações sobre todas as execuções associadas à tabela especificada.

**Solicitação**
+ `DatabaseName` – *Obrigatório:* string UTF-8.

  O nome do banco de dados no qual a tabela 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.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O tamanho máximo da resposta.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `ColumnStatisticsTaskRuns`: um array de objetos [ColumnStatisticsTaskRun](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun).

  Uma lista de execuções de tarefas de estatísticas de colunas.
+ `NextToken` – String UTF-8.

  Um token de continuação, se todas as execuções de tarefas ainda não tiverem sido retornadas.

**Erros**
+ `OperationTimeoutException`

## Ação ListColumnStatisticsTaskRuns (Python: list\$1column\$1statistics\$1task\$1runs)
<a name="aws-glue-api-crawler-column-statistics-ListColumnStatisticsTaskRuns"></a>

Liste todas as execuções tarefas para uma conta específica.

**Solicitação**
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O tamanho máximo da resposta.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `ColumnStatisticsTaskRunIds` – Uma matriz de strings UTF-8, no máximo 100 strings.

  Uma lista IDs de execuções de tarefas de estatísticas de colunas.
+ `NextToken` – String UTF-8.

  Um token de continuação, se todos os IDs de execução de tarefas ainda não tiverem sido retornados.

**Erros**
+ `OperationTimeoutException`

## Ação StopColumnStatisticsTaskRun (Python: stop\$1column\$1statistics\$1task\$1run)
<a name="aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRun"></a>

Interrompe a execução de uma tarefa para a tabela especificada.

**Solicitação**
+ `DatabaseName` – *Obrigatório:* string UTF-8.

  O nome do banco de dados no qual a tabela 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.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `ColumnStatisticsTaskNotRunningException`
+ `ColumnStatisticsTaskStoppingException`
+ `OperationTimeoutException`

## Ação CreateColumnStatisticsTaskSettings (Python: create\$1column\$1statistics\$1task\$1settings)
<a name="aws-glue-api-crawler-column-statistics-CreateColumnStatisticsTaskSettings"></a>

Cria configurações para uma tarefa de estatísticas de coluna.

**Solicitaçã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 qual a tabela 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 para a qual as estatísticas de coluna serão geradas.
+ `Role`: *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 perfil usado para executar as estatísticas de coluna.
+ `Schedule` – String UTF-8.

  Uma programação para executar as estatísticas de coluna especificada na sintaxe CRON.
+ `ColumnNameList` – Uma matriz de strings UTF-8.

  Uma lista de nomes de colunas para as quais estatísticas devem ser executadas.
+ `SampleSize`: número (double), no máximo 100.

  O percentual de dados para amostrar.
+ `CatalogID` – 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 do catálogo de dados em que o banco de dados reside.
+ `SecurityConfiguration` – 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 configuração de segurança usada para criptografar os logs do CloudWatch.
+ `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 mapa de tags.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `AlreadyExistsException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ColumnStatisticsTaskRunningException`

## Ação UpdateColumnStatisticsTaskSettings (Python: update\$1column\$1statistics\$1task\$1settings)
<a name="aws-glue-api-crawler-column-statistics-UpdateColumnStatisticsTaskSettings"></a>

Atualiza as configurações para uma tarefa de estatísticas de coluna.

**Solicitaçã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 qual a tabela 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 para a qual as estatísticas de coluna serão geradas.
+ `Role` – 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 perfil usado para executar as estatísticas de coluna.
+ `Schedule` – String UTF-8.

  Uma programação para executar as estatísticas de coluna especificada na sintaxe CRON.
+ `ColumnNameList` – Uma matriz de strings UTF-8.

  Uma lista de nomes de colunas para as quais estatísticas devem ser executadas.
+ `SampleSize`: número (double), no máximo 100.

  O percentual de dados para amostrar.
+ `CatalogID` – 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 do catálogo de dados em que o banco de dados reside.
+ `SecurityConfiguration` – 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 configuração de segurança usada para criptografar os logs do CloudWatch.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `VersionMismatchException`
+ `OperationTimeoutException`

## Ação GetColumnStatisticsTaskSettings (Python: get\$1column\$1statistics\$1task\$1settings)
<a name="aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskSettings"></a>

Obtém configurações para uma tarefa de estatísticas de coluna.

**Solicitaçã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 qual a tabela 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 para a qual as estatísticas de coluna serão recuperadas.

**Resposta**
+ `ColumnStatisticsTaskSettings` – Um objeto [ColumnStatisticsTaskSettings](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings).

  Um objeto `ColumnStatisticsTaskSettings` que representa as configurações da tarefa de estatísticas de coluna.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## Ação DeleteColumnStatisticsTaskSettings (Python: delete\$1column\$1statistics\$1task\$1settings)
<a name="aws-glue-api-crawler-column-statistics-DeleteColumnStatisticsTaskSettings"></a>

Exclui configurações para uma tarefa de estatísticas de coluna.

**Solicitaçã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 qual a tabela 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 para a qual as estatísticas de coluna serão excluídas.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## Ação StartColumnStatisticsTaskRunSchedule (Python: start\$1column\$1statistics\$1task\$1run\$1schedule)
<a name="aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRunSchedule"></a>

Inicia a programação de execução de uma tarefa de estatísticas de coluna.

**Solicitaçã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 qual a tabela 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 para a qual a programação de execução de uma tarefa de estatísticas de coluna será iniciada.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## Ação StopColumnStatisticsTaskRunSchedule (Python: stop\$1column\$1statistics\$1task\$1run\$1schedule)
<a name="aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRunSchedule"></a>

Interrompe uma programação de execução de uma tarefa de estatísticas de coluna.

**Solicitaçã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 qual a tabela 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 para a qual a programação de execução de uma tarefa de estatísticas de coluna será interrompida.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## Exceções
<a name="aws-glue-api-crawler-column-statistics-exceptions"></a>
+ [Estrutura ColumnStatisticsTaskRunningException](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRunningException)
+ [Estrutura ColumnStatisticsTaskNotRunningException](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskNotRunningException)
+ [Estrutura ColumnStatisticsTaskStoppingException](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskStoppingException)
+ [Estrutura ColumnStatisticsTaskAutoConcurrencyLimitException](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskAutoConcurrencyLimitException)
+ [Estrutura InvalidCatalogSettingException](#aws-glue-api-crawler-column-statistics-InvalidCatalogSettingException)

## Estrutura ColumnStatisticsTaskRunningException
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRunningException"></a>

Uma exceção lançada quando você tenta iniciar outro trabalho enquanto executa um trabalho de geração de estatísticas de coluna.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura ColumnStatisticsTaskNotRunningException
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskNotRunningException"></a>

Uma exceção lançada quando você tenta interromper a execução de uma tarefa quando não há nenhuma tarefa em execução.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura ColumnStatisticsTaskStoppingException
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskStoppingException"></a>

Uma exceção lançada quando você tenta interromper a execução de uma tarefa.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura ColumnStatisticsTaskAutoConcurrencyLimitException
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskAutoConcurrencyLimitException"></a>

Uma exceção lançada quando você já atingiu o limite de trabalhos simultâneos de estatísticas automáticas.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura InvalidCatalogSettingException
<a name="aws-glue-api-crawler-column-statistics-InvalidCatalogSettingException"></a>

Uma exceção lançada quando há um problema com as configurações do catálogo.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

# API do programador do crawler
<a name="aws-glue-api-crawler-scheduler"></a>

A API Crawler scheduler descreve os tipos de dados de crawler do AWS Glue, juntamente com a API para criar, excluir, atualizar e listar crawlers.

## Tipos de dados
<a name="aws-glue-api-crawler-scheduler-objects"></a>
+ [Estrutura Schedule](#aws-glue-api-crawler-scheduler-Schedule)

## Estrutura Schedule
<a name="aws-glue-api-crawler-scheduler-Schedule"></a>

Um objeto de programação que usa uma instrução `cron` para programar um evento.

**Campos**
+ `ScheduleExpression` – String UTF-8.

  Uma expressão `cron` usada para especificar a programação (consulte [Programações baseadas em hora para tarefas e crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). Por exemplo, para executar algo todos os dias às 12h15 UTC, especifique: `cron(15 12 * * ? *)`.
+ `State` – String UTF-8 (valores válidos: `SCHEDULED` \$1 `NOT_SCHEDULED` \$1 `TRANSITIONING`).

  O estado da programação.

## Operações
<a name="aws-glue-api-crawler-scheduler-actions"></a>
+ [Ação UpdateCrawlerSchedule (Python: update\$1crawler\$1schedule)](#aws-glue-api-crawler-scheduler-UpdateCrawlerSchedule)
+ [Ação StartCrawlerSchedule (Python: start\$1crawler\$1schedule)](#aws-glue-api-crawler-scheduler-StartCrawlerSchedule)
+ [Ação StopCrawlerSchedule (Python: stop\$1crawler\$1schedule)](#aws-glue-api-crawler-scheduler-StopCrawlerSchedule)

## Ação UpdateCrawlerSchedule (Python: update\$1crawler\$1schedule)
<a name="aws-glue-api-crawler-scheduler-UpdateCrawlerSchedule"></a>

Atualiza a programação de um crawler usando uma expressão `cron`. 

**Solicitação**
+ `CrawlerName`: *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 crawler cuja programação será atualizada.
+ `Schedule` – String UTF-8.

  A expressão `cron` atualizada usada para especificar a programação (consulte [Programações baseadas em hora para tarefas e crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)). Por exemplo, para executar algo todos os dias às 12h15 UTC, especifique: `cron(15 12 * * ? *)`.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `VersionMismatchException`
+ `SchedulerTransitioningException`
+ `OperationTimeoutException`

## Ação StartCrawlerSchedule (Python: start\$1crawler\$1schedule)
<a name="aws-glue-api-crawler-scheduler-StartCrawlerSchedule"></a>

Altera o estado da programação do crawler especificado para `SCHEDULED`, a menos que ele já esteja em execução ou o estado da programação já seja `SCHEDULED`.

**Solicitação**
+ `CrawlerName`: *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 do crawler a ser programado.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `SchedulerRunningException`
+ `SchedulerTransitioningException`
+ `NoScheduleException`
+ `OperationTimeoutException`

## Ação StopCrawlerSchedule (Python: stop\$1crawler\$1schedule)
<a name="aws-glue-api-crawler-scheduler-StopCrawlerSchedule"></a>

Define o estado da programação do crawler especificado para `NOT_SCHEDULED`, mas não o interrompe se já estiver em execução.

**Solicitação**
+ `CrawlerName`: *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 do crawler cujo estado da programação será definido.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `SchedulerNotRunningException`
+ `SchedulerTransitioningException`
+ `OperationTimeoutException`

# API de scripts de ETL de geração automática
<a name="aws-glue-api-etl-script-generation"></a>

A API de geração de script de ETL descreve os tipos de dados e a API para gerar scripts de ETL no AWS Glue.

## Tipos de dados
<a name="aws-glue-api-etl-script-generation-objects"></a>
+ [Estrutura CodeGenNode](#aws-glue-api-etl-script-generation-CodeGenNode)
+ [Estrutura CodeGenNodeArg](#aws-glue-api-etl-script-generation-CodeGenNodeArg)
+ [Estrutura CodeGenEdge](#aws-glue-api-etl-script-generation-CodeGenEdge)
+ [Estrutura Location](#aws-glue-api-etl-script-generation-Location)
+ [Estrutura CatalogEntry](#aws-glue-api-etl-script-generation-CatalogEntry)
+ [Estrutura MappingEntry](#aws-glue-api-etl-script-generation-MappingEntry)

## Estrutura CodeGenNode
<a name="aws-glue-api-etl-script-generation-CodeGenNode"></a>

Representa um nó em um gráfico acíclico dirigido (DAG)

**Campos**
+ `Id`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Identifier string pattern](aws-glue-api-common.md#aws-glue-api-regex-id).

  Um identificador de nó que é exclusivo no gráfico do nó.
+ `NodeType` – *Obrigatório:* string UTF-8.

  Qual é o tipo de nó.
+ `Args` – *Obrigatório:* uma matriz de [CodeGenNodeArg](#aws-glue-api-etl-script-generation-CodeGenNodeArg) objetos, não mais de 50 estruturas.

  Propriedades do nó, na forma de pares nome-valor.
+ `LineNumber` – Número (íntegro).

  O número de linha do nó.

## Estrutura CodeGenNodeArg
<a name="aws-glue-api-etl-script-generation-CodeGenNodeArg"></a>

Argumento ou propriedade de um nó.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8.

  O nome do argumento ou da propriedade.
+ `Value` – *Obrigatório:* string UTF-8.

  O valor do argumento ou da propriedade.
+ `Param` – Booleano.

  True, se o valor for usado como um parâmetro.

## Estrutura CodeGenEdge
<a name="aws-glue-api-etl-script-generation-CodeGenEdge"></a>

Representa um ponto direcional em um gráfico acíclico dirigido (DAG).

**Campos**
+ `Source`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Identifier string pattern](aws-glue-api-common.md#aws-glue-api-regex-id).

  O ID do nó onde o ponto será iniciado.
+ `Target`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Identifier string pattern](aws-glue-api-common.md#aws-glue-api-regex-id).

  O ID do nó onde o ponto será encerrado.
+ `TargetParameter` – String UTF-8.

  O destino do ponto.

## Estrutura Location
<a name="aws-glue-api-etl-script-generation-Location"></a>

O local dos recursos.

**Campos**
+ `Jdbc` – Uma matriz de [CodeGenNodeArg](#aws-glue-api-etl-script-generation-CodeGenNodeArg) objetos, não mais de 50 estruturas.

  Um local JDBC.
+ `S3` – Uma matriz de [CodeGenNodeArg](#aws-glue-api-etl-script-generation-CodeGenNodeArg) objetos, não mais de 50 estruturas.

  Uma localização do Amazon Simple Storage Service (Amazon S3).
+ `DynamoDB` – Uma matriz de [CodeGenNodeArg](#aws-glue-api-etl-script-generation-CodeGenNodeArg) objetos, não mais de 50 estruturas.

  O local de uma tabela do Amazon DynamoDB.

## Estrutura CatalogEntry
<a name="aws-glue-api-etl-script-generation-CatalogEntry"></a>

Especifica uma definição de tabela no AWS Glue Data Catalog.

**Campos**
+ `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 em que os metadados de tabela 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 em questão.

## Estrutura MappingEntry
<a name="aws-glue-api-etl-script-generation-MappingEntry"></a>

Define um mapeamento.

**Campos**
+ `SourceTable` – String UTF-8.

  O nome da tabela de origem.
+ `SourcePath` – String UTF-8.

  O caminho de origem do .
+ `SourceType` – String UTF-8.

  O tipo de origem.
+ `TargetTable` – String UTF-8.

  O nome da tabela.
+ `TargetPath` – String UTF-8.

  O caminho de destino.
+ `TargetType` – String UTF-8.

  O tipo de destino.

## Operações
<a name="aws-glue-api-etl-script-generation-actions"></a>
+ [Ação CreateScript (Python: create\$1script)](#aws-glue-api-etl-script-generation-CreateScript)
+ [Ação GetDataflowGraph (Python: get\$1dataflow\$1graph)](#aws-glue-api-etl-script-generation-GetDataflowGraph)
+ [Ação GetMapping (Python: get\$1mapping)](#aws-glue-api-etl-script-generation-GetMapping)
+ [Ação GetPlan (Python: get\$1plan)](#aws-glue-api-etl-script-generation-GetPlan)

## Ação CreateScript (Python: create\$1script)
<a name="aws-glue-api-etl-script-generation-CreateScript"></a>

Transforma um gráfico acíclico dirigido (DAG) em código.

**Solicitação**
+ `DagNodes`: um array de objetos [CodeGenNode](#aws-glue-api-etl-script-generation-CodeGenNode).

  Uma lista de nós no DAG.
+ `DagEdges`: um array de objetos [CodeGenEdge](#aws-glue-api-etl-script-generation-CodeGenEdge).

  Uma lista de pontos no DAG.
+ `Language`: string UTF-8 (valores válidos: `PYTHON` \$1 `SCALA`).

  A linguagem de programação do código resultante do DAG.

**Resposta**
+ `PythonScript` – String UTF-8.

  O script Python gerado a partir do DAG.
+ `ScalaCode` – String UTF-8.

  O código Scala gerado a partir do DAG.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetDataflowGraph (Python: get\$1dataflow\$1graph)
<a name="aws-glue-api-etl-script-generation-GetDataflowGraph"></a>

Transforma um script Python em um gráfico acíclico dirigido (DAG). 

**Solicitação**
+ `PythonScript` – String UTF-8.

  O script Python a ser transformado.

**Resposta**
+ `DagNodes`: um array de objetos [CodeGenNode](#aws-glue-api-etl-script-generation-CodeGenNode).

  Uma lista de nós no DAG resultante.
+ `DagEdges`: um array de objetos [CodeGenEdge](#aws-glue-api-etl-script-generation-CodeGenEdge).

  Uma lista de pontos no DAG resultante.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetMapping (Python: get\$1mapping)
<a name="aws-glue-api-etl-script-generation-GetMapping"></a>

Cria mapeamentos.

**Solicitação**
+ `Source` – *Obrigatório:* um objeto [CatalogEntry](#aws-glue-api-etl-script-generation-CatalogEntry).

  Especifica a tabela de origem.
+ `Sinks`: um array de objetos [CatalogEntry](#aws-glue-api-etl-script-generation-CatalogEntry).

  Uma lista de tabelas de destino.
+ `Location` – Um objeto [Local](#aws-glue-api-etl-script-generation-Location).

  Parâmetros para o mapeamento.

**Resposta**
+ `Mapping` – *Obrigatório:* uma matriz de objetos [MappingEntry](#aws-glue-api-etl-script-generation-MappingEntry).

  Uma lista de mapeamentos para os destinos especificados.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `EntityNotFoundException`

## Ação GetPlan (Python: get\$1plan)
<a name="aws-glue-api-etl-script-generation-GetPlan"></a>

Obtém o código para executar um mapeamento especificado.

**Solicitação**
+ `Mapping` – *Obrigatório:* uma matriz de objetos [MappingEntry](#aws-glue-api-etl-script-generation-MappingEntry).

  A lista de mapeamentos de uma tabela de origem para tabelas de destino.
+ `Source` – *Obrigatório:* um objeto [CatalogEntry](#aws-glue-api-etl-script-generation-CatalogEntry).

  A tabela de origem.
+ `Sinks`: um array de objetos [CatalogEntry](#aws-glue-api-etl-script-generation-CatalogEntry).

  O nome das tabelas.
+ `Location` – Um objeto [Local](#aws-glue-api-etl-script-generation-Location).

  Os parâmetros para o mapeamento.
+ `Language`: string UTF-8 (valores válidos: `PYTHON` \$1 `SCALA`).

  A linguagem de programação do código para executar o mapeamento.
+ `AdditionalPlanOptionsMap` – 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 mapa para conter parâmetros de chave-valor opcionais extras.

  Atualmente, estes pares de chave-valor são suportados:
  + `inferSchema`: especifica se é para definir `inferSchema` como true ou false para o script padrão gerado por um trabalho do AWS Glue. Por exemplo, para definir `inferSchema` como true, passe o seguinte par de chave-valor:

    `--additional-plan-options-map '{"inferSchema":"true"}'`

**Resposta**
+ `PythonScript` – String UTF-8.

  Um script Python para executar o mapeamento.
+ `ScalaCode` – String UTF-8.

  O código Scala para executar o mapeamento.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

# API de trabalhos visuais
<a name="aws-glue-api-visual-job-api"></a>

A API de trabalhos visuais permite que você crie trabalhos de integração de dados usando a API do AWS Glue com base em um objeto JSON que representa uma configuração visual de um trabalho do AWS Glue. 

Uma lista de `CodeGenConfigurationNodes` é fornecida a uma API de trabalho de criação ou atualização para registrar um DAG no AWS Glue Studio para o trabalho criado e gerar o código associado.

## Tipos de dados
<a name="aws-glue-api-visual-job-api-objects"></a>
+ [Estrutura CodeGenConfigurationNode](#aws-glue-api-visual-job-api-CodeGenConfigurationNode)
+ [Estrutura JDBCConnectorOptions](#aws-glue-api-visual-job-api-JDBCConnectorOptions)
+ [Estrutura StreamingDataPreviewOptions](#aws-glue-api-visual-job-api-StreamingDataPreviewOptions)
+ [Estrutura AthenaConnectorSource](#aws-glue-api-visual-job-api-AthenaConnectorSource)
+ [Estrutura JDBCConnectorSource](#aws-glue-api-visual-job-api-JDBCConnectorSource)
+ [Estrutura SparkConnectorSource](#aws-glue-api-visual-job-api-SparkConnectorSource)
+ [Estrutura CatalogSource](#aws-glue-api-visual-job-api-CatalogSource)
+ [Estrutura MySQLCatalogSource](#aws-glue-api-visual-job-api-MySQLCatalogSource)
+ [Estrutura PostgreSQLCatalogSource](#aws-glue-api-visual-job-api-PostgreSQLCatalogSource)
+ [Estrutura OracleSQLCatalogSource](#aws-glue-api-visual-job-api-OracleSQLCatalogSource)
+ [Estrutura MicrosoftSQLServerCatalogSource](#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogSource)
+ [Estrutura CatalogKinesisSource](#aws-glue-api-visual-job-api-CatalogKinesisSource)
+ [Estrutura DirectKinesisSource](#aws-glue-api-visual-job-api-DirectKinesisSource)
+ [Estrutura KinesisStreamingSourceOptions](#aws-glue-api-visual-job-api-KinesisStreamingSourceOptions)
+ [Estrutura CatalogKafkaSource](#aws-glue-api-visual-job-api-CatalogKafkaSource)
+ [Estrutura DirectKafkaSource](#aws-glue-api-visual-job-api-DirectKafkaSource)
+ [Estrutura KafkaStreamingSourceOptions](#aws-glue-api-visual-job-api-KafkaStreamingSourceOptions)
+ [Estrutura RedshiftSource](#aws-glue-api-visual-job-api-RedshiftSource)
+ [Estrutura AmazonRedshiftSource](#aws-glue-api-visual-job-api-AmazonRedshiftSource)
+ [Estrutura AmazonRedshiftNodeData](#aws-glue-api-visual-job-api-AmazonRedshiftNodeData)
+ [Estrutura AmazonRedshiftAdvancedOption](#aws-glue-api-visual-job-api-AmazonRedshiftAdvancedOption)
+ [Estrutura Option](#aws-glue-api-visual-job-api-Option)
+ [Estrutura S3CatalogSource](#aws-glue-api-visual-job-api-S3CatalogSource)
+ [Estrutura S3SourceAdditionalOptions](#aws-glue-api-visual-job-api-S3SourceAdditionalOptions)
+ [Estrutura S3CsvSource](#aws-glue-api-visual-job-api-S3CsvSource)
+ [Estrutura DirectJDBCSource](#aws-glue-api-visual-job-api-DirectJDBCSource)
+ [Estrutura S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions)
+ [Estrutura S3JsonSource](#aws-glue-api-visual-job-api-S3JsonSource)
+ [Estrutura S3ParquetSource](#aws-glue-api-visual-job-api-S3ParquetSource)
+ [Estrutura S3DeltaSource](#aws-glue-api-visual-job-api-S3DeltaSource)
+ [Estrutura S3CatalogDeltaSource](#aws-glue-api-visual-job-api-S3CatalogDeltaSource)
+ [Estrutura CatalogDeltaSource](#aws-glue-api-visual-job-api-CatalogDeltaSource)
+ [Estrutura S3HudiSource](#aws-glue-api-visual-job-api-S3HudiSource)
+ [Estrutura S3CatalogHudiSource](#aws-glue-api-visual-job-api-S3CatalogHudiSource)
+ [Estrutura de S3ExcelSource](#aws-glue-api-visual-job-api-S3ExcelSource)
+ [Estrutura CatalogHudiSource](#aws-glue-api-visual-job-api-CatalogHudiSource)
+ [Estrutura DynamoDBCatalogSource](#aws-glue-api-visual-job-api-DynamoDBCatalogSource)
+ [Estrutura RelationalCatalogSource](#aws-glue-api-visual-job-api-RelationalCatalogSource)
+ [Estrutura JDBCConnectorTarget](#aws-glue-api-visual-job-api-JDBCConnectorTarget)
+ [Estrutura SparkConnectorTarget](#aws-glue-api-visual-job-api-SparkConnectorTarget)
+ [Estrutura BasicCatalogTarget](#aws-glue-api-visual-job-api-BasicCatalogTarget)
+ [Estrutura MySQLCatalogTarget](#aws-glue-api-visual-job-api-MySQLCatalogTarget)
+ [Estrutura PostgreSQLCatalogTarget](#aws-glue-api-visual-job-api-PostgreSQLCatalogTarget)
+ [Estrutura OracleSQLCatalogTarget](#aws-glue-api-visual-job-api-OracleSQLCatalogTarget)
+ [Estrutura MicrosoftSQLServerCatalogTarget](#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogTarget)
+ [Estrutura RedshiftTarget](#aws-glue-api-visual-job-api-RedshiftTarget)
+ [Estrutura AmazonRedshiftTarget](#aws-glue-api-visual-job-api-AmazonRedshiftTarget)
+ [Estrutura UpsertRedshiftTargetOptions](#aws-glue-api-visual-job-api-UpsertRedshiftTargetOptions)
+ [Estrutura S3CatalogTarget](#aws-glue-api-visual-job-api-S3CatalogTarget)
+ [Estrutura S3GlueParquetTarget](#aws-glue-api-visual-job-api-S3GlueParquetTarget)
+ [Estrutura CatalogSchemaChangePolicy](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy)
+ [Estrutura S3DirectTarget](#aws-glue-api-visual-job-api-S3DirectTarget)
+ [Estrutura S3HudiCatalogTarget](#aws-glue-api-visual-job-api-S3HudiCatalogTarget)
+ [Estrutura S3HudiDirectTarget](#aws-glue-api-visual-job-api-S3HudiDirectTarget)
+ [Estrutura S3DeltaCatalogTarget](#aws-glue-api-visual-job-api-S3DeltaCatalogTarget)
+ [Estrutura S3DeltaDirectTarget](#aws-glue-api-visual-job-api-S3DeltaDirectTarget)
+ [Estrutura de S3HyperDirectTarget](#aws-glue-api-visual-job-api-S3HyperDirectTarget)
+ [Estrutura de S3IcebergDirectTarget](#aws-glue-api-visual-job-api-S3IcebergDirectTarget)
+ [Estrutura DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy)
+ [Estrutura ApplyMapping](#aws-glue-api-visual-job-api-ApplyMapping)
+ [Estrutura Mapping](#aws-glue-api-visual-job-api-Mapping)
+ [Estrutura SelectFields](#aws-glue-api-visual-job-api-SelectFields)
+ [Estrutura DropFields](#aws-glue-api-visual-job-api-DropFields)
+ [Estrutura RenameField](#aws-glue-api-visual-job-api-RenameField)
+ [Estrutura Spigot](#aws-glue-api-visual-job-api-Spigot)
+ [Estrutura Join](#aws-glue-api-visual-job-api-Join)
+ [Estrutura JoinColumn](#aws-glue-api-visual-job-api-JoinColumn)
+ [Estrutura SplitFields](#aws-glue-api-visual-job-api-SplitFields)
+ [Estrutura SelectFromCollection](#aws-glue-api-visual-job-api-SelectFromCollection)
+ [Estrutura FillMissingValues](#aws-glue-api-visual-job-api-FillMissingValues)
+ [Estrutura Filter](#aws-glue-api-visual-job-api-Filter)
+ [Estrutura FilterExpression](#aws-glue-api-visual-job-api-FilterExpression)
+ [Estrutura FilterValue](#aws-glue-api-visual-job-api-FilterValue)
+ [Estrutura CustomCode](#aws-glue-api-visual-job-api-CustomCode)
+ [Estrutura SparkSQL](#aws-glue-api-visual-job-api-SparkSQL)
+ [Estrutura SqlAlias](#aws-glue-api-visual-job-api-SqlAlias)
+ [Estrutura DropNullFields](#aws-glue-api-visual-job-api-DropNullFields)
+ [Estrutura NullCheckBoxList](#aws-glue-api-visual-job-api-NullCheckBoxList)
+ [Estrutura NullValueField](#aws-glue-api-visual-job-api-NullValueField)
+ [Estrutura Datatype](#aws-glue-api-visual-job-api-Datatype)
+ [Estrutura Merge](#aws-glue-api-visual-job-api-Merge)
+ [Estrutura Union](#aws-glue-api-visual-job-api-Union)
+ [Estrutura PIIDetection](#aws-glue-api-visual-job-api-PIIDetection)
+ [Estrutura Aggregate](#aws-glue-api-visual-job-api-Aggregate)
+ [Estrutura DropDuplicates](#aws-glue-api-visual-job-api-DropDuplicates)
+ [Estrutura GovernedCatalogTarget](#aws-glue-api-visual-job-api-GovernedCatalogTarget)
+ [Estrutura GovernedCatalogSource](#aws-glue-api-visual-job-api-GovernedCatalogSource)
+ [Estrutura AggregateOperation](#aws-glue-api-visual-job-api-AggregateOperation)
+ [Estrutura GlueSchema](#aws-glue-api-visual-job-api-GlueSchema)
+ [Estrutura GlueStudioSchemaColumn](#aws-glue-api-visual-job-api-GlueStudioSchemaColumn)
+ [Estrutura GlueStudioColumn](#aws-glue-api-visual-job-api-GlueStudioColumn)
+ [Estrutura DynamicTransform](#aws-glue-api-visual-job-api-DynamicTransform)
+ [Estrutura TransformConfigParameter](#aws-glue-api-visual-job-api-TransformConfigParameter)
+ [Estrutura EvaluateDataQuality](#aws-glue-api-visual-job-api-EvaluateDataQuality)
+ [Estrutura DQResultsPublishingOptions](#aws-glue-api-visual-job-api-DQResultsPublishingOptions)
+ [Estrutura DQStopJobOnFailureOptions](#aws-glue-api-visual-job-api-DQStopJobOnFailureOptions)
+ [Estrutura EvaluateDataQualityMultiFrame](#aws-glue-api-visual-job-api-EvaluateDataQualityMultiFrame)
+ [Estrutura da fórmula](#aws-glue-api-visual-job-api-Recipe)
+ [Estrutura SchemaReference](#aws-glue-api-visual-job-api-RecipeReference)
+ [Estrutura SnowflakeNodeData](#aws-glue-api-visual-job-api-SnowflakeNodeData)
+ [Estrutura SnowflakeSource](#aws-glue-api-visual-job-api-SnowflakeSource)
+ [Estrutura SnowflakeTarget](#aws-glue-api-visual-job-api-SnowflakeTarget)
+ [Estrutura ConnectorDataSource](#aws-glue-api-visual-job-api-ConnectorDataSource)
+ [Estrutura ConnectorDataTarget](#aws-glue-api-visual-job-api-ConnectorDataTarget)
+ [Estrutura RecipeStep](#aws-glue-api-visual-job-api-RecipeStep)
+ [Estrutura RecipeAction](#aws-glue-api-visual-job-api-RecipeAction)
+ [Estrutura ConditionExpression](#aws-glue-api-visual-job-api-ConditionExpression)
+ [Estrutura S3CatalogIcebergSource](#aws-glue-api-visual-job-api-S3CatalogIcebergSource)
+ [Estrutura CatalogIcebergSource](#aws-glue-api-visual-job-api-CatalogIcebergSource)
+ [Estrutura S3IcebergCatalogTarget](#aws-glue-api-visual-job-api-S3IcebergCatalogTarget)
+ [Estrutura DynamoDBELTConnectorSource](#aws-glue-api-visual-job-api-DynamoDBELTConnectorSource)
+ [Estrutura DDBELTConnectionOptions](#aws-glue-api-visual-job-api-DDBELTConnectionOptions)
+ [Estrutura DDBELTCatalogAdditionalOptions](#aws-glue-api-visual-job-api-DDBELTCatalogAdditionalOptions)
+ [Estrutura de rotas](#aws-glue-api-visual-job-api-Route)
+ [Estrutura GroupFilters](#aws-glue-api-visual-job-api-GroupFilters)
+ [Estrutura AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality)

## Estrutura CodeGenConfigurationNode
<a name="aws-glue-api-visual-job-api-CodeGenConfigurationNode"></a>

`CodeGenConfigurationNode`O enumera todos os tipos de nós válidos. Uma e apenas uma de suas variáveis membro podem ser preenchidas.

**Campos**
+ `AthenaConnectorSource` – Um objeto [AthenaConnectorSource](#aws-glue-api-visual-job-api-AthenaConnectorSource).

  Especifica um conector para uma fonte de dados do Amazon Athena.
+ `JDBCConnectorSource` – Um objeto [JDBCConnectorSource](#aws-glue-api-visual-job-api-JDBCConnectorSource).

  Especifica um conector para uma fonte de dados JDBC.
+ `SparkConnectorSource` – Um objeto [SparkConnectorSource](#aws-glue-api-visual-job-api-SparkConnectorSource).

  Especifica um conector para uma fonte de dados do Apache Spark.
+ `CatalogSource` – Um objeto [CatalogSource](#aws-glue-api-visual-job-api-CatalogSource).

  Especifica um datastore no catálogo de dados do.AWS Glue
+ `RedshiftSource` – Um objeto [RedshiftSource](#aws-glue-api-visual-job-api-RedshiftSource).

  Especifica um datastore do Amazon Redshift.
+ `S3CatalogSource` – Um objeto [S3CatalogSource](#aws-glue-api-visual-job-api-S3CatalogSource).

  Especifica um datastore do Amazon S3 no catálogo de dados do.AWS Glue
+ `S3CsvSource` – Um objeto [S3CSVSource](#aws-glue-api-visual-job-api-S3CsvSource).

  Especifica um datastore CSV (valores separados por comando) armazenado no Amazon S3.
+ `S3JsonSource` – Um objeto [S3JsonSource](#aws-glue-api-visual-job-api-S3JsonSource).

  Especifica um datastore JSON armazenado no Amazon S3.
+ `S3ParquetSource` – Um objeto [S3ParquetSource](#aws-glue-api-visual-job-api-S3ParquetSource).

  Especifica um datastore do Apache Parquet armazenado no Amazon S3.
+ `RelationalCatalogSource` – Um objeto [RelationalCatalogSource](#aws-glue-api-visual-job-api-RelationalCatalogSource).

  Especifica um datastore de catálogo relacional no AWS Glue Data Catalog.
+ `DynamoDBCatalogSource` – Um objeto [DynamoDBCatalogSource](#aws-glue-api-visual-job-api-DynamoDBCatalogSource).

  Especifica um datastore de catálogo relacional do DynamoDBC no AWS Glue Data Catalog.
+ `JDBCConnectorTarget` – Um objeto [JDBCConnectorTarget](#aws-glue-api-visual-job-api-JDBCConnectorTarget).

  Especifica um destino de dados que grava no Amazon S3 no armazenamento colunar do Apache Parquet.
+ `SparkConnectorTarget` – Um objeto [SparkConnectorTarget](#aws-glue-api-visual-job-api-SparkConnectorTarget).

  Especifica um destino que usa um conector Apache Spark.
+ `CatalogTarget` – Um objeto [BasicCatalogTarget](#aws-glue-api-visual-job-api-BasicCatalogTarget).

  Especifica um destino que usa uma tabela do catálogo de dados do AWS Glue.
+ `RedshiftTarget` – Um objeto [RedshiftTarget](#aws-glue-api-visual-job-api-RedshiftTarget).

  Especifica um destino que usa o Amazon Redshift.
+ `S3CatalogTarget` – Um objeto [S3CatalogTarget](#aws-glue-api-visual-job-api-S3CatalogTarget).

  Especifica um destino de dados que grava no Amazon S3 usando o catálogo de dados do AWS Glue.
+ `S3GlueParquetTarget` – Um objeto [S3GlueParquetTarget](#aws-glue-api-visual-job-api-S3GlueParquetTarget).

  Especifica um destino de dados que grava no Amazon S3 no armazenamento colunar do Apache Parquet.
+ `S3DirectTarget` – Um objeto [S3DirectTarget](#aws-glue-api-visual-job-api-S3DirectTarget).

  Especifica um destino de dados que grava no Amazon S3.
+ `ApplyMapping` – Um objeto [ApplyMapping](#aws-glue-api-visual-job-api-ApplyMapping).

  Especifica uma transformação que mapeia chaves de propriedade de dados na fonte dos dados para chaves de propriedade de dados no destino dos dados. Você pode renomear chaves, modificar os tipos de dados para chaves e escolher quais chaves remover do conjunto de dados.
+ `SelectFields` – Um objeto [SelectFields](#aws-glue-api-visual-job-api-SelectFields).

  Especifica uma transformação que escolhe as chaves de propriedade de dados que você deseja manter.
+ `DropFields` – Um objeto [DropFields](#aws-glue-api-visual-job-api-DropFields).

  Especifica uma transformação que escolhe as chaves de propriedade de dados que você deseja descartar.
+ `RenameField` – Um objeto [RenameField](#aws-glue-api-visual-job-api-RenameField).

  Especifica uma transformação que renomeia uma única chave de propriedade de dados.
+ `Spigot` – Um objeto [Spigot](#aws-glue-api-visual-job-api-Spigot).

  Especifica uma transformação que grava amostras dos dados em um bucket do Amazon S3.
+ `Join` – Um objeto [Ingressar](#aws-glue-api-visual-job-api-Join).

  Especifica uma transformação que une dois conjuntos de dados em um só, usando uma frase de comparação nas chaves de propriedade de dados especificadas. Você pode usar junção inner (interna), outer (externa), left (à esquerda), right (à direita), left semi (semi à esquerda) e left anti (anti à esquerda).
+ `SplitFields` – Um objeto [SplitFields](#aws-glue-api-visual-job-api-SplitFields).

  Especifica uma transformação que divide chaves de propriedade de dados em dois `DynamicFrames`. A saída é uma coleção de `DynamicFrames`: um com chaves de propriedade de dados selecionadas e outro com as chaves de propriedade de dados restantes.
+ `SelectFromCollection` – Um objeto [SelectFromCollection](#aws-glue-api-visual-job-api-SelectFromCollection).

  Especifica uma transformação que escolhe um `DynamicFrame` de uma coleção de `DynamicFrames`. A saída é o selecionado. `DynamicFrame`
+ `FillMissingValues` – Um objeto [FillMissingValues](#aws-glue-api-visual-job-api-FillMissingValues).

  Especifica uma transformação que localiza registros no conjunto de dados que tenham valores ausentes e adiciona um novo campo com um valor determinado por imputação. O conjunto de dados de entrada é usado para treinar o modelo de machine learning que determina qual deve ser o valor ausente.
+ `Filter` – Um objeto [Filtro](#aws-glue-api-visual-job-api-Filter).

  Especifica uma transformação que divide um conjunto de dados em dois, com base em uma condição de filtro.
+ `CustomCode` – Um objeto [CustomCode](#aws-glue-api-visual-job-api-CustomCode).

  Especifica uma transformação que usa código personalizado que você fornece para executar a transformação de dados. A saída é uma coleção de DynamicFrames.
+ `SparkSQL` – Um objeto [SparkSQL](#aws-glue-api-visual-job-api-SparkSQL).

  Especifica uma transformação em que você insere uma consulta de SQL usando a sintaxe do Spark SQL para transformar os dados. A saída é um único `DynamicFrame`.
+ `DirectKinesisSource` – Um objeto [DirectKinesisSource](#aws-glue-api-visual-job-api-DirectKinesisSource).

  Especifica uma fonte de dados direta do Amazon Kinesis.
+ `DirectKafkaSource` – Um objeto [DirectKafkaSource](#aws-glue-api-visual-job-api-DirectKafkaSource).

  Especifica um datastore do Apache Kafka.
+ `CatalogKinesisSource` – Um objeto [CatalogKinesisSource](#aws-glue-api-visual-job-api-CatalogKinesisSource).

  Especifica uma fonte de dados do Kinesis no catálogo de dados do AWS Glue.
+ `CatalogKafkaSource` – Um objeto [CatalogKafkaSource](#aws-glue-api-visual-job-api-CatalogKafkaSource).

  Especifica um datastore do Apache Kafka no catálogo de dados.
+ `DropNullFields` – Um objeto [DropNullFields](#aws-glue-api-visual-job-api-DropNullFields).

  Especifica uma transformação que remove colunas do conjunto de dados se todos os valores na coluna forem 'null'. Por padrão, o AWS Glue Studio reconhecerá objetos nulos, mas alguns valores, como strings vazias, strings que sejam "nulas", inteiros -1 ou outros espaços reservados, como zeros, não são automaticamente reconhecidos como nulos.
+ `Merge` – Um objeto [Mesclar](#aws-glue-api-visual-job-api-Merge).

  Especifica uma transformação que mescla um `DynamicFrame` com um `DynamicFrame` de preparação, de acordo com as chaves primárias especificadas para identificar registros. Registros duplicados (com as mesmas chaves primárias) não são eliminados. 
+ `Union` – Um objeto [Union](#aws-glue-api-visual-job-api-Union).

  Especifica uma transformação que combina as linhas de dois ou mais conjuntos de dados em um único resultado.
+ `PIIDetection` – Um objeto [PIIdetection](#aws-glue-api-visual-job-api-PIIDetection).

  Especifica uma transformação que identifica, remove ou mascara dados de PII.
+ `Aggregate` – Um objeto [Agregar](#aws-glue-api-visual-job-api-Aggregate).

  Especifica uma transformação que agrupa linhas por campos escolhidos e calcula o valor agregado por função especificada.
+ `DropDuplicates` – Um objeto [DropDuplicates](#aws-glue-api-visual-job-api-DropDuplicates).

  Especifica uma transformação que remove linhas de dados repetidos de um conjunto de dados.
+ `GovernedCatalogTarget` – Um objeto [GovernedCatalogTarget](#aws-glue-api-visual-job-api-GovernedCatalogTarget).

  Especifica um destino de dados que grava em um catálogo governado.
+ `GovernedCatalogSource` – Um objeto [GovernedCatalogSource](#aws-glue-api-visual-job-api-GovernedCatalogSource).

  Especifica uma fonte de dados em um catálogo de dados governado.
+ `MicrosoftSQLServerCatalogSource` – Um objeto [MicrosoftSQLServerCatalogSource](#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogSource).

  Especifica uma fonte de dados do Microsoft SQL Server no AWS Glue Data Catalog.
+ `MySQLCatalogSource` – Um objeto [MySQLCatalogSource](#aws-glue-api-visual-job-api-MySQLCatalogSource).

  Especifica uma fonte de dados do MySQL no AWS Glue Data Catalog.
+ `OracleSQLCatalogSource` – Um objeto [OracleSQLCatalogSource](#aws-glue-api-visual-job-api-OracleSQLCatalogSource).

  Especifica uma fonte de dados do Oracle no AWS Glue Data Catalog.
+ `PostgreSQLCatalogSource` – Um objeto [PostgreSQLCatalogSource](#aws-glue-api-visual-job-api-PostgreSQLCatalogSource).

  Especifica uma fonte de dados do Postgres SQL no AWS Glue Data Catalog.
+ `MicrosoftSQLServerCatalogTarget` – Um objeto [MicrosoftSQLServerCatalogTarget](#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogTarget).

  Especifica um destino que usa o Microsoft SQL.
+ `MySQLCatalogTarget` – Um objeto [MySQLCatalogTarget](#aws-glue-api-visual-job-api-MySQLCatalogTarget).

  Especifica um destino que usa o MySQL.
+ `OracleSQLCatalogTarget` – Um objeto [OracleSQLCatalogTarget](#aws-glue-api-visual-job-api-OracleSQLCatalogTarget).

  Especifica um destino que usa o Oracle SQL.
+ `PostgreSQLCatalogTarget` – Um objeto [PostgreSQLCatalogTarget](#aws-glue-api-visual-job-api-PostgreSQLCatalogTarget).

  Especifica um destino que usa o Postgres SQL.
+ `Route` – Um objeto [Rota](#aws-glue-api-visual-job-api-Route).

  Especifica um nó de rota que direciona os dados para diferentes caminhos de saída com base em condições de filtragem definidas.
+ `DynamicTransform` – Um objeto [DynamicTransform](#aws-glue-api-visual-job-api-DynamicTransform).

  Especifica uma transformação visual personalizada criada por um usuário.
+ `EvaluateDataQuality` – Um objeto [EvaluateDataQuality](#aws-glue-api-visual-job-api-EvaluateDataQuality).

  Especifica os critérios da avaliação de qualidade dos dados.
+ `S3CatalogHudiSource` – Um objeto [S3CatalogHudiSource](#aws-glue-api-visual-job-api-S3CatalogHudiSource).

  Especifica uma fonte de dados Hudi registrada no AWS Glue Data Catalog. A fonte de dados deve estar armazenada no Amazon S3.
+ `CatalogHudiSource` – Um objeto [CatalogHudiSource](#aws-glue-api-visual-job-api-CatalogHudiSource).

  Especifica uma fonte de dados Hudi registrada no AWS Glue Data Catalog.
+ `S3HudiSource` – Um objeto [S3HudiSource](#aws-glue-api-visual-job-api-S3HudiSource).

  Especifica uma fonte de dados Hudi armazenada no Amazon S3.
+ `S3HudiCatalogTarget` – Um objeto [S3HudiCatalogTarget](#aws-glue-api-visual-job-api-S3HudiCatalogTarget).

  Especifica um destino de dados que grava em uma fonte de dados Hudi no AWS Glue.
+ `S3HudiDirectTarget` – Um objeto [S3HudiDirectTarget](#aws-glue-api-visual-job-api-S3HudiDirectTarget).

  Especifica um destino que grava em uma fonte de dados Hudi no Amazon S3.
+ `S3CatalogDeltaSource` – Um objeto [S3CatalogDeltaSource](#aws-glue-api-visual-job-api-S3CatalogDeltaSource).

  Especifica uma fonte de dados do Delta Lake que é registrada no catálogo de dados do AWS Glue. A fonte de dados deve estar armazenada no Amazon S3.
+ `CatalogDeltaSource` – Um objeto [CatalogDeltaSource](#aws-glue-api-visual-job-api-CatalogDeltaSource).

  Especifica uma fonte de dados do Delta Lake que é registrada no catálogo de dados do AWS Glue.
+ `S3DeltaSource` – Um objeto [S3DeltaSource](#aws-glue-api-visual-job-api-S3DeltaSource).

  Especifica uma fonte de dados do Delta Lake armazenada no Amazon S3.
+ `S3DeltaCatalogTarget` – Um objeto [S3DeltaCatalogTarget](#aws-glue-api-visual-job-api-S3DeltaCatalogTarget).

  Especifica um destino que grava em uma fonte de dados do Delta Lake no catálogo de dados do AWS Glue.
+ `S3DeltaDirectTarget` – Um objeto [S3DeltaDirectTarget](#aws-glue-api-visual-job-api-S3DeltaDirectTarget).

  Especifica um destino que grava em uma fonte de dados do Delta Lake no Amazon S3.
+ `AmazonRedshiftSource` – Um objeto [AmazonRedshiftSource](#aws-glue-api-visual-job-api-AmazonRedshiftSource).

  Especifica um destino que grava em uma fonte de dados no Amazon Redshift.
+ `AmazonRedshiftTarget` – Um objeto [AmazonRedshiftTarget](#aws-glue-api-visual-job-api-AmazonRedshiftTarget).

  Especifica um destino que grava em um destino de dados no Amazon Redshift.
+ `EvaluateDataQualityMultiFrame` – Um objeto [EvaluateDataQualityMultiFrame](#aws-glue-api-visual-job-api-EvaluateDataQualityMultiFrame).

  Especifica os critérios da avaliação de qualidade dos dados. Permite vários dados de entrada e retorna um conjunto de quadros dinâmicos.
+ `Recipe` – Um objeto [Fórmula](#aws-glue-api-visual-job-api-Recipe).

  Especifica um nó de fórmula do AWS Glue DataBrew.
+ `SnowflakeSource` – Um objeto [SnowflakeSource](#aws-glue-api-visual-job-api-SnowflakeSource).

  Especifica uma fonte de dados do Snowflake.
+ `SnowflakeTarget` – Um objeto [SnowflakeTarget](#aws-glue-api-visual-job-api-SnowflakeTarget).

  Especifica um destino que grava em uma fonte de dados do Snowflake.
+ `ConnectorDataSource` – Um objeto [ConnectorDataSource](#aws-glue-api-visual-job-api-ConnectorDataSource).

  Especifica uma fonte gerada com opções de conexão padrão.
+ `ConnectorDataTarget` – Um objeto [ConnectorDataTarget](#aws-glue-api-visual-job-api-ConnectorDataTarget).

  Especifica um destino gerado com opções de conexão padrão.
+ `S3CatalogIcebergSource` – Um objeto [S3CatalogIcebergSource](#aws-glue-api-visual-job-api-S3CatalogIcebergSource).

  Especifica uma fonte de dados Apache Iceberg registrada no Catálogo de dados do AWS Glue. A fonte de dados do Iceberg deve ser armazenada no Amazon S3.
+ `CatalogIcebergSource` – Um objeto [CatalogIcebergSource](#aws-glue-api-visual-job-api-CatalogIcebergSource).

  Especifica uma fonte de dados Apache Iceberg registrada no Catálogo de dados do AWS Glue.
+ `S3IcebergCatalogTarget` – Um objeto [S3IcebergCatalogTarget](#aws-glue-api-visual-job-api-S3IcebergCatalogTarget).

  Especifica um destino do catálogo do Apache Iceberg que grava dados no Amazon S3 e registra a tabela no Catálogo de dados do AWS Glue.
+ `S3IcebergDirectTarget` – Um objeto [S3IcebergDirectTarget](#aws-glue-api-visual-job-api-S3IcebergDirectTarget).

  Define os parâmetros de configuração para gravação de dados no Amazon S3 como uma tabela do Apache Iceberg.
+ `S3ExcelSource` – Um objeto [S3ExcelSource](#aws-glue-api-visual-job-api-S3ExcelSource).

  Define os parâmetros de configuração para leitura de arquivos do Excel no Amazon S3.
+ `S3HyperDirectTarget` – Um objeto [S3HyperDirectTarget](#aws-glue-api-visual-job-api-S3HyperDirectTarget).

  Define os parâmetros de configuração para gravação de dados no Amazon S3 usando a otimização HyperDirect.
+ `DynamoDBELTConnectorSource` – Um objeto [DynamoDBELTConnectorSource](#aws-glue-api-visual-job-api-DynamoDBELTConnectorSource).

  Especifica uma fonte de conector ELT do DynamoDB para a extração de dados de tabelas do DynamoDB.

## Estrutura JDBCConnectorOptions
<a name="aws-glue-api-visual-job-api-JDBCConnectorOptions"></a>

Opções de conexão adicionais para o conector.

**Campos**
+ `FilterPredicate` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cláusula de condição extra para filtrar dados da fonte. Por exemplo:

  `BillingCity='Mountain View'`

  Ao usar uma consulta em vez de um nome de tabela, você deve validar que a consulta funciona com o especificado `filterPredicate`.
+ `PartitionColumn` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome de uma coluna de inteiros usada para o particionamento. Essa opção só funciona quando está incluída em `lowerBound`, `upperBound` e `numPartitions`. Essa opção funciona da mesma maneira que no leitor JDBC Spark SQL.
+ `LowerBound`: número (inteiro longo), no máximo None (Nenhum).

  O valor mínimo de `partitionColumn` que é usado para decidir o passo de partição.
+ `UpperBound`: número (inteiro longo), no máximo None (Nenhum).

  O valor máximo de `partitionColumn` que é usado para decidir o passo de partição.
+ `NumPartitions`: número (inteiro longo), no máximo None (Nenhum).

  O número de partições. Esse valor, juntamente com `lowerBound` (inclusive) e `upperBound` (exclusive), forma os passos de partição para as expressões de cláusula `WHERE` geradas que são usadas para dividir a `partitionColumn`.
+ `JobBookmarkKeys` – Uma matriz de strings UTF-8.

  O nome das chaves de marcador de trabalho pelas quais classificar.
+ `JobBookmarkKeysSortOrder` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica ordem de classificação ascendente ou descendente.
+ `DataTypeMapping` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 (valores válidos: `ARRAY` \$1 `BIGINT` \$1 `BINARY` \$1 `BIT` \$1 `BLOB` \$1 `BOOLEAN` \$1 `CHAR` \$1 `CLOB` \$1 `DATALINK` \$1 `DATE` \$1 `DECIMAL` \$1 `DISTINCT` \$1 `DOUBLE` \$1 `FLOAT` \$1 `INTEGER` \$1 `JAVA_OBJECT` \$1 `LONGNVARCHAR` \$1 `LONGVARBINARY` \$1 `LONGVARCHAR` \$1 `NCHAR` \$1 `NCLOB` \$1 `NULL` \$1 `NUMERIC` \$1 `NVARCHAR` \$1 `OTHER` \$1 `REAL` \$1 `REF` \$1 `REF_CURSOR` \$1 `ROWID` \$1 `SMALLINT` \$1 `SQLXML` \$1 `STRUCT` \$1 `TIME` \$1 `TIME_WITH_TIMEZONE` \$1 `TIMESTAMP` \$1 `TIMESTAMP_WITH_TIMEZONE` \$1 `TINYINT` \$1 `VARBINARY` \$1 `VARCHAR`).

  Cada valor é uma string UTF-8 (valores válidos: `DATE` \$1 `STRING` \$1 `TIMESTAMP` \$1 `INT` \$1 `FLOAT` \$1 `LONG` \$1 `BIGDECIMAL` \$1 `BYTE` \$1 `SHORT` \$1 `DOUBLE`).

  Mapeamento de tipo de dados personalizado que constrói um mapeamento a partir de um tipo de dados JDBC para um tipo de dados do AWS Glue. Por exemplo, a opção `"dataTypeMapping":{"FLOAT":"STRING"}` mapeia campos de dados JDBC do tipo `FLOAT` para o tipo `String` do Java chamando o método `ResultSet.getString()` do driver e o usa para construir o registro AWS Glue. O objeto `ResultSet` é implantado por cada driver, portanto, o comportamento é específico para o driver que você usa. Consulte a documentação do driver do JDBC para entender como ele executa as conversões.

## Estrutura StreamingDataPreviewOptions
<a name="aws-glue-api-visual-job-api-StreamingDataPreviewOptions"></a>

Especifica opções relacionadas à previsualização de dados para exibir uma amostra de seus dados.

**Campos**
+ `PollingTime`: número (longo), pelo menos 10.

  O tempo de sondagem, em milissegundos.
+ `RecordPollingLimit`: número (longo), pelo menos 1.

  O limite para o número de registros sondados.

## Estrutura AthenaConnectorSource
<a name="aws-glue-api-visual-job-api-AthenaConnectorSource"></a>

Especifica um conector para uma fonte de dados do Amazon Athena.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados.
+ `ConnectionName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da conexão associada ao conector.
+ `ConnectorName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome de um conector que ajuda a acessar o datastore no AWS Glue Studio.
+ `ConnectionType` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O tipo de conexão, como marketplace.athena ou custom.athena, designando uma conexão com um datastore do Amazon Athena.
+ `ConnectionTable` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela na fonte de dados.
+ `SchemaName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do grupo de logs do CloudWatch a ser lido. Por exemplo, `/aws-glue/jobs/output`.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte do Athena personalizada.

## Estrutura JDBCConnectorSource
<a name="aws-glue-api-visual-job-api-JDBCConnectorSource"></a>

Especifica um conector para uma fonte de dados JDBC.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados.
+ `ConnectionName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da conexão associada ao conector.
+ `ConnectorName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome de um conector que ajuda a acessar o datastore no AWS Glue Studio.
+ `ConnectionType` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O tipo de conexão, como marketplace.jdbc ou custom.jdbc, designando uma conexão com um datastore JDBC.
+ `AdditionalOptions` – Um objeto [JDBCConnectorOptions](#aws-glue-api-visual-job-api-JDBCConnectorOptions).

  Opções de conexão adicionais para o conector.
+ `ConnectionTable` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela na fonte de dados.
+ `Query` – String UTF-8 correspondente a [Custom string pattern #62](aws-glue-api-common.md#regex_62).

  A tabela ou consulta SQL da qual obter os dados. Você pode especificar `ConnectionTable` ou `query`, mas não os dois.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte do JDBC personalizada.

## Estrutura SparkConnectorSource
<a name="aws-glue-api-visual-job-api-SparkConnectorSource"></a>

Especifica um conector para uma fonte de dados do Apache Spark.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados.
+ `ConnectionName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da conexão associada ao conector.
+ `ConnectorName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome de um conector que ajuda a acessar o datastore no AWS Glue Studio.
+ `ConnectionType` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O tipo de conexão, como marketplace.spark ou custom.spark, designando uma conexão com um datastore do Apache Spark.
+ `AdditionalOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Opções de conexão adicionais para o conector.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte do Spark personalizada.

## Estrutura CatalogSource
<a name="aws-glue-api-visual-job-api-CatalogSource"></a>

Especifica um datastore no catálogo de dados do.AWS Glue

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do datastore.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.
+ `PartitionPredicate` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

   As partições que satisfazem a esse predicado são excluídas. Os arquivos dentro do período de retenção nessas partições não são excluídos. 
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte do catálogo.

## Estrutura MySQLCatalogSource
<a name="aws-glue-api-visual-job-api-MySQLCatalogSource"></a>

Especifica uma fonte de dados do MySQL no AWS Glue Data Catalog.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.

## Estrutura PostgreSQLCatalogSource
<a name="aws-glue-api-visual-job-api-PostgreSQLCatalogSource"></a>

Especifica uma fonte de dados do Postgres SQL no AWS Glue Data Catalog.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.

## Estrutura OracleSQLCatalogSource
<a name="aws-glue-api-visual-job-api-OracleSQLCatalogSource"></a>

Especifica uma fonte de dados do Oracle no AWS Glue Data Catalog.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.

## Estrutura MicrosoftSQLServerCatalogSource
<a name="aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogSource"></a>

Especifica uma fonte de dados do Microsoft SQL Server no AWS Glue Data Catalog.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.

## Estrutura CatalogKinesisSource
<a name="aws-glue-api-visual-job-api-CatalogKinesisSource"></a>

Especifica uma fonte de dados do Kinesis no catálogo de dados do AWS Glue.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados.
+ `WindowSize` – Número (inteiro), não mais do que None (Nenhum).

  A quantidade de tempo gasto no processamento de cada micro lote.
+ `DetectSchema` – Booleano.

  Se o esquema deve ser determinado automaticamente a partir dos dados recebidos.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `StreamingOptions` – Um objeto [KinesisStreamingSourceOptions](#aws-glue-api-visual-job-api-KinesisStreamingSourceOptions).

  Opções adicionais para a fonte de dados de transmissão do Kinesis.
+ `DataPreviewOptions` – Um objeto [StreamingDataPreviewOptions](#aws-glue-api-visual-job-api-StreamingDataPreviewOptions).

  Opções adicionais para previsualização de dados.

## Estrutura DirectKinesisSource
<a name="aws-glue-api-visual-job-api-DirectKinesisSource"></a>

Especifica uma fonte de dados direta do Amazon Kinesis.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados.
+ `WindowSize` – Número (inteiro), não mais do que None (Nenhum).

  A quantidade de tempo gasto no processamento de cada micro lote.
+ `DetectSchema` – Booleano.

  Se o esquema deve ser determinado automaticamente a partir dos dados recebidos.
+ `StreamingOptions` – Um objeto [KinesisStreamingSourceOptions](#aws-glue-api-visual-job-api-KinesisStreamingSourceOptions).

  Opções adicionais para a fonte de dados de transmissão do Kinesis.
+ `DataPreviewOptions` – Um objeto [StreamingDataPreviewOptions](#aws-glue-api-visual-job-api-StreamingDataPreviewOptions).

  Opções adicionais para previsualização de dados.

## Estrutura KinesisStreamingSourceOptions
<a name="aws-glue-api-visual-job-api-KinesisStreamingSourceOptions"></a>

Opções adicionais para a fonte de dados de transmissão do Amazon Kinesis.

**Campos**
+ `EndpointUrl` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O URL do endpoint do Kinesis.
+ `StreamName` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do fluxo de dados do Kinesis.
+ `Classification` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Uma classificação opcional.
+ `Delimiter` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica o caractere delimitador.
+ `StartingPosition` – string UTF-8 (valores válidos: `latest="LATEST"` \$1 `trim_horizon="TRIM_HORIZON"` \$1 `earliest="EARLIEST"` \$1 `timestamp="TIMESTAMP"`).

  A posição inicial no fluxo de dados do Kinesis de onde ler os dados. Os valores possíveis são `"latest"`, `"trim_horizon"`, `"earliest"` ou uma string de timestamp no formato UTC no padrão `yyyy-mm-ddTHH:MM:SSZ` (onde `Z` representa um desvio do fuso horário UTC com \$1/-). Por exemplo: "2023-04-04T08:00:00-04:00"). O valor padrão é `"latest"`.

  Observação: o uso de um valor que é uma string de timestamp no formato UTC para “StartingPosition” só é compatível com o AWS Glue a versão 4.0 ou posterior.
+ `MaxFetchTimeInMs`: número (inteiro longo), no máximo None (Nenhum).

  O tempo máximo para o executor do trabalho ler registros referentes ao lote atual do fluxo de dados do Kinesis especificado em milissegundos (ms). Várias chamadas de API `GetRecords` podem ser feitas nesse período. O valor padrão é `1000`.
+ `MaxFetchRecordsPerShard`: número (inteiro longo), no máximo None (Nenhum).

  O número máximo de registros a serem obtidos por fragmento no fluxo de dados do Kinesis por microlote. Observação: o cliente poderá exceder esse limite se o trabalho de streaming já tiver lido registros extras do Kinesis (na mesma chamada get-records). Se `MaxFetchRecordsPerShard` precisa ser rigoroso, então precisa ser um múltiplo de `MaxRecordPerRead`. O valor padrão é `100000`.
+ `MaxRecordPerRead`: número (inteiro longo), no máximo None (Nenhum).

  O número máximo de registros a serem obtidos por fragmento no fluxo de dados do Kinesis em cada operação getRecords. O valor padrão é `10000`.
+ `AddIdleTimeBetweenReads` – Booleano.

  Adiciona um atraso de tempo entre duas operações getRecords consecutivas. O valor padrão é `"False"`. Essa opção apenas pode ser configurada para o AWS Glue versão 2.0 e acima.
+ `IdleTimeBetweenReadsInMs`: número (inteiro longo), no máximo None (Nenhum).

  O atraso mínimo entre duas operações getRecords consecutivas, especificado em ms. O valor padrão é `1000`. Essa opção apenas pode ser configurada para o AWS Glue versão 2.0 e acima.
+ `DescribeShardInterval`: número (inteiro longo), no máximo None (Nenhum).

  O intervalo de tempo mínimo entre duas chamadas de API ListShards para que seu script considere a refragmentação. O valor padrão é `1s`.
+ `NumRetries` – Número (inteiro), não mais do que None (Nenhum).

  O número máximo de novas tentativas para solicitações de API do Kinesis Data Streams. O valor padrão é `3`.
+ `RetryIntervalMs`: número (inteiro longo), no máximo None (Nenhum).

  O período de espera (especificado em ms) antes de repetir a chamada da API Kinesis Data Streams. O valor padrão é `1000`.
+ `MaxRetryIntervalMs`: número (inteiro longo), no máximo None (Nenhum).

  O período de espera máximo (especificado em ms) entre duas tentativas de uma chamada de API Kinesis Data Streams. O valor padrão é `10000`.
+ `AvoidEmptyBatches` – Booleano.

  Evita a criação de um trabalho de microlote vazio verificando se há dados não lidos no fluxo de dados do Kinesis antes do lote ser iniciado. O valor padrão é `"False"`.
+ `StreamArn` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome de recurso da Amazon (ARN) do fluxo de dados do Kinesis.
+ `RoleArn` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do recurso da Amazon (ARN) da função a ser assumida pelo uso do AWS Security Token Service (AWS STS). Essa função deve ter permissões para descrever ou ler operações de registro para o fluxo de dados do Kinesis. Você deve usar esse parâmetro ao acessar um fluxo de dados em uma conta diferente. Usado em conjunto com `"awsSTSSessionName"`.
+ `RoleSessionName` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Um identificador para a sessão que assume a função usando o AWS STS. Você deve usar esse parâmetro ao acessar um fluxo de dados em uma conta diferente. Usado em conjunto com `"awsSTSRoleARN"`.
+ `AddRecordTimestamp` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Quando essa opção for definida como "true", a saída de dados conterá uma coluna adicional denominada "\$1\$1src\$1timestamp" que indica a hora que o registro correspondente é recebido pelo fluxo. O valor padrão é "false". Essa opção é compatível com o AWS Glue versão 4.0 ou posterior.
+ `EmitConsumerLagMetrics` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Quando a opção for definida como "true", para cada lote, serão emitidas métricas durante o período entre a hora que o registro mais antigo é recebido pelo tópico e a hora que ele chega ao AWS Glue para o CloudWatch. O nome da métrica é "glue.driver.streaming.maxConsumerLagInMs". O valor padrão é "false". Essa opção é compatível com o AWS Glue versão 4.0 ou posterior.
+ `StartingTimestamp` – String UTF-8.

  O timestamp do registro no fluxo de dados do Kinesis para começar a ler os dados. Os valores possíveis são uma string de timestamp no formato UTC no padrão `yyyy-mm-ddTHH:MM:SSZ` (onde Z representa um desvio do fuso horário UTC com \$1/-). Por exemplo: "2023-04-04T08:00:00\$108:00"). 
+ `FanoutConsumerARN` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do recurso da Amazon (ARN) do consumidor de fan-out aprimorado do Kinesis Data Streams. Quando especificado, habilita o fan-out aprimorado para throughput dedicado e menor latência no consumo de dados.

## Estrutura CatalogKafkaSource
<a name="aws-glue-api-visual-job-api-CatalogKafkaSource"></a>

Especifica um datastore do Apache Kafka no catálogo de dados.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do datastore.
+ `WindowSize` – Número (inteiro), não mais do que None (Nenhum).

  A quantidade de tempo gasto no processamento de cada micro lote.
+ `DetectSchema` – Booleano.

  Se o esquema deve ser determinado automaticamente a partir dos dados recebidos.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `StreamingOptions` – Um objeto [KafkaStreamingSourceOptions](#aws-glue-api-visual-job-api-KafkaStreamingSourceOptions).

  Especifica as opções de transmissão.
+ `DataPreviewOptions` – Um objeto [StreamingDataPreviewOptions](#aws-glue-api-visual-job-api-StreamingDataPreviewOptions).

  Especifica opções relacionadas à previsualização de dados para exibir uma amostra de seus dados.

## Estrutura DirectKafkaSource
<a name="aws-glue-api-visual-job-api-DirectKafkaSource"></a>

Especifica um datastore do Apache Kafka.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do datastore.
+ `StreamingOptions` – Um objeto [KafkaStreamingSourceOptions](#aws-glue-api-visual-job-api-KafkaStreamingSourceOptions).

  Especifica as opções de transmissão.
+ `WindowSize` – Número (inteiro), não mais do que None (Nenhum).

  A quantidade de tempo gasto no processamento de cada micro lote.
+ `DetectSchema` – Booleano.

  Se o esquema deve ser determinado automaticamente a partir dos dados recebidos.
+ `DataPreviewOptions` – Um objeto [StreamingDataPreviewOptions](#aws-glue-api-visual-job-api-StreamingDataPreviewOptions).

  Especifica opções relacionadas à previsualização de dados para exibir uma amostra de seus dados.

## Estrutura KafkaStreamingSourceOptions
<a name="aws-glue-api-visual-job-api-KafkaStreamingSourceOptions"></a>

Opções adicionais para transmissões.

**Campos**
+ `BootstrapServers` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Uma lista de URLs do servidor de bootstrap, por exemplo, como `b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094`. Essa opção deve ser especificada na chamada de API ou definida nos metadados da tabela no Data Catalog.
+ `SecurityProtocol` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O protocolo usado para se comunicar com os agentes. Os valores possíveis são `"SSL"` ou `"PLAINTEXT"`.
+ `ConnectionName` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da conexão.
+ `TopicName` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do tópico conforme especificado no Apache Kafka. É necessário especificar pelo menos um `"topicName"`, `"assign"` ou `"subscribePattern"`.
+ `Assign` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  As `TopicPartitions` específicas a consumir. É necessário especificar pelo menos um `"topicName"`, `"assign"` ou `"subscribePattern"`.
+ `SubscribePattern` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Uma string regex Java que identifica a lista de tópicos para assinar. É necessário especificar pelo menos um `"topicName"`, `"assign"` ou `"subscribePattern"`.
+ `Classification` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Uma classificação opcional.
+ `Delimiter` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica o caractere delimitador.
+ `StartingOffsets` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A posição inicial no tópico do Kafka de onde ler os dados. Os valores possíveis são `"earliest"` ou `"latest"`. O valor padrão é `"latest"`.
+ `EndingOffsets` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O ponto final quando uma consulta em lote é encerrada. Os valores possíveis são `"latest"` ou uma string JSON que especifica um deslocamento final para cada `TopicPartition`.
+ `PollTimeoutMs`: número (inteiro longo), no máximo None (Nenhum).

  O tempo limite em milissegundos para sondar dados do Kafka em executores de trabalho do Spark. O valor padrão é `512`.
+ `NumRetries` – Número (inteiro), não mais do que None (Nenhum).

  O número de novas tentativas antes de falhar em obter os deslocamentos do Kafka. O valor padrão é `3`.
+ `RetryIntervalMs`: número (inteiro longo), no máximo None (Nenhum).

  O tempo em milissegundos a se esperar antes de tentar novamente buscar os deslocamentos do Kafka. O valor padrão é `10`.
+ `MaxOffsetsPerTrigger`: número (inteiro longo), no máximo None (Nenhum).

  O limite de taxa no número máximo de deslocamentos que são processados por intervalo do acionador. O número total especificado de deslocamentos é dividido proporcionalmente entre `topicPartitions` de diferentes volumes. O valor padrão é nulo, o que significa que o consumidor lê todos os deslocamentos até o deslocamento mais recente conhecido.
+ `MinPartitions` – Número (inteiro), não mais do que None (Nenhum).

  O número mínimo desejado de partições a serem lidas do Kafka. O valor padrão é nulo, o que significa que o número de partições do Spark é igual ao número de partições do Kafka.
+ `IncludeHeaders` – Booleano.

  Se cabeçalhos do Kafka devem ser incluídos. Quando a opção estiver definida como "true", a saída de dados conterá uma coluna adicional chamada "glue\$1streaming\$1kafka\$1headers" com o tipo `Array[Struct(key: String, value: String)]`. O valor padrão é “false”. Essa opção só está disponível no AWS Glue versão 3.0 ou posterior.
+ `AddRecordTimestamp` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Quando essa opção for definida como “true“, a saída de dados conterá uma coluna adicional denominada "\$1\$1src\$1timestamp" que indica a hora que o registro correspondente é recebido pelo tópico. O valor padrão é "false". Essa opção é compatível com o AWS Glue versão 4.0 ou posterior.
+ `EmitConsumerLagMetrics` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Quando essa opção for definida como "true", para cada lote, serão emitidas métricas durante o período entre a hora que o registro mais antigo é recebido pelo tópico e a hora que ele chega ao AWS Glue. O nome da métrica é "glue.driver.streaming.maxConsumerLagInMs". O valor padrão é "false". Essa opção é compatível com o AWS Glue versão 4.0 ou posterior.
+ `StartingTimestamp` – String UTF-8.

  O timestamp do registro no tópico do Kafka para começar a ler os dados. Os valores possíveis são uma string de timestamp no formato UTC no padrão `yyyy-mm-ddTHH:MM:SSZ` (onde Z representa um desvio do fuso horário UTC com \$1/-). Por exemplo: "2023-04-04T08:00:00\$108:00"). 

  Somente um de `StartingTimestamp` ou `StartingOffsets` deve ser definido.

## Estrutura RedshiftSource
<a name="aws-glue-api-visual-job-api-RedshiftSource"></a>

Especifica um datastore do Amazon Redshift.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do datastore do Amazon Redshift.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A tabela do banco de dados da qual a leitura será feita.
+ `RedshiftTmpDir` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O caminho do Amazon S3 onde dados temporários podem ser preparados ao serem copiados do banco de dados.
+ `TmpDirIAMRole` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A função do IAM com permissões.

## Estrutura AmazonRedshiftSource
<a name="aws-glue-api-visual-job-api-AmazonRedshiftSource"></a>

Especifica uma fonte do Amazon Redshift.

**Campos**
+ `Name` – String UTF-8 correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte do Amazon Redshift.
+ `Data` – Um objeto [AmazonRedshiftNodeData](#aws-glue-api-visual-job-api-AmazonRedshiftNodeData).

  Especifica os dados do nó da fonte do Amazon Reshift.

## Estrutura AmazonRedshiftNodeData
<a name="aws-glue-api-visual-job-api-AmazonRedshiftNodeData"></a>

Especifica um nó do Amazon Redshift.

**Campos**
+ `AccessType` – String UTF-8 correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  O tipo de acesso para a conexão do Redshift. Pode ser uma conexão direta ou conexões de catálogo.
+ `SourceType` – String UTF-8 correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  O tipo de origem para especificar se uma determinada tabela é a fonte ou uma consulta personalizada.
+ `Connection` – Um objeto [Opção](#aws-glue-api-visual-job-api-Option).

  A conexão do AWS Glue com o cluster do Redshift.
+ `Schema` – Um objeto [Opção](#aws-glue-api-visual-job-api-Option).

  O nome do esquema do Redshift ao trabalhar com uma conexão direta.
+ `Table` – Um objeto [Opção](#aws-glue-api-visual-job-api-Option).

  O nome da tabela do Redshift ao trabalhar com uma conexão direta.
+ `CatalogDatabase` – Um objeto [Opção](#aws-glue-api-visual-job-api-Option).

  O nome do banco de dados do catálogo de dados do AWS Glue ao trabalhar com um catálogo de dados.
+ `CatalogTable` – Um objeto [Opção](#aws-glue-api-visual-job-api-Option).

  O nome da tabela do catálogo de dados do AWS Glue ao trabalhar com um catálogo de dados.
+ `CatalogRedshiftSchema` – String UTF-8.

  O nome do esquema do Redshift ao trabalhar com um catálogo de dados.
+ `CatalogRedshiftTable` – String UTF-8.

  A tabela do banco de dados da qual a leitura será feita.
+ `TempDir` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O caminho do Amazon S3 onde dados temporários podem ser preparados ao serem copiados do banco de dados.
+ `IamRole` – Um objeto [Opção](#aws-glue-api-visual-job-api-Option).

  Opcional. O nome do perfil usado ao conectar com o S3. O perfil do IAM, quando deixado em branco, assumirá como padrão o perfil no trabalho.
+ `AdvancedOptions`: um array de objetos [AmazonRedshiftAdvancedOption](#aws-glue-api-visual-job-api-AmazonRedshiftAdvancedOption).

  Valores opcionais ao se conectar ao cluster do Redshift.
+ `SampleQuery` – String UTF-8.

  O SQL usado para buscar os dados de uma fonte do Redshift quando o SourceType é "consulta".
+ `PreAction` – String UTF-8.

  O SQL usado antes de um MERGE ou APPEND com upsert ser executado.
+ `PostAction` – String UTF-8.

  O SQL usado antes de um MERGE ou APPEND com upsert ser executado.
+ `Action` – String UTF-8.

  Especifica como a gravação em um cluster do Redshift ocorrerá.
+ `TablePrefix` – String UTF-8 correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  Especifica o prefixo de uma tabela.
+ `Upsert` – Booleano.

  A ação usada no Redshift vai para o coletor ao fazer um APPEND.
+ `MergeAction` – String UTF-8 correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  A ação usada para determinar como um MERGE em um coletor do Redshift será tratado.
+ `MergeWhenMatched` – String UTF-8 correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  A ação usada para determinar como um MERGE em um coletor do Redshift será tratado quando um registro existente corresponder a um novo registro.
+ `MergeWhenNotMatched` – String UTF-8 correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  A ação usada para determinar como um MERGE em um coletor do Redshift será tratado quando um registro existente não corresponder a um novo registro.
+ `MergeClause` – String UTF-8.

  O SQL usado em uma mesclagem personalizada para lidar com registros correspondentes.
+ `CrawlerConnection` – String UTF-8.

  Especifica o nome da conexão associada à tabela do catálogo usada.
+ `TableSchema`: um array de objetos [Opção](#aws-glue-api-visual-job-api-Option).

  A matriz de saída do esquema para um determinado nó.
+ `StagingTable` – String UTF-8.

  O nome da tabela de preparação temporária usada ao fazer um MERGE ou APPEND com upsert.
+ `SelectedColumns`: um array de objetos [Opção](#aws-glue-api-visual-job-api-Option).

  A lista de nomes de colunas usada para determinar um registro correspondente ao fazer MERGE ou APPEND com upsert.

## Estrutura AmazonRedshiftAdvancedOption
<a name="aws-glue-api-visual-job-api-AmazonRedshiftAdvancedOption"></a>

Especifica um valor opcional ao se conectar ao cluster do Redshift.

**Campos**
+ `Key` – String UTF-8.

  A chave para a opção de conexão adicional.
+ `Value` – String UTF-8.

  O valor para a opção de conexão adicional.

## Estrutura Option
<a name="aws-glue-api-visual-job-api-Option"></a>

Especifica um valor de opção.

**Campos**
+ `Value` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica o valor da opção.
+ `Label` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica o rótulo da opção.
+ `Description` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica a descrição dae opção.

## Estrutura S3CatalogSource
<a name="aws-glue-api-visual-job-api-S3CatalogSource"></a>

Especifica um datastore do Amazon S3 no catálogo de dados do.AWS Glue

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do datastore.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A tabela do banco de dados da qual a leitura será feita.
+ `PartitionPredicate` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  As partições que satisfazem a esse predicado são excluídas. Os arquivos dentro do período de retenção nessas partições não são excluídos. Definido como `""`, vazio por padrão.
+ `AdditionalOptions` – Um objeto [S3SourceAdditionalOptions](#aws-glue-api-visual-job-api-S3SourceAdditionalOptions).

  Especifica opções de conexão adicionais.

## Estrutura S3SourceAdditionalOptions
<a name="aws-glue-api-visual-job-api-S3SourceAdditionalOptions"></a>

Especifica opções de conexão adicionais para o datastore do Amazon S3.

**Campos**
+ `BoundedSize` – Número (extenso).

  Define o limite superior para o tamanho de destino do conjunto de dados em bytes que serão processados.
+ `BoundedFiles` – Número (extenso).

  Define o limite superior para o número alvo de arquivos que serão processados.

## Estrutura S3CsvSource
<a name="aws-glue-api-visual-job-api-S3CsvSource"></a>

Especifica um datastore CSV (valores separados por comando) armazenado no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do datastore.
+ `Paths`: *obrigatório:* uma matriz de strings UTF-8.

  Uma lista de caminhos do Amazon S3 dos quais fazer a leitura.
+ `CompressionType` – String UTF-8 (valores válidos: `gzip="GZIP"` \$1 `bzip2="BZIP2"`).

  Especifica como os dados são compactados. Isso geralmente não é necessário se os dados tem uma extensão de arquivo padrão. Os possíveis valores são `"gzip"` e `"bzip"`).
+ `Exclusions` – Uma matriz de strings UTF-8.

  Uma string contendo uma lista JSON de padrões glob a excluir estilo Unix. Por exemplo, "[\$1"\$1\$1.pdf\$1"]" exclui todos os arquivos PDF. 
+ `GroupSize` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O tamanho do grupo de destino em bytes. O padrão é calculado com base no tamanho de dados de entrada e o tamanho de seu cluster. Quando há menos de 50.000 arquivos de entrada, `"groupFiles"` deve ser definido como `"inPartition"` para poder entrar em vigor.
+ `GroupFiles` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O agrupamento de arquivos é ativado por padrão quando a entrada contiver mais de 50.000 arquivos. Para habilitar o agrupamento com menos de 50.000 arquivos, defina esse parâmetro como "inPartition". Para desabilitar o agrupamento quando houver mais de 50.000 arquivos, defina esse parâmetro como `"none"`.
+ `Recurse` – Booleano.

  Se definido como verdadeiro, recursivamente lê arquivos em todos os subdiretórios de acordo com os caminhos especificados.
+ `MaxBand` – Número (inteiro), não mais do que None (Nenhum).

  Esta opção controla a duração, em milissegundos, após a qual a listagem do s3 provavelmente será consistente. Os arquivos com carimbos de data e hora de modificação que estão dentro dos últimos maxBand milissegundos são rastreados principalmente ao usar JobBookmarks para considerar a consistência final do Amazon S3. A maioria dos usuários não precisa definir essa opção. O valor padrão é 900.000 milissegundos, ou 15 minutos.
+ `MaxFilesInBand` – Número (inteiro), não mais do que None (Nenhum).

  Esta opção especifica o número máximo de arquivos para salvar nos últimos maxBand segundos. Se esse número for excedido, os arquivos extras são ignorados e apenas processados na próxima execução do trabalho.
+ `AdditionalOptions` – Um objeto [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions).

  Especifica opções de conexão adicionais.
+ `Separator` – *obrigatório:* string UTF-8 (valores válidos: `comma="COMMA"` \$1 `ctrla="CTRLA"` \$1 `pipe="PIPE"` \$1 `semicolon="SEMICOLON"` \$1 `tab="TAB"`).

  Especifica o caractere delimitador. O padrão é uma vírgula: ",", mas qualquer outro caractere pode ser especificado.
+ `Escaper` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica um caractere a ser usado para escape. Essa opção é usada somente ao ler arquivos CSV. O valor padrão é `none`. Se ativado, o caractere que imediatamente segue é usado no estado em que se encontram, exceto para um pequeno conjunto de escapes conhecidos (`\n`, `\r`, `\t` e `\0`).
+ `QuoteChar`: *obrigatório:* string UTF-8 (valores válidos: `quote="QUOTE"` \$1 `quillemet="QUILLEMET"` \$1 `single_quote="SINGLE_QUOTE"` \$1 `disabled="DISABLED"`).

  Especifica o caractere a ser usado para aspas. O padrão é aspas duplas: `'"'`. Defina como `-1` para desativar as aspas por completo.
+ `Multiline` – Booleano.

  Um valor booleano que especifica se um único registro pode abranger várias linhas. Isso pode ocorrer quando um campo contém um caractere de nova linha entre aspas. Você deve definir essa opção como True (Verdadeira) se qualquer registro ocupar várias linhas. O valor padrão é `False`, que permite uma divisão de arquivos mais radical durante a análise.
+ `WithHeader` – Booleano.

  Um valor booleano que especifica se é necessário tratar a primeira linha como um cabeçalho. O valor padrão é `False`.
+ `WriteHeader` – Booleano.

  Um valor booleano que especifica se é necessário escrever o cabeçalho na saída. O valor padrão é `True`. 
+ `SkipFirst` – Booleano.

  Um valor booleano que especifica se é necessário ignorar a primeira linha de dados. O valor padrão é `False`.
+ `OptimizePerformance` – Booleano.

  Um valor booleano que especifica se deve usar o leitor SIMD para CSV avançado junto com formatos de memória colunar baseados no Apache Arrow. Disponível somente no AWS Glue versão 3.0.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte CSV do S3.

## Estrutura DirectJDBCSource
<a name="aws-glue-api-visual-job-api-DirectJDBCSource"></a>

Especifica a conexão direta da fonte JDBC.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da conexão da fonte JDBC.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O banco de dados da conexão da fonte JDBC.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A tabela da conexão da fonte JDBC.
+ `ConnectionName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da conexão da fonte JDBC.
+ `ConnectionType` – *obrigatório:* string UTF-8 (valores válidos: `sqlserver` \$1 `mysql` \$1 `oracle` \$1 `postgresql` \$1 `redshift`).

  O tipo de conexão da fonte JDBC.
+ `RedshiftTmpDir` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O diretório temporário da fonte JDBC do Redshift.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte JDBC direta.

## Estrutura S3DirectSourceAdditionalOptions
<a name="aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions"></a>

Especifica opções de conexão adicionais para o datastore do Amazon S3.

**Campos**
+ `BoundedSize` – Número (extenso).

  Define o limite superior para o tamanho de destino do conjunto de dados em bytes que serão processados.
+ `BoundedFiles` – Número (extenso).

  Define o limite superior para o número alvo de arquivos que serão processados.
+ `EnableSamplePath` – Booleano.

  Define a opção para ativar um caminho de exemplo.
+ `SamplePath` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Se ativado, especifica o caminho de exemplo.

## Estrutura S3JsonSource
<a name="aws-glue-api-visual-job-api-S3JsonSource"></a>

Especifica um datastore JSON armazenado no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do datastore.
+ `Paths`: *obrigatório:* uma matriz de strings UTF-8.

  Uma lista de caminhos do Amazon S3 dos quais fazer a leitura.
+ `CompressionType` – String UTF-8 (valores válidos: `gzip="GZIP"` \$1 `bzip2="BZIP2"`).

  Especifica como os dados são compactados. Isso geralmente não é necessário se os dados tem uma extensão de arquivo padrão. Os possíveis valores são `"gzip"` e `"bzip"`).
+ `Exclusions` – Uma matriz de strings UTF-8.

  Uma string contendo uma lista JSON de padrões glob a excluir estilo Unix. Por exemplo, "[\$1"\$1\$1.pdf\$1"]" exclui todos os arquivos PDF. 
+ `GroupSize` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O tamanho do grupo de destino em bytes. O padrão é calculado com base no tamanho de dados de entrada e o tamanho de seu cluster. Quando há menos de 50.000 arquivos de entrada, `"groupFiles"` deve ser definido como `"inPartition"` para poder entrar em vigor.
+ `GroupFiles` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O agrupamento de arquivos é ativado por padrão quando a entrada contiver mais de 50.000 arquivos. Para habilitar o agrupamento com menos de 50.000 arquivos, defina esse parâmetro como "inPartition". Para desabilitar o agrupamento quando houver mais de 50.000 arquivos, defina esse parâmetro como `"none"`.
+ `Recurse` – Booleano.

  Se definido como verdadeiro, recursivamente lê arquivos em todos os subdiretórios de acordo com os caminhos especificados.
+ `MaxBand` – Número (inteiro), não mais do que None (Nenhum).

  Esta opção controla a duração, em milissegundos, após a qual a listagem do s3 provavelmente será consistente. Os arquivos com carimbos de data e hora de modificação que estão dentro dos últimos maxBand milissegundos são rastreados principalmente ao usar JobBookmarks para considerar a consistência final do Amazon S3. A maioria dos usuários não precisa definir essa opção. O valor padrão é 900.000 milissegundos, ou 15 minutos.
+ `MaxFilesInBand` – Número (inteiro), não mais do que None (Nenhum).

  Esta opção especifica o número máximo de arquivos para salvar nos últimos maxBand segundos. Se esse número for excedido, os arquivos extras são ignorados e apenas processados na próxima execução do trabalho.
+ `AdditionalOptions` – Um objeto [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions).

  Especifica opções de conexão adicionais.
+ `JsonPath` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Uma string JsonPath que define os dados JSON.
+ `Multiline` – Booleano.

  Um valor booleano que especifica se um único registro pode abranger várias linhas. Isso pode ocorrer quando um campo contém um caractere de nova linha entre aspas. Você deve definir essa opção como True (Verdadeira) se qualquer registro ocupar várias linhas. O valor padrão é `False`, que permite uma divisão de arquivos mais radical durante a análise.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte JSON do S3.

## Estrutura S3ParquetSource
<a name="aws-glue-api-visual-job-api-S3ParquetSource"></a>

Especifica um datastore do Apache Parquet armazenado no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do datastore.
+ `Paths`: *obrigatório:* uma matriz de strings UTF-8.

  Uma lista de caminhos do Amazon S3 dos quais fazer a leitura.
+ `CompressionType` – String UTF-8 (valores válidos: `snappy="SNAPPY"` \$1 `lzo="LZO"` \$1 `gzip="GZIP"` \$1 `brotli="BROTLI"` \$1 `lz4="LZ4"` \$1 `uncompressed="UNCOMPRESSED"` \$1 `none="NONE"`).

  Especifica como os dados são compactados. Isso geralmente não é necessário se os dados tem uma extensão de arquivo padrão. Os possíveis valores são `"gzip"` e `"bzip"`).
+ `Exclusions` – Uma matriz de strings UTF-8.

  Uma string contendo uma lista JSON de padrões glob a excluir estilo Unix. Por exemplo, "[\$1"\$1\$1.pdf\$1"]" exclui todos os arquivos PDF. 
+ `GroupSize` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O tamanho do grupo de destino em bytes. O padrão é calculado com base no tamanho de dados de entrada e o tamanho de seu cluster. Quando há menos de 50.000 arquivos de entrada, `"groupFiles"` deve ser definido como `"inPartition"` para poder entrar em vigor.
+ `GroupFiles` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O agrupamento de arquivos é ativado por padrão quando a entrada contiver mais de 50.000 arquivos. Para habilitar o agrupamento com menos de 50.000 arquivos, defina esse parâmetro como "inPartition". Para desabilitar o agrupamento quando houver mais de 50.000 arquivos, defina esse parâmetro como `"none"`.
+ `Recurse` – Booleano.

  Se definido como verdadeiro, recursivamente lê arquivos em todos os subdiretórios de acordo com os caminhos especificados.
+ `MaxBand` – Número (inteiro), não mais do que None (Nenhum).

  Esta opção controla a duração, em milissegundos, após a qual a listagem do s3 provavelmente será consistente. Os arquivos com carimbos de data e hora de modificação que estão dentro dos últimos maxBand milissegundos são rastreados principalmente ao usar JobBookmarks para considerar a consistência final do Amazon S3. A maioria dos usuários não precisa definir essa opção. O valor padrão é 900.000 milissegundos, ou 15 minutos.
+ `MaxFilesInBand` – Número (inteiro), não mais do que None (Nenhum).

  Esta opção especifica o número máximo de arquivos para salvar nos últimos maxBand segundos. Se esse número for excedido, os arquivos extras são ignorados e apenas processados na próxima execução do trabalho.
+ `AdditionalOptions` – Um objeto [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions).

  Especifica opções de conexão adicionais.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte Parquet do S3.

## Estrutura S3DeltaSource
<a name="aws-glue-api-visual-job-api-S3DeltaSource"></a>

Especifica uma fonte de dados do Delta Lake armazenada no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte do Delta Lake.
+ `Paths`: *obrigatório:* uma matriz de strings UTF-8.

  Uma lista de caminhos do Amazon S3 dos quais fazer a leitura.
+ `AdditionalDeltaOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica opções de conexão adicionais.
+ `AdditionalOptions` – Um objeto [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions).

  Especifica opções adicionais para o conector.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte do Delta Lake.

## Estrutura S3CatalogDeltaSource
<a name="aws-glue-api-visual-job-api-S3CatalogDeltaSource"></a>

Especifica uma fonte de dados do Delta Lake que é registrada no catálogo de dados do AWS Glue. A fonte de dados deve estar armazenada no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados do Delta Lake.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.
+ `AdditionalDeltaOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica opções de conexão adicionais.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte do Delta Lake.

## Estrutura CatalogDeltaSource
<a name="aws-glue-api-visual-job-api-CatalogDeltaSource"></a>

Especifica uma fonte de dados do Delta Lake que é registrada no catálogo de dados do AWS Glue.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados do Delta Lake.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.
+ `AdditionalDeltaOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica opções de conexão adicionais.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte do Delta Lake.

## Estrutura S3HudiSource
<a name="aws-glue-api-visual-job-api-S3HudiSource"></a>

Especifica uma fonte de dados Hudi armazenada no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte Hudi.
+ `Paths`: *obrigatório:* uma matriz de strings UTF-8.

  Uma lista de caminhos do Amazon S3 dos quais fazer a leitura.
+ `AdditionalHudiOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica opções de conexão adicionais.
+ `AdditionalOptions` – Um objeto [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions).

  Especifica opções adicionais para o conector.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte Hudi.

## Estrutura S3CatalogHudiSource
<a name="aws-glue-api-visual-job-api-S3CatalogHudiSource"></a>

Especifica uma fonte de dados Hudi registrada no AWS Glue Data Catalog. A fonte de dados Hudi deve ser armazenada no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados Hudi.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.
+ `AdditionalHudiOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica opções de conexão adicionais.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte Hudi.

## Estrutura de S3ExcelSource
<a name="aws-glue-api-visual-job-api-S3ExcelSource"></a>

Especifica uma fonte de dados no S3 Excel.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados no S3 Excel.
+ `Paths`: *obrigatório:* uma matriz de strings UTF-8.

  Os caminhos do S3 onde os arquivos do Excel estão localizados.
+ `CompressionType` – string UTF-8 (valores válidos: `snappy="SNAPPY"` \$1 `lzo="LZO"` \$1 `gzip="GZIP"` \$1 `brotli="BROTLI"` \$1 `lz4="LZ4"` \$1 `uncompressed="UNCOMPRESSED"` \$1 `none="NONE"`).

  O formato de compactação usado para os arquivos do Excel.
+ `Exclusions` – Uma matriz de strings UTF-8.

  Padrões para excluir determinados arquivos ou caminhos do processamento.
+ `GroupSize` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Define o tamanho dos grupos de arquivos para processamento em lotes.
+ `GroupFiles` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica como os arquivos devem ser agrupados para processamento.
+ `Recurse` – Booleano.

  Indica se os subdiretórios devem ser processados recursivamente.
+ `MaxBand` – Número (inteiro), não mais do que None (Nenhum).

  O número máximo de faixas de processamento a serem usadas.
+ `MaxFilesInBand` – Número (inteiro), não mais do que None (Nenhum).

  O número máximo de arquivos a serem processados em cada faixa.
+ `AdditionalOptions` – Um objeto [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions).

  Opções adicionais de configuração para processamento direto da fonte no S3.
+ `NumberRows` – Número (extenso).

  O número de linhas a serem processadas de cada arquivo do Excel.
+ `SkipFooter` – Número (inteiro), não mais do que None (Nenhum).

  O número de linhas a serem ignoradas no fim de cada arquivo do Excel.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Os esquemas do AWS Glue a serem aplicados aos dados processados.

## Estrutura CatalogHudiSource
<a name="aws-glue-api-visual-job-api-CatalogHudiSource"></a>

Especifica uma fonte de dados Hudi registrada no AWS Glue Data Catalog.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados Hudi.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.
+ `AdditionalHudiOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica opções de conexão adicionais.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte Hudi.

## Estrutura DynamoDBCatalogSource
<a name="aws-glue-api-visual-job-api-DynamoDBCatalogSource"></a>

Especifica uma fonte de dados do DynamoDB no AWS Glue Data Catalog.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.
+ `PitrEnabled` – Booleano.

  Especifica se a recuperação para um ponto no tempo (PITR) está habilitada para a tabela do DynamoDB. Quando definido como `true`, permite a leitura a partir de um ponto específico no tempo. O valor padrão é `false`.
+ `AdditionalOptions` – Um objeto [DDBELTCatalogAdditionalOptions](#aws-glue-api-visual-job-api-DDBELTCatalogAdditionalOptions).

  Especifica opções de conexão adicionais para a fonte de dados do DynamoDB.

## Estrutura RelationalCatalogSource
<a name="aws-glue-api-visual-job-api-RelationalCatalogSource"></a>

Especifica uma fonte de dados de banco de dados relacional no AWS Glue Data Catalog.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.

## Estrutura JDBCConnectorTarget
<a name="aws-glue-api-visual-job-api-JDBCConnectorTarget"></a>

Especifica um destino de dados que grava no Amazon S3 no armazenamento colunar do Apache Parquet.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `ConnectionName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da conexão associada ao conector.
+ `ConnectionTable` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no destino dos dados.
+ `ConnectorName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome de um conector que será usado.
+ `ConnectionType` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O tipo de conexão, como marketplace.jdbc ou custom.jdbc, designando uma conexão com um destino de dados JDBC.
+ `AdditionalOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Opções de conexão adicionais para o conector.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para o destino do JDBC.

## Estrutura SparkConnectorTarget
<a name="aws-glue-api-visual-job-api-SparkConnectorTarget"></a>

Especifica um destino que usa um conector Apache Spark.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `ConnectionName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome de uma conexão para um conector do Apache Spark.
+ `ConnectorName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome de um conector do Apache Spark.
+ `ConnectionType` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O tipo de conexão, como marketplace.spark ou custom.spark, designando uma conexão com um datastore do Apache Spark.
+ `AdditionalOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Opções de conexão adicionais para o conector.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para o destino do Spark personalizado.

## Estrutura BasicCatalogTarget
<a name="aws-glue-api-visual-job-api-BasicCatalogTarget"></a>

Especifica um destino que usa uma tabela do catálogo de dados do AWS Glue.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do seu destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  As chaves de partição usadas para distribuir dados em várias partições ou fragmentos com base em uma chave específica ou em um conjunto de chaves.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O banco de dados que contém a tabela que você deseja usar como destino. Esse banco de dados já deve existir no Data Catalog.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A tabela que define o esquema dos dados de saída. Essa tabela já deve existir no Data Catalog.

## Estrutura MySQLCatalogTarget
<a name="aws-glue-api-visual-job-api-MySQLCatalogTarget"></a>

Especifica um destino que usa o MySQL.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados no qual gravar.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados na qual gravar.

## Estrutura PostgreSQLCatalogTarget
<a name="aws-glue-api-visual-job-api-PostgreSQLCatalogTarget"></a>

Especifica um destino que usa o Postgres SQL.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados no qual gravar.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados na qual gravar.

## Estrutura OracleSQLCatalogTarget
<a name="aws-glue-api-visual-job-api-OracleSQLCatalogTarget"></a>

Especifica um destino que usa o Oracle SQL.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados no qual gravar.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados na qual gravar.

## Estrutura MicrosoftSQLServerCatalogTarget
<a name="aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogTarget"></a>

Especifica um destino que usa o Microsoft SQL.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados no qual gravar.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados na qual gravar.

## Estrutura RedshiftTarget
<a name="aws-glue-api-visual-job-api-RedshiftTarget"></a>

Especifica um destino que usa o Amazon Redshift.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados no qual gravar.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados na qual gravar.
+ `RedshiftTmpDir` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O caminho do Amazon S3 onde dados temporários podem ser preparados ao serem copiados do banco de dados.
+ `TmpDirIAMRole` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A função do IAM com permissões.
+ `UpsertRedshiftOptions` – Um objeto [UpsertRedshiftTargetOptions](#aws-glue-api-visual-job-api-UpsertRedshiftTargetOptions).

  O conjunto de opções para configurar uma operação upsert ao gravar em um destino do Redshift.

## Estrutura AmazonRedshiftTarget
<a name="aws-glue-api-visual-job-api-AmazonRedshiftTarget"></a>

Especifica um destino do Amazon Redshift.

**Campos**
+ `Name` – String UTF-8 correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino do Amazon Redshift.
+ `Data` – Um objeto [AmazonRedshiftNodeData](#aws-glue-api-visual-job-api-AmazonRedshiftNodeData).

  Especifica os dados do nó de destino do Amazon Redshift.
+ `Inputs`: uma matriz de strings UTF-8, com não menos que 1 nem mais que 1 string.

  Os nós que são entradas para o destino de dados.

## Estrutura UpsertRedshiftTargetOptions
<a name="aws-glue-api-visual-job-api-UpsertRedshiftTargetOptions"></a>

As opções para configurar uma operação upsert ao gravar em um destino do Redshift.

**Campos**
+ `TableLocation` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A localização física da tabela do Redshift.
+ `ConnectionName` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da conexão a ser usada para gravar no Redshift.
+ `UpsertKeys` – Uma matriz de strings UTF-8.

  As chaves usadas para determinar se uma atualização ou uma inserção será executada.

## Estrutura S3CatalogTarget
<a name="aws-glue-api-visual-job-api-S3CatalogTarget"></a>

Especifica um destino de dados que grava no Amazon S3 usando o catálogo de dados do AWS Glue.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Especifica o particionamento nativo usando uma sequência de chaves.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados na qual gravar.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados no qual gravar.
+ `SchemaChangePolicy` – Um objeto [CatalogSchemaChangePolicy](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy).

  Uma política que especifica o comportamentos de atualização do crawler.
+ `AutoDataQuality` – Um objeto [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality).

  Especifica se a avaliação da qualidade dos dados deve ser habilitada automaticamente para o destino do catálogo do S3. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente durante a operação de gravação.

## Estrutura S3GlueParquetTarget
<a name="aws-glue-api-visual-job-api-S3GlueParquetTarget"></a>

Especifica um destino de dados que grava no Amazon S3 no armazenamento colunar do Apache Parquet.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Especifica o particionamento nativo usando uma sequência de chaves.
+ `Path` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Um único caminho do Amazon S3 no qual gravar.
+ `Compression` – String UTF-8 (valores válidos: `snappy="SNAPPY"` \$1 `lzo="LZO"` \$1 `gzip="GZIP"` \$1 `brotli="BROTLI"` \$1 `lz4="LZ4"` \$1 `uncompressed="UNCOMPRESSED"` \$1 `none="NONE"`).

  Especifica como os dados são compactados. Isso geralmente não é necessário se os dados tem uma extensão de arquivo padrão. Os possíveis valores são `"gzip"` e `"bzip"`).
+ `NumberTargetPartitions` – String UTF-8.

  Especifica o número de partições de destino para os arquivos Parquet ao gravar no Amazon S3 usando o AWS Glue.
+ `SchemaChangePolicy` – Um objeto [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy).

  Uma política que especifica o comportamentos de atualização do crawler.
+ `AutoDataQuality` – Um objeto [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality).

  Especifica se a avaliação da qualidade dos dados deve ser habilitada automaticamente para o destino Parquet do S3 AWS Glue. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente durante a operação de gravação.

## Estrutura CatalogSchemaChangePolicy
<a name="aws-glue-api-visual-job-api-CatalogSchemaChangePolicy"></a>

Uma política que especifica o comportamentos de atualização do crawler.

**Campos**
+ `EnableUpdateCatalog` – Booleano.

  Se comportamento de atualização especificado deve ser usado quando o crawler encontra um esquema alterado.
+ `UpdateBehavior` – string UTF-8 (valores válidos: `UPDATE_IN_DATABASE` \$1 `LOG`).

  O comportamento de atualização quando o crawler encontra um esquema alterado.

## Estrutura S3DirectTarget
<a name="aws-glue-api-visual-job-api-S3DirectTarget"></a>

Especifica um destino de dados que grava no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Especifica o particionamento nativo usando uma sequência de chaves.
+ `Path` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Um único caminho do Amazon S3 no qual gravar.
+ `Compression` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica como os dados são compactados. Isso geralmente não é necessário se os dados tem uma extensão de arquivo padrão. Os possíveis valores são `"gzip"` e `"bzip"`).
+ `NumberTargetPartitions` – String UTF-8.

  Especifica o número de partições de destino ao gravar dados diretamente no Amazon S3.
+ `Format`: *obrigatório:* string UTF-8 (valores válidos: `json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`).

  Especifica o formato de saída de dados para o destino.
+ `SchemaChangePolicy` – Um objeto [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy).

  Uma política que especifica o comportamentos de atualização do crawler.
+ `AutoDataQuality` – Um objeto [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality).

  Especifica se a avaliação da qualidade dos dados deve ser habilitada automaticamente para o destino direto do S3. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente durante a operação de gravação.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para o destino direto do S3.

## Estrutura S3HudiCatalogTarget
<a name="aws-glue-api-visual-job-api-S3HudiCatalogTarget"></a>

Especifica um destino de dados que grava em uma fonte de dados Hudi no AWS Glue.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Especifica o particionamento nativo usando uma sequência de chaves.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados na qual gravar.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados no qual gravar.
+ `AdditionalOptions`: *obrigatório:* uma matriz de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica as opções de conexão adicionais para o conector.
+ `SchemaChangePolicy` – Um objeto [CatalogSchemaChangePolicy](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy).

  Uma política que especifica o comportamentos de atualização do crawler.
+ `AutoDataQuality` – Um objeto [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality).

  Especifica se a avaliação da qualidade dos dados deve ser habilitada automaticamente para o destino do catálogo Hudi do S3. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente durante a operação de gravação.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para o destino do catálogo Hudi do S3.

## Estrutura S3HudiDirectTarget
<a name="aws-glue-api-visual-job-api-S3HudiDirectTarget"></a>

Especifica um destino que grava em uma fonte de dados Hudi no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `Path` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O caminho do Amazon S3 da fonte de dados Hudi na qual gravar.
+ `Compression`: *obrigatório:* string UTF-8 (valores válidos: `gzip="GZIP"` \$1 `lzo="LZO"` \$1 `uncompressed="UNCOMPRESSED"` \$1 `snappy="SNAPPY"`).

  Especifica como os dados são compactados. Isso geralmente não é necessário se os dados tem uma extensão de arquivo padrão. Os possíveis valores são `"gzip"` e `"bzip"`).
+ `NumberTargetPartitions` – String UTF-8.

  Especifica o número de partições de destino para distribuição dos arquivos do conjunto de dados do Hudi no Amazon S3.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Especifica o particionamento nativo usando uma sequência de chaves.
+ `Format`: *obrigatório:* string UTF-8 (valores válidos: `json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`).

  Especifica o formato de saída de dados para o destino.
+ `AdditionalOptions`: *obrigatório:* uma matriz de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica as opções de conexão adicionais para o conector.
+ `SchemaChangePolicy` – Um objeto [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy).

  Uma política que especifica o comportamentos de atualização do crawler.
+ `AutoDataQuality` – Um objeto [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality).

  Especifica se a avaliação da qualidade dos dados deve ser habilitada automaticamente para o destino direto Hudi do S3. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente durante a operação de gravação.

## Estrutura S3DeltaCatalogTarget
<a name="aws-glue-api-visual-job-api-S3DeltaCatalogTarget"></a>

Especifica um destino que grava em uma fonte de dados do Delta Lake no catálogo de dados do AWS Glue.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Especifica o particionamento nativo usando uma sequência de chaves.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados na qual gravar.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados no qual gravar.
+ `AdditionalOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica as opções de conexão adicionais para o conector.
+ `SchemaChangePolicy` – Um objeto [CatalogSchemaChangePolicy](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy).

  Uma política que especifica o comportamentos de atualização do crawler.
+ `AutoDataQuality` – Um objeto [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality).

  Especifica se a avaliação da qualidade dos dados deve ser habilitada automaticamente para o destino do catálogo Delta do S3. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente durante a operação de gravação.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para o destino do catálogo Delta do S3.

## Estrutura S3DeltaDirectTarget
<a name="aws-glue-api-visual-job-api-S3DeltaDirectTarget"></a>

Especifica um destino que grava em uma fonte de dados do Delta Lake no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Especifica o particionamento nativo usando uma sequência de chaves.
+ `Path` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O caminho do Amazon S3 da fonte de dados do Delta Lake na qual gravar.
+ `Compression` – *Obrigatório:* string UTF-8 (valores válidos: `uncompressed="UNCOMPRESSED"` \$1 `snappy="SNAPPY"`).

  Especifica como os dados são compactados. Isso geralmente não é necessário se os dados tem uma extensão de arquivo padrão. Os possíveis valores são `"gzip"` e `"bzip"`).
+ `NumberTargetPartitions` – String UTF-8.

  Especifica o número de partições de destino para distribuição dos arquivos do conjunto de dados do Data Lake no Amazon S3.
+ `Format`: *obrigatório:* string UTF-8 (valores válidos: `json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`).

  Especifica o formato de saída de dados para o destino.
+ `AdditionalOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica as opções de conexão adicionais para o conector.
+ `SchemaChangePolicy` – Um objeto [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy).

  Uma política que especifica o comportamentos de atualização do crawler.
+ `AutoDataQuality` – Um objeto [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality).

  Especifica se a avaliação da qualidade dos dados deve ser habilitada automaticamente para o destino direto Delta do S3. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente durante a operação de gravação.

## Estrutura de S3HyperDirectTarget
<a name="aws-glue-api-visual-job-api-S3HyperDirectTarget"></a>

Especifica um destino de dados HyperDirect que grava no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O identificador exclusivo do nó de destino HyperDirect.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Especifica a fonte dos dados de entrada para o destino HyperDirect.
+ `Format` – string UTF-8 (valores válidos: `json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`).

  Especifica o formato de saída de dados para o destino HyperDirect.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Define a estratégia de particionamento dos dados de saída.
+ `Path` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O local no S3 onde os dados de saída serão gravados.
+ `Compression` – string UTF-8 (valores válidos: `uncompressed="UNCOMPRESSED"`).

  O tipo de compactação a ser aplicado aos dados de saída.
+ `SchemaChangePolicy` – Um objeto [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy).

  Define como alterações de esquemas são tratadas durante as operações de gravação.
+ `AutoDataQuality` – Um objeto [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality).

  Especifica se a avaliação da qualidade dos dados deve ser habilitada automaticamente para o destino direto Hyper do S3. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente durante a operação de gravação.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para o destino direto Hyper do S3.

## Estrutura de S3IcebergDirectTarget
<a name="aws-glue-api-visual-job-api-S3IcebergDirectTarget"></a>

Especifica um destino que grava em uma fonte de dados do Iceberg no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  Especifica o identificador exclusivo do nó de destino do Iceberg no pipeline de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Define a única fonte de entrada que fornece dados para esse destino do Iceberg.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Especifica as colunas usadas para particionar dados de tabelas do Iceberg no S3.
+ `Path` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Define o local no S3 onde os dados de tabelas do Iceberg serão armazenados.
+ `Format`: *obrigatório:* string UTF-8 (valores válidos: `json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`).

  Especifica o formato de arquivo usado para armazenar dados de tabelas do Iceberg (por exemplo, Parquet, ORC).
+ `AdditionalOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Fornece outras opções de configuração para personalizar o comportamento das tabelas do Iceberg.
+ `SchemaChangePolicy` – Um objeto [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy).

  Define como as alterações de esquemas são tratadas ao gravar dados na tabela do Iceberg.
+ `Compression`: *obrigatório:* string UTF-8 (valores válidos: `gzip="GZIP"` \$1 `lzo="LZO"` \$1 `uncompressed="UNCOMPRESSED"` \$1 `snappy="SNAPPY"`).

  Especifica o codec de compactação usado para arquivos de tabelas do Iceberg no S3.
+ `NumberTargetPartitions` – String UTF-8.

  Define o número de partições de destino para distribuição de arquivos de tabelas do Iceberg no S3.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para o destino direto Iceberg do S3.

## Estrutura DirectSchemaChangePolicy
<a name="aws-glue-api-visual-job-api-DirectSchemaChangePolicy"></a>

Uma política que especifica o comportamentos de atualização do crawler.

**Campos**
+ `EnableUpdateCatalog` – Booleano.

  Se comportamento de atualização especificado deve ser usado quando o crawler encontra um esquema alterado.
+ `UpdateBehavior` – string UTF-8 (valores válidos: `UPDATE_IN_DATABASE` \$1 `LOG`).

  O comportamento de atualização quando o crawler encontra um esquema alterado.
+ `Table` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica a tabela no banco de dados à qual a política de alteração de esquema se aplica.
+ `Database` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica o banco de dados no qual a política de alteração de esquema se aplica.

## Estrutura ApplyMapping
<a name="aws-glue-api-visual-job-api-ApplyMapping"></a>

Especifica uma transformação que mapeia chaves de propriedade de dados na fonte dos dados para chaves de propriedade de dados no destino dos dados. Você pode renomear chaves, modificar os tipos de dados para chaves e escolher quais chaves remover do conjunto de dados.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `Mapping` – *Obrigatório:* uma matriz de objetos [Mapeamento](#aws-glue-api-visual-job-api-Mapping).

  Especifica o mapeamento das chaves de propriedade de dados na fonte dos dados para chaves de propriedade de dados no destino dos dados.

## Estrutura Mapping
<a name="aws-glue-api-visual-job-api-Mapping"></a>

Especifica o mapeamento de chaves de propriedade de dados.

**Campos**
+ `ToKey` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Após o mapeamento de aplicação, qual deve ser o nome da coluna. Pode ser igual a `FromPath`.
+ `FromPath` – Uma matriz de strings UTF-8.

  A tabela ou coluna a ser modificada.
+ `FromType` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O tipo dos dados a serem modificados.
+ `ToType` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O tipo de dados para o qual os dados devem ser modificados.
+ `Dropped` – Booleano.

  Se verdadeiro, a coluna será removida.
+ `Children`: um array de objetos [Mapeamento](#aws-glue-api-visual-job-api-Mapping).

  Aplicável somente a estruturas de dados aninhadas. Se você quiser alterar a estrutura pai, mas também um de seus filhos, você pode preencher esta estrutura de dados. É também `Mapping`, mas seu `FromPath` será o `FromPath` dos pais mais o `FromPath` dessa estrutura.

  Para a parte dos filhos, suponha que você tenha a estrutura:

  `{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }`

  É possível especificar um `Mapping` parecido com:

  `{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }`

## Estrutura SelectFields
<a name="aws-glue-api-visual-job-api-SelectFields"></a>

Especifica uma transformação que escolhe as chaves de propriedade de dados que você deseja manter.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `Paths`: *obrigatório:* uma matriz de strings UTF-8.

  Um caminho JSON para uma variável na estrutura de dados.

## Estrutura DropFields
<a name="aws-glue-api-visual-job-api-DropFields"></a>

Especifica uma transformação que escolhe as chaves de propriedade de dados que você deseja descartar.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `Paths`: *obrigatório:* uma matriz de strings UTF-8.

  Um caminho JSON para uma variável na estrutura de dados.

## Estrutura RenameField
<a name="aws-glue-api-visual-job-api-RenameField"></a>

Especifica uma transformação que renomeia uma única chave de propriedade de dados.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `SourcePath`: *obrigatório:* uma matriz de strings UTF-8.

  Um caminho JSON para uma variável na estrutura de dados para os dados da fonte.
+ `TargetPath`: *obrigatório:* uma matriz de strings UTF-8.

  Um caminho JSON para uma variável na estrutura de dados para os dados do destino.

## Estrutura Spigot
<a name="aws-glue-api-visual-job-api-Spigot"></a>

Especifica uma transformação que grava amostras dos dados em um bucket do Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `Path` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Um caminho no Amazon S3 onde a transformação grava um subconjunto de registros do conjunto de dados em um arquivo JSON, em um bucket do Amazon S3.
+ `Topk`: número (inteiro), não mais do que 100.

  Especifica vários registros a serem gravados a partir do início do conjunto de dados.
+ `Prob`: número (double), no máximo 1.

  A probabilidade (um valor decimal com um valor máximo de 1) de escolher qualquer registro. Um valor de 1 indica que cada linha lida do conjunto de dados deve ser incluída na saída de amostra.

## Estrutura Join
<a name="aws-glue-api-visual-job-api-Join"></a>

Especifica uma transformação que une dois conjuntos de dados em um só, usando uma frase de comparação nas chaves de propriedade de dados especificadas. Você pode usar junção inner (interna), outer (externa), left (à esquerda), right (à direita), left semi (semi à esquerda) e left anti (anti à esquerda).

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 2 ou mais de 2 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `JoinType` – *obrigatório:* string UTF-8 (valores válidos: `equijoin="EQUIJOIN"` \$1 `left="LEFT"` \$1 `right="RIGHT"` \$1 `outer="OUTER"` \$1 `leftsemi="LEFT_SEMI"` \$1 `leftanti="LEFT_ANTI"`).

  Especifica o tipo de junção a ser executada nos conjuntos de dados.
+ `Columns`: *obrigatório:* uma matriz de objetos [JoinColumn](#aws-glue-api-visual-job-api-JoinColumn), não menos de 2 ou mais de 2 estruturas.

  Uma lista das duas colunas a serem unidas.

## Estrutura JoinColumn
<a name="aws-glue-api-visual-job-api-JoinColumn"></a>

Especifica uma coluna a ser unida.

**Campos**
+ `From` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A coluna a ser unida.
+ `Keys`: *obrigatório:* uma matriz de strings UTF-8.

  A chave da coluna a ser unida.

## Estrutura SplitFields
<a name="aws-glue-api-visual-job-api-SplitFields"></a>

Especifica uma transformação que divide chaves de propriedade de dados em dois `DynamicFrames`. A saída é uma coleção de `DynamicFrames`: um com chaves de propriedade de dados selecionadas e outro com as chaves de propriedade de dados restantes.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `Paths`: *obrigatório:* uma matriz de strings UTF-8.

  Um caminho JSON para uma variável na estrutura de dados.

## Estrutura SelectFromCollection
<a name="aws-glue-api-visual-job-api-SelectFromCollection"></a>

Especifica uma transformação que escolhe um `DynamicFrame` de uma coleção de `DynamicFrames`. A saída é o selecionado. `DynamicFrame`

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `Index` – *Obrigatório:* número (inteiro), não mais do que Nenhum.

  O índice para o DynamicFrame a ser selecionado.

## Estrutura FillMissingValues
<a name="aws-glue-api-visual-job-api-FillMissingValues"></a>

Especifica uma transformação que localiza registros no conjunto de dados que tenham valores ausentes e adiciona um novo campo com um valor determinado por imputação. O conjunto de dados de entrada é usado para treinar o modelo de machine learning que determina qual deve ser o valor ausente.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `ImputedPath` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Um caminho JSON para uma variável na estrutura de dados para o conjunto de dados imputado.
+ `FilledPath` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Um caminho JSON para uma variável na estrutura de dados para o conjunto de dados preenchido.

## Estrutura Filter
<a name="aws-glue-api-visual-job-api-Filter"></a>

Especifica uma transformação que divide um conjunto de dados em dois, com base em uma condição de filtro.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `LogicalOperator` – *Obrigatório:* string UTF-8 (valores válidos: `AND` \$1 `OR`).

  O operador costumava filtrar linhas comparando o valor da chave com um valor especificado.
+ `Filters` – *Obrigatório:* uma matriz de objetos [FilterExpression](#aws-glue-api-visual-job-api-FilterExpression).

  Especifica uma expressão de filtro.

## Estrutura FilterExpression
<a name="aws-glue-api-visual-job-api-FilterExpression"></a>

Especifica uma expressão de filtro.

**Campos**
+ `Operation`: *obrigatório:* string UTF-8 (valores válidos: `EQ` \$1 `LT` \$1 `GT` \$1 `LTE` \$1 `GTE` \$1 `REGEX` \$1 `ISNULL`).

  O tipo de operação a ser executada na expressão.
+ `Negated` – Booleano.

  Se a expressão deve ser negada.
+ `Values` – *Obrigatório:* uma matriz de objetos [FilterValue](#aws-glue-api-visual-job-api-FilterValue).

  Uma lista de valores de filtro.

## Estrutura FilterValue
<a name="aws-glue-api-visual-job-api-FilterValue"></a>

Representa uma única entrada na lista de valores de uma `FilterExpression`. 

**Campos**
+ `Type` – *Obrigatório:* string UTF-8 (valores válidos: `COLUMNEXTRACTED` \$1 `CONSTANT`).

  O tipo de valor do filtro.
+ `Value`: *obrigatório:* uma matriz de strings UTF-8.

  O valor a ser associado.

## Estrutura CustomCode
<a name="aws-glue-api-visual-job-api-CustomCode"></a>

Especifica uma transformação que usa código personalizado que você fornece para executar a transformação de dados. A saída é uma coleção de DynamicFrames.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs` – *Obrigatório:* uma matriz de strings UTF-8, pelo menos 1 string.

  As entradas de dados identificadas por seus nomes de nós.
+ `Code` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #54](aws-glue-api-common.md#regex_54).

  O código personalizado usado para executar a transformação de dados.
+ `ClassName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome definido para a classe de nó de código personalizado.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a transformação de código personalizada.

## Estrutura SparkSQL
<a name="aws-glue-api-visual-job-api-SparkSQL"></a>

Especifica uma transformação em que você insere uma consulta de SQL usando a sintaxe do Spark SQL para transformar os dados. A saída é um único `DynamicFrame`.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs` – *Obrigatório:* uma matriz de strings UTF-8, pelo menos 1 string.

  As entradas de dados identificadas por seus nomes de nós. Você pode associar um nome de tabela a cada nó de entrada a ser usado na consulta SQL. O nome escolhido deve atender às restrições de nomenclatura do Spark SQL.
+ `SqlQuery` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #62](aws-glue-api-common.md#regex_62).

  Uma consulta SQL que deve usar a sintaxe do Spark SQL e retornar um único conjunto de dados.
+ `SqlAliases` – *Obrigatório:* uma matriz de objetos [SqlAlias](#aws-glue-api-visual-job-api-SqlAlias).

  Uma lista de aliases. Um alias permite especificar qual nome usar no SQL para uma determinada entrada. Por exemplo, você tem uma fonte de dados chamada "MyDataSource". Se você especificar `From` como MyDataSource, e `Alias` como SqlName, então, em seu SQL, você pode fazer:

  `select * from SqlName`

  e isso obtém dados de MyDataSource.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a transformação do SparkSQL.

## Estrutura SqlAlias
<a name="aws-glue-api-visual-job-api-SqlAlias"></a>

Representa uma única entrada na lista de valores de `SqlAliases`. 

**Campos**
+ `From` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  Uma tabela ou uma coluna em uma tabela.
+ `Alias` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Um nome temporário dado a uma tabela ou a uma coluna em uma tabela.

## Estrutura DropNullFields
<a name="aws-glue-api-visual-job-api-DropNullFields"></a>

Especifica uma transformação que remove colunas do conjunto de dados se todos os valores na coluna forem 'null'. Por padrão, o AWS Glue Studio reconhecerá objetos nulos, mas alguns valores, como strings vazias, strings que sejam "nulas", inteiros -1 ou outros espaços reservados, como zeros, não são automaticamente reconhecidos como nulos.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `NullCheckBoxList` – Um objeto [NullCheckBoxList](#aws-glue-api-visual-job-api-NullCheckBoxList).

  Uma estrutura que representa se determinados valores são reconhecidos como valores nulos para remoção.
+ `NullTextList` – Uma matriz de [NullValueField](#aws-glue-api-visual-job-api-NullValueField) objetos, não mais de 50 estruturas.

  Uma estrutura que especifica uma lista de estruturas NullValueField que representam um valor nulo personalizado, como zero ou outro valor sendo usado como um espaço reservado nulo exclusivo para o conjunto de dados.

  A transformação `DropNullFields` remove valores nulos personalizados somente se o valor do espaço reservado nulo e o tipo de dados corresponderem aos dados.

## Estrutura NullCheckBoxList
<a name="aws-glue-api-visual-job-api-NullCheckBoxList"></a>

Representa se determinados valores são reconhecidos como valores nulos para remoção.

**Campos**
+ `IsEmpty` – Booleano.

  Especifica que uma string vazia é considerada como um valor nulo.
+ `IsNullString` – Booleano.

  Especifica que um valor com a palavra "null" é considerado como um valor nulo.
+ `IsNegOne` – Booleano.

  Especifica que um valor inteiro de -1 é considerado como um valor nulo.

## Estrutura NullValueField
<a name="aws-glue-api-visual-job-api-NullValueField"></a>

Representa um valor nulo personalizado, como zeros ou outros valores sendo usados como um espaço reservado para nulo exclusivo para o conjunto de dados.

**Campos**
+ `Value` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O valor do espaço reservado para nulo.
+ `Datatype` – *Obrigatório:* um objeto [DataType](#aws-glue-api-visual-job-api-Datatype).

  O tipo de dados do valor.

## Estrutura Datatype
<a name="aws-glue-api-visual-job-api-Datatype"></a>

Uma estrutura que representa o tipo de dados do valor.

**Campos**
+ `Id` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  O tipo de dados do valor.
+ `Label` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  Um rótulo atribuído ao tipo de dados.

## Estrutura Merge
<a name="aws-glue-api-visual-job-api-Merge"></a>

Especifica uma transformação que mescla um `DynamicFrame` com um `DynamicFrame` de preparação, de acordo com as chaves primárias especificadas para identificar registros. Registros duplicados (com as mesmas chaves primárias) não são eliminados. 

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 2 ou mais de 2 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `Source` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  O `DynamicFrame` da fonte que será mesclado com um `DynamicFrame` de preparação.
+ `PrimaryKeys`: *obrigatório:* uma matriz de strings UTF-8.

  A lista de campos de chave primária para corresponder aos registros da fonte e quadros dinâmicos de preparação.

## Estrutura Union
<a name="aws-glue-api-visual-job-api-Union"></a>

Especifica uma transformação que combina as linhas de dois ou mais conjuntos de dados em um único resultado.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 2 ou mais de 2 strings.

  A entrada do ID do nó na transformação.
+ `UnionType` – *Obrigatório:* string UTF-8 (valores válidos: `ALL` \$1 `DISTINCT`).

  Indica o tipo de transformação Union. 

  Especifica `ALL` para unir todas as linhas de fontes de dados ao DynamicFrame resultante. A união resultante não remove linhas duplicadas.

  Especifica `DISTINCT` para remover linhas duplicadas no DynamicFrame resultante.

## Estrutura PIIDetection
<a name="aws-glue-api-visual-job-api-PIIDetection"></a>

Especifica uma transformação que identifica, remove ou mascara dados de PII.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  A entrada do ID do nó na transformação.
+ `PiiType`: *obrigatório:* string UTF-8 (valores válidos: `RowAudit` \$1 `RowHashing` \$1 `RowMasking` \$1 `RowPartialMasking` \$1 `ColumnAudit` \$1 `ColumnHashing` \$1 `ColumnMasking`).

  Indica o tipo de transformação PIIDetection. 
+ `EntityTypesToDetect`: *obrigatório:* uma matriz de strings UTF-8.

  Indica os tipos de entidades que a transformação PIIDetection identificará como dados de PII. 

   As entidades do tipo PII incluem: PERSON\$1NAME, DATE, USA\$1SNN, EMAIL, USA\$1ITIN, USA\$1PASSPORT\$1NUMBER, PHONE\$1NUMBER, BANK\$1ACCOUNT, IP\$1ADDRESS, MAC\$1ADDRESS, USA\$1CPT\$1CODE, USA\$1HCPCS\$1CODE, USA\$1NATIONAL\$1DRUG\$1CODE, USA\$1MEDICARE\$1BENEFICIARY\$1IDENTIFIER, USA\$1HEALTH\$1INSURANCE\$1CLAIM\$1NUMBER,CREDIT\$1CARD,USA\$1NATIONAL\$1PROVIDER\$1IDENTIFIER,USA\$1DEA\$1NUMBER,USA\$1DRIVING\$1LICENSE 
+ `OutputColumnName` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Indica o nome da coluna de saída que conterá qualquer tipo de entidade detectado nessa linha. 
+ `SampleFraction`: número (double), no máximo 1.

  Indica a fração dos dados a serem amostrados ao verificar entidades de PII. 
+ `ThresholdFraction`: número (double), no máximo 1.

  Indica a fração dos dados que devem ser atendidos para que uma coluna seja identificada como dados de PII. 
+ `MaskValue` – string UTF-8 com no máximo 256 bytes de comprimento e correspondente a [Custom string pattern #58](aws-glue-api-common.md#regex_58).

  Indica o valor que substituirá a entidade detectada. 
+ `RedactText` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica se o texto PII detectado deve ser editado. Quando definido como `true`, o conteúdo PII é substituído por caracteres de ocultamento.
+ `RedactChar` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O caractere utilizado para substituir o conteúdo PII detectado quando o ocultamento está habilitado. O caractere de ocultamento padrão é `*`.
+ `MatchPattern` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Um padrão de expressão regular utilizado para identificar conteúdo PII adicional além dos algoritmos de detecção padrão.
+ `NumLeftCharsToExclude` – Número (inteiro), não mais do que None (Nenhum).

  O número de caracteres a serem excluídos da redação no lado esquerdo do conteúdo PII detectado. Isso permite preservar o contexto em torno dos dados sensíveis.
+ `NumRightCharsToExclude` – Número (inteiro), não mais do que None (Nenhum).

  O número de caracteres a serem excluídos da redação no lado direito do conteúdo PII detectado. Isso permite preservar o contexto em torno dos dados sensíveis.
+ `DetectionParameters` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Parâmetros adicionais para configurar o comportamento de detecção de PII e as configurações de sensibilidade.
+ `DetectionSensitivity` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nível de sensibilidade para detecção de PII. Níveis mais altos de sensibilidade detectam mais PII em potencial, mas podem resultar em mais falsos positivos.

## Estrutura Aggregate
<a name="aws-glue-api-visual-job-api-Aggregate"></a>

Especifica uma transformação que agrupa linhas por campos escolhidos e calcula o valor agregado por função especificada.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Especifica os campos e linhas a serem usados como entradas para a transformação agregada.
+ `Groups`: *obrigatório:* uma matriz de strings UTF-8.

  Especifica os campos a serem agrupados.
+ `Aggs`: *obrigatório:* uma matriz de objetos [AggregateOperation](#aws-glue-api-visual-job-api-AggregateOperation), com, no mínimo, 1 e, no máximo, 30 estruturas.

  Especifica as funções agregadas a serem executadas em campos especificados. 

## Estrutura DropDuplicates
<a name="aws-glue-api-visual-job-api-DropDuplicates"></a>

Especifica uma transformação que remove linhas de dados repetidos de um conjunto de dados. 

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó de transformação.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas de dados identificadas por seus nomes de nós.
+ `Columns` – Uma matriz de strings UTF-8.

  O nome das colunas a serem mescladas ou removidas caso sejam repetidas.

## Estrutura GovernedCatalogTarget
<a name="aws-glue-api-visual-job-api-GovernedCatalogTarget"></a>

Especifica um destino de dados que grava no Amazon S3 usando o catálogo de dados do AWS Glue.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino de dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são entradas para o destino de dados.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Especifica o particionamento nativo usando uma sequência de chaves.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados na qual gravar.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados no qual gravar.
+ `SchemaChangePolicy` – Um objeto [CatalogSchemaChangePolicy](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy).

  Uma política que especifica o comportamento do catálogo governado.

## Estrutura GovernedCatalogSource
<a name="aws-glue-api-visual-job-api-GovernedCatalogSource"></a>

Especifica o datastore no AWS Glue Data Catalog.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do datastore.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A tabela do banco de dados da qual a leitura será feita.
+ `PartitionPredicate` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  As partições que satisfazem a esse predicado são excluídas. Os arquivos dentro do período de retenção nessas partições não são excluídos. Definido como `""`, vazio por padrão.
+ `AdditionalOptions` – Um objeto [S3SourceAdditionalOptions](#aws-glue-api-visual-job-api-S3SourceAdditionalOptions).

  Especifica opções de conexão adicionais.

## Estrutura AggregateOperation
<a name="aws-glue-api-visual-job-api-AggregateOperation"></a>

Especifica o conjunto de parâmetros necessários para realizar agregação na transformação dinâmica.

**Campos**
+ `Column`: *obrigatório:* uma matriz de strings UTF-8.

  Especifica a coluna no conjunto de dados em que a função de agregação será aplicada.
+ `AggFunc`: *obrigatório:* string UTF-8 (valores válidos: `avg` \$1 `countDistinct` \$1 `count` \$1 `first` \$1 `last` \$1 `kurtosis` \$1 `max` \$1 `min` \$1 `skewness` \$1 `stddev_samp` \$1 `stddev_pop` \$1 `sum` \$1 `sumDistinct` \$1 `var_samp` \$1 `var_pop`).

  Especifica a função de agregação a ser aplicada.

  As possíveis funções de agregação incluem: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev\$1samp, stddev\$1pop, sum, sumDistinct, var\$1samp, var\$1pop

## Estrutura GlueSchema
<a name="aws-glue-api-visual-job-api-GlueSchema"></a>

Especifica um esquema definido pelo usuário quando um esquema não pode ser determinado pelo AWS Glue.

**Campos**
+ `Columns`: um array de objetos [GlueStudioSchemaColumn](#aws-glue-api-visual-job-api-GlueStudioSchemaColumn).

  Especifica as definições de coluna que compõem um esquema do AWS Glue.

## Estrutura GlueStudioSchemaColumn
<a name="aws-glue-api-visual-job-api-GlueStudioSchemaColumn"></a>

Especifica uma única coluna em uma definição de esquema do AWS Glue.

**Campos**
+ `Name`: – *Obrigatório:* string UTF-8 com não mais do que 1024 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome da coluna no esquema do AWS Glue Studio.
+ `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 hive para esta coluna no esquema do AWS Glue Studio.
+ `GlueStudioType` – 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 coluna, conforme definido no AWS Glue Studio.

## Estrutura GlueStudioColumn
<a name="aws-glue-api-visual-job-api-GlueStudioColumn"></a>

Especifica uma única coluna no AWS Glue Studio.

**Campos**
+ `Key` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A chave da coluna no AWS Glue Studio.
+ `FullPath`: *obrigatório:* uma matriz de strings UTF-8.

  O URL completo da coluna no AWS Glue Studio.
+ `Type` – *Obrigatório:* string UTF-8 (valores válidos: `array="ARRAY"` \$1 `bigint="BIGINT"` \$1 `bigint array="BIGINT_ARRAY"` \$1 `binary="BINARY"` \$1 `binary array="BINARY_ARRAY"` \$1 `boolean="BOOLEAN"` \$1 `boolean array="BOOLEAN_ARRAY"` \$1 `byte="BYTE"` \$1 `byte array="BYTE_ARRAY"` \$1 `char="CHAR"` \$1 `char array="CHAR_ARRAY"` \$1 `choice="CHOICE"` \$1 `choice array="CHOICE_ARRAY"` \$1 `date="DATE"` \$1 `date array="DATE_ARRAY"` \$1 `decimal="DECIMAL"` \$1 `decimal array="DECIMAL_ARRAY"` \$1 `double="DOUBLE"` \$1 `double array="DOUBLE_ARRAY"` \$1 `enum="ENUM"` \$1 `enum array="ENUM_ARRAY"` \$1 `float="FLOAT"` \$1 `float array="FLOAT_ARRAY"` \$1 `int="INT"` \$1 `int array="INT_ARRAY"` \$1 `interval="INTERVAL"` \$1 `interval array="INTERVAL_ARRAY"` \$1 `long="LONG"` \$1 `long array="LONG_ARRAY"` \$1 `object="OBJECT"` \$1 `short="SHORT"` \$1 `short array="SHORT_ARRAY"` \$1 `smallint="SMALLINT"` \$1 `smallint array="SMALLINT_ARRAY"` \$1 `string="STRING"` \$1 `string array="STRING_ARRAY"` \$1 `timestamp="TIMESTAMP"` \$1 `timestamp array="TIMESTAMP_ARRAY"` \$1 `tinyint="TINYINT"` \$1 `tinyint array="TINYINT_ARRAY"` \$1 `varchar="VARCHAR"` \$1 `varchar array="VARCHAR_ARRAY"` \$1 `null="NULL"` \$1 `unknown="UNKNOWN"` \$1 `unknown array="UNKNOWN_ARRAY"`).

  O tipo da coluna no AWS Glue Studio.
+ `Children`: uma matriz de estruturas.

  Os itens secundários da coluna principal no AWS Glue Studio.
+ `GlueStudioType` – String UTF-8 (valores válidos: `array="ARRAY"` \$1 `bigint="BIGINT"` \$1 `bigint array="BIGINT_ARRAY"` \$1 `binary="BINARY"` \$1 `binary array="BINARY_ARRAY"` \$1 `boolean="BOOLEAN"` \$1 `boolean array="BOOLEAN_ARRAY"` \$1 `byte="BYTE"` \$1 `byte array="BYTE_ARRAY"` \$1 `char="CHAR"` \$1 `char array="CHAR_ARRAY"` \$1 `choice="CHOICE"` \$1 `choice array="CHOICE_ARRAY"` \$1 `date="DATE"` \$1 `date array="DATE_ARRAY"` \$1 `decimal="DECIMAL"` \$1 `decimal array="DECIMAL_ARRAY"` \$1 `double="DOUBLE"` \$1 `double array="DOUBLE_ARRAY"` \$1 `enum="ENUM"` \$1 `enum array="ENUM_ARRAY"` \$1 `float="FLOAT"` \$1 `float array="FLOAT_ARRAY"` \$1 `int="INT"` \$1 `int array="INT_ARRAY"` \$1 `interval="INTERVAL"` \$1 `interval array="INTERVAL_ARRAY"` \$1 `long="LONG"` \$1 `long array="LONG_ARRAY"` \$1 `object="OBJECT"` \$1 `short="SHORT"` \$1 `short array="SHORT_ARRAY"` \$1 `smallint="SMALLINT"` \$1 `smallint array="SMALLINT_ARRAY"` \$1 `string="STRING"` \$1 `string array="STRING_ARRAY"` \$1 `timestamp="TIMESTAMP"` \$1 `timestamp array="TIMESTAMP_ARRAY"` \$1 `tinyint="TINYINT"` \$1 `tinyint array="TINYINT_ARRAY"` \$1 `varchar="VARCHAR"` \$1 `varchar array="VARCHAR_ARRAY"` \$1 `null="NULL"` \$1 `unknown="UNKNOWN"` \$1 `unknown array="UNKNOWN_ARRAY"`).

  O tipo de dados da coluna, conforme definido no AWS Glue Studio.

## Estrutura DynamicTransform
<a name="aws-glue-api-visual-job-api-DynamicTransform"></a>

Especifica o conjunto de parâmetros necessários para realizar a transformação dinâmica.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica o nome da transformação dinâmica.
+ `TransformName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica o nome da transformação dinâmica como aparece no editor visual do AWS Glue Studio.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Especifica as entradas necessárias para a transformação dinâmica.
+ `Parameters`: um array de objetos [TransformConfigParameter](#aws-glue-api-visual-job-api-TransformConfigParameter).

  Especifica os parâmetros da transformação dinâmica.
+ `FunctionName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica o nome da função da transformação dinâmica.
+ `Path` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica o caminho da origem da transformação dinâmica e dos arquivos de configuração.
+ `Version` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Esse campo não é usado e será removido em uma versão futura.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a transformação dinâmica.

## Estrutura TransformConfigParameter
<a name="aws-glue-api-visual-job-api-TransformConfigParameter"></a>

Especifica os parâmetros no arquivo de configuração da transformação dinâmica.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica o nome do parâmetro no arquivo de configuração da transformação dinâmica.
+ `Type`: *obrigatório:* string UTF-8 (valores válidos: `str="STR"` \$1 `int="INT"` \$1 `float="FLOAT"` \$1 `complex="COMPLEX"` \$1 `bool="BOOL"` \$1 `list="LIST"` \$1 `null="NULL"`).

  Especifica o tipo de parâmetro no arquivo de configuração da transformação dinâmica.
+ `ValidationRule` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica a regra de validação no arquivo de configuração da transformação dinâmica.
+ `ValidationMessage` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica a mensagem de validação no arquivo de configuração da transformação dinâmica.
+ `Value` – Uma matriz de strings UTF-8.

  Especifica o valor do parâmetro no arquivo de configuração da transformação dinâmica.
+ `ListType` – string UTF-8 (valores válidos: `str="STR"` \$1 `int="INT"` \$1 `float="FLOAT"` \$1 `complex="COMPLEX"` \$1 `bool="BOOL"` \$1 `list="LIST"` \$1 `null="NULL"`).

  Especifica o tipo de lista do parâmetro no arquivo de configuração da transformação dinâmica.
+ `IsOptional` – Booleano.

  Especifica se o parâmetro é opcional ou não no arquivo de configuração da transformação dinâmica.

## Estrutura EvaluateDataQuality
<a name="aws-glue-api-visual-job-api-EvaluateDataQuality"></a>

Especifica os critérios da avaliação de qualidade dos dados.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da avaliação de qualidade dos dados.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  As entradas da avaliação de qualidade dos dados.
+ `Ruleset`: *obrigatório:* string UTF-8, não menos que 1 ou mais que 65.536 bytes de comprimento, correspondente ao [Custom string pattern #59](aws-glue-api-common.md#regex_59).

  O conjunto de regras para a avaliação de qualidade dos dados.
+ `Output` – string UTF-8 (valores válidos: `PrimaryInput` \$1 `EvaluationResults`).

  As resultado da avaliação de qualidade dos dados.
+ `PublishingOptions` – Um objeto [DQResultsPublishingOptions](#aws-glue-api-visual-job-api-DQResultsPublishingOptions).

  Opções para configurar como os resultados são publicados.
+ `StopJobOnFailureOptions` – Um objeto [DQStopJobOnFailureOptions](#aws-glue-api-visual-job-api-DQStopJobOnFailureOptions).

  Opções para configurar como o trabalho será interrompido se a avaliação de qualidade dos dados falhar.

## Estrutura DQResultsPublishingOptions
<a name="aws-glue-api-visual-job-api-DQResultsPublishingOptions"></a>

Opções para configurar como os resultados da avaliação de qualidade dos dados são publicados.

**Campos**
+ `EvaluationContext` – String UTF-8 correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  O contexto da avaliação.
+ `ResultsS3Prefix` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O prefixo do Amazon S3 adicionado aos resultados.
+ `CloudWatchMetricsEnabled` – Booleano.

  Habilitar métricas para os resultados de qualidade dos dados.
+ `ResultsPublishingEnabled` – Booleano.

  Habilitar a publicação dos resultados de qualidade dos dados.

## Estrutura DQStopJobOnFailureOptions
<a name="aws-glue-api-visual-job-api-DQStopJobOnFailureOptions"></a>

Opções para configurar como o trabalho será interrompido se a avaliação de qualidade dos dados falhar.

**Campos**
+ `StopJobOnFailureTiming`: string UTF-8 (valores válidos: `Immediate` \$1 `AfterDataLoad`).

  Quando interromper o trabalho se a avaliação de qualidade dos dados falhar. As opções são Immediate ou AfterDataLoad.

## Estrutura EvaluateDataQualityMultiFrame
<a name="aws-glue-api-visual-job-api-EvaluateDataQualityMultiFrame"></a>

Especifica os critérios da avaliação de qualidade dos dados.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da avaliação de qualidade dos dados.
+ `Inputs` – *Obrigatório:* uma matriz de strings UTF-8, pelo menos 1 string.

  As entradas da avaliação de qualidade dos dados. A primeira entrada nessa lista é a fonte de dados primária.
+ `AdditionalDataSources` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Os aliases de todas as fontes de dados, exceto a primária.
+ `Ruleset`: *obrigatório:* string UTF-8, não menos que 1 ou mais que 65.536 bytes de comprimento, correspondente ao [Custom string pattern #59](aws-glue-api-common.md#regex_59).

  O conjunto de regras para a avaliação de qualidade dos dados.
+ `PublishingOptions` – Um objeto [DQResultsPublishingOptions](#aws-glue-api-visual-job-api-DQResultsPublishingOptions).

  Opções para configurar como os resultados são publicados.
+ `AdditionalOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 (valores válidos: `performanceTuning.caching="CacheOption"` \$1 `observations.scope="ObservationsOption"` \$1 `compositeRuleEvaluation.method="CompositeOption"`).

  Cada valor é uma sequência de caracteres UTF-8.

  Opções para configurar o comportamento do runtime da transformação.
+ `StopJobOnFailureOptions` – Um objeto [DQStopJobOnFailureOptions](#aws-glue-api-visual-job-api-DQStopJobOnFailureOptions).

  Opções para configurar como o trabalho será interrompido se a avaliação de qualidade dos dados falhar.

## Estrutura da fórmula
<a name="aws-glue-api-visual-job-api-Recipe"></a>

Um nó do AWS Glue Studio que usa uma fórmula do AWS Glue DataBrew em trabalhos do AWS Glue.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó do AWS Glue Studio.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  Os nós que são inseridos no nó da fórmula, identificados por ID.
+ `RecipeReference` – Um objeto [RecipeReference](#aws-glue-api-visual-job-api-RecipeReference).

  Uma referência à fórmula do DataBrew usada pelo nó.
+ `RecipeSteps`: um array de objetos [RecipeStep](#aws-glue-api-visual-job-api-RecipeStep).

  Etapas de transformação usadas no nó da fórmula.

## Estrutura SchemaReference
<a name="aws-glue-api-visual-job-api-RecipeReference"></a>

Uma referência a uma fórmula do AWS Glue DataBrew.

**Campos**
+ `RecipeArn` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O ARN da fórmula do DataBrew.
+ `RecipeVersion` - *obrigatório:* string UTF-8, com não menos do que 1 nem mais do que 16 bytes de comprimento.

  A RecipeVersion da fórmula do DataBrew.

## Estrutura SnowflakeNodeData
<a name="aws-glue-api-visual-job-api-SnowflakeNodeData"></a>

Especifica a configuração dos nós do Snowflake no AWS Glue Studio

**Campos**
+ `SourceType` – String UTF-8 correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  Especifica como os dados recuperados são especificados. Valores válidos: `"table"`, ` "query"`.
+ `Connection` – Um objeto [Opção](#aws-glue-api-visual-job-api-Option).

  Especifica uma conexão do catálogo de dados do AWS Glue com um endpoint do Snowflake.
+ `Schema` – String UTF-8.

  Especifica um esquema de banco de dados do Snowflake para seu nó usar.
+ `Table` – String UTF-8.

  Especifica uma tabela do Snowflake para seu nó usar.
+ `Database` – String UTF-8.

  Especifica um banco de dados do Snowflake para seu nó usar.
+ `TempDir` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Não utilizado no momento.
+ `IamRole` – Um objeto [Opção](#aws-glue-api-visual-job-api-Option).

  Não utilizado no momento.
+ `AdditionalOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica opções adicionais passadas ao conector do Snowflake. Se as opções forem especificadas em outro lugar neste nó, isso terá precedência.
+ `SampleQuery` – String UTF-8.

  Uma string SQL usada para recuperar dados com o tipo de fonte `query`.
+ `PreAction` – String UTF-8.

  Uma string SQL executada antes que o conector do Snowflake execute suas ações padrão.
+ `PostAction` – String UTF-8.

  Uma string SQL executada depois que o conector do Snowflake executa suas ações padrão.
+ `Action` – String UTF-8.

  Especifica a ação a ser realizada ao gravar em uma tabela com dados preexistentes. Valores válidos: ` append`, `merge`, `truncate`, `drop`.
+ `Upsert` – Booleano.

  Usado quando a ação é `append`. Especifica o comportamento da resolução quando uma linha já existe. Se verdadeiro, as linhas preexistentes serão atualizadas. Se falso, essas linhas serão inseridas.
+ `MergeAction` – String UTF-8 correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  Especifica uma ação de mesclagem. Valores válidos: `simple`, `custom`. Se for simples, o comportamento de mesclagem será definido por `MergeWhenMatched` e ` MergeWhenNotMatched`. Se for personalizado, será definido por `MergeClause`.
+ `MergeWhenMatched` – String UTF-8 correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  Especifica como resolver registros que correspondam a dados preexistentes durante a mesclagem. Valores válidos: ` update`, `delete`.
+ `MergeWhenNotMatched` – String UTF-8 correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  Especifica como processar registros que não correspondem a dados preexistentes durante a mesclagem. Valores válidos: `insert`, `none`.
+ `MergeClause` – String UTF-8.

  Uma instrução SQL que especifica um comportamento de mesclagem personalizado.
+ `StagingTable` – String UTF-8.

  O nome de uma tabela de preparação usada ao executar `merge` ou fazer o upsert das ações `append`. Os dados são gravados nessa tabela e, em seguida, movidos para a `table` por uma pós-ação gerada.
+ `SelectedColumns`: um array de objetos [Opção](#aws-glue-api-visual-job-api-Option).

  Especifica as colunas combinadas para identificar um registro ao detectar correspondências para mesclagens e upserts. Uma lista de estruturas com as chaves `value`, `label` e ` description`. Cada estrutura descreve uma coluna.
+ `AutoPushdown` – Booleano.

  Especifica se o pushdown de consultas está habilitado. Se o pushdown estiver habilitado, quando uma consulta for executada no Spark, se for possível fazer pushdown de parte da consulta para o servidor do Snowflake, isso ocorrerá. Isso melhora a performance de algumas consultas.
+ `TableSchema`: um array de objetos [Opção](#aws-glue-api-visual-job-api-Option).

  Define manualmente o esquema de destino para o nó. Uma lista de estruturas com as chaves `value`, `label` e `description`. Cada estrutura define uma coluna.

## Estrutura SnowflakeSource
<a name="aws-glue-api-visual-job-api-SnowflakeSource"></a>

Especifica uma fonte de dados do Snowflake.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados do Snowflake.
+ `Data` – *Obrigatório:* um objeto [SnowflakeNodeData](#aws-glue-api-visual-job-api-SnowflakeNodeData).

  Configuração da fonte de dados do Snowflake.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica esquemas definidos pelo usuário para seus dados de saída.

## Estrutura SnowflakeTarget
<a name="aws-glue-api-visual-job-api-SnowflakeTarget"></a>

Especifica um destino do Snowflake.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino do Snowflake.
+ `Data` – *Obrigatório:* um objeto [SnowflakeNodeData](#aws-glue-api-visual-job-api-SnowflakeNodeData).

  Especifica os dados do nó de destino do Snowflake.
+ `Inputs`: uma matriz de strings UTF-8, com não menos que 1 nem mais que 1 string.

  Os nós que são entradas para o destino de dados.

## Estrutura ConnectorDataSource
<a name="aws-glue-api-visual-job-api-ConnectorDataSource"></a>

Especifica uma fonte gerada com opções de conexão padrão.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome desse nó de origem.
+ `ConnectionType` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O `connectionType`, conforme fornecido à biblioteca AWS Glue subjacente. Esse tipo de nó é compatível com os seguintes tipos de conexão: 
  + `opensearch`
  + `azuresql`
  + `azurecosmos`
  + `bigquery`
  + `saphana`
  + `teradata`
  + `vertica`
+ `Data`: *obrigatório:* uma matriz de mapa dos pares de chave-valor.

  Cada chave é uma sequência de caracteres UTF-8.

  Cada valor é uma sequência de caracteres UTF-8.

  Um mapa que especifica as opções de conexão para o nó. É possível encontrar opções de conexão padrão para o tipo de conexão correspondente na seção [Parâmetros de conexão](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-connect.html) da documentação do AWS Glue.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para esta fonte.

## Estrutura ConnectorDataTarget
<a name="aws-glue-api-visual-job-api-ConnectorDataTarget"></a>

Especifica um destino gerado com opções de conexão padrão.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome desse nó de destino.
+ `ConnectionType` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O `connectionType`, conforme fornecido à biblioteca AWS Glue subjacente. Esse tipo de nó é compatível com os seguintes tipos de conexão: 
  + `opensearch`
  + `azuresql`
  + `azurecosmos`
  + `bigquery`
  + `saphana`
  + `teradata`
  + `vertica`
+ `Data`: *obrigatório:* uma matriz de mapa dos pares de chave-valor.

  Cada chave é uma sequência de caracteres UTF-8.

  Cada valor é uma sequência de caracteres UTF-8.

  Um mapa que especifica as opções de conexão para o nó. É possível encontrar opções de conexão padrão para o tipo de conexão correspondente na seção [Parâmetros de conexão](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-connect.html) da documentação do AWS Glue.
+ `Inputs`: uma matriz de strings UTF-8, com não menos que 1 nem mais que 1 string.

  Os nós que são entradas para o destino de dados.

## Estrutura RecipeStep
<a name="aws-glue-api-visual-job-api-RecipeStep"></a>

Uma etapa de fórmula usada em um nó de fórmula de preparação de dados do AWS Glue Studio.

**Campos**
+ `Action` – *Obrigatório:* um objeto [RecipeAction](#aws-glue-api-visual-job-api-RecipeAction).

  A ação de transformação da etapa de fórmula.
+ `ConditionExpressions`: um array de objetos [ConditionExpression](#aws-glue-api-visual-job-api-ConditionExpression).

  Expressões de condição para a etapa de fórmula.

## Estrutura RecipeAction
<a name="aws-glue-api-visual-job-api-RecipeAction"></a>

Ações definidas no nó da fórmula de preparação de dados do AWS Glue Studio.

**Campos**
+ `Operation`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #56](aws-glue-api-common.md#regex_56).

  A operação da ação da fórmula.
+ `Parameters` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes, correspondente a [Custom string pattern #57](aws-glue-api-common.md#regex_57).

  Cada chave é uma string UTF-8, podendo ter entre 1 e 32.768 bytes.

  Os parâmetros da ação da fórmula.

## Estrutura ConditionExpression
<a name="aws-glue-api-visual-job-api-ConditionExpression"></a>

Expressão de condição definida no nó da fórmula de preparação de dados do AWS Glue Studio.

**Campos**
+ `Condition`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #56](aws-glue-api-common.md#regex_56).

  A condição da expressão de condição.
+ `Value`: string UTF-8, com no máximo 1.024 bytes.

  O valor da expressão de condição.
+ `TargetColumn` *(obrigatório):* string UTF-8, podendo ter entre 1 e 1.024 bytes.

  A coluna de destino das expressões de condição.

## Estrutura S3CatalogIcebergSource
<a name="aws-glue-api-visual-job-api-S3CatalogIcebergSource"></a>

Especifica uma fonte de dados Apache Iceberg registrada no Catálogo de dados do AWS Glue. A fonte de dados do Iceberg deve ser armazenada no Amazon S3.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados do Iceberg.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.
+ `AdditionalIcebergOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica opções de conexão adicionais para a fonte de dados do Iceberg.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte do Iceberg.

## Estrutura CatalogIcebergSource
<a name="aws-glue-api-visual-job-api-CatalogIcebergSource"></a>

Especifica uma fonte de dados Apache Iceberg registrada no Catálogo de dados do AWS Glue.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte de dados do Iceberg.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados do qual a leitura será feita.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela no banco de dados da qual a leitura será feita.
+ `AdditionalIcebergOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica opções de conexão adicionais para a fonte de dados do Iceberg.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte do Iceberg.

## Estrutura S3IcebergCatalogTarget
<a name="aws-glue-api-visual-job-api-S3IcebergCatalogTarget"></a>

Especifica um destino do catálogo do Apache Iceberg que grava dados no Amazon S3 e registra a tabela no Catálogo de dados do AWS Glue.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do destino do catálogo do Iceberg.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  A conexão de entrada para o destino do catálogo do Iceberg.
+ `PartitionKeys` – Uma matriz de strings UTF-8.

  Uma lista de chaves de partição para a tabela do Iceberg.
+ `Table` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome da tabela na qual escrever no catálogo.
+ `Database` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do banco de dados no qual gravar.
+ `AdditionalOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Cada valor é uma string UTF-8 que corresponde a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica opções de conexão adicionais para o destino do catálogo do Iceberg.
+ `SchemaChangePolicy` – Um objeto [CatalogSchemaChangePolicy](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy).

  A política para lidar com alterações de esquema no destino do catálogo.
+ `AutoDataQuality` – Um objeto [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality).

  Especifica se a avaliação da qualidade dos dados deve ser habilitada automaticamente para o destino do catálogo do Iceberg do S3. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente durante a operação de gravação.

## Estrutura DynamoDBELTConnectorSource
<a name="aws-glue-api-visual-job-api-DynamoDBELTConnectorSource"></a>

Especifica uma fonte de conector ELT do DynamoDB para a extração de dados de tabelas do DynamoDB.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome da fonte do conector ELT do DynamoDB.
+ `ConnectionOptions` – Um objeto [DDBELTConnectionOptions](#aws-glue-api-visual-job-api-DDBELTConnectionOptions).

  As opções de conexão para a fonte do conector ELT do DynamoDB.
+ `OutputSchemas`: um array de objetos [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema).

  Especifica o esquema de dados para a fonte do conector ELT do DynamoDB.

## Estrutura DDBELTConnectionOptions
<a name="aws-glue-api-visual-job-api-DDBELTConnectionOptions"></a>

Especifica as opções de conexão para operações ELT (extração, carregamento e transformação) do DynamoDB. Essa estrutura contém parâmetros de configuração para conectar-se e extrair dados das tabelas do DynamoDB usando o conector ELT.

**Campos**
+ `DynamodbExport` – string UTF-8 (valores válidos: `ddb` \$1 `s3`).

  Especifica o tipo de exportação para extração de dados do DynamoDB. Esse parâmetro determina como os dados são exportados da tabela do DynamoDB durante o processo de ELT.
+ `DynamodbUnnestDDBJson` – Booleano.

  Um valor booleano que especifica se o formato JSON do DynamoDB deve ser desaninhado durante a extração de dados. Quando definido como `true`, o conector achatará estruturas JSON aninhadas de itens do DynamoDB. Quando definido como `false`, a estrutura JSON original do DynamoDB é preservada.
+ `DynamodbTableArn` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do recurso da Amazon (ARN) da tabela do DynamoDB da qual os dados serão extraídos. Este parâmetro especifica a tabela de origem para a operação de ELT. 
+ `DynamodbS3Bucket` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do bucket do Amazon S3 utilizado para armazenamento intermediário durante o processo de ELT do DynamoDB. Este bucket é utilizado para armazenar temporariamente os dados exportados do DynamoDB antes de serem processados pelo trabalho de ELT.
+ `DynamodbS3Prefix` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O prefixo da chave do objeto S3 para arquivos armazenados no bucket do S3 intermediário durante o processo de ELT do DynamoDB. Esse prefixo ajuda a organizar e identificar os arquivos temporários criados durante a extração de dados.
+ `DynamodbS3BucketOwner` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  A ID da conta da AWS do proprietário do bucket do S3 especificado em `DynamodbS3Bucket`. Esse parâmetro é necessário quando o bucket do S3 pertence a uma conta da AWS diferente daquela que está executando o trabalho de ELT, habilitando o acesso entre contas ao bucket de armazenamento intermediário.
+ `DynamodbStsRoleArn` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O nome do recurso da Amazon (ARN) do perfil do Serviço de Token de Segurança (STS) da AWS a ser assumido para acessar os recursos do DynamoDB e do S3 durante a operação de ELT. Esse perfil deve ter as permissões necessárias para ler da tabela do DynamoDB e gravar no bucket intermediário do S3. 

## Estrutura DDBELTCatalogAdditionalOptions
<a name="aws-glue-api-visual-job-api-DDBELTCatalogAdditionalOptions"></a>

Especifica opções adicionais para operações de catálogo ELT do DynamoDB.

**Campos**
+ `DynamodbExport` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  Especifica a configuração de exportação do DynamoDB para a operação de ELT.
+ `DynamodbUnnestDDBJson` – Booleano.

  Especifica se o formato JSON do DynamoDB deve ser desaninhado. Quando definido como `true`, as estruturas JSON aninhadas nos itens do DynamoDB são achatadas.

## Estrutura de rotas
<a name="aws-glue-api-visual-job-api-Route"></a>

Especifica um nó de rota que direciona os dados para diferentes caminhos de saída com base em condições de filtragem definidas.

**Campos**
+ `Name` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #63](aws-glue-api-common.md#regex_63).

  O nome do nó da rota.
+ `Inputs`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 1 strings.

  A conexão de entrada para o nó da rota.
+ `GroupFiltersList` – *Obrigatório:* uma matriz de objetos [GroupFilters](#aws-glue-api-visual-job-api-GroupFilters).

  Uma lista de filtros de grupo que definem as condições e os critérios de roteamento para direcionar os dados para diferentes caminhos de saída.

## Estrutura GroupFilters
<a name="aws-glue-api-visual-job-api-GroupFilters"></a>

Especifica um grupo de filtros com um operador lógico que determina como os filtros são combinados para avaliar as condições de roteamento.

**Campos**
+ `GroupName` – *Obrigatório:* string UTF-8, correspondente a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  O nome do grupo de filtros.
+ `Filters` – *Obrigatório:* uma matriz de objetos [FilterExpression](#aws-glue-api-visual-job-api-FilterExpression).

  Uma lista de expressões de filtro que definem as condições para este grupo.
+ `LogicalOperator` – *Obrigatório:* string UTF-8 (valores válidos: `AND` \$1 `OR`).

  O operador lógico utilizado para combinar os filtros neste grupo. Determina se todos os filtros devem corresponder (AND) ou se qualquer filtro pode corresponder (OR).

## Estrutura AutoDataQuality
<a name="aws-glue-api-visual-job-api-AutoDataQuality"></a>

Especifica as opções de configuração para avaliação automática da qualidade dos dados em trabalhos do AWS Glue. Essa estrutura permite verificações automatizadas da qualidade dos dados e monitoramento durante as operações de ETL, ajudando a garantir a integridade e a confiabilidade dos dados sem intervenção manual.

**Campos**
+ `IsEnabled` – Booleano.

  Especifica se a avaliação automática da qualidade dos dados está habilitada. Quando definido como `true`, as verificações de qualidade dos dados são realizadas automaticamente.
+ `EvaluationContext` – String UTF-8 correspondente a [Custom string pattern #61](aws-glue-api-common.md#regex_61).

  O contexto de avaliação para as verificações automáticas da qualidade dos dados. Isso define o escopo e os parâmetros para a avaliação da qualidade dos dados.

# API de trabalhos
<a name="aws-glue-api-jobs"></a>

A API de trabalhos descreve os tipos de dados de trabalhos e contém APIs para operar com trabalhos, execuções de trabalhos e acionadores no AWS Glue.

**Topics**
+ [Tarefas](aws-glue-api-jobs-job.md)
+ [Execuções de trabalhos](aws-glue-api-jobs-runs.md)
+ [Acionadores](aws-glue-api-jobs-trigger.md)

# Tarefas
<a name="aws-glue-api-jobs-job"></a>

A API de trabalhos descreve os tipos de dados e a API relacionada à criação, atualização, exclusão ou previsualização de trabalhos no AWS Glue.

## Tipos de dados
<a name="aws-glue-api-jobs-job-objects"></a>
+ [Estrutura do trabalho](#aws-glue-api-jobs-job-Job)
+ [Estrutura ExecutionProperty](#aws-glue-api-jobs-job-ExecutionProperty)
+ [Estrutura NotificationProperty](#aws-glue-api-jobs-job-NotificationProperty)
+ [Estrutura JobCommand](#aws-glue-api-jobs-job-JobCommand)
+ [Estrutura ConnectionsList](#aws-glue-api-jobs-job-ConnectionsList)
+ [Estrutura JobUpdate](#aws-glue-api-jobs-job-JobUpdate)
+ [Estrutura SourceControlDetails](#aws-glue-api-jobs-job-SourceControlDetails)

## Estrutura do trabalho
<a name="aws-glue-api-jobs-job-Job"></a>

Especifica uma definição de trabalho.

**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 que você atribui a esta definição de trabalho.
+ `JobMode` – string UTF-8 (valores válidos: `SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`).

  Um modo que descreve como um trabalho foi criado. Os valores válidos são:
  + `SCRIPT`: o trabalho foi criado usando o editor de scripts do AWS Glue Studio.
  + `VISUAL`: o trabalho foi criado usando o editor visual do AWS Glue Studio.
  + `NOTEBOOK`: o trabalho foi criado usando um caderno de sessões interativas.

  Quando o campo `JobMode` está ausente ou é nulo, `SCRIPT` é atribuído como o valor padrão.
+ `JobRunQueuingEnabled` – Booleano.

  Especifica se o enfileiramento da execução de trabalhos está habilitado para as execuções desse trabalho.

  Um valor "verdadeiro" significa que o enfileiramento da execução de trabalhos está habilitado para a execução do trabalho. Se o valor for "falso" ou não estiver preenchido, as execuções do trabalho não serão consideradas para enfileiramento.

  Se esse campo não corresponder ao valor definido na execução do trabalho, o valor do campo de execução do trabalho será usado.
+ `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 trabalho.
+ `LogUri` – String UTF-8.

  Este campo está reservado para uso futuro.
+ `Role` – String UTF-8.

  O nome ou o nome do recurso da Amazon (ARN) da função do IAM associada a esta trabalho.
+ `CreatedOn` – Timestamp.

  A hora e a data em que esta definição de trabalho foi criada.
+ `LastModifiedOn` – Timestamp.

  O último momento em que esta definição de trabalho foi modificada.
+ `ExecutionProperty` – Um objeto [ExecutionProperty](#aws-glue-api-jobs-job-ExecutionProperty).

  Um `ExecutionProperty` que especifica o número máximo de execuções simultâneas permitidas para o trabalho.
+ `Command` – Um objeto [JobCommand](#aws-glue-api-jobs-job-JobCommand).

  O `JobCommand` que executa esse trabalho.
+ `DefaultArguments` – 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.

  Os argumentos padrão para toda execução desse trabalho, especificados como pares de nome-valor.

  Aqui, é possível especificar os argumentos que seu próprio script de execução de trabalho consome, além dos argumentos que o AWS Glue consome.

  Os argumentos do trabalho podem ser registrados em log. Não transmita segredos em texto simples como argumentos. Recupere os segredos de uma conexão do AWS Glue, AWS Secrets Manager ou outro mecanismo de gerenciamento de segredo se pretender mantê-los dentro do trabalho. 

  Para obter informações sobre como especificar e consumir seus próprios argumentos de trabalho, consulte o tópico [Chamar APIs do AWS Glue em Python](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) no guia do desenvolvedor.

  Para obter informações sobre os argumentos que podem ser fornecidos a esse campo ao configurar trabalhos do Spark, consulte o tópico [Parâmetros especiais usados pelo AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) no guia do desenvolvedor.

  Para obter informações sobre os argumentos que podem ser fornecidos a esse campo ao configurar trabalhos do Ray, consulte o tópico [Usar parâmetros de trabalho em trabalhos do Ray](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) no guia do desenvolvedor.
+ `NonOverridableArguments` – 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.

  Argumentos para esse trabalho que não são substituídos ao fornecer argumentos de trabalho na execução de um trabalho, especificados como pares de nome-valor.
+ `Connections` – Um objeto [ConnectionsList](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ConnectionsList).

  As conexões usadas no trabalho.
+ `MaxRetries` – Número (íntegro).

  O número máximo de novas tentativas desse trabalho após a falha de um JobRun.
+ `AllocatedCapacity` – Número (íntegro).

  Este campo está obsoleto. Use `MaxCapacity` em vez disso.

  O número de unidades de processamento de dados (DPUs) do AWS Glue alocadas em execuções desse trabalho. É possível alocar um mínimo de 2 DPUs; o padrão é 10. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/).

  
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite do trabalho em minutos. Este é o tempo máximo durante o qual uma execução de trabalho pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`.

  Os trabalhos devem ter valores de tempo limite inferiores a 7 dias ou 10.080 minutos. Caso contrário, os trabalhos gerarão uma exceção.

  Quando o valor é deixado em branco, o tempo limite padrão é de 2.880 minutos.

  Quaisquer trabalhos do AWS Glue existentes que tinham um valor de tempo limite maior que 7 dias serão padronizados para 7 dias. Por exemplo, se você especificou um tempo limite de 20 dias para um trabalho em lote, ele será interrompido no 7º dia.

  Para trabalhos de streaming, se você tiver configurado uma janela de manutenção, ela será reiniciada durante a janela de manutenção após 7 dias.
+ `MaxCapacity` – Número (duplo).

  Para trabalhos do Glue versão 1.0 ou anterior, usando o tipo de operador padrão, é o número de unidades de processamento de dados (DPUs) do AWS Glue que poderão ser alocadas quando esse trabalho for executado. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/).

  Para trabalhos do Glue versão 2.0 ou posterior, você não pode um `Maximum capacity`. Em vez disso, você deve especificar um `Worker type` e o `Number of workers`.

  Não defina `MaxCapacity` se estiver usando `WorkerType` e `NumberOfWorkers`.

  O valor que pode ser alocado para `MaxCapacity` depende se você está executando um trabalho de shell do Python, um trabalho de ETL do Apache Spark ou um trabalho de ETL de streaming do Apache Spark:
  + Ao especificar um trabalho de shell do Python (`JobCommand.Name`="pythonshell"), será possível alocar 0,0625 ou 1 DPU. O padrão é 0,0625 DPU.
  + Ao especificar um trabalho de ETL do Apache Spark (`JobCommand.Name`="glueetl") ou um trabalho de ETL de streaming do Apache Spark (`JobCommand.Name`="gluestreaming"), é possível alocar de 2 a 100 DPUs. O padrão é de 10 DPUs. Esse tipo de trabalho não pode ter uma alocação de DPU fracionada.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 `G.16X=""` \$1 `R.1X=""` \$1 `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido que é alocado quando um trabalho é executado.

  O AWS Glue oferece vários tipos de operadores para acomodar diferentes requisitos de workload:

  Tipos de operadores G (operadores de computação de uso geral):
  + G.025X: 0.25 DPUs (2 vCPUs, 4 GB de memória, 84 GB de disco)
  + G.1X: 1 DPU (4 vCPUs, 16 GB de memória, 94 GB de disco)
  + G.2X: 2 DPUs (8 vCPUs, 32 GB de memória, 138 GB de disco)
  + G.4X: 4 DPUs (16 vCPUs, 64 GB de memória, 256 GB de disco)
  + G.8X: 8 DPUs (32 vCPUs, 128 GB de memória, 512 GB de disco)
  + G.12X: 12 DPUs (48 vCPUs, 192 GB de memória, 768 GB de disco)
  + G16X: 16 DPUs (64 vCPUs, 256 GB de memória, 1.024 GB de disco)

  Tipos de operadores R (operadores com memória otimizada):
  + R.1X: 1 DPU (4 vCPUs, 32 GB de memória, 94 GB de disco)
  + R.2X: 2 DPU (8 vCPUs, 64 GB de memória, 128 GB de disco)
  + R.4X: 4 DPU (16 vCPUs, 128 GB de memória, 256 GB de disco)
  + R.8X: 8 DPU (32 vCPUs, 256 GB de memória, 512 GB de disco)
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de determinado `workerType` que são alocados quando um trabalho é executado.
+ `SecurityConfiguration` – 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 estrutura de `SecurityConfiguration` a ser usada com esse trabalho.
+ `NotificationProperty` – Um objeto [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty).

  Especifica propriedades de configuração de uma notificação de trabalho.
+ `Running` – Booleano.

  Este campo está reservado para uso futuro.
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Nas tarefas do Spark, `GlueVersion` determina as versões do Apache Spark e do Python que o AWS Glue disponibiliza em um trabalho. A versão do Python indica a versão compatível com trabalhos do tipo Spark. 

  Os trabalhos de Ray devem definir `GlueVersion` como `4.0` ou mais. Porém, as versões do Ray, do Python e das bibliotecas adicionais disponíveis no seu trabalho do Ray são determinadas pelo parâmetro `Runtime` do comando Job.

  Para obter mais informações sobre as versões disponíveis do AWS Glue e as versões correspondentes do Spark e do Python, consulte [Versão do Glue](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) no guia do desenvolvedor.

  Os trabalhos criados sem especificar uma versão do Glue usam como padrão o Glue 0.9.
+ `CodeGenConfigurationNodes` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  Cada valor é um objeto [CodeGenConfigurationNode](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CodeGenConfigurationNode) A.

  A representação de um gráfico acíclico direcionado no qual tanto o componente visual do Glue Studio quanto a geração de código do Glue Studio são baseados.
+ `ExecutionClass`: string UTF-8, inferior a 16 bytes de comprimento (valores válidos: `FLEX=""` \$1 `STANDARD=""`).

  Indica se o trabalho é executado com uma classe de execução padrão ou flexível. A classe de execução padrão é ideal para workloads sensíveis ao tempo que exigem a inicialização rápida de trabalhos e recursos dedicados.

  A classe de execução flexível é adequada para trabalhos insensíveis ao tempo, cujos horários de início e conclusão podem variar. 

  Somente trabalhos com o AWS Glue versão 3.0 e posterior e o tipo de comando `glueetl` terão permissão para definir `ExecutionClass` como `FLEX`. A classe de execução flexível está disponível para trabalhos do Spark.
+ `SourceControlDetails` – Um objeto [SourceControlDetails](#aws-glue-api-jobs-job-SourceControlDetails).

  Os detalhes de uma configuração de controle de origem para um trabalho, permitindo a sincronização de artefatos de trabalho de ou para um repositório remoto.
+ `MaintenanceWindow` – String UTF-8 correspondente a [Custom string pattern #34](aws-glue-api-common.md#regex_34).

  Esse campo especifica um dia da semana e uma hora para uma janela de manutenção para trabalhos de streaming. O AWS Glue realiza periodicamente atividades de manutenção. Durante essas janelas de manutenção, o AWS Glue precisará reiniciar seus trabalhos de streaming.

  O AWS Glue reiniciará o trabalho dentro de 3 horas da janela de manutenção especificada. Por exemplo, se você configurar a janela de manutenção para segunda-feira às 10h (GMT), seus trabalhos serão reiniciados entre 10h (GMT) e 13h (GMT).
+ `ProfileName` – 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 de um perfil de uso do AWS Glue associado ao trabalho.

## Estrutura ExecutionProperty
<a name="aws-glue-api-jobs-job-ExecutionProperty"></a>

Uma propriedade de execução de um trabalho.

**Campos**
+ `MaxConcurrentRuns` – Número (íntegro).

  O número máximo de execuções simultâneas permitidas para o trabalho. O padrão é 1. Um erro será retornado quando este limite for atingido. O valor máximo que pode ser especificado é controlado por um limite de serviço.

## Estrutura NotificationProperty
<a name="aws-glue-api-jobs-job-NotificationProperty"></a>

Especifica propriedades de configuração de uma notificação.

**Campos**
+ `NotifyDelayAfter` – Número (inteiro), pelo menos 1.

  Depois que a execução de um trabalho for iniciada, o número de minutos a esperar antes de enviar uma notificação de atraso de execução de trabalho.

## Estrutura JobCommand
<a name="aws-glue-api-jobs-job-JobCommand"></a>

Especifica o código executado quando um trabalho é executado.

**Campos**
+ `Name` – String UTF-8.

  O nome do comando de trabalho. Para um trabalho de ETL do Apache Spark, ele deve ser `glueetl`. Para um trabalho de shell do Python, ele deve ser `pythonshell`. Para um trabalho de ETL de streaming do Apache Spark, ele deve ser `gluestreaming`. Para um trabalho do Ray, isso deve ser `glueray`.
+ `ScriptLocation`: string UTF-8, não superior a 400.000 bytes de comprimento.

  Especifica o caminho do Amazon Simple Storage Service (Amazon S3) para um script que executa um trabalho.
+ `PythonVersion` – String UTF-8 correspondente a [Custom string pattern #49](aws-glue-api-common.md#regex_49).

  A versão de Python que está em uso para executar um trabalho de shell em Python. Os valores permitidos são 2 ou 3.
+ `Runtime` – string UTF-8, com no máximo 64 bytes de comprimento, correspondendo a [Custom string pattern #33](aws-glue-api-common.md#regex_33).

  Em trabalhos do Ray, Runtime é usado para especificar as versões do Ray, do Python e das bibliotecas adicionais disponíveis no ambiente. Esse campo não é usado em outros tipos de trabalho. Para obter os valores do ambiente de runtime compatíveis, consulte [Ambientes de runtime do Ray compatíveis](https://docs.aws.amazon.com/glue/latest/dg/ray-jobs-section.html) no Guia do desenvolvedor do AWS Glue.

## Estrutura ConnectionsList
<a name="aws-glue-api-jobs-job-ConnectionsList"></a>

Especifica as conexões usadas por um trabalho.

**Campos**
+ `Connections`: uma matriz de strings UTF-8, no máximo mil strings.

  Uma lista das conexões usadas pelo trabalho.

## Estrutura JobUpdate
<a name="aws-glue-api-jobs-job-JobUpdate"></a>

Especifica as informações usadas para atualizar uma definição de trabalho existente. A definição de trabalho anterior é totalmente substituída por essa informação.

**Campos**
+ `JobMode` – string UTF-8 (valores válidos: `SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`).

  Um modo que descreve como um trabalho foi criado. Os valores válidos são:
  + `SCRIPT`: o trabalho foi criado usando o editor de scripts do AWS Glue Studio.
  + `VISUAL`: o trabalho foi criado usando o editor visual do AWS Glue Studio.
  + `NOTEBOOK`: o trabalho foi criado usando um caderno de sessões interativas.

  Quando o campo `JobMode` está ausente ou é nulo, `SCRIPT` é atribuído como o valor padrão.
+ `JobRunQueuingEnabled` – Booleano.

  Especifica se o enfileiramento da execução de trabalhos está habilitado para as execuções desse trabalho.

  Um valor "verdadeiro" significa que o enfileiramento da execução de trabalhos está habilitado para a execução do trabalho. Se o valor for "falso" ou não estiver preenchido, as execuções do trabalho não serão consideradas para enfileiramento.

  Se esse campo não corresponder ao valor definido na execução do trabalho, o valor do campo de execução do trabalho será usado.
+ `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).

  Descrição do trabalho que está sendo definido.
+ `LogUri` – String UTF-8.

  Este campo está reservado para uso futuro.
+ `Role` – String UTF-8.

  O nome ou o nome do recurso da Amazon (ARN) da função do IAM associada a esse trabalho (obrigatório).
+ `ExecutionProperty` – Um objeto [ExecutionProperty](#aws-glue-api-jobs-job-ExecutionProperty).

  Um `ExecutionProperty` que especifica o número máximo de execuções simultâneas permitidas para o trabalho.
+ `Command` – Um objeto [JobCommand](#aws-glue-api-jobs-job-JobCommand).

  O `JobCommand` que executa esse trabalho (obrigatório).
+ `DefaultArguments` – 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.

  Os argumentos padrão para toda execução desse trabalho, especificados como pares de nome-valor.

  Aqui, é possível especificar os argumentos que seu próprio script de execução de trabalho consome, além dos argumentos que o AWS Glue consome.

  Os argumentos do trabalho podem ser registrados em log. Não transmita segredos em texto simples como argumentos. Recupere os segredos de uma conexão do AWS Glue, AWS Secrets Manager ou outro mecanismo de gerenciamento de segredo se pretender mantê-los dentro do trabalho. 

  Para obter informações sobre como especificar e consumir seus próprios argumentos de trabalho, consulte o tópico [Chamar APIs do AWS Glue em Python](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) no guia do desenvolvedor.

  Para obter informações sobre os argumentos que podem ser fornecidos a esse campo ao configurar trabalhos do Spark, consulte o tópico [Parâmetros especiais usados pelo AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) no guia do desenvolvedor.

  Para obter informações sobre os argumentos que podem ser fornecidos a esse campo ao configurar trabalhos do Ray, consulte o tópico [Usar parâmetros de trabalho em trabalhos do Ray](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) no guia do desenvolvedor.
+ `NonOverridableArguments` – 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.

  Argumentos para esse trabalho que não são substituídos ao fornecer argumentos de trabalho na execução de um trabalho, especificados como pares de nome-valor.
+ `Connections` – Um objeto [ConnectionsList](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ConnectionsList).

  As conexões usadas no trabalho.
+ `MaxRetries` – Número (íntegro).

  O número máximo de novas tentativas desse trabalho em caso de falha.
+ `AllocatedCapacity` – Número (íntegro).

  Este campo está obsoleto. Use `MaxCapacity` em vez disso.

  O número de unidades de processamento de dados (DPUs) do AWS Glue a serem alocadas para esse trabalho. É possível alocar um mínimo de 2 DPUs; o padrão é 10. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/).
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite do trabalho em minutos. Este é o tempo máximo durante o qual uma execução de trabalho pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`.

  Os trabalhos devem ter valores de tempo limite inferiores a 7 dias ou 10.080 minutos. Caso contrário, os trabalhos gerarão uma exceção.

  Quando o valor é deixado em branco, o tempo limite padrão é de 2.880 minutos.

  Quaisquer trabalhos do AWS Glue existentes que tinham um valor de tempo limite maior que 7 dias serão padronizados para 7 dias. Por exemplo, se você especificou um tempo limite de 20 dias para um trabalho em lote, ele será interrompido no 7º dia.

  Para trabalhos de streaming, se você tiver configurado uma janela de manutenção, ela será reiniciada durante a janela de manutenção após 7 dias.
+ `MaxCapacity` – Número (duplo).

  Para trabalhos do Glue versão 1.0 ou anterior, usando o tipo de operador padrão, é o número de unidades de processamento de dados (DPUs) do AWS Glue que poderão ser alocadas quando esse trabalho for executado. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/).

  Para trabalhos do Glue versão 2.0\$1, você não pode especificar uma `Maximum capacity`. Em vez disso, você deve especificar um `Worker type` e o `Number of workers`.

  Não defina `MaxCapacity` se estiver usando `WorkerType` e `NumberOfWorkers`.

  O valor que pode ser alocado para `MaxCapacity` depende se você está executando um trabalho de shell do Python, um trabalho de ETL do Apache Spark ou um trabalho de ETL de streaming do Apache Spark:
  + Ao especificar um trabalho de shell do Python (`JobCommand.Name`="pythonshell"), será possível alocar 0,0625 ou 1 DPU. O padrão é 0,0625 DPU.
  + Ao especificar um trabalho de ETL do Apache Spark (`JobCommand.Name`="glueetl") ou um trabalho de ETL de streaming do Apache Spark (`JobCommand.Name`="gluestreaming"), é possível alocar de 2 a 100 DPUs. O padrão é de 10 DPUs. Esse tipo de trabalho não pode ter uma alocação de DPU fracionada.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 `G.16X=""` \$1 `R.1X=""` \$1 `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido que é alocado quando um trabalho é executado. Aceita um valor de G.025X, G.1X, G.2X, G.4X, G.8X, G.12X, G.16X, R.1X, R.2X, R.4X, or R.8X para trabalhos do Spark. Aceita o valor Z.2X para trabalhos do Ray. Para obter mais informações, consulte [Definir propriedades de trabalho para trabalhos do Spark](https://docs.aws.amazon.com/glue/latest/dg/add-job.html#create-job).
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de determinado `workerType` que são alocados quando um trabalho é executado.
+ `SecurityConfiguration` – 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 estrutura de `SecurityConfiguration` a ser usada com esse trabalho.
+ `NotificationProperty` – Um objeto [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty).

  Especifica as propriedades de configuração de uma notificação de trabalho.
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Nas tarefas do Spark, `GlueVersion` determina as versões do Apache Spark e do Python que o AWS Glue disponibiliza em um trabalho. A versão do Python indica a versão compatível com trabalhos do tipo Spark. 

  Os trabalhos de Ray devem definir `GlueVersion` como `4.0` ou mais. Porém, as versões do Ray, do Python e das bibliotecas adicionais disponíveis no seu trabalho do Ray são determinadas pelo parâmetro `Runtime` do comando Job.

  Para obter mais informações sobre as versões disponíveis do AWS Glue e as versões correspondentes do Spark e do Python, consulte [Versão do Glue](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) no guia do desenvolvedor.

  Os trabalhos criados sem especificar uma versão do Glue usam como padrão o Glue 0.9.
+ `CodeGenConfigurationNodes` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  Cada valor é um objeto [CodeGenConfigurationNode](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CodeGenConfigurationNode) A.

  A representação de um gráfico acíclico direcionado no qual tanto o componente visual do Glue Studio quanto a geração de código do Glue Studio são baseados.
+ `ExecutionClass`: string UTF-8, inferior a 16 bytes de comprimento (valores válidos: `FLEX=""` \$1 `STANDARD=""`).

  Indica se o trabalho é executado com uma classe de execução padrão ou flexível. A classe de execução padrão é ideal para workloads sensíveis ao tempo que exigem a inicialização rápida de trabalhos e recursos dedicados.

  A classe de execução flexível é adequada para trabalhos insensíveis ao tempo, cujos horários de início e conclusão podem variar. 

  Somente trabalhos com o AWS Glue versão 3.0 e posterior e o tipo de comando `glueetl` terão permissão para definir `ExecutionClass` como `FLEX`. A classe de execução flexível está disponível para trabalhos do Spark.
+ `SourceControlDetails` – Um objeto [SourceControlDetails](#aws-glue-api-jobs-job-SourceControlDetails).

  Os detalhes de uma configuração de controle de origem para um trabalho, permitindo a sincronização de artefatos de trabalho de ou para um repositório remoto.
+ `MaintenanceWindow` – String UTF-8 correspondente a [Custom string pattern #34](aws-glue-api-common.md#regex_34).

  Esse campo especifica um dia da semana e uma hora para uma janela de manutenção para trabalhos de streaming. O AWS Glue realiza periodicamente atividades de manutenção. Durante essas janelas de manutenção, o AWS Glue precisará reiniciar seus trabalhos de streaming.

  O AWS Glue reiniciará o trabalho dentro de 3 horas da janela de manutenção especificada. Por exemplo, se você configurar a janela de manutenção para segunda-feira às 10h (GMT), seus trabalhos serão reiniciados entre 10h (GMT) e 13h (GMT).
+ `ProfileName` – 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 de um perfil de uso do AWS Glue associado ao trabalho.

## Estrutura SourceControlDetails
<a name="aws-glue-api-jobs-job-SourceControlDetails"></a>

Os detalhes de uma configuração de controle de origem para um trabalho, permitindo a sincronização de artefatos de trabalho de ou para um repositório remoto.

**Campos**
+ `Provider` – string UTF-8 (valores válidos: `GITHUB` \$1 `AWS_CODE_COMMIT`).

  O provedor do repositório remoto.
+ `Repository`: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento.

  O nome do repositório remoto que contém os artefatos do trabalho.
+ `Owner`: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento.

  O proprietário do repositório remoto que contém os artefatos do trabalho.
+ `Branch`: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento.

  Uma ramificação opcional no repositório remoto.
+ `Folder`: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento.

  Uma pasta opcional no repositório remoto.
+ `LastCommitId`: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento.

  O último ID de confirmação no repositório remoto.
+ `LastSyncTimestamp`: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento.

  A data e a hora em que a última sincronização de trabalho foi realizada.
+ `AuthStrategy` – string UTF-8 (valores válidos: `PERSONAL_ACCESS_TOKEN` \$1 `AWS_SECRETS_MANAGER`).

  O tipo de autenticação, que pode ser um token de autenticação armazenado no AWS Secrets Manager ou um token de acesso pessoal.
+ `AuthToken`: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento.

  O valor de um token de autorização.

## Operações
<a name="aws-glue-api-jobs-job-actions"></a>
+ [Ação CreateJob (Python: create\$1job)](#aws-glue-api-jobs-job-CreateJob)
+ [Ação UpdateJob (Python: update\$1job)](#aws-glue-api-jobs-job-UpdateJob)
+ [Ação GetJob (Python: get\$1job)](#aws-glue-api-jobs-job-GetJob)
+ [Ação GetJobs (Python: get\$1jobs)](#aws-glue-api-jobs-job-GetJobs)
+ [Ação DeleteJob (Python: delete\$1job)](#aws-glue-api-jobs-job-DeleteJob)
+ [Ação ListJobs (Python: list\$1jobs)](#aws-glue-api-jobs-job-ListJobs)
+ [Ação BatchGetJobs (Python: batch\$1get\$1jobs)](#aws-glue-api-jobs-job-BatchGetJobs)

## Ação CreateJob (Python: create\$1job)
<a name="aws-glue-api-jobs-job-CreateJob"></a>

Cria uma nova definição de trabalho.

**Solicitaçã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 que você atribui a esta definição de trabalho. Ele deve ser exclusivo na sua conta.
+ `JobMode` – string UTF-8 (valores válidos: `SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`).

  Um modo que descreve como um trabalho foi criado. Os valores válidos são:
  + `SCRIPT`: o trabalho foi criado usando o editor de scripts do AWS Glue Studio.
  + `VISUAL`: o trabalho foi criado usando o editor visual do AWS Glue Studio.
  + `NOTEBOOK`: o trabalho foi criado usando um caderno de sessões interativas.

  Quando o campo `JobMode` está ausente ou é nulo, `SCRIPT` é atribuído como o valor padrão.
+ `JobRunQueuingEnabled` – Booleano.

  Especifica se o enfileiramento da execução de trabalhos está habilitado para as execuções desse trabalho.

  Um valor "verdadeiro" significa que o enfileiramento da execução de trabalhos está habilitado para a execução do trabalho. Se o valor for "falso" ou não estiver preenchido, as execuções do trabalho não serão consideradas para enfileiramento.

  Se esse campo não corresponder ao valor definido na execução do trabalho, o valor do campo de execução do trabalho será usado.
+ `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).

  Descrição do trabalho que está sendo definido.
+ `LogUri` – String UTF-8.

  Este campo está reservado para uso futuro.
+ `Role` – *Obrigatório:* string UTF-8.

  O nome ou o nome do recurso da Amazon (ARN) da função do IAM associada a esta trabalho.
+ `ExecutionProperty` – Um objeto [ExecutionProperty](#aws-glue-api-jobs-job-ExecutionProperty).

  Um `ExecutionProperty` que especifica o número máximo de execuções simultâneas permitidas para o trabalho.
+ `Command` – *Obrigatório:* um objeto [JobCommand](#aws-glue-api-jobs-job-JobCommand).

  O `JobCommand` que executa esse trabalho.
+ `DefaultArguments` – 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.

  Os argumentos padrão para toda execução desse trabalho, especificados como pares de nome-valor.

  Aqui, é possível especificar os argumentos que seu próprio script de execução de trabalho consome, além dos argumentos que o AWS Glue consome.

  Os argumentos do trabalho podem ser registrados em log. Não transmita segredos em texto simples como argumentos. Recupere os segredos de uma conexão do AWS Glue, AWS Secrets Manager ou outro mecanismo de gerenciamento de segredo se pretender mantê-los dentro do trabalho. 

  Para obter informações sobre como especificar e consumir seus próprios argumentos de trabalho, consulte o tópico [Chamar APIs do AWS Glue em Python](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) no guia do desenvolvedor.

  Para obter informações sobre os argumentos que podem ser fornecidos a esse campo ao configurar trabalhos do Spark, consulte o tópico [Parâmetros especiais usados pelo AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) no guia do desenvolvedor.

  Para obter informações sobre os argumentos que podem ser fornecidos a esse campo ao configurar trabalhos do Ray, consulte o tópico [Usar parâmetros de trabalho em trabalhos do Ray](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) no guia do desenvolvedor.
+ `NonOverridableArguments` – 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.

  Argumentos para esse trabalho que não são substituídos ao fornecer argumentos de trabalho na execução de um trabalho, especificados como pares de nome-valor.
+ `Connections` – Um objeto [ConnectionsList](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ConnectionsList).

  As conexões usadas no trabalho.
+ `MaxRetries` – Número (íntegro).

  O número máximo de novas tentativas desse trabalho em caso de falha.
+ `AllocatedCapacity` – Número (íntegro).

  Esse parâmetro está suspenso. Use `MaxCapacity` em vez disso.

  O número de unidades de processamento de dados (DPUs) do AWS Glue a serem alocadas para esse trabalho. É possível alocar um mínimo de 2 DPUs; o padrão é 10. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/).
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite do trabalho em minutos. Este é o tempo máximo durante o qual uma execução de trabalho pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`.

  Os trabalhos devem ter valores de tempo limite inferiores a 7 dias ou 10.080 minutos. Caso contrário, os trabalhos gerarão uma exceção.

  Quando o valor é deixado em branco, o tempo limite padrão é de 2.880 minutos.

  Quaisquer trabalhos do AWS Glue existentes que tinham um valor de tempo limite maior que 7 dias serão padronizados para 7 dias. Por exemplo, se você especificou um tempo limite de 20 dias para um trabalho em lote, ele será interrompido no 7º dia.

  Para trabalhos de streaming, se você tiver configurado uma janela de manutenção, ela será reiniciada durante a janela de manutenção após 7 dias.
+ `MaxCapacity` – Número (duplo).

  Para trabalhos do Glue versão 1.0 ou anterior, usando o tipo de operador padrão, é o número de unidades de processamento de dados (DPUs) do AWS Glue que poderão ser alocadas quando esse trabalho for executado. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/).

  Para trabalhos do Glue versão 2.0\$1, você não pode especificar uma `Maximum capacity`. Em vez disso, você deve especificar um `Worker type` e o `Number of workers`.

  Não defina `MaxCapacity` se estiver usando `WorkerType` e `NumberOfWorkers`.

  O valor que pode ser alocado para `MaxCapacity` depende se você está executando um trabalho de shell do Python, um trabalho de ETL do Apache Spark ou um trabalho de ETL de streaming do Apache Spark:
  + Ao especificar um trabalho de shell do Python (`JobCommand.Name`="pythonshell"), será possível alocar 0,0625 ou 1 DPU. O padrão é 0,0625 DPU.
  + Ao especificar um trabalho de ETL do Apache Spark (`JobCommand.Name`="glueetl") ou um trabalho de ETL de streaming do Apache Spark (`JobCommand.Name`="gluestreaming"), é possível alocar de 2 a 100 DPUs. O padrão é de 10 DPUs. Esse tipo de trabalho não pode ter uma alocação de DPU fracionada.
+ `SecurityConfiguration` – 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 estrutura de `SecurityConfiguration` a ser usada com esse trabalho.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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 a serem usadas com essa tarefa. Você pode usar tags para limitar o acesso à tarefa. Para obter mais informações sobre tags no AWS Glue, consulte [Tags da AWS no AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) no guia do desenvolvedor.
+ `NotificationProperty` – Um objeto [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty).

  Especifica propriedades de configuração de uma notificação de trabalho.
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Nas tarefas do Spark, `GlueVersion` determina as versões do Apache Spark e do Python que o AWS Glue disponibiliza em um trabalho. A versão do Python indica a versão compatível com trabalhos do tipo Spark. 

  Os trabalhos de Ray devem definir `GlueVersion` como `4.0` ou mais. Porém, as versões do Ray, do Python e das bibliotecas adicionais disponíveis no seu trabalho do Ray são determinadas pelo parâmetro `Runtime` do comando Job.

  Para obter mais informações sobre as versões disponíveis do AWS Glue e as versões correspondentes do Spark e do Python, consulte [Versão do Glue](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) no guia do desenvolvedor.

  Os trabalhos criados sem especificar uma versão do Glue usam como padrão o Glue 0.9.
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de determinado `workerType` que são alocados quando um trabalho é executado.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 `G.16X=""` \$1 `R.1X=""` \$1 `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido que é alocado quando um trabalho é executado. Aceita um valor de G.025X, G.1X, G.2X, G.4X, G.8X, G.12X, G.16X, R.1X, R.2X, R.4X, or R.8X para trabalhos do Spark. Aceita o valor Z.2X para trabalhos do Ray.
  + Para o tipo de operador `G.025X`, cada operador é mapeado para 0,25 DPU (2 vCPU, 4 GB de memória) com 84 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos de streaming de baixo volume. Esse tipo de operador só está disponível para trabalhos de streaming do AWS Glue versão 3.0 ou posterior.
  + Para o tipo de operador `G.1X`, cada operador é mapeado em 1 DPU (4 vCPU, 16 GB de memória) com 94 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads, como transformações de dados, uniões e consultas, para oferecer uma maneira escalável e econômica de executar a maioria dos trabalhos.
  + Para o tipo de operador `G.2X`, cada operador é mapeado em 2 DPU (8 vCPU, 32 GB de memória) com 138 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads, como transformações de dados, uniões e consultas, para oferecer uma maneira escalável e econômica de executar a maioria dos trabalhos.
  + Para o tipo de operador `G.4X`, cada operador é mapeado em 4 DPU (16 vCPU, 64 GB de memória) com 256 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos cujas workloads contêm as transformações, agregações, uniões e consultas mais exigentes. Estes tipos de operadores estão disponíveis apenas para trabalhos Spark ETL do AWS Glue versão 3.0 ou posteriores nas seguintes regiões da AWS: Leste dos EUA (Ohio), Leste dos EUA (Norte da Virgínia), Oeste dos EUA (N. da Califórnia), Oeste dos EUA (Oregon), Ásia-Pacífico (Mumbai), Ásia-Pacífico (Seul), Ásia-Pacífico (Singapura), Ásia-Pacífico (Sydney), Ásia-Pacífico (Tóquio), Canadá (Central), Europa (Frankfurt), Europa (Irlanda), Europa (Londres), Europa (Espanha), Europa (Estocolmo) e 
  + Para o tipo de operador `G.8X`, cada operador é mapeado em 8 DPU (32 vCPU, 128 GB de memória) com 512 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos cujas workloads contêm as transformações, agregações, uniões e consultas mais exigentes. Esse tipo de operador está disponível somente para trabalhos de ETL do Spark no AWS Glue versão 3.0 ou posterior, nas mesmas regiões da AWS compatíveis com o tipo de operador `G.4X`.
  + Para o tipo de operador `G.12X`, cada operador é mapeado em 12 DPU (48 vCPU, 192 GB de memória) com 768 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos com workloads muito grandes. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `G.16X`, cada operador é mapeado em 16 DPU (64 vCPU, 256 GB de memória) com 1024 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos com workloads muito grandes. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `R.1X`, cada operador é mapeado em 1 DPU (4 vCPU, 32 GB de memória) com 94 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `R.2X`, cada operador é mapeado em 2 DPU (8 vCPU, 64 GB de memória) com 128 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `R.4X`, cada operador é mapeado em 4 DPU (16 vCPU, 128 GB de memória) com 256 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `R.8X`, cada operador é mapeado em 8 DPU (32 vCPU, 256 GB de memória) com 512 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `Z.2X`, cada operador é mapeado em 2 M-DPU (8 vCPUs, 64 GB de memória) com 128 GB de disco e fornece até 8 operadores do Ray baseados no autoscaler.
+ `CodeGenConfigurationNodes` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 que corresponde a [Custom string pattern #60](aws-glue-api-common.md#regex_60).

  Cada valor é um objeto [CodeGenConfigurationNode](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CodeGenConfigurationNode) A.

  A representação de um gráfico acíclico direcionado no qual tanto o componente visual do Glue Studio quanto a geração de código do Glue Studio são baseados.
+ `ExecutionClass`: string UTF-8, inferior a 16 bytes de comprimento (valores válidos: `FLEX=""` \$1 `STANDARD=""`).

  Indica se o trabalho é executado com uma classe de execução padrão ou flexível. A classe de execução padrão é ideal para workloads sensíveis ao tempo que exigem a inicialização rápida de trabalhos e recursos dedicados.

  A classe de execução flexível é adequada para trabalhos insensíveis ao tempo, cujos horários de início e conclusão podem variar. 

  Somente trabalhos com o AWS Glue versão 3.0 e posterior e o tipo de comando `glueetl` terão permissão para definir `ExecutionClass` como `FLEX`. A classe de execução flexível está disponível para trabalhos do Spark.
+ `SourceControlDetails` – Um objeto [SourceControlDetails](#aws-glue-api-jobs-job-SourceControlDetails).

  Os detalhes de uma configuração de controle de origem para um trabalho, permitindo a sincronização de artefatos de trabalho de ou para um repositório remoto.
+ `MaintenanceWindow` – String UTF-8 correspondente a [Custom string pattern #34](aws-glue-api-common.md#regex_34).

  Esse campo especifica um dia da semana e uma hora para uma janela de manutenção para trabalhos de streaming. O AWS Glue realiza periodicamente atividades de manutenção. Durante essas janelas de manutenção, o AWS Glue precisará reiniciar seus trabalhos de streaming.

  O AWS Glue reiniciará o trabalho dentro de 3 horas da janela de manutenção especificada. Por exemplo, se você configurar a janela de manutenção para segunda-feira às 10h (GMT), seus trabalhos serão reiniciados entre 10h (GMT) e 13h (GMT).
+ `ProfileName` – 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 de um perfil de uso do AWS Glue associado ao trabalho.

**Resposta**
+ `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 exclusivo que foi fornecido para esta definição de trabalho.

**Erros**
+ `InvalidInputException`
+ `IdempotentParameterMismatchException`
+ `AlreadyExistsException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`

## Ação UpdateJob (Python: update\$1job)
<a name="aws-glue-api-jobs-job-UpdateJob"></a>

Atualiza uma definição de trabalho existente. A definição de trabalho anterior é totalmente substituída por essa informação.

**Solicitação**
+ `JobName`: *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 definição de trabalho a ser atualizada.
+ `JobUpdate` – *Obrigatório:* um objeto [JobUpdate](#aws-glue-api-jobs-job-JobUpdate).

  Especifica os valores com os quais a definição de trabalho será atualizada. A configuração não especificada é removida ou redefinida para os valores padrão.
+ `ProfileName` – 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 de um perfil de uso do AWS Glue associado ao trabalho.

**Resposta**
+ `JobName` – 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).

  Retorna o nome da definição de trabalho atualizada.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## Ação GetJob (Python: get\$1job)
<a name="aws-glue-api-jobs-job-GetJob"></a>

Recupera uma definição de trabalho existente.

**Solicitação**
+ `JobName`: *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 trabalho a ser recuperada.

**Resposta**
+ `Job` – Um objeto [Trabalho](#aws-glue-api-jobs-job-Job).

  A definição de trabalho solicitada.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetJobs (Python: get\$1jobs)
<a name="aws-glue-api-jobs-job-GetJobs"></a>

Recupera todas as definições de trabalho atuais.

**Solicitaçã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 tamanho máximo da resposta.

**Resposta**
+ `Jobs`: um array de objetos [Trabalho](#aws-glue-api-jobs-job-Job).

  Uma lista de definições de trabalho.
+ `NextToken` – String UTF-8.

  Um token de continuação, caso algumas definições de trabalho ainda não tenham sido retornadas.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação DeleteJob (Python: delete\$1job)
<a name="aws-glue-api-jobs-job-DeleteJob"></a>

Exclui uma definição de trabalho especificada. Se a definição de trabalho não for encontrada, nenhuma exceção será gerada.

**Solicitação**
+ `JobName`: *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 trabalho a ser excluída.

**Resposta**
+ `JobName` – 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 de trabalho que foi excluída.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação ListJobs (Python: list\$1jobs)
<a name="aws-glue-api-jobs-job-ListJobs"></a>

Recupera os nomes de todos os recursos do trabalho nessa conta da AWS ou os recursos com a tag especificada. Essa operação permite que você veja quais recursos estão disponíveis em sua conta e seus nomes.

Essa operação aceita o campo `Tags` opcional, que pode ser usado como um filtro na resposta, para que recursos com tags possam ser recuperados como um grupo. Se você optar por usar a filtragem por tags, apenas os recursos com a tag serão recuperados.

**Solicitação**
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma solicitação de continuação.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O tamanho máximo de uma lista a ser retornada.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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.

  Especifica apenas o retorno desses recursos com tags.

**Resposta**
+ `JobNames` – Uma matriz de strings UTF-8.

  Os nomes de todos os trabalhos na conta ou os trabalhos com as tags especificadas.
+ `NextToken` – String UTF-8.

  Um token de continuação, se a lista retornada não contiver a métrica mais recente disponível.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação BatchGetJobs (Python: batch\$1get\$1jobs)
<a name="aws-glue-api-jobs-job-BatchGetJobs"></a>

Retorna uma lista de metadados do recurso para uma lista de nomes de trabalho. Depois de chamar a operação `ListJobs`, você pode chamar essa operação para acessar os dados aos quais você recebeu permissões. Essa operação oferece suporte a todas as permissões do IAM, incluindo condições de permissão que usam tags. 

**Solicitação**
+ `JobNames`: *obrigatório:* uma matriz de strings UTF-8.

  Uma lista de nomes de trabalho, que podem ser os nomes retornados da operação `ListJobs`.

**Resposta**
+ `Jobs`: um array de objetos [Trabalho](#aws-glue-api-jobs-job-Job).

  Uma lista de definições de trabalho.
+ `JobsNotFound` – Uma matriz de strings UTF-8.

  Uma lista de nomes de trabalho não encontrados.

**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

# Execuções de trabalhos
<a name="aws-glue-api-jobs-runs"></a>

 A API de execuções de trabalhos descreve os tipos de dados e a API relacionada para iniciar, interromper ou visualizar execuções de trabalhos e redefinir marcações de trabalhos no AWS Glue. O histórico de execução de trabalhos pode ser acessado por 90 dias para seu fluxo de trabalho e execução de trabalhos. 

## Tipos de dados
<a name="aws-glue-api-jobs-runs-objects"></a>
+ [Estrutura JobRun](#aws-glue-api-jobs-runs-JobRun)
+ [Estrutura Predecessor](#aws-glue-api-jobs-runs-Predecessor)
+ [Estrutura JobBookmarkEntry](#aws-glue-api-jobs-runs-JobBookmarkEntry)
+ [Estrutura BatchStopJobRunSuccessfulSubmission](#aws-glue-api-jobs-runs-BatchStopJobRunSuccessfulSubmission)
+ [Estrutura BatchStopJobRunError](#aws-glue-api-jobs-runs-BatchStopJobRunError)
+ [Estrutura NotificationProperty](#aws-glue-api-jobs-runs-NotificationProperty)

## Estrutura JobRun
<a name="aws-glue-api-jobs-runs-JobRun"></a>

Contém informações sobre uma execução de trabalho.

**Campos**
+ `Id` – 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 dessa execução de trabalho.
+ `Attempt` – Número (íntegro).

  O número de tentativas para execução deste trabalho.
+ `PreviousRunId` – 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 execução anterior deste trabalho. Por exemplo, o `JobRunId` especificado na ação `StartJobRun`.
+ `TriggerName` – 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 gatilho que iniciou esta execução de trabalho.
+ `JobName` – 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 de trabalho que está sendo usada nesta execução.
+ `JobMode` – string UTF-8 (valores válidos: `SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`).

  Um modo que descreve como um trabalho foi criado. Os valores válidos são:
  + `SCRIPT`: o trabalho foi criado usando o editor de scripts do AWS Glue Studio.
  + `VISUAL`: o trabalho foi criado usando o editor visual do AWS Glue Studio.
  + `NOTEBOOK`: o trabalho foi criado usando um caderno de sessões interativas.

  Quando o campo `JobMode` está ausente ou é nulo, `SCRIPT` é atribuído como o valor padrão.
+ `JobRunQueuingEnabled` – Booleano.

  Especifica se o enfileiramento da execução de trabalhos está habilitado para a execução do trabalho.

  Um valor "verdadeiro" significa que o enfileiramento da execução de trabalhos está habilitado para as execuções do trabalho. Se o valor for "falso" ou não estiver preenchido, a execução do trabalho não será considerada para enfileiramento.
+ `StartedOn` – Timestamp.

  A data e a hora em que a execução deste trabalho foi iniciada.
+ `LastModifiedOn` – Timestamp.

  A hora em que a execução desse trabalho foi modificada.
+ `CompletedOn` – Timestamp.

  A data e a hora em que a execução desse trabalho foi concluída.
+ `JobRunState`: string UTF-8 (valores válidos: `STARTING` \$1 `RUNNING` \$1 `STOPPING` \$1 `STOPPED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `TIMEOUT` \$1 `ERROR` \$1 `WAITING` \$1 `EXPIRED`).

  O estado atual da execução do trabalho. Para obter mais informações sobre os status de trabalhos que foram terminados de forma anormal, consulte [Status de execução de trabalhos do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/job-run-statuses.html).
+ `Arguments` – 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.

  Os argumentos de trabalho associados a esta execução. Para essa execução de tarefa, eles substituem os argumentos padrão definidos na própria definição de tarefa.

  Aqui, é possível especificar os argumentos que seu próprio script de execução de trabalho consome, além dos argumentos que o AWS Glue consome.

  Os argumentos do trabalho podem ser registrados em log. Não transmita segredos em texto simples como argumentos. Recupere os segredos de uma conexão do AWS Glue, AWS Secrets Manager ou outro mecanismo de gerenciamento de segredo se pretender mantê-los dentro do trabalho. 

  Para obter informações sobre como especificar e consumir seus próprios argumentos de trabalho, consulte o tópico [Chamar APIs do AWS Glue em Python](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) no guia do desenvolvedor.

  Para obter informações sobre os argumentos que podem ser fornecidos a esse campo ao configurar trabalhos do Spark, consulte o tópico [Parâmetros especiais usados pelo AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) no guia do desenvolvedor.

  Para obter informações sobre os argumentos que podem ser fornecidos a esse campo ao configurar trabalhos do Ray, consulte o tópico [Uso de parâmetros de trabalho em trabalhos do Ray](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) no guia do desenvolvedor.
+ `ErrorMessage` – String UTF-8.

  Uma mensagem de erro associada à execução deste trabalho.
+ `PredecessorRuns`: um array de objetos [Predecessor](#aws-glue-api-jobs-runs-Predecessor).

  Uma lista de predecessores para a execução deste trabalho.
+ `AllocatedCapacity` – Número (íntegro).

  Este campo está obsoleto. Use `MaxCapacity` em vez disso.

  O número de unidades de processamento de dados (DPUs) do AWS Glue atribuídas a esse JobRun. É possível atribuir de 2 a 100 DPUs, e o padrão é 10. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/).
+ `ExecutionTime` – Número (íntegro).

  A quantidade de tempo (em segundos) em que o trabalho executado consumiu recursos.
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite de `JobRun` em minutos. Este é o tempo máximo durante o qual uma execução de trabalho pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. Esse valor substitui o valor de tempo limite definido no trabalho principal.

  Os trabalhos devem ter valores de tempo limite inferiores a 7 dias ou 10.080 minutos. Caso contrário, os trabalhos gerarão uma exceção.

  Quando o valor é deixado em branco, o tempo limite padrão é de 2.880 minutos.

  Quaisquer trabalhos do AWS Glue existentes que tinham um valor de tempo limite maior que 7 dias serão padronizados para 7 dias. Por exemplo, se você especificou um tempo limite de 20 dias para um trabalho em lote, ele será interrompido no 7º dia.

  Para trabalhos de streaming, se você tiver configurado uma janela de manutenção, ela será reiniciada durante a janela de manutenção após 7 dias.
+ `MaxCapacity` – Número (duplo).

  Para trabalhos do Glue versão 1.0 ou anterior, usando o tipo de operador padrão, é o número de unidades de processamento de dados (DPUs) do AWS Glue que poderão ser alocadas quando esse trabalho for executado. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/).

  Para trabalhos do Glue versão 2.0\$1, você não pode especificar uma `Maximum capacity`. Em vez disso, você deve especificar um `Worker type` e o `Number of workers`.

  Não defina `MaxCapacity` se estiver usando `WorkerType` e `NumberOfWorkers`.

  O valor que pode ser alocado para `MaxCapacity` depende se você está executando um trabalho de shell do Python, um trabalho de ETL do Apache Spark ou um trabalho de ETL de streaming do Apache Spark:
  + Ao especificar um trabalho de shell do Python (`JobCommand.Name`="pythonshell"), será possível alocar 0,0625 ou 1 DPU. O padrão é 0,0625 DPU.
  + Ao especificar um trabalho de ETL do Apache Spark (`JobCommand.Name`="glueetl") ou um trabalho de ETL de streaming do Apache Spark (`JobCommand.Name`="gluestreaming"), é possível alocar de 2 a 100 DPUs. O padrão é de 10 DPUs. Esse tipo de trabalho não pode ter uma alocação de DPU fracionada.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 `G.16X=""` \$1 `R.1X=""` \$1 `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido que é alocado quando um trabalho é executado. Aceita um valor de G.025X, G.1X, G.2X, G.4X, G.8X, G.12X, G.16X, R.1X, R.2X, R.4X, or R.8X para trabalhos do Spark. Aceita o valor Z.2X para trabalhos do Ray.
  + Para o tipo de operador `G.1X`, cada operador é mapeado em 1 DPU (4 vCPU, 16 GB de memória) com 94 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads, como transformações de dados, uniões e consultas, para oferecer uma maneira escalável e econômica de executar a maioria dos trabalhos.
  + Para o tipo de operador `G.2X`, cada operador é mapeado em 2 DPU (8 vCPU, 32 GB de memória) com 138 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads, como transformações de dados, uniões e consultas, para oferecer uma maneira escalável e econômica de executar a maioria dos trabalhos.
  + Para o tipo de operador `G.4X`, cada operador é mapeado em 4 DPU (16 vCPU, 64 GB de memória) com 256 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos cujas workloads contêm as transformações, agregações, uniões e consultas mais exigentes. Esse tipo de operador está disponível somente para trabalhos de ETL do Spark no AWS Glue versão 3.0 ou posterior nas seguintes regiões da AWS: Leste dos EUA (Ohio), Leste dos EUA (Norte da Virgínia), Oeste dos EUA (Oregon), Ásia-Pacífico (Singapura), Ásia-Pacífico (Sydney), Ásia-Pacífico (Tóquio), Canadá (Central), Europa (Frankfurt), Europa (Irlanda) e Europa (Estocolmo).
  + Para o tipo de operador `G.8X`, cada operador é mapeado em 8 DPU (32 vCPU, 128 GB de memória) com 512 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos cujas workloads contêm as transformações, agregações, uniões e consultas mais exigentes. Esse tipo de operador está disponível somente para trabalhos de ETL do Spark no AWS Glue versão 3.0 ou posterior, nas mesmas regiões da AWS compatíveis com o tipo de operador `G.4X`.
  + Para o tipo de operador `G.12X`, cada operador é mapeado em 12 DPU (48 vCPU, 192 GB de memória) com 768 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos com workloads muito grandes. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `G.16X`, cada operador é mapeado em 16 DPU (64 vCPU, 256 GB de memória) com 1024 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos com workloads muito grandes. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `G.025X`, cada operador é mapeado para 0,25 DPU (2 vCPU, 4 GB de memória) com 84 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos de streaming de baixo volume. Esse tipo de operador só está disponível para trabalhos de streaming do AWS Glue versão 3.0 ou posterior.
  + Para o tipo de operador `R.1X`, cada operador é mapeado em 1 DPU (4 vCPU, 32 GB de memória) com 94 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `R.2X`, cada operador é mapeado em 2 DPU (8 vCPU, 64 GB de memória) com 128 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `R.4X`, cada operador é mapeado em 4 DPU (16 vCPU, 128 GB de memória) com 256 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `R.8X`, cada operador é mapeado em 8 DPU (32 vCPU, 256 GB de memória) com 512 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `Z.2X`, cada operador é mapeado em 2 M-DPU (8 vCPUs, 64 GB de memória) com 128 GB de disco e fornece até 8 operadores do Ray baseados no autoscaler.
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de determinado `workerType` que são alocados quando um trabalho é executado.
+ `SecurityConfiguration` – 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 estrutura de `SecurityConfiguration` a ser usada com a execução desse trabalho.
+ `LogGroupName` – String UTF-8.

  O nome do grupo de logs para registro seguro, que pode ser criptografado no lado do servidor no Amazon CloudWatch usando o AWS KMS. Esse nome pode ser `/aws-glue/jobs/` e, nesse caso, a criptografia padrão é `NONE`. Se você adicionar o nome de um perfil e o nome de `SecurityConfiguration` (em outras palavras, `/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/`), essa configuração de segurança será usada para criptografar o grupo de logs.
+ `NotificationProperty` – Um objeto [NotificationProperty](#aws-glue-api-jobs-runs-NotificationProperty).

  Especifica propriedades de configuração de uma notificação de execução de trabalho.
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Nas tarefas do Spark, `GlueVersion` determina as versões do Apache Spark e do Python que o AWS Glue disponibiliza em um trabalho. A versão do Python indica a versão compatível com trabalhos do tipo Spark. 

  Os trabalhos de Ray devem definir `GlueVersion` como `4.0` ou mais. Porém, as versões do Ray, do Python e das bibliotecas adicionais disponíveis no seu trabalho do Ray são determinadas pelo parâmetro `Runtime` do comando Job.

  Para obter mais informações sobre as versões disponíveis do AWS Glue e as versões correspondentes do Spark e do Python, consulte [Versão do Glue](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) no guia do desenvolvedor.

  Os trabalhos criados sem especificar uma versão do Glue usam como padrão o Glue 0.9.
+ `DPUSeconds` – Número (duplo).

  Esse campo pode ser preenchido para execuções de trabalhos com classes de execução `FLEX` ou quando o Auto Scaling está habilitado e representa o tempo total de execução de um executor durante o ciclo de vida de uma execução de trabalho em segundos, multiplicado por um fator de DPU (1 para operadores `G.1X`, 2 para operadores `G.2X` e 0,25 para operadores `G.025X`). Esse valor pode ser diferente de `executionEngineRuntime` \$1 `MaxCapacity`, como no caso de trabalhos do Auto Scaling, pois o número de executores em execução em um determinado momento pode ser menor que `MaxCapacity`. Portanto, é possível que o valor de `DPUSeconds` seja menor que `executionEngineRuntime` \$1 `MaxCapacity`.
+ `ExecutionClass`: string UTF-8, inferior a 16 bytes de comprimento (valores válidos: `FLEX=""` \$1 `STANDARD=""`).

  Indica se o trabalho é executado com uma classe de execução padrão ou flexível. A classe de execução padrão é ideal para workloads sensíveis ao tempo que exigem a inicialização rápida de trabalhos e recursos dedicados.

  A classe de execução flexível é adequada para trabalhos insensíveis ao tempo, cujos horários de início e conclusão podem variar. 

  Somente trabalhos com o AWS Glue versão 3.0 e posterior e o tipo de comando `glueetl` terão permissão para definir `ExecutionClass` como `FLEX`. A classe de execução flexível está disponível para trabalhos do Spark.
+ `MaintenanceWindow` – String UTF-8 correspondente a [Custom string pattern #34](aws-glue-api-common.md#regex_34).

  Esse campo especifica um dia da semana e uma hora para uma janela de manutenção para trabalhos de streaming. O AWS Glue realiza periodicamente atividades de manutenção. Durante essas janelas de manutenção, o AWS Glue precisará reiniciar seus trabalhos de streaming.

  O AWS Glue reiniciará o trabalho dentro de 3 horas da janela de manutenção especificada. Por exemplo, se você configurar a janela de manutenção para segunda-feira às 10h (GMT), seus trabalhos serão reiniciados entre 10h (GMT) e 13h (GMT).
+ `ProfileName` – 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 de um perfil de uso do AWS Glue associado à execução do trabalho.
+ `StateDetail`: string UTF-8, não superior a 400.000 bytes de comprimento.

  Esse campo contém detalhes referentes ao estado da execução de um trabalho. O campo é anulável.

  Por exemplo, quando a execução de um trabalho está em um estado "EM ESPERA" como resultado da fila de execução de um trabalho, o campo contém o motivo pelo qual a execução do trabalho está nesse estado.
+ `ExecutionRoleSessionPolicy`: string UTF-8 com no mínimo 2 e no máximo 2.048 bytes de comprimento.

  Essa política de sessão em linha da API StartJobRun permite restringir dinamicamente as permissões da função de execução especificada para o escopo do trabalho, sem exigir a criação de perfis do IAM adicionais.

## Estrutura Predecessor
<a name="aws-glue-api-jobs-runs-Predecessor"></a>

Uma execução de trabalho usada no predicado de um gatilho condicional que a acionou.

**Campos**
+ `JobName` – 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 de trabalho usada pela execução do trabalho antecessor.
+ `RunId` – 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 execução de trabalho predecessor.

## Estrutura JobBookmarkEntry
<a name="aws-glue-api-jobs-runs-JobBookmarkEntry"></a>

Define um ponto em que um trabalho pode retomar o processamento.

**Campos**
+ `JobName` – String UTF-8.

  O nome do trabalho em questão.
+ `Version` – Número (íntegro).

  A versão do trabalho.
+ `Run` – Número (íntegro).

  O número do ID de execução.
+ `Attempt` – Número (íntegro).

  O número do ID de tentativa.
+ `PreviousRunId` – String UTF-8.

  O identificador de execução exclusivo associado à execução do trabalho anterior.
+ `RunId` – String UTF-8.

  O número do ID de execução.
+ `JobBookmark` – String UTF-8.

  O próprio marcador.

## Estrutura BatchStopJobRunSuccessfulSubmission
<a name="aws-glue-api-jobs-runs-BatchStopJobRunSuccessfulSubmission"></a>

Registra uma solicitação bem-sucedido para interromper um especificado `JobRun`.

**Campos**
+ `JobName` – 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 de trabalho usada na execução do trabalho que foi interrompida.
+ `JobRunId` – 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 `JobRunId` da execução de trabalho que foi interrompida.

## Estrutura BatchStopJobRunError
<a name="aws-glue-api-jobs-runs-BatchStopJobRunError"></a>

Registra um erro que ocorreu ao tentar interromper uma execução de trabalho especificada.

**Campos**
+ `JobName` – 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 de trabalho usada na execução do trabalho em questão.
+ `JobRunId` – 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 `JobRunId` da execução do trabalho em questão.
+ `ErrorDetail` – Um objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).

  Especifica detalhes sobre o erro encontrado.

## Estrutura NotificationProperty
<a name="aws-glue-api-jobs-runs-NotificationProperty"></a>

Especifica propriedades de configuração de uma notificação.

**Campos**
+ `NotifyDelayAfter` – Número (inteiro), pelo menos 1.

  Depois que a execução de um trabalho for iniciada, o número de minutos a esperar antes de enviar uma notificação de atraso de execução de trabalho.

## Operações
<a name="aws-glue-api-jobs-runs-actions"></a>
+ [Ação StartJobRun (Python: start\$1job\$1run)](#aws-glue-api-jobs-runs-StartJobRun)
+ [Ação BatchStopJobRun (Python: batch\$1stop\$1job\$1run)](#aws-glue-api-jobs-runs-BatchStopJobRun)
+ [Ação GetJobRun (Python: get\$1job\$1run)](#aws-glue-api-jobs-runs-GetJobRun)
+ [Ação GetJobRuns (Python: get\$1job\$1runs)](#aws-glue-api-jobs-runs-GetJobRuns)
+ [Ação GetJobBookmark (Python: get\$1job\$1bookmark)](#aws-glue-api-jobs-runs-GetJobBookmark)
+ [Ação GetJobBookmarks (Python: get\$1job\$1bookmarks)](#aws-glue-api-jobs-runs-GetJobBookmarks)
+ [Ação ResetJobBookmark (Python: reset\$1job\$1bookmark)](#aws-glue-api-jobs-runs-ResetJobBookmark)

## Ação StartJobRun (Python: start\$1job\$1run)
<a name="aws-glue-api-jobs-runs-StartJobRun"></a>

Inicia uma execução de trabalho usando uma definição de trabalho.

**Solicitação**
+ `JobName`: *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 trabalho que será usada.
+ `JobRunQueuingEnabled` – Booleano.

  Especifica se o enfileiramento da execução de trabalhos está habilitado para a execução do trabalho.

  Um valor "verdadeiro" significa que o enfileiramento da execução de trabalhos está habilitado para as execuções do trabalho. Se o valor for "falso" ou não estiver preenchido, a execução do trabalho não será considerada para enfileiramento.
+ `JobRunId` – 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 de um `JobRun` anterior para tentar novamente.
+ `Arguments` – 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.

  Os argumentos de trabalho associados a esta execução. Para essa execução de tarefa, eles substituem os argumentos padrão definidos na própria definição de tarefa.

  Aqui, é possível especificar os argumentos que seu próprio script de execução de trabalho consome, além dos argumentos que o AWS Glue consome.

  Os argumentos do trabalho podem ser registrados em log. Não transmita segredos em texto simples como argumentos. Recupere os segredos de uma conexão do AWS Glue, AWS Secrets Manager ou outro mecanismo de gerenciamento de segredo se pretender mantê-los dentro do trabalho. 

  Para obter informações sobre como especificar e consumir seus próprios argumentos de trabalho, consulte o tópico [Chamar APIs do AWS Glue em Python](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) no guia do desenvolvedor.

  Para obter informações sobre os argumentos que você pode fornecer a esse campo ao configurar trabalhos do Spark, consulte o AWS Glue tópico [Special Parameters Used by ](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) no guia do desenvolvedor.

  Para obter informações sobre os argumentos que podem ser fornecidos a esse campo ao configurar trabalhos do Ray, consulte o tópico [Uso de parâmetros de trabalho em trabalhos do Ray](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) no guia do desenvolvedor.
+ `AllocatedCapacity` – Número (íntegro).

  Este campo está obsoleto. Use `MaxCapacity` em vez disso.

  O número de unidades de processamento de dados (DPUs) do AWS Glue a serem atribuídas a esse JobRun. É possível alocar um mínimo de 2 DPUs. O padrão é 10. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/).
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite de `JobRun` em minutos. Este é o tempo máximo durante o qual uma execução de trabalho pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. Esse valor substitui o valor de tempo limite definido no trabalho principal. 

  Os trabalhos devem ter valores de tempo limite inferiores a 7 dias ou 10.080 minutos. Caso contrário, os trabalhos gerarão uma exceção.

  Quando o valor é deixado em branco, o tempo limite padrão é de 2.880 minutos.

  Quaisquer trabalhos do AWS Glue existentes que tinham um valor de tempo limite maior que 7 dias serão padronizados para 7 dias. Por exemplo, se você especificou um tempo limite de 20 dias para um trabalho em lote, ele será interrompido no 7º dia.

  Para trabalhos de streaming, se você tiver configurado uma janela de manutenção, ela será reiniciada durante a janela de manutenção após 7 dias.
+ `MaxCapacity` – Número (duplo).

  Para trabalhos do Glue versão 1.0 ou anterior, usando o tipo de operador padrão, é o número de unidades de processamento de dados (DPUs) do AWS Glue que poderão ser alocadas quando esse trabalho for executado. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/).

  Para trabalhos do Glue versão 2.0\$1, você não pode especificar uma `Maximum capacity`. Em vez disso, você deve especificar um `Worker type` e o `Number of workers`.

  Não defina `MaxCapacity` se estiver usando `WorkerType` e `NumberOfWorkers`.

  O valor que pode ser alocado para `MaxCapacity` depende se você está executando um trabalho de shell do Python, um trabalho de ETL do Apache Spark ou um trabalho de ETL de streaming do Apache Spark:
  + Ao especificar um trabalho de shell do Python (`JobCommand.Name`="pythonshell"), será possível alocar 0,0625 ou 1 DPU. O padrão é 0,0625 DPU.
  + Ao especificar um trabalho de ETL do Apache Spark (`JobCommand.Name`="glueetl") ou um trabalho de ETL de streaming do Apache Spark (`JobCommand.Name`="gluestreaming"), é possível alocar de 2 a 100 DPUs. O padrão é de 10 DPUs. Esse tipo de trabalho não pode ter uma alocação de DPU fracionada.
+ `SecurityConfiguration` – 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 estrutura de `SecurityConfiguration` a ser usada com a execução desse trabalho.
+ `NotificationProperty` – Um objeto [NotificationProperty](#aws-glue-api-jobs-runs-NotificationProperty).

  Especifica propriedades de configuração de uma notificação de execução de trabalho.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido que é alocado quando um trabalho é executado. Aceita um valor de G.1X, G.2X, G.4X, G.8X ou G.025X para trabalhos do Spark. Aceita o valor Z.2X para trabalhos do Ray.
  + Para o tipo de operador `G.1X`, cada operador é mapeado em 1 DPU (4 vCPU, 16 GB de memória) com 94 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads, como transformações de dados, uniões e consultas, para oferecer uma maneira escalável e econômica de executar a maioria dos trabalhos.
  + Para o tipo de operador `G.2X`, cada operador é mapeado em 2 DPU (8 vCPU, 32 GB de memória) com 138 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads, como transformações de dados, uniões e consultas, para oferecer uma maneira escalável e econômica de executar a maioria dos trabalhos.
  + Para o tipo de operador `G.4X`, cada operador é mapeado em 4 DPU (16 vCPU, 64 GB de memória) com 256 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos cujas workloads contêm as transformações, agregações, uniões e consultas mais exigentes. Esse tipo de operador está disponível somente para trabalhos de ETL do Spark no AWS Glue versão 3.0 ou posterior nas seguintes regiões da AWS: Leste dos EUA (Ohio), Leste dos EUA (Norte da Virgínia), Oeste dos EUA (Oregon), Ásia-Pacífico (Singapura), Ásia-Pacífico (Sydney), Ásia-Pacífico (Tóquio), Canadá (Central), Europa (Frankfurt), Europa (Irlanda) e Europa (Estocolmo).
  + Para o tipo de operador `G.8X`, cada operador é mapeado em 8 DPU (32 vCPU, 128 GB de memória) com 512 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos cujas workloads contêm as transformações, agregações, uniões e consultas mais exigentes. Esse tipo de operador está disponível somente para trabalhos de ETL do Spark no AWS Glue versão 3.0 ou posterior, nas mesmas regiões da AWS compatíveis com o tipo de operador `G.4X`.
  + Para o tipo de operador `G.12X`, cada operador é mapeado em 12 DPU (48 vCPU, 192 GB de memória) com 768 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos com workloads muito grandes. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `G.16X`, cada operador é mapeado em 16 DPU (64 vCPU, 256 GB de memória) com 1024 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos com workloads muito grandes. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `G.025X`, cada operador é mapeado para 0,25 DPU (2 vCPU, 4 GB de memória) com 84 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos de streaming de baixo volume. Esse tipo de operador só está disponível para trabalhos de streaming do AWS Glue versão 3.0 ou posterior.
  + Para o tipo de operador `R.1X`, cada operador é mapeado em 1 DPU (4 vCPU, 32 GB de memória) com 94 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `R.2X`, cada operador é mapeado em 2 DPU (8 vCPU, 64 GB de memória) com 128 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `R.4X`, cada operador é mapeado em 4 DPU (16 vCPU, 128 GB de memória) com 256 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `R.8X`, cada operador é mapeado em 8 DPU (32 vCPU, 256 GB de memória) com 512 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads com uso intensivo de memória. Esse tipo de operador só está disponível para trabalhos de ETL do Spark no AWS Glue versão 4.0 ou posterior.
  + Para o tipo de operador `Z.2X`, cada operador é mapeado em 2 M-DPU (8 vCPUs, 64 GB de memória) com 128 GB de disco e fornece até 8 operadores do Ray baseados no autoscaler.
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de determinado `workerType` que são alocados quando um trabalho é executado.
+ `ExecutionClass`: string UTF-8, inferior a 16 bytes de comprimento (valores válidos: `FLEX=""` \$1 `STANDARD=""`).

  Indica se o trabalho é executado com uma classe de execução padrão ou flexível. A classe de execução padrão é ideal para workloads sensíveis ao tempo que exigem a inicialização rápida de trabalhos e recursos dedicados.

  A classe de execução flexível é adequada para trabalhos insensíveis ao tempo, cujos horários de início e conclusão podem variar. 

  Somente trabalhos com o AWS Glue versão 3.0 e posterior e o tipo de comando `glueetl` terão permissão para definir `ExecutionClass` como `FLEX`. A classe de execução flexível está disponível para trabalhos do Spark.
+ `ProfileName` – 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 de um perfil de uso do AWS Glue associado à execução do trabalho.
+ `ExecutionRoleSessionPolicy`: string UTF-8 com no mínimo 2 e no máximo 2.048 bytes de comprimento.

  Essa política de sessão em linha da API StartJobRun permite restringir dinamicamente as permissões da função de execução especificada para o escopo do trabalho, sem exigir a criação de perfis do IAM adicionais.

**Resposta**
+ `JobRunId` – 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 atribuído a esta execução de trabalho.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentRunsExceededException`

## Ação BatchStopJobRun (Python: batch\$1stop\$1job\$1run)
<a name="aws-glue-api-jobs-runs-BatchStopJobRun"></a>

Interrompe uma ou mais execuções de trabalho para uma definição de trabalho determinada.

**Solicitação**
+ `JobName`: *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 trabalho para a qual as execuções de trabalho são interrompidas.
+ `JobRunIds` – *Obrigatório:* uma matriz de strings UTF-8, no mínimo 1 ou mais de 25 strings.

  Uma lista dos `JobRunIds` que devem ser interrompidos para essa definição de trabalho.

**Resposta**
+ `SuccessfulSubmissions`: um array de objetos [BatchStopJobRunSuccessfulSubmission](#aws-glue-api-jobs-runs-BatchStopJobRunSuccessfulSubmission).

  Uma lista dos JobRuns que foram enviados com sucesso para interrupção.
+ `Errors`: um array de objetos [BatchStopJobRunError](#aws-glue-api-jobs-runs-BatchStopJobRunError).

  Uma lista dos erros que foram encontrados durante a tentativa de interrupção de `JobRuns`, incluindo o `JobRunId` para o qual cada erro foi encontrado e os detalhes do erro.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetJobRun (Python: get\$1job\$1run)
<a name="aws-glue-api-jobs-runs-GetJobRun"></a>

Recupera os metadados para uma execução de trabalho específica. O histórico de execução de trabalhos fica disponível por 365 dias para seu fluxo de trabalho e para a execução do trabalho.

**Solicitação**
+ `JobName`: *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 definição de trabalho em execução.
+ `RunId`: *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 execução de trabalho.
+ `PredecessorsIncluded` – Booleano.

  True, se uma lista de execuções antecessoras for retornada.

**Resposta**
+ `JobRun` – Um objeto [JobRun](#aws-glue-api-jobs-runs-JobRun).

  Os metadados solicitados da execução de trabalho.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetJobRuns (Python: get\$1job\$1runs)
<a name="aws-glue-api-jobs-runs-GetJobRuns"></a>

Recupera os metadados para todas as execuções de uma determinada definição de trabalho.

`GetJobRuns` retorna as execuções da tarefa em ordem cronológica, com as tarefas mais recentes primeiro.

**Solicitação**
+ `JobName`: *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 trabalho para a qual todas as execuções de trabalho são recuperadas.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.
+ `MaxResults`: número (inteiro) não inferior a 1 nem superior a 200.

  O tamanho máximo da resposta.

**Resposta**
+ `JobRuns`: um array de objetos [JobRun](#aws-glue-api-jobs-runs-JobRun).

  Uma lista de objetos de metadados de execução de trabalho.
+ `NextToken` – String UTF-8.

  Um token de continuação, se todas as execuções de trabalho solicitadas não tiverem sido retornadas.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetJobBookmark (Python: get\$1job\$1bookmark)
<a name="aws-glue-api-jobs-runs-GetJobBookmark"></a>

Retorna informações sobre uma entrada de marcador de trabalho.

Para obter mais informações sobre como habilitar e usar marcadores de trabalho, consulte:
+ [Rastrear dados processados usando marcadores de trabalho](https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html)
+ [Parâmetros de trabalho usados pelo AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html)
+ [Estrutura do trabalho](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job)

**Solicitação**
+ `JobName` – *Obrigatório:* string UTF-8.

  O nome do trabalho em questão.
+ `Version` – Número (íntegro).

  A versão do trabalho.
+ `RunId` – String UTF-8.

  O identificador de execução exclusivo associado à execução desse trabalho.

**Resposta**
+ `JobBookmarkEntry` – Um objeto [JobBookmarkEntry](#aws-glue-api-jobs-runs-JobBookmarkEntry).

  Uma estrutura que define um ponto em que um trabalho pode retomar o processamento.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ValidationException`

## Ação GetJobBookmarks (Python: get\$1job\$1bookmarks)
<a name="aws-glue-api-jobs-runs-GetJobBookmarks"></a>

Retorna informações sobre as entradas de marcador de trabalho. A ordem da lista é em números de versão decrescentes.

Para obter mais informações sobre como habilitar e usar marcadores de trabalho, consulte:
+ [Rastrear dados processados usando marcadores de trabalho](https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html)
+ [Parâmetros de trabalho usados pelo AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html)
+ [Estrutura do trabalho](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job)

**Solicitação**
+ `JobName` – *Obrigatório:* string UTF-8.

  O nome do trabalho em questão.
+ `MaxResults` – Número (íntegro).

  O tamanho máximo da resposta.
+ `NextToken` – Número (íntegro).

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `JobBookmarkEntries`: um array de objetos [JobBookmarkEntry](#aws-glue-api-jobs-runs-JobBookmarkEntry).

  Uma lista de entradas de marcador de trabalho que define um ponto em que um trabalho pode retomar o processamento.
+ `NextToken` – Número (íntegro).

  Um token de continuação, que terá um valor de 1 se todas as entradas forem retornadas ou > 1 se nem todas as execuções solicitadas forem retornadas.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação ResetJobBookmark (Python: reset\$1job\$1bookmark)
<a name="aws-glue-api-jobs-runs-ResetJobBookmark"></a>

Redefine uma entrada de marcador.

Para obter mais informações sobre como habilitar e usar marcadores de trabalho, consulte:
+ [Rastrear dados processados usando marcadores de trabalho](https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html)
+ [Parâmetros de trabalho usados pelo AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html)
+ [Estrutura do trabalho](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job)

**Solicitação**
+ `JobName` – *Obrigatório:* string UTF-8.

  O nome do trabalho em questão.
+ `RunId` – String UTF-8.

  O identificador de execução exclusivo associado à execução desse trabalho.

**Resposta**
+ `JobBookmarkEntry` – Um objeto [JobBookmarkEntry](#aws-glue-api-jobs-runs-JobBookmarkEntry).

  A redefinição da entrada de marcador.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

# Acionadores
<a name="aws-glue-api-jobs-trigger"></a>

A API de acionadores descreve os tipos de dados e a API relacionada à criação, atualização ou exclusão, e início e interrupção, de acionadores de trabalho no AWS Glue.

## Tipos de dados
<a name="aws-glue-api-jobs-trigger-objects"></a>
+ [Estrutura de acionador](#aws-glue-api-jobs-trigger-Trigger)
+ [Estrutura TriggerUpdate](#aws-glue-api-jobs-trigger-TriggerUpdate)
+ [Estrutura Predicate](#aws-glue-api-jobs-trigger-Predicate)
+ [Estrutura Condition](#aws-glue-api-jobs-trigger-Condition)
+ [Estrutura Action](#aws-glue-api-jobs-trigger-Action)
+ [Estrutura EventBatchingCondition](#aws-glue-api-jobs-trigger-EventBatchingCondition)

## Estrutura de acionador
<a name="aws-glue-api-jobs-trigger-Trigger"></a>

As informações sobre um determinado gatilho.

**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 do gatilho.
+ `WorkflowName` – 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 fluxo de trabalho associado ao gatilho.
+ `Id` – 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).

  Reservado para uso futuro.
+ `Type` – String UTF-8 (valores válidos: `SCHEDULED` \$1 `CONDITIONAL` \$1 `ON_DEMAND` \$1 `EVENT`).

  O tipo de gatilho.
+ `State` – String UTF-8 (valores válidos: `CREATING` \$1 `CREATED` \$1 `ACTIVATING` \$1 `ACTIVATED` \$1 `DEACTIVATING` \$1 `DEACTIVATED` \$1 `DELETING` \$1 `UPDATING`).

  O estado atual do gatilho do trabalho.
+ `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 desse gatilho.
+ `Schedule` – String UTF-8.

  Uma expressão `cron` usada para especificar a programação (consulte [Programações baseadas em hora para tarefas e crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). Por exemplo, para executar algo todos os dias às 12h15 UTC, especifique: `cron(15 12 * * ? *)`.
+ `Actions`: um array de objetos [Ação](#aws-glue-api-jobs-trigger-Action).

  As ações iniciadas por esse gatilho.
+ `Predicate` – Um objeto [Predicado](#aws-glue-api-jobs-trigger-Predicate).

  O predicado deste gatilho, que define quando ele disparará.
+ `EventBatchingCondition` – Um objeto [EventBatchingCondition](#aws-glue-api-jobs-trigger-EventBatchingCondition).

  Condição de lote que deve ser atendida (número especificado de eventos recebidos ou janela de tempo de lote expirada) antes que o acionador do evento do EventBridge dispare.

## Estrutura TriggerUpdate
<a name="aws-glue-api-jobs-trigger-TriggerUpdate"></a>

Uma estrutura usada para fornecer as informações necessárias para atualizar um gatilho. Este objeto atualiza a definição do gatilho anterior, substituindo-a completamente.

**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).

  Reservado para uso futuro.
+ `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 desse gatilho.
+ `Schedule` – String UTF-8.

  Uma expressão `cron` usada para especificar a programação (consulte [Programações baseadas em hora para tarefas e crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). Por exemplo, para executar algo todos os dias às 12h15 UTC, especifique: `cron(15 12 * * ? *)`.
+ `Actions`: um array de objetos [Ação](#aws-glue-api-jobs-trigger-Action).

  As ações iniciadas por esse gatilho.
+ `Predicate` – Um objeto [Predicado](#aws-glue-api-jobs-trigger-Predicate).

  O predicado deste gatilho, que define quando ele disparará.
+ `EventBatchingCondition` – Um objeto [EventBatchingCondition](#aws-glue-api-jobs-trigger-EventBatchingCondition).

  Condição de lote que deve ser atendida (número especificado de eventos recebidos ou janela de tempo de lote expirada) antes que o acionador do evento do EventBridge dispare.

## Estrutura Predicate
<a name="aws-glue-api-jobs-trigger-Predicate"></a>

Define o predicado do gatilho, que determina quando ele é acionado.

**Campos**
+ `Logical`: string UTF-8 (valores válidos: `AND` \$1 `ANY`).

  Um campo opcional se apenas uma condição estiver listada. Se várias condições estiverem listadas, esse campo será obrigatório.
+ `Conditions`: uma matriz de objetos [Condição](#aws-glue-api-jobs-trigger-Condition), não mais de 500 estruturas.

  Uma lista das condições que determinam quando o gatilho será acionado.

## Estrutura Condition
<a name="aws-glue-api-jobs-trigger-Condition"></a>

Define em que condição um gatilho será acionado.

**Campos**
+ `LogicalOperator` – String UTF-8 (valores válidos: `EQUALS`).

  Um operador lógico.
+ `JobName` – 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 trabalho cujo `JobRuns` essa condição se aplica e na qual esse gatilho aguardará.
+ `State`: string UTF-8 (valores válidos: `STARTING` \$1 `RUNNING` \$1 `STOPPING` \$1 `STOPPED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `TIMEOUT` \$1 `ERROR` \$1 `WAITING` \$1 `EXPIRED`).

  O estado da condição. No momento, os únicos estados de trabalho que um trigger pode escutar são `SUCCEEDED`, `STOPPED`, `FAILED` e `TIMEOUT`. Os únicos estados de crawler que um trigger pode escutar são `SUCCEEDED`, `FAILED` e `CANCELLED`.
+ `CrawlerName` – 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 crawler ao qual essa condição se aplica.
+ `CrawlState` – String UTF-8 (valores válidos: `RUNNING` \$1 `CANCELLING` \$1 `CANCELLED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `ERROR`).

  O estado do crawler ao qual essa condição se aplica.

## Estrutura Action
<a name="aws-glue-api-jobs-trigger-Action"></a>

Define uma ação a ser iniciada por um gatilho.

**Campos**
+ `JobName` – 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 de um trabalho a ser executado.
+ `Arguments` – 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.

  Os argumentos de tarefa usados ao acionar esse trigger. Para essa execução de tarefa, eles substituem os argumentos padrão definidos na própria definição de tarefa.

  Aqui, é possível especificar os argumentos que seu próprio script de execução de trabalho consome, além dos argumentos que o AWS Glue consome.

  Para obter informações sobre como especificar e consumir seus próprios argumentos de trabalho, consulte o tópico [Chamar APIs do AWS Glue em Python](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) no guia do desenvolvedor.

  Para obter informações sobre os pares de chave-valor que o AWS Glue consome para configurar o trabalho, consulte o tópico [Parâmetros especiais usados ​​pelo AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) no guia do desenvolvedor.
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite de `JobRun` em minutos. Este é o tempo máximo durante o qual uma execução de trabalho pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. Isso substitui o valor de tempo limite definido no trabalho principal.

  Os trabalhos devem ter valores de tempo limite inferiores a 7 dias ou 10.080 minutos. Caso contrário, os trabalhos gerarão uma exceção.

  Quando o valor é deixado em branco, o tempo limite padrão é de 2.880 minutos.

  Quaisquer trabalhos do AWS Glue existentes que tinham um valor de tempo limite maior que 7 dias serão padronizados para 7 dias. Por exemplo, se você especificou um tempo limite de 20 dias para um trabalho em lote, ele será interrompido no 7º dia.

  Para trabalhos de streaming, se você tiver configurado uma janela de manutenção, ela será reiniciada durante a janela de manutenção após 7 dias.
+ `SecurityConfiguration` – 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 estrutura de `SecurityConfiguration` a ser usada com essa ação.
+ `NotificationProperty` – Um objeto [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty).

  Especifica propriedades de configuração de uma notificação de execução de trabalho.
+ `CrawlerName` – 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 crawler que será usado com essa ação.

## Estrutura EventBatchingCondition
<a name="aws-glue-api-jobs-trigger-EventBatchingCondition"></a>

Condição de lote que deve ser atendida (número especificado de eventos recebidos ou janela de tempo de lote expirada) antes que o acionador do evento do EventBridge dispare.

**Campos**
+ `BatchSize`: *obrigatório:* número (inteiro), não menos do que 1 ou superior a 100.

  Número de eventos que devem ser recebidos do Amazon EventBridge antes que o acionador do evento do EventBridge dispare.
+ `BatchWindow`: número (inteiro), não menos do que 1 ou superior a 900.

  Janela de tempo em segundos após a qual o acionador do evento do EventBridge dispara. A janela é iniciada quando o primeiro evento é recebido.

## Operações
<a name="aws-glue-api-jobs-trigger-actions"></a>
+ [Ação CreateTrigger (Python: create\$1trigger)](#aws-glue-api-jobs-trigger-CreateTrigger)
+ [Ação StartTrigger (Python: start\$1trigger)](#aws-glue-api-jobs-trigger-StartTrigger)
+ [Ação GetTrigger (Python: get\$1trigger)](#aws-glue-api-jobs-trigger-GetTrigger)
+ [Ação GetTriggers (Python: get\$1triggers)](#aws-glue-api-jobs-trigger-GetTriggers)
+ [Ação UpdateTrigger (Python: update\$1trigger)](#aws-glue-api-jobs-trigger-UpdateTrigger)
+ [Ação StopTrigger (Python: stop\$1trigger)](#aws-glue-api-jobs-trigger-StopTrigger)
+ [Ação DeleteTrigger (Python: delete\$1trigger)](#aws-glue-api-jobs-trigger-DeleteTrigger)
+ [Ação ListTriggers (Python: list\$1triggers)](#aws-glue-api-jobs-trigger-ListTriggers)
+ [Ação BatchGetTriggers (Python: batch\$1get\$1triggers)](#aws-glue-api-jobs-trigger-BatchGetTriggers)

## Ação CreateTrigger (Python: create\$1trigger)
<a name="aws-glue-api-jobs-trigger-CreateTrigger"></a>

Cria um novo gatilho.

Os argumentos do trabalho podem ser registrados em log. Não transmita segredos em texto simples como argumentos. Recupere os segredos de uma conexão do AWS Glue, AWS Secrets Manager ou outro mecanismo de gerenciamento de segredos se pretender mantê-los dentro do trabalho.

**Solicitaçã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 gatilho.
+ `WorkflowName` – 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 fluxo de trabalho associado ao gatilho.
+ `Type`: *obrigatório:* string UTF-8 (valores válidos: `SCHEDULED` \$1 `CONDITIONAL` \$1 `ON_DEMAND` \$1 `EVENT`).

  O tipo do novo gatilho.
+ `Schedule` – String UTF-8.

  Uma expressão `cron` usada para especificar a programação (consulte [Programações baseadas em hora para tarefas e crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). Por exemplo, para executar algo todos os dias às 12h15 UTC, especifique: `cron(15 12 * * ? *)`.

  Esse campo é obrigatório quando o tipo do gatilho é SCHEDULED.
+ `Predicate` – Um objeto [Predicado](#aws-glue-api-jobs-trigger-Predicate).

  Um predicado para especificar quando o novo gatilho será disparado.

  Esse campo é obrigatório quando o tipo do gatilho é `CONDITIONAL`.
+ `Actions` – *Obrigatório:* uma matriz de objetos [Ação](#aws-glue-api-jobs-trigger-Action).

  As ações iniciadas por esse gatilho quando ele é disparado.
+ `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 novo gatilho.
+ `StartOnCreation` – Booleano.

  Defina como `true` para iniciar os gatilhos `SCHEDULED` e `CONDITIONAL` na criação. True (Verdadeiro) não é compatível com gatilhos `ON_DEMAND`.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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 a serem usadas com esse trigger. Você pode usar tags para limitar o acesso ao trigger. Para obter mais informações sobre tags no AWS Glue, consulte [Tags da AWS no AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) no guia do desenvolvedor. 
+ `EventBatchingCondition` – Um objeto [EventBatchingCondition](#aws-glue-api-jobs-trigger-EventBatchingCondition).

  Condição de lote que deve ser atendida (número especificado de eventos recebidos ou janela de tempo de lote expirada) antes que o acionador do evento do EventBridge dispare.

**Resposta**
+ `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 do gatilho.

**Erros**
+ `AlreadyExistsException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `IdempotentParameterMismatchException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`

## Ação StartTrigger (Python: start\$1trigger)
<a name="aws-glue-api-jobs-trigger-StartTrigger"></a>

Inicia um gatilho existente. Consulte [Acionar tarefas](https://docs.aws.amazon.com/glue/latest/dg/trigger-job.html) para obter informações sobre como diferentes tipos de gatilho são acionados.

**Solicitaçã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 gatilho a ser iniciado.

**Resposta**
+ `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 do gatilho iniciado.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentRunsExceededException`

## Ação GetTrigger (Python: get\$1trigger)
<a name="aws-glue-api-jobs-trigger-GetTrigger"></a>

Recupera a definição de um gatilho.

**Solicitaçã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 gatilho a ser recuperado.

**Resposta**
+ `Trigger` – Um objeto [Trigger](#aws-glue-api-jobs-trigger-Trigger).

  A definição de gatilho solicitada.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetTriggers (Python: get\$1triggers)
<a name="aws-glue-api-jobs-trigger-GetTriggers"></a>

Obtém todos os gatilhos associados a um trabalho.

**Solicitação**
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.
+ `DependentJobName` – 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 trabalho para o qual recuperar gatilhos. O gatilho que pode iniciar esse trabalho será retornado e, se ele não existir, todos os gatilhos serão retornados.
+ `MaxResults`: número (inteiro) não inferior a 1 nem superior a 200.

  O tamanho máximo da resposta.

**Resposta**
+ `Triggers`: um array de objetos [Trigger](#aws-glue-api-jobs-trigger-Trigger).

  Uma lista de gatilhos para o trabalho especificado.
+ `NextToken` – String UTF-8.

  Um token de continuação, se todos os gatilhos solicitados ainda não tiverem sido retornados.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação UpdateTrigger (Python: update\$1trigger)
<a name="aws-glue-api-jobs-trigger-UpdateTrigger"></a>

Atualiza uma definição do gatilho.

Os argumentos do trabalho podem ser registrados em log. Não transmita segredos em texto simples como argumentos. Recupere os segredos de uma conexão do AWS Glue, AWS Secrets Manager ou outro mecanismo de gerenciamento de segredos se pretender mantê-los dentro do trabalho.

**Solicitaçã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 gatilho a ser atualizado.
+ `TriggerUpdate` – *Obrigatório:* um objeto [TriggerUpdate](#aws-glue-api-jobs-trigger-TriggerUpdate).

  Os novos valores para atualização do gatilho.

**Resposta**
+ `Trigger` – Um objeto [Trigger](#aws-glue-api-jobs-trigger-Trigger).

  A definição de gatilho resultante.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## Ação StopTrigger (Python: stop\$1trigger)
<a name="aws-glue-api-jobs-trigger-StopTrigger"></a>

Interrompe um gatilho especificado.

**Solicitaçã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 gatilho a ser interrompido.

**Resposta**
+ `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 do gatilho interrompido.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## Ação DeleteTrigger (Python: delete\$1trigger)
<a name="aws-glue-api-jobs-trigger-DeleteTrigger"></a>

Exclui um gatilho especificado. Se o gatilho não for encontrado, nenhuma exceção será lançada.

**Solicitaçã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 gatilho a ser excluído.

**Resposta**
+ `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 do gatilho excluído.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## Ação ListTriggers (Python: list\$1triggers)
<a name="aws-glue-api-jobs-trigger-ListTriggers"></a>

Recupera os nomes de todos os recursos de acionador nessa conta da AWS ou os recursos com a tag especificada. Essa operação permite que você veja quais recursos estão disponíveis em sua conta e seus nomes.

Essa operação aceita o campo `Tags` opcional, que pode ser usado como um filtro na resposta, para que recursos com tags possam ser recuperados como um grupo. Se você optar por usar a filtragem por tags, apenas os recursos com a tag serão recuperados.

**Solicitação**
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma solicitação de continuação.
+ `DependentJobName` – 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 trabalho para o qual recuperar gatilhos. O gatilho que pode iniciar esse trabalho é retornado. Se esse gatilho não existir, todos os gatilhos serão retornados.
+ `MaxResults`: número (inteiro) não inferior a 1 nem superior a 200.

  O tamanho máximo de uma lista a ser retornada.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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.

  Especifica apenas o retorno desses recursos com tags.

**Resposta**
+ `TriggerNames` – Uma matriz de strings UTF-8.

  Os nomes de todos os gatilhos na conta ou os gatilhos com as tags especificadas.
+ `NextToken` – String UTF-8.

  Um token de continuação, se a lista retornada não contiver a métrica mais recente disponível.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação BatchGetTriggers (Python: batch\$1get\$1triggers)
<a name="aws-glue-api-jobs-trigger-BatchGetTriggers"></a>

Retorna uma lista de metadados de recurso para uma lista de nomes de gatilho. Depois de chamar a operação `ListTriggers`, você pode chamar essa operação para acessar os dados aos quais você recebeu permissões. Essa operação oferece suporte a todas as permissões do IAM, incluindo condições de permissão que usam tags.

**Solicitação**
+ `TriggerNames`: *obrigatório:* uma matriz de strings UTF-8.

  Uma lista de nomes de gatilho, que podem ser os nomes retornados pela operação `ListTriggers`.

**Resposta**
+ `Triggers`: um array de objetos [Trigger](#aws-glue-api-jobs-trigger-Trigger).

  Uma lista das definições de gatilho.
+ `TriggersNotFound` – Uma matriz de strings UTF-8.

  Uma lista de nomes de gatilhos não encontrados.

**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

# APIs de integração no AWS Glue
<a name="aws-glue-api-integrations"></a>

## Tipos de dados
<a name="aws-glue-api-integrations-objects"></a>
+ [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
<a name="aws-glue-api-integrations-Integration"></a>

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
<a name="aws-glue-api-integrations-IntegrationConfig"></a>

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
<a name="aws-glue-api-integrations-IntegrationPartition"></a>

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
<a name="aws-glue-api-integrations-IntegrationError"></a>

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
<a name="aws-glue-api-integrations-IntegrationFilter"></a>

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
<a name="aws-glue-api-integrations-InboundIntegration"></a>

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
<a name="aws-glue-api-integrations-SourceProcessingProperties"></a>

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
<a name="aws-glue-api-integrations-TargetProcessingProperties"></a>

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
<a name="aws-glue-api-integrations-SourceTableConfig"></a>

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
<a name="aws-glue-api-integrations-TargetTableConfig"></a>

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 name="aws-glue-api-integrations-actions"></a>
+ [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)
<a name="aws-glue-api-integrations-CreateIntegration"></a>

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)
<a name="aws-glue-api-integrations-ModifyIntegration"></a>

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 name="aws-glue-api-integrations-DescribeIntegrations"></a>

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)
<a name="aws-glue-api-integrations-DeleteIntegration"></a>

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)
<a name="aws-glue-api-integrations-DescribeInboundIntegrations"></a>

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)
<a name="aws-glue-api-integrations-CreateIntegrationTableProperties"></a>

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)
<a name="aws-glue-api-integrations-UpdateIntegrationTableProperties"></a>

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)
<a name="aws-glue-api-integrations-GetIntegrationTableProperties"></a>

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)
<a name="aws-glue-api-integrations-DeleteIntegrationTableProperties"></a>

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)
<a name="aws-glue-api-integrations-CreateIntegrationResourceProperty"></a>

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)
<a name="aws-glue-api-integrations-UpdateIntegrationResourceProperty"></a>

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)
<a name="aws-glue-api-integrations-GetIntegrationResourceProperty"></a>

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)
<a name="aws-glue-api-integrations-UntagResource"></a>

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)
<a name="aws-glue-api-integrations-ListTagsForResource"></a>

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
<a name="aws-glue-api-integrations-exceptions"></a>
+ [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
<a name="aws-glue-api-integrations-ResourceNotFoundException"></a>

Não foi possível encontrar o recurso.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura InternalServiceException
<a name="aws-glue-api-integrations-InternalServerException"></a>

Ocorreu um erro interno do servidor.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura IntegrationAlreadyExistsFault
<a name="aws-glue-api-integrations-IntegrationAlreadyExistsFault"></a>

A integração especificada já existe.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura IntegrationConflictOperationFault
<a name="aws-glue-api-integrations-IntegrationConflictOperationFault"></a>

A operação solicitada está em conflito com outra operação.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura IntegrationQuotaExceededFault
<a name="aws-glue-api-integrations-IntegrationQuotaExceededFault"></a>

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 name="aws-glue-api-integrations-KMSKeyNotAccessibleFault"></a>

A chave do KMS especificada não está acessível.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura IntegrationNotFoundFault
<a name="aws-glue-api-integrations-IntegrationNotFoundFault"></a>

Não foi possível encontrar a integração especificada.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura TargetResourceNotFound
<a name="aws-glue-api-integrations-TargetResourceNotFound"></a>

Não foi possível encontrar o recurso de destino.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura InvalidIntegrationStateFault
<a name="aws-glue-api-integrations-InvalidIntegrationStateFault"></a>

A integração está em um estado inválido.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

# Sessões API interativas
<a name="aws-glue-api-interactive-sessions"></a>

A API de sessões interativas descreve a API do AWS Glue relacionada ao uso de sessões interativas do AWS Glue para criar e testar scripts de extração, transformação e carregamento (ETL) para a integração de dados.

## Tipos de dados
<a name="aws-glue-api-interactive-sessions-objects"></a>
+ [Estrutura Session](#aws-glue-api-interactive-sessions-Session)
+ [Estrutura SessionCommand](#aws-glue-api-interactive-sessions-SessionCommand)
+ [Estrutura Statement](#aws-glue-api-interactive-sessions-Statement)
+ [Estrutura StatementOutput](#aws-glue-api-interactive-sessions-StatementOutput)
+ [Estrutura StatementOutputData](#aws-glue-api-interactive-sessions-StatementOutputData)
+ [Estrutura ConnectionsList](#aws-glue-api-interactive-sessions-ConnectionsList)

## Estrutura Session
<a name="aws-glue-api-interactive-sessions-Session"></a>

O período em que um ambiente do runtime remoto do Spark está sendo executado.

**Campos**
+ `Id` – 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 sessão.
+ `CreatedOn` – Timestamp.

  A data e a hora em que a sessão foi criada.
+ `Status` – String UTF-8 (valores válidos: `PROVISIONING` \$1 `READY` \$1 `FAILED` \$1 `TIMEOUT` \$1 `STOPPING` \$1 `STOPPED`).

  O status da sessão. 
+ `ErrorMessage` – 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 mensagem de erro exibida durante a sessã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 sessão.
+ `Role` – String UTF-8, superior a 20 e inferior a 2048 bytes de comprimento, correspondente a [Custom string pattern #30](aws-glue-api-common.md#regex_30).

  O nome ou nome de recurso da Amazon (ARN) da função do IAM associada à sessão.
+ `Command` – Um objeto [SessionCommand](#aws-glue-api-interactive-sessions-SessionCommand).

  O comando Object.Consulte SessionCommand.
+ `DefaultArguments` – Uma matriz de mapas de pares de valores-chave, não mais de 75 pares.

  Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes, correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  Cada valor é uma string UTF-8, com comprimento não superior a 4096 bytes, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Um array de mapa dos pares de valor-chave. O máximo é de 75 pares. 
+ `Connections` – Um objeto [ConnectionsList](#aws-glue-api-interactive-sessions-ConnectionsList).

  O número de conexões usadas para a sessão.
+ `Progress` – Número (duplo).

  O andamento da execução do código da sessão.
+ `MaxCapacity` – Número (duplo).

  O número de unidades de processamento de dados (DPUs) do AWS Glue que poderão ser alocadas quando o trabalho for executado. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. 
+ `SecurityConfiguration` – 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 estrutura SecurityConfiguration a ser usada com a sessão.
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  A versão AWS Glue determina as versões do Apache Spark e do Python compatíveis com o AWS Glue. O GlueVersion deve ser maior que 2.0.
+ `DataAccessId` - String UTF-8, não menos do que 1 ou superior a 36 bytes de comprimento.

  O ID de acesso a dados da sessão.
+ `PartitionId` - String UTF-8, não menos do que 1 ou superior a 36 bytes de comprimento.

  O ID da partição da sessão.
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de determinado `WorkerType` para usar na sessão.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido que é alocado quando uma sessão é executada. Aceita um valor de `G.1X`, `G.2X`, `G.4X` ou `G.8X` para sessões do Spark. Aceita o valor `Z.2X` para sessões do Ray.
+ `CompletedOn` – Timestamp.

  A data e a hora em que a execução desse trabalho foi concluída.
+ `ExecutionTime` – Número (duplo).

  O tempo total durante o qual a sessão foi executada.
+ `DPUSeconds` – Número (duplo).

  As DPUs consumidas pela sessão (fórmula: ExecutionTime \$1 MaxCapacity).
+ `IdleTimeout` – Número (íntegro).

  O número de minutos de natividade até esgotar o tempo limite da sessão.
+ `ProfileName` – 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 de um perfil de uso do AWS Glue associado à sessão.

## Estrutura SessionCommand
<a name="aws-glue-api-interactive-sessions-SessionCommand"></a>

O `SessionCommand` que executa esse trabalho.

**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).

  Especifica o nome do SessionCommand. Pode ser “glueetl” ou “glueestreaming”.
+ `PythonVersion` – String UTF-8 correspondente a [Custom string pattern #49](aws-glue-api-common.md#regex_49).

  Especifica a versão usada do Python. A versão do Python indica a versão compatível com trabalhos do tipo Spark.

## Estrutura Statement
<a name="aws-glue-api-interactive-sessions-Statement"></a>

A declaração ou solicitação para que uma ação específica ocorra em uma sessão.

**Campos**
+ `Id` – Número (íntegro).

  O ID da instrução.
+ `Code` – String UTF-8.

  O código de execução da instrução.
+ `State` – String UTF-8 (valores válidos: `WAITING` \$1 `RUNNING` \$1 `AVAILABLE` \$1 `CANCELLING` \$1 `CANCELLED` \$1 `ERROR`).

  O estado enquanto a solicitação é acionada.
+ `Output` – Um objeto [StatementOutput](#aws-glue-api-interactive-sessions-StatementOutput).

  A saída em JSON.
+ `Progress` – Número (duplo).

  O progresso da execução do código.
+ `StartedOn` – Número (extenso).

  A hora e a data unix em que a definição de trabalho foi iniciada.
+ `CompletedOn` – Número (extenso).

  A hora e a data unix em que a definição de trabalho foi concluída.

## Estrutura StatementOutput
<a name="aws-glue-api-interactive-sessions-StatementOutput"></a>

O resultado da execução de código no formato JSON.

**Campos**
+ `Data` – Um objeto [StatementOutputData](#aws-glue-api-interactive-sessions-StatementOutputData).

  O resultado da execução de código.
+ `ExecutionCount` – Número (íntegro).

  A contagem de execução da saída.
+ `Status` – String UTF-8 (valores válidos: `WAITING` \$1 `RUNNING` \$1 `AVAILABLE` \$1 `CANCELLING` \$1 `CANCELLED` \$1 `ERROR`).

  O status da saída do código de execução.
+ `ErrorName` – String UTF-8.

  O nome do erro na saída.
+ `ErrorValue` – String UTF-8.

  O valor de erro da saída.
+ `Traceback` – Uma matriz de strings UTF-8.

  O traceback da saída.

## Estrutura StatementOutputData
<a name="aws-glue-api-interactive-sessions-StatementOutputData"></a>

O resultado da execução de código no formato JSON.

**Campos**
+ `TextPlain` – String UTF-8.

  O resultado da execução do código no formato de texto.

## Estrutura ConnectionsList
<a name="aws-glue-api-interactive-sessions-ConnectionsList"></a>

Especifica as conexões usadas por um trabalho.

**Campos**
+ `Connections`: uma matriz de strings UTF-8, no máximo mil strings.

  Uma lista das conexões usadas pelo trabalho.

## Operações
<a name="aws-glue-api-interactive-sessions-actions"></a>
+ [Ação CreateSession (Python: create\$1session)](#aws-glue-api-interactive-sessions-CreateSession)
+ [Ação StopSession (Python: stop\$1session)](#aws-glue-api-interactive-sessions-StopSession)
+ [Ação DeleteSession (Python: delete\$1session)](#aws-glue-api-interactive-sessions-DeleteSession)
+ [Ação GetSession (Python: get\$1session)](#aws-glue-api-interactive-sessions-GetSession)
+ [Ação ListSessions (Python: list\$1sessions)](#aws-glue-api-interactive-sessions-ListSessions)
+ [Ação RunStatement (Python: run\$1statement)](#aws-glue-api-interactive-sessions-RunStatement)
+ [Ação CancelStatement (Python: cancel\$1statement)](#aws-glue-api-interactive-sessions-CancelStatement)
+ [Ação GetStatement (Python: get\$1statement)](#aws-glue-api-interactive-sessions-GetStatement)
+ [Ação ListStatations (Python: list\$1statements)](#aws-glue-api-interactive-sessions-ListStatements)
+ [Ação GetGlueIdentityCenterConfiguration (Python: get\$1glue\$1identity\$1center\$1configuration)](#aws-glue-api-interactive-sessions-GetGlueIdentityCenterConfiguration)
+ [Ação UpdateGlueIdentityCenterConfiguration (Python: update\$1glue\$1identity\$1center\$1configuration)](#aws-glue-api-interactive-sessions-UpdateGlueIdentityCenterConfiguration)
+ [Ação CreateGlueIdentityCenterConfiguration (Python: create\$1glue\$1identity\$1center\$1configuration)](#aws-glue-api-interactive-sessions-CreateGlueIdentityCenterConfiguration)
+ [Ação DeleteGlueIdentityCenterConfiguration (Python: delete\$1glue\$1identity\$1center\$1configuration)](#aws-glue-api-interactive-sessions-DeleteGlueIdentityCenterConfiguration)

## Ação CreateSession (Python: create\$1session)
<a name="aws-glue-api-interactive-sessions-CreateSession"></a>

Cria uma nova sessão..

**Solicitação**

Solicitação para criar uma nova sessão.
+ `Id`: *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 solicitação de sessã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 sessão. 
+ `Role` – *Obrigatório:* string UTF-8, não inferior a 20 ou superior a 2048 bytes de comprimento, correspondendo a [Custom string pattern #30](aws-glue-api-common.md#regex_30).

  O ARN da função do &IAM 
+ `Command` – *Obrigatório:* um objeto [SessionCommand](#aws-glue-api-interactive-sessions-SessionCommand).

  O `SessionCommand` que executa esse trabalho. 
+ `Timeout` – Número (inteiro), pelo menos 1.

   O número de minutos até esgotar o tempo limite da sessão. O valor padrão para trabalhos de ETL no Spark é 48 horas, equivalente a 2.880 minutos. Consulte a documentação para outros tipos de trabalho. 
+ `IdleTimeout` – Número (inteiro), pelo menos 1.

   O número de minutos de natividade até esgotar o tempo limite da sessão. O padrão para trabalhos de ETL do Spark é o valor do tempo limite. Consulte a documentação para outros tipos de trabalho. 
+ `DefaultArguments` – Uma matriz de mapas de pares de valores-chave, não mais de 75 pares.

  Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes, correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  Cada valor é uma string UTF-8, com comprimento não superior a 4096 bytes, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Um array de mapa dos pares de valor-chave. O máximo é de 75 pares. 
+ `Connections` – Um objeto [ConnectionsList](#aws-glue-api-interactive-sessions-ConnectionsList).

  O número de conexões usadas para a sessão. 
+ `MaxCapacity` – Número (duplo).

  O número de unidades de processamento de dados (DPUs) do AWS Glue que poderão ser alocadas quando o trabalho for executado. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. 
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de determinado `WorkerType` para usar na sessão. 
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido que é alocado quando um trabalho é executado. Aceita um valor de G.1X, G.2X, G.4X ou G.8X para trabalhos do Spark. Aceita o valor Z.2X para cadernos do Ray.
  + Para o tipo de operador `G.1X`, cada operador é mapeado em 1 DPU (4 vCPU, 16 GB de memória) com 94 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads, como transformações de dados, uniões e consultas, para oferecer uma maneira escalável e econômica de executar a maioria dos trabalhos.
  + Para o tipo de operador `G.2X`, cada operador é mapeado em 2 DPU (8 vCPU, 32 GB de memória) com 138 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para workloads, como transformações de dados, uniões e consultas, para oferecer uma maneira escalável e econômica de executar a maioria dos trabalhos.
  + Para o tipo de operador `G.4X`, cada operador é mapeado em 4 DPU (16 vCPU, 64 GB de memória) com 256 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos cujas workloads contêm as transformações, agregações, uniões e consultas mais exigentes. Esse tipo de operador está disponível somente para trabalhos de ETL do Spark no AWS Glue versão 3.0 ou posterior nas seguintes regiões da AWS: Leste dos EUA (Ohio), Leste dos EUA (Norte da Virgínia), Oeste dos EUA (Oregon), Ásia-Pacífico (Singapura), Ásia-Pacífico (Sydney), Ásia-Pacífico (Tóquio), Canadá (Central), Europa (Frankfurt), Europa (Irlanda) e Europa (Estocolmo).
  + Para o tipo de operador `G.8X`, cada operador é mapeado em 8 DPU (32 vCPU, 128 GB de memória) com 512 GB de disco e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos cujas workloads contêm as transformações, agregações, uniões e consultas mais exigentes. Esse tipo de operador está disponível somente para trabalhos de ETL do Spark no AWS Glue versão 3.0 ou posterior, nas mesmas regiões da AWS compatíveis com o tipo de operador `G.4X`.
  + Para o tipo de operador `Z.2X`, cada operador é mapeado em 2 M-DPU (8 vCPUs, 64 GB de memória) com 128 GB de disco e fornece até 8 operadores do Ray baseados no autoscaler.
+ `SecurityConfiguration` – 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 estrutura SecurityConfiguration a ser usada com a sessão. 
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  A versão AWS Glue determina as versões do Apache Spark e do Python compatíveis com o AWS Glue. O GlueVersion deve ser maior que 2.0. 
+ `DataAccessId` - String UTF-8, não menos do que 1 ou superior a 36 bytes de comprimento.

  O ID de acesso a dados da sessão. 
+ `PartitionId` - String UTF-8, não menos do que 1 ou superior a 36 bytes de comprimento.

  O ID da partição da sessão. 
+ `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.

  O mapa dos pares de valores-chave (tags) pertencentes à sessão.
+ `RequestOrigin`: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  A origem da solicitação. 
+ `ProfileName` – 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 de um perfil de uso do AWS Glue associado à sessão.

**Resposta**
+ `Session` – Um objeto [Sessão](#aws-glue-api-interactive-sessions-Session).

  Retorna o objeto de sessão na resposta.

**Erros**
+ `AccessDeniedException`
+ `IdempotentParameterMismatchException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ValidationException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`

## Ação StopSession (Python: stop\$1session)
<a name="aws-glue-api-interactive-sessions-StopSession"></a>

Interrompa a sessão. 

**Solicitação**
+ `Id`: *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 sessão a ser interrompida.
+ `RequestOrigin` – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  A origem da solicitação.

**Resposta**
+ `Id` – 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).

  Retorna o ID da sessão interrompida.

**Erros**
+ `AccessDeniedException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `IllegalSessionStateException`
+ `ConcurrentModificationException`

## Ação DeleteSession (Python: delete\$1session)
<a name="aws-glue-api-interactive-sessions-DeleteSession"></a>

Exclui a sessão.

**Solicitação**
+ `Id`: *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 sessão a ser excluído.
+ `RequestOrigin` – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  O nome da origem da solicitação de sessão de exclusão.

**Resposta**
+ `Id` – 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).

  Retorna o ID da sessão excluída.

**Erros**
+ `AccessDeniedException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `IllegalSessionStateException`
+ `ConcurrentModificationException`

## Ação GetSession (Python: get\$1session)
<a name="aws-glue-api-interactive-sessions-GetSession"></a>

Recupera a sessão.

**Solicitação**
+ `Id`: *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 sessão. 
+ `RequestOrigin` – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  A origem da solicitação. 

**Resposta**
+ `Session` – Um objeto [Sessão](#aws-glue-api-interactive-sessions-Session).

  O objeto de sessão é retornado na resposta.

**Erros**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## Ação ListSessions (Python: list\$1sessions)
<a name="aws-glue-api-interactive-sessions-ListSessions"></a>

Recupere uma lista de sessões.

**Solicitação**
+ `NextToken`: string UTF-8, não superior a 400.000 bytes de comprimento.

  O token para o próximo conjunto de resultados ou nulo se não houver mais resultados. 
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados. 
+ `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.

  Tags pertencentes à sessão. 
+ `RequestOrigin` – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  A origem da solicitação. 

**Resposta**
+ `Ids` – Uma matriz de strings UTF-8.

  Retorna o ID da sessão. 
+ `Sessions`: um array de objetos [Sessão](#aws-glue-api-interactive-sessions-Session).

  Retorna o objeto de sessão. 
+ `NextToken`: string UTF-8, não superior a 400.000 bytes de comprimento.

  O token para o próximo conjunto de resultados ou nulo se não houver mais resultados. 

**Erros**
+ `AccessDeniedException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação RunStatement (Python: run\$1statement)
<a name="aws-glue-api-interactive-sessions-RunStatement"></a>

Executa a instrução.

**Solicitação**
+ `SessionId`: *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 sessão da instrução a ser executado.
+ `Code`: *Obrigatório:* string UTF-8, não superior a 68000 bytes de comprimento.

  O código da instrução a ser executado.
+ `RequestOrigin` – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  A origem da solicitação.

**Resposta**
+ `Id` – Número (íntegro).

  Retorna o ID da instrução que foi executada.

**Erros**
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ValidationException`
+ `ResourceNumberLimitExceededException`
+ `IllegalSessionStateException`

## Ação CancelStatement (Python: cancel\$1statement)
<a name="aws-glue-api-interactive-sessions-CancelStatement"></a>

Cancela a instrução.

**Solicitação**
+ `SessionId`: *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 sessão da instrução a ser cancelado.
+ `Id`: *obrigatório:* número (inteiro).

  O ID da instrução a ser cancelado.
+ `RequestOrigin` – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  A origem da solicitação para cancelar a instrução.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `IllegalSessionStateException`

## Ação GetStatement (Python: get\$1statement)
<a name="aws-glue-api-interactive-sessions-GetStatement"></a>

Recupera a instrução.

**Solicitação**
+ `SessionId`: *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 sessão da instrução.
+ `Id`: *obrigatório:* número (inteiro).

  O ID da instrução.
+ `RequestOrigin` – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  A origem da solicitação.

**Resposta**
+ `Statement` – Um objeto [Declaração](#aws-glue-api-interactive-sessions-Statement).

  Recupera a instrução.

**Erros**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `IllegalSessionStateException`

## Ação ListStatations (Python: list\$1statements)
<a name="aws-glue-api-interactive-sessions-ListStatements"></a>

Lista as instruções para a sessão.

**Solicitação**
+ `SessionId`: *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 sessão das instruções.
+ `RequestOrigin` – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  A origem da solicitação para listar instruções.
+ `NextToken`: string UTF-8, não superior a 400.000 bytes de comprimento.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `Statements`: um array de objetos [Declaração](#aws-glue-api-interactive-sessions-Statement).

  Retorna a lista de instruções.
+ `NextToken`: string UTF-8, não superior a 400.000 bytes de comprimento.

  Um token de continuação, se nem todas as instruções ainda tiverem sido retornadas.

**Erros**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `IllegalSessionStateException`

## Ação GetGlueIdentityCenterConfiguration (Python: get\$1glue\$1identity\$1center\$1configuration)
<a name="aws-glue-api-interactive-sessions-GetGlueIdentityCenterConfiguration"></a>

Recupera os detalhes da configuração atual do Centro de Identidade do AWS Glue, incluindo a instância associada do Centro de Identidade e as informações da aplicação.

**Solicitação**
+ *Sem parâmetros de solicitação.*

**Resposta**

Resposta que contém os detalhes da configuração do Centro de Identidade do AWS Glue.
+ `ApplicationArn`: string UTF-8 com no mínimo 10 e no máximo 1.224 bytes de comprimento.

  O nome do recurso da Amazon (ARN) da aplicação do Centro de Identidade associada à configuração do AWS Glue.
+ `InstanceArn`: string UTF-8 com no mínimo 10 e no máximo 1.224 bytes de comprimento.

  O nome do recurso da Amazon (ARN) da instância do Centro de Identidade associado à configuração do AWS Glue.
+ `Scopes` – Uma matriz de strings UTF-8.

  Uma lista dos escopos do Centro de Identidade que definem as permissões e os níveis de acesso para a configuração do AWS Glue.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `AccessDeniedException`
+ `ConcurrentModificationException`

## Ação UpdateGlueIdentityCenterConfiguration (Python: update\$1glue\$1identity\$1center\$1configuration)
<a name="aws-glue-api-interactive-sessions-UpdateGlueIdentityCenterConfiguration"></a>

Atualiza a configuração existente do Centro de Identidade do AWS Glue, permitindo a modificação de escopos e permissões para a integração.

**Solicitação**

Solicitação para atualizar uma configuração existente do Centro de Identidade do AWS Glue.
+ `Scopes` - Uma matriz de strings UTF-8, não menos que 1 ou mais que 50 strings.

  Uma lista dos escopos do Centro de Identidade que definem as permissões e os níveis de acesso atualizados para a configuração do AWS Glue.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `AccessDeniedException`
+ `ConcurrentModificationException`

## Ação CreateGlueIdentityCenterConfiguration (Python: create\$1glue\$1identity\$1center\$1configuration)
<a name="aws-glue-api-interactive-sessions-CreateGlueIdentityCenterConfiguration"></a>

Cria uma nova configuração do Centro de Identidade do AWS Glue para permitir a integração entre AWS Glue e o Centro de Identidade do AWS IAM para autenticação e autorização.

**Solicitação**

Solicitação para criar uma nova configuração do Centro de Identidade do AWS Glue.
+ `InstanceArn`: *obrigatório:* string UTF-8 com no mínimo 10 e no máximo 1.224 bytes de comprimento.

  O nome do recurso da Amazon (ARN) da instância do Centro de Identidade a ser associado à configuração do AWS Glue.
+ `Scopes` - Uma matriz de strings UTF-8, não menos que 1 ou mais que 50 strings.

  Uma lista dos escopos do Centro de Identidade que definem as permissões e os níveis de acesso para a configuração do AWS Glue.

**Resposta**

Resposta da criação de uma nova configuração do Centro de Identidade do AWS Glue.
+ `ApplicationArn`: string UTF-8 com no mínimo 10 e no máximo 1.224 bytes de comprimento.

  O nome do recurso da Amazon (ARN) da aplicação do Centro de Identidade que foi criada para a configuração do AWS Glue.

**Erros**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `AccessDeniedException`
+ `ConcurrentModificationException`

## Ação DeleteGlueIdentityCenterConfiguration (Python: delete\$1glue\$1identity\$1center\$1configuration)
<a name="aws-glue-api-interactive-sessions-DeleteGlueIdentityCenterConfiguration"></a>

Exclui a configuração existente do Centro de Identidade do AWS Glue, removendo a integração entre o AWS Glue e o Centro de Identidade do AWS IAM.

**Solicitação**
+ *Sem parâmetros de solicitação.*

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `AccessDeniedException`
+ `ConcurrentModificationException`

# API de endpoints de desenvolvimento
<a name="aws-glue-api-dev-endpoint"></a>

A API Development endpoints descreve a API do AWS Glue relacionada a testes com uso de um DevEndpoint personalizado.

## Tipos de dados
<a name="aws-glue-api-dev-endpoint-objects"></a>
+ [Estrutura DevEndpoint](#aws-glue-api-dev-endpoint-DevEndpoint)
+ [Estrutura DevEndpointCustomLibraries](#aws-glue-api-dev-endpoint-DevEndpointCustomLibraries)

## Estrutura DevEndpoint
<a name="aws-glue-api-dev-endpoint-DevEndpoint"></a>

Um endpoint de desenvolvimento no qual um desenvolvedor pode depurar scripts de extração, transformação e carregamento (ETL) remotamente.

**Campos**
+ `EndpointName` – String UTF-8.

  O nome da `DevEndpoint`.
+ `RoleArn` – String UTF-8 correspondente a [AWS IAM ARN string pattern](aws-glue-api-common.md#aws-glue-api-regex-aws-iam-arn-id).

  O nome de recurso da Amazon (ARN) da função do IAM usada nesse `DevEndpoint`.
+ `SecurityGroupIds` – Uma matriz de strings UTF-8.

  Uma lista dos identificadores de grupo de segurança usados ​​neste `DevEndpoint`.
+ `SubnetId` – String UTF-8.

  O ID de sub-rede para esse `DevEndpoint`.
+ `YarnEndpointAddress` – String UTF-8.

  O endereço do endpoint YARN usado por este `DevEndpoint`.
+ `PrivateAddress` – String UTF-8.

  Um endereço IP privado para acessar o `DevEndpoint` em uma VPC se o `DevEndpoint` for criado dentro de um. O campo `PrivateAddress` está presente somente quando você cria o `DevEndpoint` na VPC.
+ `ZeppelinRemoteSparkInterpreterPort` – Número (íntegro).

  A porta Apache Zeppelin para o intérprete Apache Spark remoto.
+ `PublicAddress` – String UTF-8.

  O endereço IP público usado por esse `DevEndpoint`. O campo `PublicAddress` está presente somente quando você cria uma nuvem privada não virtual (VPC) `DevEndpoint`.
+ `Status` – String UTF-8.

  O status atual deste `DevEndpoint`.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido alocado para o endpoint de desenvolvimento. Aceita um valor de Standard (Padrão), G.1X ou G.2X.
  + Para o tipo de operador `Standard`, cada operador fornece 4 vCPU, 16 GB de memória e um disco de 50 GB e 2 executores por operador.
  + Para o tipo de operador `G.1X`, cada operador é mapeado para 1 DPU (4 vCPU, 16 GB de memória, disco de 64 GB), e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos com uso intensivo de memória.
  + Para o tipo de operador `G.2X`, cada operador é mapeado para 2 DPU (8 vCPU, 32 GB de memória, disco de 128 GB), e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos com uso intensivo de memória.

  Problema conhecido: quando um endpoint de desenvolvimento é criado com a configuração `G.2X` `WorkerType`, os drivers do Spark para o endpoint de desenvolvimento são executados em 4 vCPUs, 16 GB de memória e um disco de 64 GB. 
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  A versão do Glue determina as versões do Apache Spark e do Python compatíveis com o AWS Glue. A versão do Python indica a versão compatível para executar seus scripts de ETL em endpoints de desenvolvimento. 

  Para obter mais informações sobre as versões disponíveis do AWS Glue e as versões correspondentes do Spark e do Python, consulte [Versão do Glue](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) no guia do desenvolvedor.

  Os endpoints de desenvolvimento criados sem especificar uma versão do Glue usam como padrão o Glue 0.9.

  É possível especificar uma versão do suporte do Python para endpoints de desenvolvimento usando o parâmetro `Arguments` nas APIs `CreateDevEndpoint` ou `UpdateDevEndpoint`. Se nenhum argumento for fornecido, a versão usará o Python 2 como padrão.
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de um `workerType` definido que são alocados para o endpoint de desenvolvimento.

  O número máximo de operadores que você pode definir são 299 para `G.1X` e 149 para `G.2X`. 
+ `NumberOfNodes` – Número (íntegro).

  O número de unidades de processamento de dados (DPUs) do AWS Glue alocadas para esse `DevEndpoint`.
+ `AvailabilityZone` – String UTF-8.

  A zona de disponibilidade da AWS onde esse `DevEndpoint` está localizado.
+ `VpcId` – String UTF-8.

  O ID da nuvem privada virtual (VPC) usada por esse `DevEndpoint`.
+ `ExtraPythonLibsS3Path` – String UTF-8.

  Os caminhos para um ou mais bibliotecas Python em um bucket do Amazon S3 que deve ser carregado no seu `DevEndpoint`. Vários valores devem ser caminhos completos separados por uma vírgula.
**nota**  
Você pode usar apenas bibliotecas Python puras com um `DevEndpoint`. Bibliotecas que contam com extensões C, como a biblioteca de análise de dados Python 8[pandas](http://pandas.pydata.org/), não são compatíveis no momento.
+ `ExtraJarsS3Path` – String UTF-8.

  Os caminhos para um ou mais arquivos `.jar` do Java em um bucket do S3 que deve ser carregado no `DevEndpoint`.
**nota**  
Você pode usar apenas bibliotecas Java/Scala com um `DevEndpoint`.
+ `FailureReason` – String UTF-8.

  O motivo da falha atual neste `DevEndpoint`.
+ `LastUpdateStatus` – String UTF-8.

  O status da última atualização.
+ `CreatedTimestamp` – Timestamp.

  O momento em que este DevEndpoint foi criado.
+ `LastModifiedTimestamp` – Timestamp.

  O momento em que esse `DevEndpoint` foi modificado pela última vez.
+ `PublicKey` – String UTF-8.

  A chave pública a ser usada por esse `DevEndpoint` para autenticação. Este atributo é fornecido para compatibilidade com versões anteriores, pois o atributo recomendado para uso são chaves públicas.
+ `PublicKeys` – Uma matriz de strings UTF-8, no máximo 5 strings.

  Uma lista de chaves públicas a serem usadas pelos `DevEndpoints` para autenticação. O uso desse atributo é preferido em vez de uma única chave pública, pois as chaves públicas permitem que você tenha uma chave privada diferente por cliente.
**nota**  
Se você tiver criado um endpoint com uma chave pública, deverá remover essa chave para poder definir uma lista de chaves públicas. Chame a operação da API `UpdateDevEndpoint` com o conteúdo da chave pública no atributo `deletePublicKeys` e a lista de novas chaves no atributo `addPublicKeys`.
+ `SecurityConfiguration` – 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 estrutura de `SecurityConfiguration` a ser usada com esse `DevEndpoint`.
+ `Arguments`: uma matriz de mapa dos pares de chave-valor, não mais do que 100 pares.

  Cada chave é uma sequência de caracteres UTF-8.

  Cada valor é uma sequência de caracteres UTF-8.

  Um mapa de argumentos usados para configurar o `DevEndpoint`.

  Os argumentos válidos são:
  + `"--enable-glue-datacatalog": ""`

  É possível especificar uma versão do suporte do Python para endpoints de desenvolvimento usando o parâmetro `Arguments` nas APIs `CreateDevEndpoint` ou `UpdateDevEndpoint`. Se nenhum argumento for fornecido, a versão usará o Python 2 como padrão.

## Estrutura DevEndpointCustomLibraries
<a name="aws-glue-api-dev-endpoint-DevEndpointCustomLibraries"></a>

Bibliotecas personalizadas a serem carregadas em um endpoint de desenvolvimento.

**Campos**
+ `ExtraPythonLibsS3Path` – String UTF-8.

  Os caminhos para uma ou mais bibliotecas Python em um bucket do Amazon Simple Storage Service (Amazon S3) que devem ser carregadas no `DevEndpoint`. Vários valores devem ser caminhos completos separados por uma vírgula.
**nota**  
Você pode usar apenas bibliotecas Python puras com um `DevEndpoint`. Bibliotecas que contam com extensões C, como a biblioteca de análise de dados Python 8[pandas](http://pandas.pydata.org/), não são compatíveis no momento.
+ `ExtraJarsS3Path` – String UTF-8.

  Os caminhos para um ou mais arquivos `.jar` do Java em um bucket do S3 que deve ser carregado no `DevEndpoint`.
**nota**  
Você pode usar apenas bibliotecas Java/Scala com um `DevEndpoint`.

## Operações
<a name="aws-glue-api-dev-endpoint-actions"></a>
+ [Ação CreateDevEndpoint (Python: create\$1dev\$1endpoint)](#aws-glue-api-dev-endpoint-CreateDevEndpoint)
+ [Ação UpdateDevEndpoint (Python: update\$1dev\$1endpoint)](#aws-glue-api-dev-endpoint-UpdateDevEndpoint)
+ [Ação DeleteDevEndpoint (Python: delete\$1dev\$1endpoint)](#aws-glue-api-dev-endpoint-DeleteDevEndpoint)
+ [Ação GetDevEndpoint (Python: get\$1dev\$1endpoint)](#aws-glue-api-dev-endpoint-GetDevEndpoint)
+ [Ação GetDevEndpoints (Python: get\$1dev\$1endpoints)](#aws-glue-api-dev-endpoint-GetDevEndpoints)
+ [Ação BatchGetDevEndpoints (Python: batch\$1get\$1dev\$1endpoints)](#aws-glue-api-dev-endpoint-BatchGetDevEndpoints)
+ [Ação ListDevEndpoints (Python: list\$1dev\$1endpoints)](#aws-glue-api-dev-endpoint-ListDevEndpoints)

## Ação CreateDevEndpoint (Python: create\$1dev\$1endpoint)
<a name="aws-glue-api-dev-endpoint-CreateDevEndpoint"></a>

Cria um endpoint de desenvolvimento.

**Solicitação**
+ `EndpointName` – *Obrigatório:* string UTF-8.

  O nome a ser atribuído ao novo `DevEndpoint`.
+ `RoleArn` – *Obrigatório:* string UTF-8, correspondente a [AWS IAM ARN string pattern](aws-glue-api-common.md#aws-glue-api-regex-aws-iam-arn-id).

  A função do IAM para o `DevEndpoint`.
+ `SecurityGroupIds` – Uma matriz de strings UTF-8.

  IDs dos grupos de segurança a serem usados ​​pelo novo `DevEndpoint`.
+ `SubnetId` – String UTF-8.

  O ID de sub-rede para o novo `DevEndpoint` a ser usado.
+ `PublicKey` – String UTF-8.

  A chave pública a ser usada por esse `DevEndpoint` para autenticação. Este atributo é fornecido para compatibilidade com versões anteriores, pois o atributo recomendado para uso são chaves públicas.
+ `PublicKeys` – Uma matriz de strings UTF-8, no máximo 5 strings.

  Uma lista de chaves públicas a serem usadas pelos endpoints de desenvolvimento para autenticação. O uso desse atributo é preferido em vez de uma única chave pública, pois as chaves públicas permitem que você tenha uma chave privada diferente por cliente.
**nota**  
Se você tiver criado um endpoint com uma chave pública, deverá remover essa chave para poder definir uma lista de chaves públicas. Chame a API `UpdateDevEndpoint` com o conteúdo da chave pública no atributo `deletePublicKeys` e a lista de novas chaves no atributo `addPublicKeys`.
+ `NumberOfNodes` – Número (íntegro).

  O número de unidades de processamento de dados (DPUs) do AWS Glue a serem alocadas para esse `DevEndpoint`.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido alocado para o endpoint de desenvolvimento. Aceita um valor de Standard (Padrão), G.1X ou G.2X.
  + Para o tipo de operador `Standard`, cada operador fornece 4 vCPU, 16 GB de memória e um disco de 50 GB e 2 executores por operador.
  + Para o tipo de operador `G.1X`, cada operador é mapeado para 1 DPU (4 vCPU, 16 GB de memória, disco de 64 GB), e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos com uso intensivo de memória.
  + Para o tipo de operador `G.2X`, cada operador é mapeado para 2 DPU (8 vCPU, 32 GB de memória, disco de 128 GB), e fornece 1 executor por operador. Recomendamos esse tipo de operador para trabalhos com uso intensivo de memória.

  Problema conhecido: quando um endpoint de desenvolvimento é criado com a configuração `G.2X` `WorkerType`, os drivers do Spark para o endpoint de desenvolvimento são executados em 4 vCPUs, 16 GB de memória e um disco de 64 GB. 
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  A versão do Glue determina as versões do Apache Spark e do Python compatíveis com o AWS Glue. A versão do Python indica a versão compatível para executar seus scripts de ETL em endpoints de desenvolvimento. 

  Para obter mais informações sobre as versões disponíveis do AWS Glue e as versões correspondentes do Spark e do Python, consulte [Versão do Glue](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) no guia do desenvolvedor.

  Os endpoints de desenvolvimento criados sem especificar uma versão do Glue usam como padrão o Glue 0.9.

  É possível especificar uma versão do suporte do Python para endpoints de desenvolvimento usando o parâmetro `Arguments` nas APIs `CreateDevEndpoint` ou `UpdateDevEndpoint`. Se nenhum argumento for fornecido, a versão usará o Python 2 como padrão.
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de um `workerType` definido que são alocados para o endpoint de desenvolvimento.

  O número máximo de operadores que você pode definir são 299 para `G.1X` e 149 para `G.2X`. 
+ `ExtraPythonLibsS3Path` – String UTF-8.

  Os caminhos para um ou mais bibliotecas Python em um bucket do Amazon S3 que deve ser carregado no seu `DevEndpoint`. Vários valores devem ser caminhos completos separados por uma vírgula.
**nota**  
Você pode usar apenas bibliotecas Python puras com um `DevEndpoint`. Bibliotecas que contam com extensões C, como a biblioteca de análise de dados Python [pandas](http://pandas.pydata.org/), ainda não são compatíveis.
+ `ExtraJarsS3Path` – String UTF-8.

  Os caminhos para um ou mais arquivos `.jar` do Java em um bucket do S3 que deve ser carregado no `DevEndpoint`.
+ `SecurityConfiguration` – 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 estrutura de `SecurityConfiguration` a ser usada com esse `DevEndpoint`.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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 a serem usadas com esse DevEndpoint. Você pode usar tags para limitar o acesso ao DevEndpoint. Para obter mais informações sobre tags no AWS Glue, consulte [Tags da AWS no AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) no guia do desenvolvedor.
+ `Arguments`: uma matriz de mapa dos pares de chave-valor, não mais do que 100 pares.

  Cada chave é uma sequência de caracteres UTF-8.

  Cada valor é uma sequência de caracteres UTF-8.

  Um mapa de argumentos usados para configurar o `DevEndpoint`.

**Resposta**
+ `EndpointName` – String UTF-8.

  O nome atribuído ao novo `DevEndpoint`.
+ `Status` – String UTF-8.

  O status atual do novo `DevEndpoint`.
+ `SecurityGroupIds` – Uma matriz de strings UTF-8.

  Os grupos de segurança atribuídos ao novo `DevEndpoint`.
+ `SubnetId` – String UTF-8.

  O ID de sub-rede atribuído ao novo `DevEndpoint`.
+ `RoleArn` – String UTF-8 correspondente a [AWS IAM ARN string pattern](aws-glue-api-common.md#aws-glue-api-regex-aws-iam-arn-id).

  O nome de recurso da Amazon (ARN) da função atribuída ao novo `DevEndpoint`.
+ `YarnEndpointAddress` – String UTF-8.

  O endereço do endpoint YARN usado por esse `DevEndpoint`.
+ `ZeppelinRemoteSparkInterpreterPort` – Número (íntegro).

  A porta Apache Zeppelin para o intérprete Apache Spark remoto.
+ `NumberOfNodes` – Número (íntegro).

  O número de unidades de processamento de dados (DPUs) do AWS Glue alocadas para esse DevEndpoint.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido alocado para o endpoint de desenvolvimento. Deve ser um valor de Standard (Padrão), G.1X ou G.2X.
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  A versão do Glue determina as versões do Apache Spark e do Python compatíveis com o AWS Glue. A versão do Python indica a versão compatível para executar seus scripts de ETL em endpoints de desenvolvimento. 

  Para obter mais informações sobre as versões disponíveis do AWS Glue e as versões correspondentes do Spark e do Python, consulte [Versão do Glue](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) no guia do desenvolvedor.
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de um `workerType` definido que são alocados para o endpoint de desenvolvimento.
+ `AvailabilityZone` – String UTF-8.

  A zona de disponibilidade da AWS onde esse `DevEndpoint` está localizado.
+ `VpcId` – String UTF-8.

  O ID da nuvem privada virtual (VPC) usada por esse `DevEndpoint`.
+ `ExtraPythonLibsS3Path` – String UTF-8.

  Os caminhos para um ou mais bibliotecas Python em um bucket do S3 que será carregado no `DevEndpoint`.
+ `ExtraJarsS3Path` – String UTF-8.

  Os caminhos para um ou mais arquivos `.jar` do Java em um bucket do S3 que será carregado no `DevEndpoint`.
+ `FailureReason` – String UTF-8.

  O motivo da falha atual neste `DevEndpoint`.
+ `SecurityConfiguration` – 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 estrutura de `SecurityConfiguration` a ser usada com esse `DevEndpoint`.
+ `CreatedTimestamp` – Timestamp.

  O momento em que esse `DevEndpoint` foi criado.
+ `Arguments`: uma matriz de mapa dos pares de chave-valor, não mais do que 100 pares.

  Cada chave é uma sequência de caracteres UTF-8.

  Cada valor é uma sequência de caracteres UTF-8.

  O mapa de argumentos usados para configurar esse `DevEndpoint`.

  Os argumentos válidos são:
  + `"--enable-glue-datacatalog": ""`

  É possível especificar uma versão do suporte do Python para endpoints de desenvolvimento usando o parâmetro `Arguments` nas APIs `CreateDevEndpoint` ou `UpdateDevEndpoint`. Se nenhum argumento for fornecido, a versão usará o Python 2 como padrão.

**Erros**
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `IdempotentParameterMismatchException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ValidationException`
+ `ResourceNumberLimitExceededException`

## Ação UpdateDevEndpoint (Python: update\$1dev\$1endpoint)
<a name="aws-glue-api-dev-endpoint-UpdateDevEndpoint"></a>

Atualiza um endpoint de desenvolvimento especificado.

**Solicitação**
+ `EndpointName` – *Obrigatório:* string UTF-8.

  O nome do `DevEndpoint` a ser atualizado.
+ `PublicKey` – String UTF-8.

  A chave pública a ser usada pelo `DevEndpoint`.
+ `AddPublicKeys` – Uma matriz de strings UTF-8, no máximo 5 strings.

  A lista de chaves públicas a serem usadas pelo `DevEndpoint`.
+ `DeletePublicKeys` – Uma matriz de strings UTF-8, no máximo 5 strings.

  A lista de chaves públicas a serem excluídas do `DevEndpoint`.
+ `CustomLibraries` – Um objeto [DevEndpointCustomLibraries](#aws-glue-api-dev-endpoint-DevEndpointCustomLibraries).

  Bibliotecas personalizadas Python ou Java a serem carregadas no `DevEndpoint`.
+ `UpdateEtlLibraries` – Booleano.

  `True`, se a lista de bibliotecas personalizadas a serem carregadas no endpoint de desenvolvimento precisarem ser atualizadas, ou `False`, caso contrário.
+ `DeleteArguments` – Uma matriz de strings UTF-8.

  A lista de chaves de argumentos a serem excluídos do mapa de argumentos usado para configurar o `DevEndpoint`.
+ `AddArguments`: uma matriz de mapa dos pares de chave-valor, não mais do que 100 pares.

  Cada chave é uma sequência de caracteres UTF-8.

  Cada valor é uma sequência de caracteres UTF-8.

  O mapa de argumentos para adicionar o mapa de argumentos usado para configurar o `DevEndpoint`.

  Os argumentos válidos são:
  + `"--enable-glue-datacatalog": ""`

  É possível especificar uma versão do suporte do Python para endpoints de desenvolvimento usando o parâmetro `Arguments` nas APIs `CreateDevEndpoint` ou `UpdateDevEndpoint`. Se nenhum argumento for fornecido, a versão usará o Python 2 como padrão.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ValidationException`

## Ação DeleteDevEndpoint (Python: delete\$1dev\$1endpoint)
<a name="aws-glue-api-dev-endpoint-DeleteDevEndpoint"></a>

Exclui um endpoint de desenvolvimento especificado.

**Solicitação**
+ `EndpointName` – *Obrigatório:* string UTF-8.

  O nome da `DevEndpoint`.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## Ação GetDevEndpoint (Python: get\$1dev\$1endpoint)
<a name="aws-glue-api-dev-endpoint-GetDevEndpoint"></a>

Recupera informações sobre um endpoint de desenvolvimento especificado.

**nota**  
Quando você cria um endpoint de desenvolvimento em uma nuvem privada virtual (VPC), o AWS Glue retorna apenas um endereço IP privado e o campo do endereço IP público campo não é preenchido. Quando você cria um endpoint de desenvolvimento não seja da VPC, o AWS Glue retorna somente um endereço IP público.

**Solicitação**
+ `EndpointName` – *Obrigatório:* string UTF-8.

  Nome do `DevEndpoint` para o qual recuperar informações.

**Resposta**
+ `DevEndpoint` – Um objeto [DevEndpoint](#aws-glue-api-dev-endpoint-DevEndpoint).

  Uma definição de `DevEndpoint`.

**Erros**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## Ação GetDevEndpoints (Python: get\$1dev\$1endpoints)
<a name="aws-glue-api-dev-endpoint-GetDevEndpoints"></a>

Recupera todos os endpoints de desenvolvimento nessa conta da AWS.

**nota**  
Quando você cria um endpoint de desenvolvimento em uma nuvem privada virtual (VPC), o AWS Glue retorna apenas um endereço IP privado, e o campo do endereço IP público campo não é preenchido. Quando você cria um endpoint de desenvolvimento não seja da VPC, o AWS Glue retorna somente um endereço IP público.

**Solicitação**
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O tamanho máximo das informações a serem retornadas.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `DevEndpoints`: um array de objetos [DevEndpoint](#aws-glue-api-dev-endpoint-DevEndpoint).

  Uma lista de definições de `DevEndpoint`.
+ `NextToken` – String UTF-8.

  Um token de continuação, caso nem todas as definições de `DevEndpoint` tenham sido retornadas ainda.

**Erros**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## Ação BatchGetDevEndpoints (Python: batch\$1get\$1dev\$1endpoints)
<a name="aws-glue-api-dev-endpoint-BatchGetDevEndpoints"></a>

Retorna uma lista de metadados de recurso para uma lista de nomes de endpoints de desenvolvimento. Depois de chamar a operação `ListDevEndpoints`, você pode chamar essa operação para acessar os dados aos quais você recebeu permissões. Essa operação oferece suporte a todas as permissões do IAM, incluindo condições de permissão que usam tags.

**Solicitação**
+ `customerAccountId` – String UTF-8.

  O ID da conta da AWS.
+ `DevEndpointNames` – *Obrigatório:* uma matriz de strings UTF-8, no mínimo 1 ou mais de 25 strings.

  Uma lista de nomes de `DevEndpoint`, que podem ser os nomes retornados da operação `ListDevEndpoint`.

**Resposta**
+ `DevEndpoints`: um array de objetos [DevEndpoint](#aws-glue-api-dev-endpoint-DevEndpoint).

  Uma lista de definições de `DevEndpoint`.
+ `DevEndpointsNotFound`: uma matriz de strings UTF-8, não menos do que 1 ou superior a 25 strings.

  Uma lista de `DevEndpoints` não encontrados.

**Erros**
+ `AccessDeniedException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## Ação ListDevEndpoints (Python: list\$1dev\$1endpoints)
<a name="aws-glue-api-dev-endpoint-ListDevEndpoints"></a>

Recupera os nomes de todos os recursos do `DevEndpoint` nessa conta da AWS ou os recursos com a tag especificada. Essa operação permite que você veja quais recursos estão disponíveis em sua conta e seus nomes.

Essa operação aceita o campo `Tags` opcional, que pode ser usado como um filtro na resposta, para que recursos com tags possam ser recuperados como um grupo. Se você optar por usar a filtragem por tags, apenas os recursos com a tag serão recuperados.

**Solicitação**
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma solicitação de continuação.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O tamanho máximo de uma lista a ser retornada.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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.

  Especifica apenas o retorno desses recursos com tags.

**Resposta**
+ `DevEndpointNames` – Uma matriz de strings UTF-8.

  Os nomes de cada `DevEndpoint` na conta de cada `DevEndpoint` com as tags especificadas.
+ `NextToken` – String UTF-8.

  Um token de continuação, se a lista retornada não contiver a métrica mais recente disponível.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

# Registro de esquemas
<a name="aws-glue-api-schema-registry-api"></a>

A API de registro de esquemas descreve os tipos de dados e a API relacionada ao trabalho com esquemas no AWS Glue.

## Tipos de dados
<a name="aws-glue-api-schema-registry-api-objects"></a>
+ [Estrutura RegistryId](#aws-glue-api-schema-registry-api-RegistryId)
+ [Estrutura RegistryListItem](#aws-glue-api-schema-registry-api-RegistryListItem)
+ [Estrutura MetadataInfo](#aws-glue-api-schema-registry-api-MetadataInfo)
+ [Estrutura OtherMetadataValueListItem](#aws-glue-api-schema-registry-api-OtherMetadataValueListItem)
+ [Estrutura SchemaListItem](#aws-glue-api-schema-registry-api-SchemaListItem)
+ [Estrutura SchemaVersionListItem](#aws-glue-api-schema-registry-api-SchemaVersionListItem)
+ [Estrutura MetadataKeyValuePair](#aws-glue-api-schema-registry-api-MetadataKeyValuePair)
+ [Estrutura SchemaVersionErrorItem](#aws-glue-api-schema-registry-api-SchemaVersionErrorItem)
+ [Estrutura ErrorDetails](#aws-glue-api-schema-registry-api-ErrorDetails)
+ [Estrutura SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber)
+ [Estrutura SchemaId](#aws-glue-api-schema-registry-api-SchemaId)

## Estrutura RegistryId
<a name="aws-glue-api-schema-registry-api-RegistryId"></a>

Uma estrutura de wrapper que pode conter o nome de registro e o nome do recurso da Amazon (ARN).

**Campos**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  Nome do registro. Usado apenas para pesquisa. Um de `RegistryArn` ou `RegistryName` tem de ser fornecido. 
+ `RegistryArn` – 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).

  ARN do registro a ser atualizado. Um de `RegistryArn` ou `RegistryName` tem de ser fornecido.

## Estrutura RegistryListItem
<a name="aws-glue-api-schema-registry-api-RegistryListItem"></a>

Uma estrutura que contém os detalhes de um registro.

**Campos**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro.
+ `RegistryArn` – 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 de recurso da Amazon (ARN) do registro.
+ `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 registro.
+ `Status` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `DELETING`).

  O status do registro.
+ `CreatedTime` – String UTF-8.

  A data em que o registro foi criado.
+ `UpdatedTime` – String UTF-8.

  A data em que o registro foi atualizado.

## Estrutura MetadataInfo
<a name="aws-glue-api-schema-registry-api-MetadataInfo"></a>

Uma estrutura que contém informações de metadados para uma versão do esquema.

**Campos**
+ `MetadataValue` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).

  O valor correspondente da chave de metadados.
+ `CreatedTime` – String UTF-8.

  A hora em que a entrada foi criada.
+ `OtherMetadataValueList`: um array de objetos [OtherMetadataValueListItem](#aws-glue-api-schema-registry-api-OtherMetadataValueListItem).

  Outros metadados pertencentes à mesma chave de metadados.

## Estrutura OtherMetadataValueListItem
<a name="aws-glue-api-schema-registry-api-OtherMetadataValueListItem"></a>

Uma estrutura que contém outros metadados para uma versão do esquema pertencente à mesma chave de metadados.

**Campos**
+ `MetadataValue` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).

  O valor correspondente da chave de metadados para os outros metadados pertencentes à mesma chave de metadados.
+ `CreatedTime` – String UTF-8.

  A hora em que a entrada foi criada.

## Estrutura SchemaListItem
<a name="aws-glue-api-schema-registry-api-SchemaListItem"></a>

Um objeto que contém detalhes mínimos para um esquema.

**Campos**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro em que o esquema reside.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do esquema.
+ `SchemaArn` – 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 esquema.
+ `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 para o esquema.
+ `SchemaStatus` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `DELETING`).

  O status do esquema.
+ `CreatedTime` – String UTF-8.

  A data e a hora em que o esquema foi criado.
+ `UpdatedTime` – String UTF-8.

  A data e a hora em que o esquema foi atualizado.

## Estrutura SchemaVersionListItem
<a name="aws-glue-api-schema-registry-api-SchemaVersionListItem"></a>

Um objeto que contém os detalhes sobre uma versão do esquema.

**Campos**
+ `SchemaArn` – 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 de recurso da Amazon (ARN) do esquema.
+ `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 identificador exclusivo da versão do esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  O número da versão do esquema.
+ `Status` – String UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `FAILURE` \$1 `DELETING`).

  O status da versão do esquema.
+ `CreatedTime` – String UTF-8.

  A data e hora em que a versão do esquema foi criada.

## Estrutura MetadataKeyValuePair
<a name="aws-glue-api-schema-registry-api-MetadataKeyValuePair"></a>

Uma estrutura que contém um par de chave-valor para metadados.

**Campos**
+ `MetadataKey` – string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).

  Uma chave de metadados.
+ `MetadataValue` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).

  O valor correspondente de uma chave de metadados.

## Estrutura SchemaVersionErrorItem
<a name="aws-glue-api-schema-registry-api-SchemaVersionErrorItem"></a>

Um objeto que contém os detalhes de erro de uma operação em uma versão do esquema.

**Campos**
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  O número da versão do esquema.
+ `ErrorDetails` – Um objeto [ErrorDetails](#aws-glue-api-schema-registry-api-ErrorDetails).

  Os detalhes do erro para a versão do esquema.

## Estrutura ErrorDetails
<a name="aws-glue-api-schema-registry-api-ErrorDetails"></a>

Um objeto que contém detalhes do erro.

**Campos**
+ `ErrorCode` – String UTF-8.

  O código de erro para um erro.
+ `ErrorMessage` – String UTF-8.

  A mensagem de erro para um erro.

## Estrutura SchemaVersionNumber
<a name="aws-glue-api-schema-registry-api-SchemaVersionNumber"></a>

Uma estrutura que contém as informações da versão do esquema.

**Campos**
+ `LatestVersion` – Booleano.

  A versão mais recente disponível para o esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  O número da versão do esquema.

## Estrutura SchemaId
<a name="aws-glue-api-schema-registry-api-SchemaId"></a>

O ID exclusivo do esquema no registro de esquemas do AWS Glue.

**Campos**
+ `SchemaArn` – 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 de recurso da Amazon (ARN) do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro do esquema que contém o esquema.

## Operações
<a name="aws-glue-api-schema-registry-api-actions"></a>
+ [Ação CreateRegistry (Python: create\$1registry)](#aws-glue-api-schema-registry-api-CreateRegistry)
+ [Ação CreateSchema (Python: create\$1esquema)](#aws-glue-api-schema-registry-api-CreateSchema)
+ [Ação GetSchema (Python: get\$1schema)](#aws-glue-api-schema-registry-api-GetSchema)
+ [Ação ListSchemaVersions (Python: list\$1schema\$1versions)](#aws-glue-api-schema-registry-api-ListSchemaVersions)
+ [Ação GetSchemaVersion (Python: get\$1schema\$1version)](#aws-glue-api-schema-registry-api-GetSchemaVersion)
+ [Ação GetSchemaVersionsDiff (Python: get\$1schema\$1versions\$1diff)](#aws-glue-api-schema-registry-api-GetSchemaVersionsDiff)
+ [Ação ListRegistries (Python: list\$1registries)](#aws-glue-api-schema-registry-api-ListRegistries)
+ [Ação ListSchemas (Python: list\$1schemas)](#aws-glue-api-schema-registry-api-ListSchemas)
+ [Ação RegisterSchemaVersion (Python: register\$1schema\$1version)](#aws-glue-api-schema-registry-api-RegisterSchemaVersion)
+ [Ação UpdateSchema (Python: update\$1schema)](#aws-glue-api-schema-registry-api-UpdateSchema)
+ [Ação CheckSchemaVersionValidity (Python: check\$1schema\$1version\$1validity)](#aws-glue-api-schema-registry-api-CheckSchemaVersionValidity)
+ [Ação UpdateRegistry (Python: update\$1registry)](#aws-glue-api-schema-registry-api-UpdateRegistry)
+ [Ação GetSchemaByDefinition (Python: get\$1schema\$1by\$1definition)](#aws-glue-api-schema-registry-api-GetSchemaByDefinition)
+ [Ação GetRegistry (Python: get\$1registry)](#aws-glue-api-schema-registry-api-GetRegistry)
+ [Ação PutSchemaVersionMetadata (Python: put\$1schema\$1version\$1metadata)](#aws-glue-api-schema-registry-api-PutSchemaVersionMetadata)
+ [Ação QuerySchemaVersionMetadata (Python: query\$1schema\$1version\$1metadata)](#aws-glue-api-schema-registry-api-QuerySchemaVersionMetadata)
+ [Ação RemoveSchemaVersionMetadata (Python: remove\$1schema\$1version\$1metadata)](#aws-glue-api-schema-registry-api-RemoveSchemaVersionMetadata)
+ [Ação DeleteRegistry (Python: delete\$1registry)](#aws-glue-api-schema-registry-api-DeleteRegistry)
+ [Ação DeleteSchema (Python: delete\$1schema)](#aws-glue-api-schema-registry-api-DeleteSchema)
+ [Ação DeleteSchemaVersions (Python: delete\$1schema\$1versions)](#aws-glue-api-schema-registry-api-DeleteSchemaVersions)

## Ação CreateRegistry (Python: create\$1registry)
<a name="aws-glue-api-schema-registry-api-CreateRegistry"></a>

Cria um novo registro que pode ser usado para armazenar uma coleção de esquemas.

**Solicitação**
+ `RegistryName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  Nome do esquema a ser criado com comprimento máximo de 255 e que só pode conter letras, números, hífen, sublinhado, sinal de dólar ou cerquilha. Sem espaço em branco
+ `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 registro. Se a descrição não for fornecida, não haverá nenhum valor padrão para esse campo.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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.

  AWSTags da que contêm um par de chave-valor e podem ser pesquisadas por console, linha de comando ou API.

**Resposta**
+ `RegistryArn` – 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 registro recém-criado.
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro.
+ `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 registro.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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 do registro.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação CreateSchema (Python: create\$1esquema)
<a name="aws-glue-api-schema-registry-api-CreateSchema"></a>

Cria um novo conjunto de esquemas e registra a definição do esquema. Retorna um erro se o conjunto de esquemas já existir sem realmente registrar a versão.

Quando o conjunto de esquemas é criado, um ponto de verificação de versão é definido para a primeira versão. O modo de compatibilidade “DISABLED” (Desabilitado) restringe a adição de versões adicionais do esquema após a primeira versão. Para todos os outros modos de compatibilidade, a validação das configurações de compatibilidade será aplicada somente a partir da segunda versão em diante, quando a API do `RegisterSchemaVersion` for usada.

Quando esta API é chamada sem um `RegistryId`, isso cria uma entrada para um “default-registry” (registro padrão) nas tabelas de banco de dados do registro, se ela ainda não estiver presente.

**Solicitação**
+ `RegistryId` – Um objeto [RegistryId](#aws-glue-api-schema-registry-api-RegistryId).

   Esta é uma forma de wrapper para conter os campos de identidade do registro. Se essa propriedade não for definida, o registro padrão será usado. O formato do ARN para a mesma propriedade será: `arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id`.
+ `SchemaName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  Nome do esquema a ser criado com comprimento máximo de 255, e só pode conter letras, números, hífen, sublinhado, sinal de dólar ou marca de hash. Sem espaço em branco
+ `DataFormat` – *Obrigatório:* string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).

  O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `Compatibility` – string UTF-8 (valores válidos: `NONE` \$1 `DISABLED` \$1 `BACKWARD` \$1 `BACKWARD_ALL` \$1 `FORWARD` \$1 `FORWARD_ALL` \$1 `FULL` \$1 `FULL_ALL`).

  O modo de compatibilidade do esquema. Os valores possíveis são:
  +  *NONE* (Nenhum): nenhum modo de compatibilidade se aplica. Você pode usar essa opção em cenários de desenvolvimento ou se você não souber o modo de compatibilidade que deseja aplicar aos esquemas. Qualquer nova versão adicionada será aceita sem ser submetida a uma verificação de compatibilidade.
  +  *DISABLED* (Desabilitado): esta opção de compatibilidade impede o versionamento de um esquema específico. Você pode usar essa opção para evitar versionamentos futuros de um esquema.
  +  *BACKWARD* (Anterior): esta opção de compatibilidade é recomendada, pois permite que os receptores de dados leiam a versão atual e uma anterior do esquema. Isso significa que, por exemplo, uma nova versão do esquema não pode descartar campos de dados ou alterar o tipo desses campos, portanto, eles não podem ser lidos pelos leitores usando a versão anterior.
  +  *BACKWARD\$1ALL* (Todas as anteriores): esta opção de compatibilidade é recomendada, pois permite que os receptores de dados leiam a versão atual e todas as anteriores do esquema. Você pode usar essa opção quando precisar excluir campos ou adicionar campos opcionais e verificar a compatibilidade com todas as versões anteriores do esquema. 
  +  *FORWARD* (Próxima): esta opção de compatibilidade permite que os receptores de dados leiam a versão atual e uma próxima do esquema, mas não necessariamente versões posteriores. Você pode usar essa opção quando precisar adicionar campos ou excluir campos opcionais, mas apenas verificar a compatibilidade com a última versão do esquema.
  +  *FORWARD\$1ALL* (Todas as próximas): esta opção de compatibilidade permite que os receptores de dados leiam dados gravados pelos produtores de qualquer novo esquema registrado. Você pode usar essa opção quando precisar adicionar campos ou excluir campos opcionais e verificar a compatibilidade com todas as versões anteriores do esquema.
  +  *FULL* (Completo): esta opção de compatibilidade permite que os receptores de dados leiam dados gravados por produtores usando a versão anterior ou seguinte do esquema, mas não necessariamente versões anteriores ou posteriores. Você pode usar essa opção quando precisar adicionar ou remover campos opcionais, mas apenas verificar a compatibilidade com a última versão do esquema.
  +  *FULL\$1ALL* (Completo total): esta opção de compatibilidade permite que os receptores de dados leiam dados gravados por produtores usando todas as versões de esquema anteriores. Você pode usar essa opção quando precisar adicionar ou remover campos opcionais e verificar a compatibilidade com todas as versões anteriores do esquema.
+ `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 opcional do esquema. Se a descrição não for fornecida, não haverá nenhum valor padrão automático para esse campo.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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.

  AWSTags da que contêm um par de chave-valor e podem ser pesquisadas por console, linha de comando ou API. Se especificado, segue o padrão tags-on-create da AWS.
+ `SchemaDefinition` – string UTF-8, não menos do que 1 ou superior a 170.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).

  A definição do esquema usando a configuração `DataFormat` para `SchemaName`.

**Resposta**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro.
+ `RegistryArn` – 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 de recurso da Amazon (ARN) do registro.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do esquema.
+ `SchemaArn` – 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 de recurso da Amazon (ARN) do esquema.
+ `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 esquema, se especificado quando criado.
+ `DataFormat` – string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).

  O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `Compatibility` – string UTF-8 (valores válidos: `NONE` \$1 `DISABLED` \$1 `BACKWARD` \$1 `BACKWARD_ALL` \$1 `FORWARD` \$1 `FORWARD_ALL` \$1 `FULL` \$1 `FULL_ALL`).

  O modo de compatibilidade do esquema.
+ `SchemaCheckpoint`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  O número da versão do ponto de verificação (a última vez que o modo de compatibilidade foi alterado).
+ `LatestSchemaVersion`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  A versão mais recente do esquema associado à definição do esquema retornado.
+ `NextSchemaVersion`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  A próxima versão do esquema associado à definição do esquema retornado.
+ `SchemaStatus` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `DELETING`).

  O status do esquema. 
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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 do esquema.
+ `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 identificador exclusivo da primeira versão do esquema.
+ `SchemaVersionStatus` – String UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `FAILURE` \$1 `DELETING`).

  O status da primeira versão do esquema criada.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação GetSchema (Python: get\$1schema)
<a name="aws-glue-api-schema-registry-api-GetSchema"></a>

Descreve o esquema especificado em detalhes.

**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
  + SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
  + SchemaId\$1SchemaName: o nome do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.

**Resposta**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro.
+ `RegistryArn` – 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 de recurso da Amazon (ARN) do registro.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do esquema.
+ `SchemaArn` – 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 de recurso da Amazon (ARN) do esquema.
+ `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 esquema, se especificado quando criado
+ `DataFormat` – string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).

  O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `Compatibility` – string UTF-8 (valores válidos: `NONE` \$1 `DISABLED` \$1 `BACKWARD` \$1 `BACKWARD_ALL` \$1 `FORWARD` \$1 `FORWARD_ALL` \$1 `FULL` \$1 `FULL_ALL`).

  O modo de compatibilidade do esquema.
+ `SchemaCheckpoint`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  O número da versão do ponto de verificação (a última vez que o modo de compatibilidade foi alterado).
+ `LatestSchemaVersion`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  A versão mais recente do esquema associado à definição do esquema retornado.
+ `NextSchemaVersion`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  A próxima versão do esquema associado à definição do esquema retornado.
+ `SchemaStatus` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `DELETING`).

  O status do esquema.
+ `CreatedTime` – String UTF-8.

  A data e a hora em que o esquema foi criado.
+ `UpdatedTime` – String UTF-8.

  A data e a hora em que o esquema foi atualizado.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação ListSchemaVersions (Python: list\$1schema\$1versions)
<a name="aws-glue-api-schema-registry-api-ListSchemaVersions"></a>

Retorna uma lista de versões de esquema que você criou, com informações mínimas. As versões do esquema no status Deleted (Excluído) não serão incluídas nos resultados. Resultados vazios serão retornados, se não houver versões de esquema disponíveis.

**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
  + SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
  + SchemaId\$1SchemaName: o nome do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 100.

  O número máximo de resultados exigidos por página. Se o valor não for fornecido, esse valor será definido por padrão como 25 por página.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `Schemas`: um array de objetos [SchemaVersionListItem](#aws-glue-api-schema-registry-api-SchemaVersionListItem).

  Uma matriz de objetos `SchemaVersionList` contendo detalhes de cada versão do esquema.
+ `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`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação GetSchemaVersion (Python: get\$1schema\$1version)
<a name="aws-glue-api-schema-registry-api-GetSchemaVersion"></a>

Obtém o esquema especificado por seu ID exclusivo atribuído quando uma versão do esquema é criada ou registrada. As versões do esquema no status Deleted (Excluído) não serão incluídas nos resultados.

**Solicitação**
+ `SchemaId` – Um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
  + SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
  + SchemaId\$1SchemaName: o nome do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
+ `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 `SchemaVersionId` da versão do esquema. Esse campo é obrigatório para buscar pelo ID do esquema. Esse ou o wrapper `SchemaId` tem que ser fornecido.
+ `SchemaVersionNumber` – Um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).

  O número da versão do esquema.

**Resposta**
+ `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 `SchemaVersionId` da versão do esquema.
+ `SchemaDefinition` – string UTF-8, não menos do que 1 ou superior a 170.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).

  A definição do esquema para o ID do esquema.
+ `DataFormat` – string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).

  O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `SchemaArn` – 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 de recurso da Amazon (ARN) do esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  O número da versão do esquema.
+ `Status` – String UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `FAILURE` \$1 `DELETING`).

  O status da versão do esquema. 
+ `CreatedTime` – String UTF-8.

  A data e hora em que a versão do esquema foi criada.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação GetSchemaVersionsDiff (Python: get\$1schema\$1versions\$1diff)
<a name="aws-glue-api-schema-registry-api-GetSchemaVersionsDiff"></a>

Obtém a diferença de versão do esquema no tipo de diferença especificado entre duas versões de esquema armazenadas no registro de esquema.

Essa API permite comparar duas versões de esquema entre duas definições sob o mesmo esquema.

**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
  + SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
  + SchemaId\$1SchemaName: o nome do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ `FirstSchemaVersionNumber` – *Obrigatório:* um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).

  A primeira das duas versões de esquema a serem comparadas.
+ `SecondSchemaVersionNumber` – *Obrigatório:* um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).

  A segunda das duas versões de esquema a serem comparadas.
+ `SchemaDiffType`: *obrigatório:* string UTF-8 (valores válidos: `SYNTAX_DIFF`).

  Refere-se a `SYNTAX_DIFF`, que é o tipo de comparação atualmente suportado.

**Resposta**
+ `Diff` – string UTF-8, não menos do que 1 ou superior a 340.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).

  A diferença entre esquemas como uma string no formato JsonPatch.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação ListRegistries (Python: list\$1registries)
<a name="aws-glue-api-schema-registry-api-ListRegistries"></a>

Retorna uma lista de registros que você criou, com informações mínimas de registro. Registros no status `Deleting` não serão incluídos nos resultados. Resultados vazios serão retornados, se não houver registros disponíveis.

**Solicitação**
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 100.

  O número máximo de resultados exigidos por página. Se o valor não for fornecido, esse valor será definido por padrão como 25 por página.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `Registries`: um array de objetos [RegistryListItem](#aws-glue-api-schema-registry-api-RegistryListItem).

  Uma matriz de objetos `RegistryDetailedListItem` contendo detalhes mínimos de cada registro.
+ `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`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação ListSchemas (Python: list\$1schemas)
<a name="aws-glue-api-schema-registry-api-ListSchemas"></a>

Retorna uma lista de esquemas com detalhes mínimos. Esquemas no status Deleting (Exclusão) não serão incluídos nos resultados. Resultados vazios serão retornados, se não houver esquemas disponíveis.

Quando o `RegistryId` não for fornecido, todos os esquemas nos registros serão parte da resposta da API.

**Solicitação**
+ `RegistryId` – Um objeto [RegistryId](#aws-glue-api-schema-registry-api-RegistryId).

  Uma estrutura de wrapper que pode conter o nome de registro e o nome do recurso da Amazon (ARN).
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 100.

  O número máximo de resultados exigidos por página. Se o valor não for fornecido, esse valor será definido por padrão como 25 por página.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `Schemas`: um array de objetos [SchemaListItem](#aws-glue-api-schema-registry-api-SchemaListItem).

  Uma matriz de objetos `SchemaListItem` contendo detalhes de cada esquema.
+ `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`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação RegisterSchemaVersion (Python: register\$1schema\$1version)
<a name="aws-glue-api-schema-registry-api-RegisterSchemaVersion"></a>

Adiciona uma nova versão ao esquema existente. Retorna um erro se a nova versão do esquema não atender aos requisitos de compatibilidade do conjunto de esquemas. Essa API não criará um novo conjunto de esquemas e retornará um erro 404 se o conjunto de esquemas ainda não estiver presente no registro de esquema.

Se essa for a primeira definição de esquema a ser registrada no registro de esquema, essa API armazenará a versão do esquema e retornará imediatamente. Caso contrário, essa chamada tem o potencial de ser executada por mais tempo do que outras operações graças aos modos de compatibilidade. Você pode chamar a API `GetSchemaVersion` com o `SchemaVersionId` para conferir os modos de compatibilidade.

Se a mesma definição de esquema já estiver armazenada no registro de esquema como uma versão, o ID do esquema existente será retornado ao autor da chamada.

**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
  + SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
  + SchemaId\$1SchemaName: o nome do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
+ `SchemaDefinition`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 170.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).

  A definição do esquema usando a configuração `DataFormat` para o `SchemaName`.

**Resposta**
+ `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 que representa a versão desse esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  A versão desse esquema (apenas para fluxo de sincronização, caso esta seja a primeira versão).
+ `Status` – String UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `FAILURE` \$1 `DELETING`).

  O status da versão do esquema.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ResourceNumberLimitExceededException`
+ `ThrottlingException`
+ `ConcurrentModificationException`
+ `InternalServiceException`

## Ação UpdateSchema (Python: update\$1schema)
<a name="aws-glue-api-schema-registry-api-UpdateSchema"></a>

Atualiza a descrição, a configuração de compatibilidade ou o ponto de verificação de versão de um conjunto de esquemas.

Para atualizar a configuração de compatibilidade, a chamada não validará a compatibilidade para todo o conjunto de versões de esquema com a nova configuração de compatibilidade. Se o valor para `Compatibility` for fornecido, o `VersionNumber` (um ponto de verificação) também será necessário. A API validará o número de versão do ponto de verificação para fins de consistência.

Se o valor para `VersionNumber` (ponto de verificação) for fornecido, `Compatibility` será opcional e isso poderá ser usado para definir/redefinir um ponto de verificação para o esquema.

Essa atualização ocorrerá somente se o esquema estiver no estado AVAILABLE (Disponível).

**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
  + SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
  + SchemaId\$1SchemaName: o nome do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ `SchemaVersionNumber` – Um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).

  Número de versão necessário para criar o ponto de verificação. Um de `VersionNumber` ou `Compatibility` tem de ser fornecido.
+ `Compatibility` – string UTF-8 (valores válidos: `NONE` \$1 `DISABLED` \$1 `BACKWARD` \$1 `BACKWARD_ALL` \$1 `FORWARD` \$1 `FORWARD_ALL` \$1 `FULL` \$1 `FULL_ALL`).

  A nova configuração de compatibilidade do esquema.
+ `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 nova descrição do esquema.

**Resposta**
+ `SchemaArn` – 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 de recurso da Amazon (ARN) do esquema.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do esquema.
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro que contém o esquema.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação CheckSchemaVersionValidity (Python: check\$1schema\$1version\$1validity)
<a name="aws-glue-api-schema-registry-api-CheckSchemaVersionValidity"></a>

Valida o esquema fornecido. Essa chamada não tem efeitos colaterais, ela simplesmente valida usando o esquema fornecido que usa `DataFormat` como o formato. Como ela não usa um nome de conjunto de esquemas, nenhuma verificação de compatibilidade é realizada.

**Solicitação**
+ `DataFormat` – *Obrigatório:* string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).

  O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `SchemaDefinition`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 170.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).

  A definição do esquema que deve ser validado.

**Resposta**
+ `Valid` – Booleano.

  Retorna true, se o esquema for válido, e false, caso contrário.
+ `Error`: string UTF-8, não menos do que 1 ou superior a 5.000 bytes de comprimento.

  Uma mensagem de erro de falha de validação.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação UpdateRegistry (Python: update\$1registry)
<a name="aws-glue-api-schema-registry-api-UpdateRegistry"></a>

Atualiza um registro existente que é usado para armazenar uma coleção de esquemas. As propriedades atualizadas se relacionam com o registro e não modificam nenhum dos esquemas dentro dele. 

**Solicitação**
+ `RegistryId` – *Obrigatório:* um objeto [RegistryId](#aws-glue-api-schema-registry-api-RegistryId).

  Esta é uma estrutura de wrapper que pode conter o nome de registro e o nome do recurso da Amazon (ARN).
+ `Description`: *obrigatório:* string de descrição, inferior a 2.048 bytes de comprimento, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma descrição do registro. Se a descrição não for fornecida, esse campo não será atualizado.

**Resposta**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro atualizado.
+ `RegistryArn` – 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 registro atualizado.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação GetSchemaByDefinition (Python: get\$1schema\$1by\$1definition)
<a name="aws-glue-api-schema-registry-api-GetSchemaByDefinition"></a>

Recupera um esquema pela `SchemaDefinition`. A definição de esquema é enviada para o registro de esquema, canonizada e com hash. Se o hash for correspondido dentro do escopo do `SchemaName` ou ARN (ou o registro padrão, se nenhum for fornecido), os metadados desse esquema serão retornados. Caso contrário, um erro 404 ou NotFound (não encontrado) é retornado. As versões do esquema no status `Deleted` não serão incluídas nos resultados.

**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
  + SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
  + SchemaId\$1SchemaName: o nome do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ `SchemaDefinition`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 170.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).

  A definição do esquema para a qual os detalhes do esquema são necessários.

**Resposta**
+ `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 do esquema da versão do esquema.
+ `SchemaArn` – 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 de recurso da Amazon (ARN) do esquema.
+ `DataFormat` – string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).

  O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `Status` – String UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `FAILURE` \$1 `DELETING`).

  O status da versão do esquema.
+ `CreatedTime` – String UTF-8.

  A data e a hora em que o esquema foi criado.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação GetRegistry (Python: get\$1registry)
<a name="aws-glue-api-schema-registry-api-GetRegistry"></a>

Descreve o registro especificado em detalhes.

**Solicitação**
+ `RegistryId` – *Obrigatório:* um objeto [RegistryId](#aws-glue-api-schema-registry-api-RegistryId).

  Esta é uma estrutura de wrapper que pode conter o nome de registro e o nome do recurso da Amazon (ARN).

**Resposta**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro.
+ `RegistryArn` – 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 de recurso da Amazon (ARN) do registro.
+ `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 registro.
+ `Status` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `DELETING`).

  O status do registro.
+ `CreatedTime` – String UTF-8.

  A data e a hora em que o registro foi criado.
+ `UpdatedTime` – String UTF-8.

  A data e a hora em que o registro foi atualizado.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## Ação PutSchemaVersionMetadata (Python: put\$1schema\$1version\$1metadata)
<a name="aws-glue-api-schema-registry-api-PutSchemaVersionMetadata"></a>

Insere o par de chave-valor de metadados para um ID de versão de esquema especificado. Um máximo de dez pares de chave-valor será permitido por versão do esquema. Eles podem ser adicionados em uma ou mais chamadas.

**Solicitação**
+ `SchemaId` – Um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  O ID exclusivo do esquema.
+ `SchemaVersionNumber` – Um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).

  O número da versão do esquema.
+ `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 de versão exclusivo da versão do esquema.
+ `MetadataKeyValue` – *Obrigatório:* um objeto [MetadataKeyValuePair](#aws-glue-api-schema-registry-api-MetadataKeyValuePair).

  O valor correspondente da chave de metadados.

**Resposta**
+ `SchemaArn` – 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 esquema.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do esquema.
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro.
+ `LatestVersion` – Booleano.

  A versão mais recente do esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  O número da versão do esquema.
+ `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 de versão exclusivo da versão do esquema.
+ `MetadataKey` – string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).

  A chave de metadados.
+ `MetadataValue` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).

  O valor da chave de metadados.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `ResourceNumberLimitExceededException`

## Ação QuerySchemaVersionMetadata (Python: query\$1schema\$1version\$1metadata)
<a name="aws-glue-api-schema-registry-api-QuerySchemaVersionMetadata"></a>

Consultas para obter as informações de metadados da versão do esquema. 

**Solicitação**
+ `SchemaId` – Um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  Uma estrutura de wrapper que pode conter o nome do esquema e o nome do recurso da Amazon (ARN).
+ `SchemaVersionNumber` – Um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).

  O número da versão do esquema.
+ `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 de versão exclusivo da versão do esquema.
+ `MetadataList`: um array de objetos [MetadataKeyValuePair](#aws-glue-api-schema-registry-api-MetadataKeyValuePair).

  Pesquisa os pares de chave-valor para metadados. Se eles não forem fornecidos, todas as informações de metadados serão buscadas.
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 50.

  O número máximo de resultados exigidos por página. Se o valor não for fornecido, esse valor será definido por padrão como 25 por página.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `MetadataInfoMap` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).

  Cada valor é um objeto [MetadataInfo](#aws-glue-api-schema-registry-api-MetadataInfo) A.

  Um mapa de uma chave de metadados e valores associados.
+ `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 de versão exclusivo da versão do esquema.
+ `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`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `EntityNotFoundException`

## Ação RemoveSchemaVersionMetadata (Python: remove\$1schema\$1version\$1metadata)
<a name="aws-glue-api-schema-registry-api-RemoveSchemaVersionMetadata"></a>

Remove um par de chave-valor dos metadados de versão do esquema para o ID de versão do esquema especificado.

**Solicitação**
+ `SchemaId` – Um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  Uma estrutura de wrapper que pode conter o nome do esquema e o nome do recurso da Amazon (ARN).
+ `SchemaVersionNumber` – Um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).

  O número da versão do esquema.
+ `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 de versão exclusivo da versão do esquema.
+ `MetadataKeyValue` – *Obrigatório:* um objeto [MetadataKeyValuePair](#aws-glue-api-schema-registry-api-MetadataKeyValuePair).

  O valor da chave de metadados.

**Resposta**
+ `SchemaArn` – 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 de recurso da Amazon (ARN) do esquema.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do esquema.
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro.
+ `LatestVersion` – Booleano.

  A versão mais recente do esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.

  O número da versão do esquema.
+ `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 da versão para a versão do esquema.
+ `MetadataKey` – string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).

  A chave de metadados.
+ `MetadataValue` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).

  O valor da chave de metadados.

**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `EntityNotFoundException`

## Ação DeleteRegistry (Python: delete\$1registry)
<a name="aws-glue-api-schema-registry-api-DeleteRegistry"></a>

Exclui todo o registro, incluindo esquema e todas as suas versões. Para obter o status da operação de exclusão, é possível chamar a API `GetRegistry` após a chamada assíncrona. Excluir um registro desativará todas as operações online para ele, como as APIs `UpdateRegistry`, `CreateSchema`, `UpdateSchema` e `RegisterSchemaVersion`. 

**Solicitação**
+ `RegistryId` – *Obrigatório:* um objeto [RegistryId](#aws-glue-api-schema-registry-api-RegistryId).

  Esta é uma estrutura de wrapper que pode conter o nome de registro e o nome do recurso da Amazon (ARN).

**Resposta**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do registro sendo excluído.
+ `RegistryArn` – 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 registro a ser excluído.
+ `Status` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `DELETING`).

  O status do registro. Uma operação bem-sucedida retornará o status `Deleting`.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `ConcurrentModificationException`

## Ação DeleteSchema (Python: delete\$1schema)
<a name="aws-glue-api-schema-registry-api-DeleteSchema"></a>

Exclui todo o conjunto de esquemas, incluindo o conjunto de esquemas e todas as suas versões. Para obter o status da operação de exclusão, é possível chamar a API `GetSchema` após a chamada assíncrona. Excluir um registro desativará todas as operações online para ele, como as APIs `GetSchemaByDefinition` e `RegisterSchemaVersion`.

**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  Esta é uma estrutura de wrapper que pode conter o nome do esquema e o nome do recurso da Amazon (ARN).

**Resposta**
+ `SchemaArn` – 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 esquema sendo excluído.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).

  O nome do esquema sendo excluído.
+ `Status` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `DELETING`).

  O status do esquema.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `ConcurrentModificationException`

## Ação DeleteSchemaVersions (Python: delete\$1schema\$1versions)
<a name="aws-glue-api-schema-registry-api-DeleteSchemaVersions"></a>

Remove versões do esquema especificado. Um número de versão ou intervalo pode ser fornecido. Se o modo de compatibilidade proibir a exclusão de uma versão que é necessária, como BACKWARDS\$1FULL, um erro será retornado. Chamar a API `GetSchemaVersions` após essa chamada listará o status das versões excluídas.

Quando o intervalo de números de versão contiver a versão de ponto de verificação, a API retornará um conflito 409 e não prosseguirá com a exclusão. Primeiro, é preciso remover o ponto de verificação usando a API `DeleteSchemaCheckpoint` antes de usar essa API.

Não é possível utilizar a API `DeleteSchemaVersions` para excluir a primeira versão do esquema no conjunto de esquemas. A primeira versão do esquema só pode ser excluída pela API `DeleteSchema`. Essa operação também excluirá os `SchemaVersionMetadata` anexados nas versões do esquema. Exclusões irreversíveis serão impostas no banco de dados.

Se o modo de compatibilidade proibir a exclusão de uma versão que é necessária, como BACKWARDS\$1FULL, um erro será retornado.

**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).

  Esta é uma estrutura de wrapper que pode conter o nome do esquema e o nome do recurso da Amazon (ARN).
+ `Versions`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 100.000 bytes de comprimento, correspondente a [Custom string pattern #15](aws-glue-api-common.md#regex_15).

  Pode ser fornecido um intervalo de versões que pode ser do formato:
  + um único número de versão, 5
  + um intervalo, 5-8: exclui as versões 5, 6, 7 e 8

**Resposta**
+ `SchemaVersionErrors`: um array de objetos [SchemaVersionErrorItem](#aws-glue-api-schema-registry-api-SchemaVersionErrorItem).

  Uma lista de objetos `SchemaVersionErrorItem`, cada um contendo uma versão de esquema e erro.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `ConcurrentModificationException`

# Fluxos de trabalho
<a name="aws-glue-api-workflow"></a>

 A API de fluxos de trabalho descreve os tipos de dados e a API relacionados à criação, atualização ou exibição de fluxos de trabalho no AWS Glue. O histórico de execução de trabalhos pode ser acessado por 90 dias para seu fluxo de trabalho e execução de trabalhos. 

## Tipos de dados
<a name="aws-glue-api-workflow-objects"></a>
+ [Estrutura JobNodeDetails](#aws-glue-api-workflow-JobNodeDetails)
+ [Estrutura CrawlerNodeDetails](#aws-glue-api-workflow-CrawlerNodeDetails)
+ [Estrutura TriggerNodeDetails](#aws-glue-api-workflow-TriggerNodeDetails)
+ [Estrutura Crawl](#aws-glue-api-workflow-Crawl)
+ [Estrutura Node](#aws-glue-api-workflow-Node)
+ [Estrutura Edge](#aws-glue-api-workflow-Edge)
+ [Estrutura Workflow](#aws-glue-api-workflow-Workflow)
+ [Estrutura WorkflowGraph](#aws-glue-api-workflow-WorkflowGraph)
+ [Estrutura WorkflowRun](#aws-glue-api-workflow-WorkflowRun)
+ [Estrutura WorkflowRunStatistics](#aws-glue-api-workflow-WorkflowRunStatistics)
+ [Estrutura StartingEventBatchCondition](#aws-glue-api-workflow-StartingEventBatchCondition)
+ [Estrutura Blueprint](#aws-glue-api-workflow-Blueprint)
+ [Estrutura BlueprintDetails](#aws-glue-api-workflow-BlueprintDetails)
+ [Estrutura LastActiveDefinition](#aws-glue-api-workflow-LastActiveDefinition)
+ [Estrutura BlueprintRun](#aws-glue-api-workflow-BlueprintRun)

## Estrutura JobNodeDetails
<a name="aws-glue-api-workflow-JobNodeDetails"></a>

Os detalhes de um nó de tarefa presente no fluxo de trabalho.

**Campos**
+ `JobRuns`: um array de objetos [JobRun](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-JobRun).

  As informações da execução da tarefa representada pelo nó de tarefa.

## Estrutura CrawlerNodeDetails
<a name="aws-glue-api-workflow-CrawlerNodeDetails"></a>

Os detalhes de um nó de crawler presente no fluxo de trabalho.

**Campos**
+ `Crawls`: um array de objetos [Crawl](#aws-glue-api-workflow-Crawl).

  Uma lista de monitoramentos representados pelo nó de monitoramento.

## Estrutura TriggerNodeDetails
<a name="aws-glue-api-workflow-TriggerNodeDetails"></a>

Os detalhes de um nó de gatilho presente no fluxo de trabalho.

**Campos**
+ `Trigger` – Um objeto [Trigger](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-Trigger).

  As informações do gatilho representado pelo nó de gatilho.

## Estrutura Crawl
<a name="aws-glue-api-workflow-Crawl"></a>

Os detalhes de um monitoramento no fluxo de trabalho

**Campos**
+ `State` – String UTF-8 (valores válidos: `RUNNING` \$1 `CANCELLING` \$1 `CANCELLED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `ERROR`).

  O estado do crawler.
+ `StartedOn` – Timestamp.

  A data e a hora em que o monitoramento foi iniciado.
+ `CompletedOn` – Timestamp.

  A data e a hora em que o monitoramento foi concluído.
+ `ErrorMessage`: 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 mensagem de erro associada ao crawl.
+ `LogGroup`: string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a [Log group string pattern](aws-glue-api-common.md#aws-glue-api-regex-logGroup-id).

  O grupo de logs associado ao crawl.
+ `LogStream`: string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a [Log-stream string pattern](aws-glue-api-common.md#aws-glue-api-regex-logStream-id).

  O fluxo de logs associado ao rastreamento.

## Estrutura Node
<a name="aws-glue-api-workflow-Node"></a>

Um nó representa um componente AWS Glue (acionador, crawler ou trabalho) em um gráfico de fluxo de trabalho.

**Campos**
+ `Type` – String UTF-8 (valores válidos: `CRAWLER` \$1 `JOB` \$1 `TRIGGER`).

  O tipo de componente do AWS Glue representado pelo nó.
+ `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 do componente do AWS Glue representado pelo nó.
+ `UniqueId` – 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 exclusivo atribuído ao nó no fluxo de trabalho.
+ `TriggerDetails` – Um objeto [TriggerNodeDetails](#aws-glue-api-workflow-TriggerNodeDetails).

  Detalhes do gatilho quando o nó representa um gatilho.
+ `JobDetails` – Um objeto [JobNodeDetails](#aws-glue-api-workflow-JobNodeDetails).

  Detalhes da tarefa quando o nó representa uma tarefa.
+ `CrawlerDetails` – Um objeto [CrawlerNodeDetails](#aws-glue-api-workflow-CrawlerNodeDetails).

  Detalhes do crawler quando o nó representa um crawler.

## Estrutura Edge
<a name="aws-glue-api-workflow-Edge"></a>

Uma borda representa uma conexão direta entre dois componentes do AWS Glue que fazem parte do fluxo de trabalho ao qual a borda pertence.

**Campos**
+ `SourceId` – 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 exclusivo do nó no fluxo de trabalho onde a borda é iniciada.
+ `DestinationId` – 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 exclusivo do nó no fluxo de trabalho onde a borda é finalizada.

## Estrutura Workflow
<a name="aws-glue-api-workflow-Workflow"></a>

Um fluxo de trabalho é uma colação de vários trabalhos e crawlers do AWS Glue dependentes, que são executados para concluir uma tarefa de ETL complexa. Um fluxo de trabalho gerencia a execução e o monitoramento de todos os seus trabalhos e crawlers.

**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 do fluxo de trabalho.
+ `Description` – String UTF-8.

  Uma descrição do fluxo de trabalho.
+ `DefaultRunProperties` – 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 é uma sequência de caracteres UTF-8.

  Um conjunto de propriedades a serem usadas como parte de cada execução do fluxo de trabalho. As propriedades de execução são disponibilizadas para cada trabalho no fluxo de trabalho. Um trabalho pode modificar as propriedades dos próximos trabalhos no fluxo.
+ `CreatedOn` – Timestamp.

  A data e a hora em que o fluxo de trabalho foi criado.
+ `LastModifiedOn` – Timestamp.

  A data e a hora em que o fluxo de trabalho foi modificado pela última vez.
+ `LastRun` – Um objeto [WorkflowRun](#aws-glue-api-workflow-WorkflowRun).

  As informações sobre a última execução do fluxo de trabalho.
+ `Graph` – Um objeto [WorkflowGraph](#aws-glue-api-workflow-WorkflowGraph).

  O gráfico que representa todos os componentes do AWS Glue que pertencem ao fluxo de trabalho como nós e conexões direcionadas entre eles como bordas.
+ `CreationStatus` – String UTF-8 (valores válidos: `CREATING` \$1 `CREATED` \$1 `CREATION_FAILED`).

  O status de criação do fluxo de trabalho.
+ `MaxConcurrentRuns` – Número (íntegro).

  Você pode usar esse parâmetro para evitar várias atualizações indesejadas de dados, para controlar custos ou, em alguns casos, evitar que exceda o número máximo de execuções simultâneas de qualquer um dos trabalhos do componente. Se você deixar esse parâmetro em branco, não haverá limite para o número de execuções de fluxo de trabalho simultâneas.
+ `BlueprintDetails` – Um objeto [BlueprintDetails](#aws-glue-api-workflow-BlueprintDetails).

  Essa estrutura indica os detalhes do blueprint do qual esse fluxo de trabalho específico foi criado.

## Estrutura WorkflowGraph
<a name="aws-glue-api-workflow-WorkflowGraph"></a>

Um gráfico de fluxo de trabalho representa o fluxo de trabalho completo que contém todos os componentes do AWS Glue presentes no fluxo de trabalho e todas as conexões direcionadas entre eles.

**Campos**
+ `Nodes`: um array de objetos [Nó](#aws-glue-api-workflow-Node).

  Uma lista dos componentes do AWS Glue que pertencem ao fluxo de trabalho representados como nós.
+ `Edges`: um array de objetos [Borda](#aws-glue-api-workflow-Edge).

  Uma lista de todas as conexões direcionadas entre os nós que pertencem ao fluxo de trabalho.

## Estrutura WorkflowRun
<a name="aws-glue-api-workflow-WorkflowRun"></a>

Uma execução de fluxo de trabalho é uma execução de um fluxo de trabalho que fornece todas as informações do runtime.

**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 do fluxo de trabalho que foi executado.
+ `WorkflowRunId` – 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 dessa execução de fluxo de trabalho.
+ `PreviousRunId` – 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 execução do fluxo de trabalho anterior.
+ `WorkflowRunProperties` – 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 é uma sequência de caracteres UTF-8.

  As propriedades da execução do fluxo de trabalho que foram definidas durante a execução.
+ `StartedOn` – Timestamp.

  A data e a hora em que a execução do fluxo de trabalho foi iniciada.
+ `CompletedOn` – Timestamp.

  A data e a hora em que a execução do fluxo de trabalho foi concluída.
+ `Status` – String UTF-8 (valores válidos: `RUNNING` \$1 `COMPLETED` \$1 `STOPPING` \$1 `STOPPED` \$1 `ERROR`).

  O status da execução do fluxo de trabalho.
+ `ErrorMessage` – String UTF-8.

  Essa mensagem de erro descreve qualquer erro que possa ter ocorrido ao iniciar a execução do fluxo de trabalho. Atualmente, a única mensagem de erro é “Concurrent runs exceeded for workflow: `foo`” (Execuções simultâneas excedidas para fluxo de trabalho: foo).
+ `Statistics` – Um objeto [WorkflowRunStatistics](#aws-glue-api-workflow-WorkflowRunStatistics).

  As estatísticas da execução.
+ `Graph` – Um objeto [WorkflowGraph](#aws-glue-api-workflow-WorkflowGraph).

  O gráfico que representa todos os componentes do AWS Glue que pertencem ao fluxo de trabalho como nós e conexões direcionadas entre eles como bordas.
+ `StartingEventBatchCondition` – Um objeto [StartingEventBatchCondition](#aws-glue-api-workflow-StartingEventBatchCondition).

  A condição do lote que iniciou a execução do fluxo de trabalho.

## Estrutura WorkflowRunStatistics
<a name="aws-glue-api-workflow-WorkflowRunStatistics"></a>

As estatísticas da execução do fluxo de trabalho fornecem estatísticas sobre a execução do fluxo de trabalho.

**Campos**
+ `TotalActions` – Número (íntegro).

  O número total de ações na execução do fluxo de trabalho.
+ `TimeoutActions` – Número (íntegro).

  O número total de ações que atingiram o tempo limite.
+ `FailedActions` – Número (íntegro).

  O número total de ações que falharam.
+ `StoppedActions` – Número (íntegro).

  O número total de ações que foram interrompidas.
+ `SucceededActions` – Número (íntegro).

  O número total de ações que foram bem-sucedidas.
+ `RunningActions` – Número (íntegro).

  O número total de ações no estado de execução.
+ `ErroredActions` – Número (íntegro).

  Indica a contagem de execuções de trabalho no estado ERROR (ERRO) na execução do fluxo de trabalho.
+ `WaitingActions` – Número (íntegro).

  Indica a contagem de execuções de trabalho no estado WAITING (AGUARDANDO) na execução do fluxo de trabalho.

## Estrutura StartingEventBatchCondition
<a name="aws-glue-api-workflow-StartingEventBatchCondition"></a>

A condição do lote que iniciou a execução do fluxo de trabalho. Ou o número de eventos no tamanho do lote chegou, caso em que o membro BatchSize é diferente de zero, ou a janela do lote expirou, caso em que o membro BatchWindow é diferente de zero.

**Campos**
+ `BatchSize` – Número (íntegro).

  Número de eventos no lote.
+ `BatchWindow` – Número (íntegro).

  Duração da janela do lote em segundos.

## Estrutura Blueprint
<a name="aws-glue-api-workflow-Blueprint"></a>

Os detalhes de um blueprint.

**Campos**
+ `Name`: string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  O nome do blueprint.
+ `Description`: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento.

  A descrição do blueprint.
+ `CreatedOn` – Timestamp.

  A data e a hora em que o blueprint foi registrado.
+ `LastModifiedOn` – Timestamp.

  A data e a hora em que o blueprint foi modificado pela última vez.
+ `ParameterSpec`: string UTF-8, não menos do que 1 ou superior a 131.072 bytes de comprimento.

  Uma string JSON que indica a lista de especificações de parâmetros para o blueprint.
+ `BlueprintLocation` – String UTF-8.

  Especifica o caminho no Amazon S3 onde o blueprint é publicado.
+ `BlueprintServiceLocation` – String UTF-8.

  Especifica um caminho no Amazon S3 onde o blueprint é copiado quando você chama `CreateBlueprint/UpdateBlueprint` para registrá-lo no AWS Glue.
+ `Status` – String UTF-8 (valores válidos: `CREATING` \$1 `ACTIVE` \$1 `UPDATING` \$1 `FAILED`).

  O status do registro do blueprint.
  + Creating (Criando): o registro do blueprint está em andamento.
  + Active (Ativo): o blueprint foi registrado com sucesso.
  + Updating (Atualizando): uma atualização para o registro do blueprint está em andamento.
  + Failed (Falha): falha no registro do blueprint.
+ `ErrorMessage` – String UTF-8.

  Uma mensagem de erro.
+ `LastActiveDefinition` – Um objeto [LastActiveDefinition](#aws-glue-api-workflow-LastActiveDefinition).

  Quando há várias versões de um blueprint e a versão mais recente apresenta alguns erros, esse atributo indica a última definição do blueprint bem-sucedida que está disponível com o serviço.

## Estrutura BlueprintDetails
<a name="aws-glue-api-workflow-BlueprintDetails"></a>

Os detalhes de um blueprint.

**Campos**
+ `BlueprintName`: string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  O nome do blueprint.
+ `RunId` – 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 de execução desse blueprint.

## Estrutura LastActiveDefinition
<a name="aws-glue-api-workflow-LastActiveDefinition"></a>

Quando há várias versões de um blueprint e a versão mais recente apresenta alguns erros, esse atributo indica a última definição do blueprint bem-sucedida que está disponível com o serviço.

**Campos**
+ `Description`: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento.

  A descrição do blueprint.
+ `LastModifiedOn` – Timestamp.

  A data e a hora em que o blueprint foi modificado pela última vez.
+ `ParameterSpec`: string UTF-8, não menos do que 1 ou superior a 131.072 bytes de comprimento.

  Uma string JSON que especifica os parâmetros para o blueprint.
+ `BlueprintLocation` – String UTF-8.

  Especifica um caminho no Amazon S3 em que o blueprint é publicado pelo desenvolvedor do AWS Glue.
+ `BlueprintServiceLocation` – String UTF-8.

  Especifica um caminho no Amazon S3 onde o esquema é copiado quando você cria ou atualiza o esquema.

## Estrutura BlueprintRun
<a name="aws-glue-api-workflow-BlueprintRun"></a>

Os detalhes de uma execução de blueprint.

**Campos**
+ `BlueprintName`: string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  O nome do blueprint.
+ `RunId` – 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 de execução para essa execução de blueprint.
+ `WorkflowName` – 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 de um fluxo de trabalho criado como resultado de uma execução bem-sucedida do blueprint. Se uma execução de blueprint tiver um erro, não haverá um fluxo de trabalho criado.
+ `State` – String UTF-8 (valores válidos: `RUNNING` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `ROLLING_BACK`).

  O estado da execução do blueprint. Os valores possíveis são:
  + Running (Executando): a execução do blueprint está em andamento.
  + Succeeded (Êxito): a execução do blueprint foi concluída com êxito.
  + Failed (Falha): a execução do blueprint falhou e a reversão está concluída.
  + Rolling Back (Revertendo): a execução do blueprint falhou e a reversão está em andamento.
+ `StartedOn` – Timestamp.

  A data e a hora em que a execução do blueprint foi iniciada.
+ `CompletedOn` – Timestamp.

  A data e a hora em que a execução do blueprint foi concluída.
+ `ErrorMessage` – String UTF-8.

  Indica os erros que são vistos durante a execução do blueprint.
+ `RollbackErrorMessage` – String UTF-8.

  Se houver erros ao criar as entidades de um fluxo de trabalho, tentamos reverter as entidades criadas até esse ponto e excluí-las. Esse atributo indica os erros vistos ao tentar excluir as entidades que foram criadas.
+ `Parameters`: string UTF-8, não menos do que 1 ou superior a 131.072 bytes de comprimento.

  Os parâmetros do blueprint como uma string. Você terá que fornecer um valor para cada chave exigida pela especificação do parâmetro, que é definida em `Blueprint$ParameterSpec`.
+ `RoleArn` – String UTF-8, superior a 1 e inferior a 1024 bytes de comprimento, correspondente a [Custom string pattern #30](aws-glue-api-common.md#regex_30). 

  O ARN do perfil. Essa função será assumida pelo produto AWS Glue e será usada para criar o fluxo de trabalho e outras entidades de um fluxo de trabalho.

## Operações
<a name="aws-glue-api-workflow-actions"></a>
+ [Ação CreateWorkflow (Python: create\$1workflow)](#aws-glue-api-workflow-CreateWorkflow)
+ [Ação UpdateWorkflow (Python: update\$1workflow)](#aws-glue-api-workflow-UpdateWorkflow)
+ [Ação DeleteWorkflow (Python: delete\$1workflow)](#aws-glue-api-workflow-DeleteWorkflow)
+ [Ação GetWorkflow (Python: get\$1workflow)](#aws-glue-api-workflow-GetWorkflow)
+ [Ação ListWorkflows (Python: list\$1workflows)](#aws-glue-api-workflow-ListWorkflows)
+ [Ação BatchGetWorkflows (Python: batch\$1get\$1workflows)](#aws-glue-api-workflow-BatchGetWorkflows)
+ [Ação GetWorkflowRun (Python: get\$1workflow\$1run)](#aws-glue-api-workflow-GetWorkflowRun)
+ [Ação GetWorkflowRuns (Python: get\$1workflow\$1runs)](#aws-glue-api-workflow-GetWorkflowRuns)
+ [Ação GetWorkflowRunProperties (Python: get\$1workflow\$1run\$1properties)](#aws-glue-api-workflow-GetWorkflowRunProperties)
+ [Ação PutWorkflowRunProperties (Python: put\$1workflow\$1run\$1properties)](#aws-glue-api-workflow-PutWorkflowRunProperties)
+ [Ação CreateBlueprint (Python: create\$1blueprint)](#aws-glue-api-workflow-CreateBlueprint)
+ [Ação UpdateBlueprint (Python: update\$1blueprint)](#aws-glue-api-workflow-UpdateBlueprint)
+ [Ação DeleteBlueprint (Python: delete\$1blueprint)](#aws-glue-api-workflow-DeleteBlueprint)
+ [Ação ListBlueprints (Python: list\$1blueprints)](#aws-glue-api-workflow-ListBlueprints)
+ [Ação BatchGetBlueprints (Python: batch\$1get\$1blueprints)](#aws-glue-api-workflow-BatchGetBlueprints)
+ [Ação StartBlueprintRun (Python: start\$1blueprint\$1run)](#aws-glue-api-workflow-StartBlueprintRun)
+ [Ação GetBlueprintRun (Python: get\$1blueprint\$1run)](#aws-glue-api-workflow-GetBlueprintRun)
+ [Ação GetBlueprintRuns (Python: get\$1blueprint\$1runs)](#aws-glue-api-workflow-GetBlueprintRuns)
+ [Ação StartWorkflowRun (Python: start\$1workflow\$1run)](#aws-glue-api-workflow-StartWorkflowRun)
+ [Ação StopWorkflowRun (Python: stop\$1workflow\$1run)](#aws-glue-api-workflow-StopWorkflowRun)
+ [Ação ResumeWorkflowRun (Python: resume\$1workflow\$1run)](#aws-glue-api-workflow-ResumeWorkflowRun)

## Ação CreateWorkflow (Python: create\$1workflow)
<a name="aws-glue-api-workflow-CreateWorkflow"></a>

Cria uma nova workload.

**Solicitaçã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 a ser atribuído ao fluxo de trabalho. Ele deve ser exclusivo na conta.
+ `Description`: string UTF-8, com no máximo 120 mil bytes.

  Uma descrição do fluxo de trabalho.
+ `DefaultRunProperties` – 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 é uma sequência de caracteres UTF-8.

  Um conjunto de propriedades a serem usadas como parte de cada execução do fluxo de trabalho.

  As propriedades de execução podem ser registradas em log. Evite fornecer segredos em texto simples e não criptografado como propriedades. Caso necessite utilizá-los no decorrer da execução do fluxo de trabalho, recupere-os de uma Conexão do AWS Glue, do AWS Secrets Manager ou de outro mecanismo de gerenciamento de segredos.
+ `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 a serem usadas com esse fluxo de trabalho.
+ `MaxConcurrentRuns` – Número (íntegro).

  Você pode usar esse parâmetro para evitar várias atualizações indesejadas de dados, para controlar custos ou, em alguns casos, evitar que exceda o número máximo de execuções simultâneas de qualquer um dos trabalhos do componente. Se você deixar esse parâmetro em branco, não haverá limite para o número de execuções de fluxo de trabalho simultâneas.

**Resposta**
+ `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 do fluxo de trabalho que foi fornecido como parte da solicitação.

**Erros**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`

## Ação UpdateWorkflow (Python: update\$1workflow)
<a name="aws-glue-api-workflow-UpdateWorkflow"></a>

Atualiza um fluxo de trabalho existente.

**Solicitaçã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).

  Nome do fluxo de trabalho a ser atualizado.
+ `Description`: string UTF-8, com no máximo 120 mil bytes.

  A descrição do fluxo de trabalho.
+ `DefaultRunProperties` – 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 é uma sequência de caracteres UTF-8.

  Um conjunto de propriedades a serem usadas como parte de cada execução do fluxo de trabalho.

  As propriedades de execução podem ser registradas em log. Evite fornecer segredos em texto simples e não criptografado como propriedades. Caso necessite utilizá-los no decorrer da execução do fluxo de trabalho, recupere-os de uma Conexão do AWS Glue, do AWS Secrets Manager ou de outro mecanismo de gerenciamento de segredos.
+ `MaxConcurrentRuns` – Número (íntegro).

  Você pode usar esse parâmetro para evitar várias atualizações indesejadas de dados, para controlar custos ou, em alguns casos, evitar que exceda o número máximo de execuções simultâneas de qualquer um dos trabalhos do componente. Se você deixar esse parâmetro em branco, não haverá limite para o número de execuções de fluxo de trabalho simultâneas.

**Resposta**
+ `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 do fluxo de trabalho que foi especificado na entrada.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## Ação DeleteWorkflow (Python: delete\$1workflow)
<a name="aws-glue-api-workflow-DeleteWorkflow"></a>

Exclui um fluxo de trabalho.

**Solicitaçã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).

  Nome do fluxo de trabalho a ser excluído.

**Resposta**
+ `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 do fluxo de trabalho especificado na entrada.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## Ação GetWorkflow (Python: get\$1workflow)
<a name="aws-glue-api-workflow-GetWorkflow"></a>

Recupera metadados de recurso para um fluxo de trabalho.

**Solicitaçã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 fluxo de trabalho a ser recuperado.
+ `IncludeGraph` – Booleano.

  Especifica se um gráfico será incluído ao retornar os metadados do recurso do fluxo de trabalho.

**Resposta**
+ `Workflow` – Um objeto [Fluxo de trabalho](#aws-glue-api-workflow-Workflow).

  Os metadados de recurso para o fluxo de trabalho.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação ListWorkflows (Python: list\$1workflows)
<a name="aws-glue-api-workflow-ListWorkflows"></a>

Lista nomes de fluxos de trabalho criados na conta.

**Solicitação**
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma solicitação de continuação.
+ `MaxResults`: número (inteiro), não inferior a 1 nem superior a 25.

  O tamanho máximo de uma lista a ser retornada.

**Resposta**
+ `Workflows`: uma matriz de strings UTF-8, não menos do que 1 ou superior a 25 strings.

  Lista de nomes de fluxos de trabalho na conta.
+ `NextToken` – String UTF-8.

  Um token de continuação, caso nem todos os nomes de fluxos de trabalho tenham sido retornados.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação BatchGetWorkflows (Python: batch\$1get\$1workflows)
<a name="aws-glue-api-workflow-BatchGetWorkflows"></a>

Retorna uma lista de metadados de recurso para uma lista de nomes de fluxos de trabalho. Depois de chamar a operação `ListWorkflows`, você pode chamar essa operação para acessar os dados aos quais você recebeu permissões. Essa operação oferece suporte a todas as permissões do IAM, incluindo condições de permissão que usam tags.

**Solicitação**
+ `Names` – *Obrigatório:* uma matriz de strings UTF-8, no mínimo 1 ou mais de 25 strings.

  Uma lista de nomes de fluxos de trabalho, que podem ser os nomes retornados pela operação `ListWorkflows`.
+ `IncludeGraph` – Booleano.

  Especifica se um gráfico será incluído ao retornar os metadados do recurso do fluxo de trabalho.

**Resposta**
+ `Workflows`: uma matriz de objetos [Fluxo de trabalho](#aws-glue-api-workflow-Workflow), não menos do que 1 ou superior a 25 estruturas.

  Uma lista de metadados do recurso do fluxo de trabalho.
+ `MissingWorkflows`: uma matriz de strings UTF-8, não menos do que 1 ou superior a 25 strings.

  Uma lista de nomes de fluxos de trabalho não encontrados.

**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## Ação GetWorkflowRun (Python: get\$1workflow\$1run)
<a name="aws-glue-api-workflow-GetWorkflowRun"></a>

Recupera os metadados de determinada execução do fluxo de trabalho. O histórico de execução de trabalhos pode ser acessado por 90 dias para seu fluxo de trabalho e execução de trabalhos.

**Solicitaçã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).

  Nome do fluxo de trabalho em execução.
+ `RunId`: *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 execução do fluxo de trabalho.
+ `IncludeGraph` – Booleano.

  Especifica se deve incluir o gráfico do fluxo de trabalho como resposta ou não.

**Resposta**
+ `Run` – Um objeto [WorkflowRun](#aws-glue-api-workflow-WorkflowRun).

  Os metadados da execução do fluxo de trabalho solicitados.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetWorkflowRuns (Python: get\$1workflow\$1runs)
<a name="aws-glue-api-workflow-GetWorkflowRuns"></a>

Recupera os metadados de todas as execuções de determinado fluxo de trabalho.

**Solicitaçã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).

  Nome do fluxo de trabalho cujos metadados de execuções devem ser retornados.
+ `IncludeGraph` – Booleano.

  Especifica se deve incluir o gráfico do fluxo de trabalho como resposta ou não.
+ `NextToken` – String UTF-8.

  O tamanho máximo da resposta.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de execuções do fluxo de trabalho a serem incluídas na resposta.

**Resposta**
+ `Runs`: uma matriz de objetos [WorkflowRun](#aws-glue-api-workflow-WorkflowRun), não menos do que 1 ou superior a 1.000 estruturas.

  Uma lista de objetos de metadados da execução do fluxo de trabalho.
+ `NextToken` – String UTF-8.

  Um token de continuação, se todas as execuções do fluxo de trabalho solicitadas não tiverem sido retornadas.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetWorkflowRunProperties (Python: get\$1workflow\$1run\$1properties)
<a name="aws-glue-api-workflow-GetWorkflowRunProperties"></a>

Recupera as propriedades de execução do fluxo de trabalho que foram definidas durante a execução.

**Solicitaçã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).

  Nome do fluxo de trabalho que foi executado.
+ `RunId`: *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 execução do fluxo de trabalho cujas propriedades deveriam ser retornadas.

**Resposta**
+ `RunProperties` – 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 é uma sequência de caracteres UTF-8.

  As propriedades da execução do fluxo de trabalho que foram definidas durante a execução especificada.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação PutWorkflowRunProperties (Python: put\$1workflow\$1run\$1properties)
<a name="aws-glue-api-workflow-PutWorkflowRunProperties"></a>

Coloca as propriedades da execução do fluxo de trabalho especificadas para determinada execução do fluxo de trabalho. Se uma propriedade já existir para a execução especificada, ela substituirá o valor. Caso contrário, a propriedade será adicionada às propriedades existentes.

**Solicitaçã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).

  Nome do fluxo de trabalho que foi executado.
+ `RunId`: *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 execução do fluxo de trabalho para o qual as propriedades de execução deveriam ser atualizadas.
+ `RunProperties`: *obrigatório:* uma matriz de mapa dos pares de chave-valor.

  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 é uma sequência de caracteres UTF-8.

  As propriedades para colocar a execução especificada.

  As propriedades de execução podem ser registradas em log. Evite fornecer segredos em texto simples e não criptografado como propriedades. Caso necessite utilizá-los no decorrer da execução do fluxo de trabalho, recupere-os de uma Conexão do AWS Glue, do AWS Secrets Manager ou de outro mecanismo de gerenciamento de segredos.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `AlreadyExistsException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`

## Ação CreateBlueprint (Python: create\$1blueprint)
<a name="aws-glue-api-workflow-CreateBlueprint"></a>

Regista um blueprint com o AWS Glue.

**Solicitação**
+ `Name`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  O nome do blueprint.
+ `Description`: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento.

  Uma descrição do blueprint.
+ `BlueprintLocation`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 8.192 bytes de comprimento, correspondente a [Custom string pattern #32](aws-glue-api-common.md#regex_32).

  Especifica um caminho no Amazon S3 em que o blueprint é publicado.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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 a serem aplicadas a esse blueprint.

**Resposta**
+ `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).

  Retorna o nome do blueprint que foi registrado.

**Erros**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`

## Ação UpdateBlueprint (Python: update\$1blueprint)
<a name="aws-glue-api-workflow-UpdateBlueprint"></a>

Atualiza um blueprint registrado.

**Solicitação**
+ `Name`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  O nome do blueprint.
+ `Description`: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento.

  Uma descrição do blueprint.
+ `BlueprintLocation`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 8.192 bytes de comprimento, correspondente a [Custom string pattern #32](aws-glue-api-common.md#regex_32).

  Especifica um caminho no Amazon S3 em que o blueprint é publicado.

**Resposta**
+ `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).

  Retorna o nome do blueprint que foi atualizado.

**Erros**
+ `EntityNotFoundException`
+ `ConcurrentModificationException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `IllegalBlueprintStateException`

## Ação DeleteBlueprint (Python: delete\$1blueprint)
<a name="aws-glue-api-workflow-DeleteBlueprint"></a>

Exclui um blueprint existente.

**Solicitaçã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 blueprint a ser excluído.

**Resposta**
+ `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).

  Retorna o nome do blueprint que foi excluído.

**Erros**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação ListBlueprints (Python: list\$1blueprints)
<a name="aws-glue-api-workflow-ListBlueprints"></a>

Lista todos os nomes de blueprints em uma conta.

**Solicitação**
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma solicitação de continuação.
+ `MaxResults`: número (inteiro), não inferior a 1 nem superior a 25.

  O tamanho máximo de uma lista a ser retornada.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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.

  Filtra a lista por uma tag de recurso da AWS.

**Resposta**
+ `Blueprints` – Uma matriz de strings UTF-8.

  Lista de nomes de blueprints na conta.
+ `NextToken` – String UTF-8.

  Um token de continuação, se nem todos os nomes de blueprints sejam retornados.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação BatchGetBlueprints (Python: batch\$1get\$1blueprints)
<a name="aws-glue-api-workflow-BatchGetBlueprints"></a>

Recupera informações sobre uma lista de blueprints.

**Solicitação**
+ `Names` – *Obrigatório:* uma matriz de strings UTF-8, no mínimo 1 ou mais de 25 strings.

  Uma lista de nomes de blueprints.
+ `IncludeBlueprint` – Booleano.

  Especifica se deve incluir o blueprint na resposta ou não.
+ `IncludeParameterSpec` – Booleano.

  Especifica se deve incluir os parâmetros para o blueprint, como uma string JSON, na resposta ou não.

**Resposta**
+ `Blueprints`: um array de objetos [Blueprint](#aws-glue-api-workflow-Blueprint).

  Retorna uma lista de blueprints como um objeto `Blueprints`.
+ `MissingBlueprints` – Uma matriz de strings UTF-8.

  Retorna uma lista de `BlueprintNames` que não foram encontrados.

**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## Ação StartBlueprintRun (Python: start\$1blueprint\$1run)
<a name="aws-glue-api-workflow-StartBlueprintRun"></a>

Inicia uma nova execução do blueprint especificado.

**Solicitação**
+ `BlueprintName`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  O nome do blueprint.
+ `Parameters`: string UTF-8, não menos do que 1 ou superior a 131.072 bytes de comprimento.

  Especifica os parâmetros como um objeto `BlueprintParameters`.
+ `RoleArn` – *Obrigatório:* string UTF-8, no mínimo 1 ou mais de 1024 bytes de comprimento, correspondente a [Custom string pattern #30](aws-glue-api-common.md#regex_30).

  Especifica a função do IAM usada para criar o fluxo de trabalho.

**Resposta**
+ `RunId` – 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 de execução para essa execução de blueprint.

**Erros**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`
+ `EntityNotFoundException`
+ `IllegalBlueprintStateException`

## Ação GetBlueprintRun (Python: get\$1blueprint\$1run)
<a name="aws-glue-api-workflow-GetBlueprintRun"></a>

Recupera os detalhes de uma execução de bluetprint.

**Solicitação**
+ `BlueprintName`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #31](aws-glue-api-common.md#regex_31).

  O nome do blueprint.
+ `RunId`: *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 de execução do blueprint que você deseja recuperar.

**Resposta**
+ `BlueprintRun` – Um objeto [BlueprintRun](#aws-glue-api-workflow-BlueprintRun).

  Informa um objeto `BlueprintRun`.

**Erros**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação GetBlueprintRuns (Python: get\$1blueprint\$1runs)
<a name="aws-glue-api-workflow-GetBlueprintRuns"></a>

Recupera os detalhes das execuções de blueprint para um blueprint especificado.

**Solicitação**
+ `BlueprintName`: *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 blueprint.
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma solicitação de continuação.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O tamanho máximo de uma lista a ser retornada.

**Resposta**
+ `BlueprintRuns`: um array de objetos [BlueprintRun](#aws-glue-api-workflow-BlueprintRun).

  Retorna uma lista de objetos `BlueprintRun`.
+ `NextToken` – String UTF-8.

  Um token de continuação, se nem todas as execuções de blueprint solicitadas forem retornadas.

**Erros**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## Ação StartWorkflowRun (Python: start\$1workflow\$1run)
<a name="aws-glue-api-workflow-StartWorkflowRun"></a>

Inicia uma nova execução do fluxo de trabalho especificado.

**Solicitaçã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 fluxo de trabalho a ser iniciado.
+ `RunProperties` – 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 é uma sequência de caracteres UTF-8.

  As propriedades de execução de fluxo de trabalho para a nova execução de fluxo de trabalho.

  As propriedades de execução podem ser registradas em log. Evite fornecer segredos em texto simples e não criptografado como propriedades. Caso necessite utilizá-los no decorrer da execução do fluxo de trabalho, recupere-os de uma Conexão do AWS Glue, do AWS Secrets Manager ou de outro mecanismo de gerenciamento de segredos.

**Resposta**
+ `RunId` – 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 ID para a nova execução.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentRunsExceededException`

## Ação StopWorkflowRun (Python: stop\$1workflow\$1run)
<a name="aws-glue-api-workflow-StopWorkflowRun"></a>

Interrompe a execução do fluxo de trabalho especificada.

**Solicitaçã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 fluxo de trabalho a ser interrompido.
+ `RunId`: *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 execução do fluxo de trabalho a ser interrompida.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `IllegalWorkflowStateException`

## Ação ResumeWorkflowRun (Python: resume\$1workflow\$1run)
<a name="aws-glue-api-workflow-ResumeWorkflowRun"></a>

Reinicia os nós selecionados de uma execução de fluxo de trabalho anterior parcialmente concluída e retoma a execução do fluxo de trabalho. Os nós selecionados e todos os nós downstream a eles são executados.

**Solicitaçã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 fluxo de trabalho a ser retomado.
+ `RunId`: *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 execução do fluxo de trabalho a ser retomada.
+ `NodeIds`: *obrigatório:* uma matriz de strings UTF-8.

  Uma lista de IDs de nó daqueles que você deseja reiniciar. Os nós que devem ser reiniciados devem ter uma tentativa de execução na execução original.

**Resposta**
+ `RunId` – 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 novo ID atribuído à execução do fluxo de trabalho retomada. Cada retomada de uma execução de fluxo de trabalho terá um novo ID de execução.
+ `NodeIds` – Uma matriz de strings UTF-8.

  Uma lista de IDs dos nós que foram realmente reiniciados.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentRunsExceededException`
+ `IllegalWorkflowStateException`

# Perfis de uso
<a name="aws-glue-api-usage-profiles"></a>

A API de perfis de uso descreve os tipos de dados e API relacionados à criação, atualização ou exibição de fluxos de trabalho no AWS Glue.

## Tipos de dados
<a name="aws-glue-api-usage-profiles-objects"></a>
+ [Estrutura ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration)
+ [Estrutura ConfigurationObject](#aws-glue-api-usage-profiles-ConfigurationObject)
+ [Estrutura UsageProfileDefinition](#aws-glue-api-usage-profiles-UsageProfileDefinition)

## Estrutura ProfileConfiguration
<a name="aws-glue-api-usage-profiles-ProfileConfiguration"></a>

Especifica os valores de trabalho e sessão que um administrador configura em um perfil de uso do AWS Glue.

**Campos**
+ `SessionConfiguration` – 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 [ConfigurationObject](#aws-glue-api-usage-profiles-ConfigurationObject) A.

  Um mapa de chave-valor de configuração para sessões do AWS Glue. 
+ `JobConfiguration` – 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 [ConfigurationObject](#aws-glue-api-usage-profiles-ConfigurationObject) A.

  Um mapa de chave-valor de configuração para trabalhos do AWS Glue. 

## Estrutura ConfigurationObject
<a name="aws-glue-api-usage-profiles-ConfigurationObject"></a>

Especifica os valores que um administrador define para cada parâmetro de trabalho ou sessão configurado em um perfil de uso do AWS Glue.

**Campos**
+ `DefaultValue`: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #35](aws-glue-api-common.md#regex_35).

  Um valor padrão para o parâmetro.
+ `AllowedValues` – Uma matriz de strings UTF-8.

  Uma lista dos valores permitidos para o parâmetro.
+ `MinValue`: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #35](aws-glue-api-common.md#regex_35).

  Um valor mínimo permitido para o parâmetro.
+ `MaxValue`: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #35](aws-glue-api-common.md#regex_35).

  Um valor máximo permitido para o parâmetro.

## Estrutura UsageProfileDefinition
<a name="aws-glue-api-usage-profiles-UsageProfileDefinition"></a>

Descreve um perfil de uso do AWS Glue.

**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 do perfil do usuário.
+ `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 perfil de uso.
+ `CreatedOn` – Timestamp.

  A data e a hora em que o perfil de uso foi criado.
+ `LastModifiedOn` – Timestamp.

  A data e a hora em que o perfil de uso foi modificado pela última vez.

## Operações
<a name="aws-glue-api-usage-profiles-actions"></a>
+ [Ação CreateUsageProfile (Python: create\$1usage\$1profile)](#aws-glue-api-usage-profiles-CreateUsageProfile)
+ [Ação GetUsageProfile (Python: get\$1usage\$1profile)](#aws-glue-api-usage-profiles-GetUsageProfile)
+ [Ação UpdateUsageProfile (Python: update\$1usage\$1profile)](#aws-glue-api-usage-profiles-UpdateUsageProfile)
+ [Ação DeleteUsageProfile (Python: delete\$1usage\$1profile)](#aws-glue-api-usage-profiles-DeleteUsageProfile)
+ [Ação ListUsageProfiles (Python: list\$1usage\$1profiles)](#aws-glue-api-usage-profiles-ListUsageProfiles)

## Ação CreateUsageProfile (Python: create\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-CreateUsageProfile"></a>

Cria um perfil de uso do AWS Glue.

**Solicitaçã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 perfil do usuário.
+ `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 perfil de uso.
+ `Configuration` – *Obrigatório:* um objeto [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration).

  Um objeto `ProfileConfiguration` que especifica os valores do trabalho e da sessão para o perfil.
+ `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.

  Uma lista de tags aplicadas ao perfil de uso.

**Resposta**
+ `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 do perfil de uso que foi criado.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `AlreadyExistsException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `OperationNotSupportedException`

## Ação GetUsageProfile (Python: get\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-GetUsageProfile"></a>

Recupera informações sobre o perfil de uso do AWS Glue especificado.

**Solicitaçã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 perfil de uso a ser recuperado.

**Resposta**
+ `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 do perfil do usuário.
+ `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 perfil de uso.
+ `Configuration` – Um objeto [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration).

  Um objeto `ProfileConfiguration` que especifica os valores do trabalho e da sessão para o perfil.
+ `CreatedOn` – Timestamp.

  A data e a hora em que o perfil de uso foi criado.
+ `LastModifiedOn` – Timestamp.

  A data e a hora em que o perfil de uso foi modificado pela última vez.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`

## Ação UpdateUsageProfile (Python: update\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-UpdateUsageProfile"></a>

Atualiza um perfil de uso do AWS Glue.

**Solicitaçã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 perfil do usuário.
+ `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 perfil de uso.
+ `Configuration` – *Obrigatório:* um objeto [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration).

  Um objeto `ProfileConfiguration` que especifica os valores do trabalho e da sessão para o perfil.

**Resposta**
+ `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 do perfil de uso que foi atualizado.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`
+ `ConcurrentModificationException`

## Ação DeleteUsageProfile (Python: delete\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-DeleteUsageProfile"></a>

Exclui o perfil de uso do AWS Glue especificado.

**Solicitaçã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 perfil de uso a ser excluído.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`

## Ação ListUsageProfiles (Python: list\$1usage\$1profiles)
<a name="aws-glue-api-usage-profiles-ListUsageProfiles"></a>

Liste todos os perfis de uso do AWS Glue.

**Solicitação**
+ `NextToken`: string UTF-8, não superior a 400.000 bytes de comprimento.

  Um token de continuação, incluído se esta for uma chamada de continuação.
+ `MaxResults`: número (inteiro) não inferior a 1 nem superior a 200.

  O número máximo de perfis de uso a serem retornados em uma única resposta.

**Resposta**
+ `Profiles`: um array de objetos [UsageProfileDefinition](#aws-glue-api-usage-profiles-UsageProfileDefinition).

  Uma lista de objetos do perfil de uso (`UsageProfileDefinition`).
+ `NextToken`: string UTF-8, não superior a 400.000 bytes de comprimento.

  Um token de continuação, presente se o segmento de lista atual não for o último.

**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `OperationNotSupportedException`

# API de machine learning
<a name="aws-glue-api-machine-learning-api"></a>

A API Machine learning descreve os tipos de dados de machine learning e inclui a API para criar, excluir ou atualizar uma transformação, ou iniciar a execução de uma tarefa de machine learning.

## Tipos de dados
<a name="aws-glue-api-machine-learning-api-objects"></a>
+ [Estrutura TransformParameters](#aws-glue-api-machine-learning-api-TransformParameters)
+ [Estrutura EvaluationMetrics](#aws-glue-api-machine-learning-api-EvaluationMetrics)
+ [Estrutura MLTransform](#aws-glue-api-machine-learning-api-MLTransform)
+ [Estrutura FindMatchesParameters](#aws-glue-api-machine-learning-api-FindMatchesParameters)
+ [Estrutura FindMatchesMetrics](#aws-glue-api-machine-learning-api-FindMatchesMetrics)
+ [Estrutura ConfusionMatrix](#aws-glue-api-machine-learning-api-ConfusionMatrix)
+ [Estrutura GlueTable](#aws-glue-api-machine-learning-api-GlueTable)
+ [Estrutura TaskRun](#aws-glue-api-machine-learning-api-TaskRun)
+ [Estrutura TransformFilterCriteria](#aws-glue-api-machine-learning-api-TransformFilterCriteria)
+ [Estrutura TransformSortCriteria](#aws-glue-api-machine-learning-api-TransformSortCriteria)
+ [Estrutura TaskRunFilterCriteria](#aws-glue-api-machine-learning-api-TaskRunFilterCriteria)
+ [Estrutura TaskRunSortCriteria](#aws-glue-api-machine-learning-api-TaskRunSortCriteria)
+ [Estrutura TaskRunProperties](#aws-glue-api-machine-learning-api-TaskRunProperties)
+ [Estrutura FindMatchesTaskRunProperties](#aws-glue-api-machine-learning-api-FindMatchesTaskRunProperties)
+ [Estrutura ImportLabelsTaskRunProperties](#aws-glue-api-machine-learning-api-ImportLabelsTaskRunProperties)
+ [Estrutura ExportLabelsTaskRunProperties](#aws-glue-api-machine-learning-api-ExportLabelsTaskRunProperties)
+ [Estrutura LabelingSetGenerationTaskRunProperties](#aws-glue-api-machine-learning-api-LabelingSetGenerationTaskRunProperties)
+ [Estrutura SchemaColumn](#aws-glue-api-machine-learning-api-SchemaColumn)
+ [Estrutura TransformEncryption](#aws-glue-api-machine-learning-api-TransformEncryption)
+ [Estrutura MLUserDataEncryption](#aws-glue-api-machine-learning-api-MLUserDataEncryption)
+ [Estrutura ColumnImportance](#aws-glue-api-machine-learning-api-ColumnImportance)

## Estrutura TransformParameters
<a name="aws-glue-api-machine-learning-api-TransformParameters"></a>

Os parâmetros de algoritmo específicos associados à transformação de machine learning.

**Campos**
+ `TransformType`: *obrigatório:* string UTF-8 (valores válidos: `FIND_MATCHES`).

  O tipo de transformação de machine learning.

  Para obter informações sobre os tipos de transformações de machine learning, consulte [Criação de transformações para machine learning](https://docs.aws.amazon.com/glue/latest/dg/add-job-machine-learning-transform.html).
+ `FindMatchesParameters` – Um objeto [FindMatchesParameters](#aws-glue-api-machine-learning-api-FindMatchesParameters).

  Os parâmetros do algoritmo de busca de correspondências.

## Estrutura EvaluationMetrics
<a name="aws-glue-api-machine-learning-api-EvaluationMetrics"></a>

As métricas de avaliação fornecem uma estimativa da qualidade da transformação de machine learning.

**Campos**
+ `TransformType`: *obrigatório:* string UTF-8 (valores válidos: `FIND_MATCHES`).

  O tipo de transformação de machine learning.
+ `FindMatchesMetrics` – Um objeto [FindMatchesMetrics](#aws-glue-api-machine-learning-api-FindMatchesMetrics).

  As métricas de avaliação do algoritmo de busca de correspondências.

## Estrutura MLTransform
<a name="aws-glue-api-machine-learning-api-MLTransform"></a>

Uma estrutura para a transformação de machine learning.

**Campos**
+ `TransformId` – 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 de transformação exclusivo gerado para a transformação de machine learning. É garantido que o ID será único e não mudará.
+ `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).

  Um nome definido pelo usuário para a transformação de machine learning. Não é garantido que os nomes serão únicos, e poderão ser trocados a qualquer momento.
+ `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).

  Um texto de descrição de formato longo e definido pelo usuário para a transformação de machine learning. Não é garantido que as descrições serão únicas, e elas poderão mudar a qualquer momento.
+ `Status` – string UTF-8 (valores válidos: `NOT_READY` \$1 `READY` \$1 `DELETING`).

  O status atual da transformação de machine learning.
+ `CreatedOn` – Timestamp.

  Um carimbo de data/hora. A data e hora em que essa transformação de machine learning foi criada.
+ `LastModifiedOn` – Timestamp.

  Um carimbo de data/hora. O último momento em que essa transformação de machine learning foi modificada.
+ `InputRecordTables`: uma matriz de objetos [GlueTable](#aws-glue-api-machine-learning-api-GlueTable), não mais do que dez estruturas.

  Uma lista de definições de tabela do AWS Glue usadas pela transformação.
+ `Parameters` – Um objeto [TransformParameters](#aws-glue-api-machine-learning-api-TransformParameters).

  Um objeto `TransformParameters`. Você pode usar parâmetros para ajustar (personalizar) o comportamento da transformação de machine learning, especificando quais dados ela aprenderá e sua preferência sobre vários tradeoffs (como precisão vs. revocação, ou acurácia vs. custo).
+ `EvaluationMetrics` – Um objeto [EvaluationMetrics](#aws-glue-api-machine-learning-api-EvaluationMetrics).

  Um objeto `EvaluationMetrics`. As métricas de avaliação fornecem uma estimativa da qualidade da transformação de machine learning.
+ `LabelCount` – Número (íntegro).

  Um identificador de contagem para rotular arquivos gerados pelo AWS Glue para essa transformação. À medida que você cria uma transformação melhor, é possível fazer download, rotular e fazer upload do arquivo de rotulamento de maneira interativa.
+ `Schema`: uma matriz de objetos [SchemaColumn](#aws-glue-api-machine-learning-api-SchemaColumn), não mais de 100 estruturas.

  Um mapa de pares de chave-valor representando as colunas e os tipos de dados que podem ser executados em relação a essa transformação. Tem um limite superior de 100 colunas.
+ `Role` – String UTF-8.

  O nome ou o nome de recurso da Amazon (ARN) da função do IAM com as permissões necessárias. As permissões necessárias incluem as permissões de função de serviço do AWS Glue para recursos do AWS Glue e as permissões do Amazon S3 exigidas pela transformação. 
  + Essa função precisa de permissões de função de serviço do AWS Glue para conceder o acesso aos recursos no AWS Glue. Consulte [Anexar uma política aos usuários do IAM que acessam o AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html).
  + Essa função precisa de permissão para suas origens, seus destinos, seu diretório temporário, seus scripts e quaisquer bibliotecas do Amazon Simple Storage Service (Amazon S3) usadas pela execução de tarefa nessa transformação.
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Este valor determina com qual versão de AWS Glue essa transformação de machine learning é compatível. O Glue 1.0 é recomendado para a maioria dos clientes. Se o valor não for definido, a compatibilidade com o Glue 0.9 será definida como padrão. Para obter mais informações, consulte [Versões do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) no guia do desenvolvedor.
+ `MaxCapacity` – Número (duplo).

  O número de unidades de processamento de dados (DPUs) do AWS Glue alocadas para execuções de tarefas para essa transformação. Você pode alocar de 2 a 100 DPUs. O padrão é 10. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/). 

  `MaxCapacity` é uma opção mutuamente exclusiva com `NumberOfWorkers` e `WorkerType`.
  + Se `NumberOfWorkers` ou `WorkerType` estiver definido, `MaxCapacity` não poderá ser definido.
  + Se `MaxCapacity` estiver definido, nem `NumberOfWorkers` e nem `WorkerType` poderá ser definido.
  + Se `WorkerType` estiver definido, `NumberOfWorkers` será necessário (e vice-versa).
  + `MaxCapacity` e `NumberOfWorkers` devem ser pelo menos 1.

  Quando o campo `WorkerType` é definido como um valor diferente de `Standard`, o campo `MaxCapacity` é definido automaticamente e se torna somente leitura.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido alocado quando uma tarefa dessa transformação é executada. Aceita um valor de Standard (Padrão), G.1X ou G.2X.
  + Para o tipo de operador `Standard`, cada operador fornece 4 vCPU, 16 GB de memória e um disco de 50 GB e 2 executores por operador.
  + Para o tipo de operador `G.1X`, cada operador fornece 4 vCPU, 16 GB de memória e um disco e 64 GB, 1 executor por operador.
  + Para o tipo de operador `G.2X`, cada operador fornece 8 vCPU, 32 GB de memória e um disco de 128 GB e 1 executor por operador.

  `MaxCapacity` é uma opção mutuamente exclusiva com `NumberOfWorkers` e `WorkerType`.
  + Se `NumberOfWorkers` ou `WorkerType` estiver definido, `MaxCapacity` não poderá ser definido.
  + Se `MaxCapacity` estiver definido, nem `NumberOfWorkers` e nem `WorkerType` poderá ser definido.
  + Se `WorkerType` estiver definido, `NumberOfWorkers` será necessário (e vice-versa).
  + `MaxCapacity` e `NumberOfWorkers` devem ser pelo menos 1.
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de um `workerType` definido alocados quando uma tarefa da transformação é executada.

  Se `WorkerType` estiver definido, `NumberOfWorkers` será necessário (e vice-versa).
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite em minutos da transformação de machine learning.
+ `MaxRetries` – Número (íntegro).

  O número máximo de novas tentativas após uma falha de transformação `MLTaskRun` de machine learning.
+ `TransformEncryption` – Um objeto [TransformEncryption](#aws-glue-api-machine-learning-api-TransformEncryption).

  As configurações de criptografia em repouso da transformação que se aplicam ao acesso aos dados do usuário. As transformações de machine learning podem acessar dados do usuário criptografados no Amazon S3 usando o KMS.

## Estrutura FindMatchesParameters
<a name="aws-glue-api-machine-learning-api-FindMatchesParameters"></a>

Os parâmetros para configurar a transformação de localização de correspondências.

**Campos**
+ `PrimaryKeyColumnName` – String UTF-8, superior a 1 e inferior a 1024 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome de uma coluna que identifica exclusivamente as linhas na tabela de origem. Usado para ajudar a identificar os registros correspondentes.
+ `PrecisionRecallTradeoff`: número (double), no máximo 1,0.

  O valor selecionado ao ajustar a transformação para um equilíbrio entre precisão e revocação. Um valor de 0.5 significa que não há preferência; um valor de 1.0 significa um desvio puramente para precisão, e um valor de 0.0 significa um desvio para revocação. Como este é um tradeoff, escolher valores próximos a 1.0 significa uma revocação muito baixa, e escolher valores próximos a 0.0 resulta em uma precisão muito baixa.

  A métrica de precisão indica a frequência com que seu modelo está correto ao prever uma correspondência. 

  A métrica de revocação indica, para uma correspondência real, com que frequência seu modelo prevê a correspondência.
+ `AccuracyCostTradeoff`: número (double), no máximo 1,0.

  O valor selecionado ao ajustar sua transformação para um equilíbrio entre acurácia e custo. Um valor de 0.5 significa que o sistema equilibra as preocupações de acurácia e o custo. Um valor de 1.0 significa um desvio puramente para a acurácia, o que normalmente resulta em um custo mais alto, que é, às vezes, substancialmente superior. Um valor de 0.0 significa um desvio puramente para o custo, o que resulta em uma transformação `FindMatches` menos precisa e que é, às vezes, uma acurácia inaceitável.

  A acurácia mede quão bem a transformação encontra verdadeiros positivos e verdadeiros negativos. Aumentar a acurácia exige mais recursos de máquina e eleva os custos. Mas isso também resulta em um aumento da revocação. 

  O custo avalia o número de recursos de computação, ou seja, o dinheiro, consumidos para executar a transformação.
+ `EnforceProvidedLabels` – Booleano.

  O valor para ativar/desativar a forçar a saída para corresponder aos rótulos fornecidos por usuários. Se o valor for `True`, a transformação `find matches` forçará a saída para corresponder aos rótulos fornecidos. Os resultados substituem os resultados de confluência normal. Se o valor for `False`, a transformação `find matches` não garantirá que todos os rótulos fornecidos serão respeitados, e os resultados contarão com o modelo treinado.

  Observe que definir esse valor como true pode aumentar o tempo de execução do trabalho.

## Estrutura FindMatchesMetrics
<a name="aws-glue-api-machine-learning-api-FindMatchesMetrics"></a>

As métricas de avaliação do algoritmo de busca de correspondências. A qualidade da transformação de machine learning é avaliada fazendo com que sua transformação preveja algumas correspondências e comparando os resultados com correspondências conhecidas do mesmo conjunto de dados. As métricas de qualidade são baseadas em um subconjunto dos seus dados, para que eles não sejam precisos.

**Campos**
+ `AreaUnderPRCurve`: número (double), no máximo 1,0.

  A área sob a curva de precisão/revocação (AUPRC) é um único número único que mede a qualidade geral da transformação, que é independente da escolha feita em precisão vs. revocação. Valores mais altos indicam que você tem um tradeoff de precisão vs. revocação mais atrativo.

  Para obter mais informações, consulte [Precisão e revocação](https://en.wikipedia.org/wiki/Precision_and_recall) na Wikipédia.
+ `Precision`: número (double), no máximo 1,0.

  A métrica de precisão indica a frequência com que sua transformação está correta ao prever uma correspondência. Especificamente, avalia quão bem a transformação encontra verdadeiros positivos do total possível de verdadeiros positivos.

  Para obter mais informações, consulte [Precisão e revocação](https://en.wikipedia.org/wiki/Precision_and_recall) na Wikipédia.
+ `Recall`: número (double), no máximo 1,0.

  A métrica de revocação indica, para uma correspondência real, com que frequência sua transformação prevê a correspondência. Especificamente, avalia quão bem a transformação encontra verdadeiros positivos do total de registros nos dados de origem.

  Para obter mais informações, consulte [Precisão e revocação](https://en.wikipedia.org/wiki/Precision_and_recall) na Wikipédia.
+ `F1`: número (double), no máximo 1,0.

  O F1 máximo indica a acurácia da transformação entre 0 e 1, onde 1 é a melhor acurácia.

  Para obter mais informações, consulte [F1 score](https://en.wikipedia.org/wiki/F1_score) na Wikipédia.
+ `ConfusionMatrix` – Um objeto [ConfusionMatrix](#aws-glue-api-machine-learning-api-ConfusionMatrix).

  A matriz de confusão mostra o que sua transformação está prevendo com precisão, e quais tipos de erros está cometendo.

  Para obter mais informações, consulte [Confusion Matrix](https://en.wikipedia.org/wiki/Confusion_matrix) na Wikipédia.
+ `ColumnImportances`: uma matriz de objetos [ColumnImportance](#aws-glue-api-machine-learning-api-ColumnImportance), não mais de 100 estruturas.

  Uma lista de estruturas `ColumnImportance` contendo métricas de importância de coluna, classificadas em ordem de importância decrescente.

## Estrutura ConfusionMatrix
<a name="aws-glue-api-machine-learning-api-ConfusionMatrix"></a>

A matriz de confusão mostra o que sua transformação está prevendo com precisão, e quais tipos de erros está cometendo.

Para obter mais informações, consulte [Confusion Matrix](https://en.wikipedia.org/wiki/Confusion_matrix) na Wikipédia.

**Campos**
+ `NumTruePositives` – Número (extenso).

  O número de correspondências nos dados que a transformação encontrou corretamente, na matriz de confusão da sua transformação.
+ `NumFalsePositives` – Número (extenso).

  O número de não correspondências nos dados que a transformação incorretamente classificou como correspondências, na matriz de confusão da sua transformação.
+ `NumTrueNegatives` – Número (extenso).

  O número de não correspondências nos dados que a transformação rejeitou corretamente, na matriz de confusão da sua transformação.
+ `NumFalseNegatives` – Número (extenso).

  O número de correspondências nos dados que a transformação não encontrou, na matriz de confusão da sua transformação.

## Estrutura GlueTable
<a name="aws-glue-api-machine-learning-api-GlueTable"></a>

O banco de dados e a tabela no AWS Glue Data Catalog usados para os dados de entrada ou saída.

**Campos**
+ `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 AWS Glue Data Catalog.
+ `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 no AWS Glue Data Catalog.
+ `CatalogId` – 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 identificador exclusivo para o AWS Glue Data Catalog.
+ `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 AWS Glue Data Catalog.
+ `AdditionalOptions`: uma matriz de mapas de pares chave-valor, não menos que 1 o não mais que 10 pares.

  Cada chave é uma string UTF-8, com comprimento entre 1 e 255 bytes, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Cada valor é uma string de descrição, com não mais de 2048 de comprimento, correspondo a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Opções adicionais para a tabela. Atualmente, duas chaves são compatíveis:
  + `pushDownPredicate`: para filtrar por partições sem a necessidade de listar e ler todos os arquivos do conjunto de dados.
  + `catalogPartitionPredicate`: para usar a remoção de partições do lado do servidor usando índices de partição no AWS Glue Data Catalog.

## Estrutura TaskRun
<a name="aws-glue-api-machine-learning-api-TaskRun"></a>

Os parâmetros de amostragem associados à transformação de machine learning.

**Campos**
+ `TransformId` – 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 transformação
+ `TaskRunId` – 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 para a execução dessa tarefa.
+ `Status` – string UTF-8 (valores válidos: `RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`).

  O status atual da execução de tarefa solicitada.
+ `LogGroupName` – String UTF-8.

  Os nomes do grupo de log para proteger os registros, associados a essa execução de tarefa.
+ `Properties` – Um objeto [TaskRunProperties](#aws-glue-api-machine-learning-api-TaskRunProperties).

  Especifica as propriedades de configuração associadas à execução de tarefa.
+ `ErrorString` – String UTF-8.

  A lista de strings de erros associadas a essa execução de tarefa.
+ `StartedOn` – Timestamp.

  A data e a hora em que essa execução de tarefa iniciou.
+ `LastModifiedOn` – Timestamp.

  O último momento em que a execução de tarefa foi atualizada.
+ `CompletedOn` – Timestamp.

  O último momento em que a execução de tarefa foi finalizada.
+ `ExecutionTime` – Número (íntegro).

  A quantidade de tempo (em segundos) em que a tarefa executada consumiu recursos.

## Estrutura TransformFilterCriteria
<a name="aws-glue-api-machine-learning-api-TransformFilterCriteria"></a>

Os critérios usado para filtrar as transformações de machine learning.

**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).

  Um nome de transformação exclusivo usado para filtrar as transformações de machine learning.
+ `TransformType` – string UTF-8 (valores válidos: `FIND_MATCHES`).

  O tipo de transformação de machine learning usado para filtrar as transformações de machine learning.
+ `Status` – string UTF-8 (valores válidos: `NOT_READY` \$1 `READY` \$1 `DELETING`).

  Filtra a lista de transformações de machine learning pelo último status conhecido das transformações (para indicar se uma transformação pode ser usada ou não). Um dos "NOT\$1READY", "READY" ou "DELETING".
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Este valor determina com qual versão de AWS Glue essa transformação de machine learning é compatível. O Glue 1.0 é recomendado para a maioria dos clientes. Se o valor não for definido, a compatibilidade com o Glue 0.9 será definida como padrão. Para obter mais informações, consulte [Versões do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) no guia do desenvolvedor.
+ `CreatedBefore` – Timestamp.

  A data e hora antes de as transformações serem criadas.
+ `CreatedAfter` – Timestamp.

  A data e hora depois de as transformações serem criadas.
+ `LastModifiedBefore` – Timestamp.

  Filtro da última modificação das transformações antes dessa data.
+ `LastModifiedAfter` – Timestamp.

  Filtro da última modificação das transformações depois dessa data.
+ `Schema`: uma matriz de objetos [SchemaColumn](#aws-glue-api-machine-learning-api-SchemaColumn), não mais de 100 estruturas.

  Filtros dos conjuntos de dados com um esquema específico. O objeto `Map<Column, Type>` é uma matriz de pares de chave-valor que representa o esquema que essa transformação aceita, em que `Column` é o nome de uma coluna, e `Type` é o tipo dos dados como um número inteiro ou uma string. Tem um limite superior de 100 colunas.

## Estrutura TransformSortCriteria
<a name="aws-glue-api-machine-learning-api-TransformSortCriteria"></a>

Os critérios de classificação associados à transformação de machine learning.

**Campos**
+ `Column` – *obrigatório:* string UTF-8 (valores válidos: `NAME` \$1 `TRANSFORM_TYPE` \$1 `STATUS` \$1 `CREATED` \$1 `LAST_MODIFIED`).

  A coluna a ser usada nos critérios de classificação que estão associados à transformação de machine learning.
+ `SortDirection` – *Obrigatório:* string UTF-8 (valores válidos: `DESCENDING` \$1 `ASCENDING`).

  A direção da classificação a ser usada nos critérios de classificação associados à transformação de machine learning.

## Estrutura TaskRunFilterCriteria
<a name="aws-glue-api-machine-learning-api-TaskRunFilterCriteria"></a>

Os critérios usados para filtrar a execução de tarefa para a transformação de machine learning.

**Campos**
+ `TaskRunType` – string UTF-8 (valores válidos: `EVALUATION` \$1 `LABELING_SET_GENERATION` \$1 `IMPORT_LABELS` \$1 `EXPORT_LABELS` \$1 `FIND_MATCHES`).

  O tipo da tarefa executada.
+ `Status` – string UTF-8 (valores válidos: `RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`).

  O status atual da tarefa executada.
+ `StartedBefore` – Timestamp.

  Filtra as execuções de tarefas iniciadas antes dessa data.
+ `StartedAfter` – Timestamp.

  Filtra as execuções de tarefas iniciadas após essa data.

## Estrutura TaskRunSortCriteria
<a name="aws-glue-api-machine-learning-api-TaskRunSortCriteria"></a>

Os critérios de classificação usados para classificar a lista de execuções de tarefas para a transformação de machine learning.

**Campos**
+ `Column` – *Obrigatório:* string UTF-8 (valores válidos: `TASK_RUN_TYPE` \$1 `STATUS` \$1 `STARTED`).

  A coluna que será usada para classificar a lista de execuções de tarefas para a transformação de machine learning.
+ `SortDirection` – *Obrigatório:* string UTF-8 (valores válidos: `DESCENDING` \$1 `ASCENDING`).

  A direção de classificação que será usada para classificar a lista de execuções de tarefas para a transformação de machine learning.

## Estrutura TaskRunProperties
<a name="aws-glue-api-machine-learning-api-TaskRunProperties"></a>

As propriedades de configuração para a execução de tarefa.

**Campos**
+ `TaskType` – string UTF-8 (valores válidos: `EVALUATION` \$1 `LABELING_SET_GENERATION` \$1 `IMPORT_LABELS` \$1 `EXPORT_LABELS` \$1 `FIND_MATCHES`).

  O tipo da tarefa executada.
+ `ImportLabelsTaskRunProperties` – Um objeto [ImportLabelsTaskRunProperties](#aws-glue-api-machine-learning-api-ImportLabelsTaskRunProperties).

  As propriedades de configuração para uma execução de tarefa de rótulos de importação.
+ `ExportLabelsTaskRunProperties` – Um objeto [ExportLabelsTaskRunProperties](#aws-glue-api-machine-learning-api-ExportLabelsTaskRunProperties).

  As propriedades de configuração para uma execução de tarefa de rótulos de exportação.
+ `LabelingSetGenerationTaskRunProperties` – Um objeto [LabelingSetGenerationTaskRunProperties](#aws-glue-api-machine-learning-api-LabelingSetGenerationTaskRunProperties).

  As propriedades de configuração para execução de tarefa de geração de conjunto de rótulos.
+ `FindMatchesTaskRunProperties` – Um objeto [FindMatchesTaskRunProperties](#aws-glue-api-machine-learning-api-FindMatchesTaskRunProperties).

  As propriedades de configuração de uma execução de tarefa de busca de correspondências.

## Estrutura FindMatchesTaskRunProperties
<a name="aws-glue-api-machine-learning-api-FindMatchesTaskRunProperties"></a>

Especifica as propriedades de configuração de uma execução de tarefa de busca de correspondências.

**Campos**
+ `JobId` – 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 do trabalho da execução de tarefa de busca de correspondências.
+ `JobName` – 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 atribuído ao trabalho da execução de tarefa de busca de correspondências.
+ `JobRunId` – 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 execução de trabalho para a execução de tarefa de busca de correspondências

## Estrutura ImportLabelsTaskRunProperties
<a name="aws-glue-api-machine-learning-api-ImportLabelsTaskRunProperties"></a>

Especifica as propriedades de configuração para uma execução de tarefa de importação de rótulos.

**Campos**
+ `InputS3Path` – String UTF-8.

  O caminho do Amazon Simple Storage Service (Amazon S3) para onde você importará os rótulos.
+ `Replace` – Booleano.

  Indica se você deve substituir os rótulos existentes.

## Estrutura ExportLabelsTaskRunProperties
<a name="aws-glue-api-machine-learning-api-ExportLabelsTaskRunProperties"></a>

Especifica as propriedades de configuração para uma execução de tarefa de exportação de rótulos.

**Campos**
+ `OutputS3Path` – String UTF-8.

  O caminho do Amazon Simple Storage Service (Amazon S3) de onde você exportará os rótulos.

## Estrutura LabelingSetGenerationTaskRunProperties
<a name="aws-glue-api-machine-learning-api-LabelingSetGenerationTaskRunProperties"></a>

Especifica as propriedades de configuração para execução de tarefa de geração de conjunto de rótulos.

**Campos**
+ `OutputS3Path` – String UTF-8.

  O caminho do Amazon Simple Storage Service (Amazon S3) de onde você irá gerar o conjunto de rótulos.

## Estrutura SchemaColumn
<a name="aws-glue-api-machine-learning-api-SchemaColumn"></a>

Um par de chave-valor representando a coluna e o tipo de dado que podem ser executados em relação a essa transformação. O parâmetro `Schema` do `MLTransform` pode conter até 100 dessas estruturas.

**Campos**
+ `Name` – String UTF-8, superior a 1 e inferior a 1024 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome da coluna.
+ `DataType` – 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 na coluna.

## Estrutura TransformEncryption
<a name="aws-glue-api-machine-learning-api-TransformEncryption"></a>

As configurações de criptografia em repouso da transformação que se aplicam ao acesso aos dados do usuário. As transformações de machine learning podem acessar dados do usuário criptografados no Amazon S3 usando o KMS.

Além disso, rótulos importados e transformações treinadas agora podem ser criptografados usando uma chave KMS fornecida pelo cliente.

**Campos**
+ `MlUserDataEncryption` – Um objeto [MLUserDataEncryption](#aws-glue-api-machine-learning-api-MLUserDataEncryption).

  Um objeto `MLUserDataEncryption` que contém o modo de criptografia e o ID da chave do KMS fornecida pelo cliente.
+ `TaskRunSecurityConfigurationName` – 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 configuração de segurança.

## Estrutura MLUserDataEncryption
<a name="aws-glue-api-machine-learning-api-MLUserDataEncryption"></a>

As configurações de criptografia em repouso da transformação que se aplicam ao acesso aos dados do usuário.

**Campos**
+ `MlUserDataEncryptionMode` – *Obrigatório:* string UTF-8 (valores válidos: `DISABLED` \$1 `SSE-KMS="SSEKMS"`).

  O modo de criptografia aplicado aos dados do usuário. Os valores válidos são:
  + DISABLED: a criptografia está desativada
  + SSEKMS: uso de criptografia no lado do servidor com o AWS Key Management Service (SSE-KMS) para dados do usuário armazenados no Amazon S3.
+ `KmsKeyId` – 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 chave do KMS fornecida pelo cliente.

## Estrutura ColumnImportance
<a name="aws-glue-api-machine-learning-api-ColumnImportance"></a>

Uma estrutura que contém o nome e a pontuação de importância de uma coluna. 

A importância da coluna ajuda você a entender como as colunas contribuem para o seu modelo, identificando quais delas em seus registros são mais usadas para fazer a correspondência.

**Campos**
+ `ColumnName` – 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 de uma coluna.
+ `Importance`: número (double), no máximo 1,0.

  A pontuação de importância da coluna, como um valor decimal.

## Operações
<a name="aws-glue-api-machine-learning-api-actions"></a>
+ [Ação CreateMLTransform (Python: create\$1ml\$1transform)](#aws-glue-api-machine-learning-api-CreateMLTransform)
+ [Ação UpdateMLTransform (Python: update\$1ml\$1transform)](#aws-glue-api-machine-learning-api-UpdateMLTransform)
+ [Ação DeleteMLTransform (Python: delete\$1ml\$1transform)](#aws-glue-api-machine-learning-api-DeleteMLTransform)
+ [Ação GetMLTransform (Python: get\$1ml\$1transform)](#aws-glue-api-machine-learning-api-GetMLTransform)
+ [Ação GetMLTransforms (Python: get\$1ml\$1transforms)](#aws-glue-api-machine-learning-api-GetMLTransforms)
+ [Ação ListMLTransforms (Python: list\$1ml\$1transforms)](#aws-glue-api-machine-learning-api-ListMLTransforms)
+ [Ação StartMLEvaluationTaskRun (Python: start\$1ml\$1evaluation\$1task\$1run)](#aws-glue-api-machine-learning-api-StartMLEvaluationTaskRun)
+ [Ação StartMLLabelingSetGenerationTaskRun (Python: start\$1ml\$1labeling\$1set\$1generation\$1task\$1run)](#aws-glue-api-machine-learning-api-StartMLLabelingSetGenerationTaskRun)
+ [Ação GetMLTaskRun (Python: get\$1ml\$1task\$1run)](#aws-glue-api-machine-learning-api-GetMLTaskRun)
+ [Ação GetMLTaskRuns (Python: get\$1ml\$1task\$1runs)](#aws-glue-api-machine-learning-api-GetMLTaskRuns)
+ [Ação CancelMLTaskRun (Python: cancel\$1ml\$1task\$1run)](#aws-glue-api-machine-learning-api-CancelMLTaskRun)
+ [Ação StartExportLabelsTaskRun (Python: start\$1export\$1labels\$1task\$1run)](#aws-glue-api-machine-learning-api-StartExportLabelsTaskRun)
+ [Ação StartImportLabelsTaskRun (Python: start\$1import\$1labels\$1task\$1run)](#aws-glue-api-machine-learning-api-StartImportLabelsTaskRun)

## Ação CreateMLTransform (Python: create\$1ml\$1transform)
<a name="aws-glue-api-machine-learning-api-CreateMLTransform"></a>

Cria uma transformação de machine learning do AWS Glue. Essa operação cria a transformação e todos os parâmetros necessários para treiná-la.

Chame esta operação como a primeira etapa no processo de usar uma transformação de machine learning (como a transformação `FindMatches`) para a desduplicação de dados. Você pode fornecer uma `Description`, adicional, além dos parâmetros que você quer usar para seu algoritmo.

Você também deve especificar determinados parâmetros para as tarefas que o AWS Glue executa em seu nome como parte do aprendizado com seus dados e para criação de uma transformação de machine learning de alta qualidade. Esses parâmetros incluem `Role` e, opcionalmente, `AllocatedCapacity`, `Timeout` e `MaxRetries`. Para obter mais informações, consulte [Tarefas](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html).

**Solicitaçã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 exclusivo que você atribui à transformação quando a cria.
+ `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 da transformação de machine learning que está sendo definida. O padrão é uma string vazia.
+ `InputRecordTables` - *obrigatório:* uma matriz de objetos [GlueTable](#aws-glue-api-machine-learning-api-GlueTable), não mais que dez estruturas.

  Uma lista de definições de tabela do AWS Glue usadas pela transformação.
+ `Parameters` – *Obrigatório:* um objeto [TransformParameters](#aws-glue-api-machine-learning-api-TransformParameters).

  Os parâmetros do algoritmo específicos para o tipo de transformação utilizado. Dependente condicionalmente do tipo de transformação.
+ `Role` – *Obrigatório:* string UTF-8.

  O nome ou o nome de recurso da Amazon (ARN) da função do IAM com as permissões necessárias. As permissões necessárias incluem as permissões de função de serviço do AWS Glue para recursos do AWS Glue e as permissões do Amazon S3 exigidas pela transformação. 
  + Essa função precisa de permissões de função de serviço do AWS Glue para conceder o acesso aos recursos no AWS Glue. Consulte [Anexar uma política aos usuários do IAM que acessam o AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html).
  + Essa função precisa de permissão para suas origens, seus destinos, seu diretório temporário, seus scripts e quaisquer bibliotecas do Amazon Simple Storage Service (Amazon S3) usadas pela execução de tarefa nessa transformação.
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Este valor determina com qual versão de AWS Glue essa transformação de machine learning é compatível. O Glue 1.0 é recomendado para a maioria dos clientes. Se o valor não for definido, a compatibilidade com o Glue 0.9 será definida como padrão. Para obter mais informações, consulte [Versões do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) no guia do desenvolvedor.
+ `MaxCapacity` – Número (duplo).

  O número de unidades de processamento de dados (DPUs) do AWS Glue alocadas para execuções de tarefas para essa transformação. Você pode alocar de 2 a 100 DPUs. O padrão é 10. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/). 

  `MaxCapacity` é uma opção mutuamente exclusiva com `NumberOfWorkers` e `WorkerType`.
  + Se `NumberOfWorkers` ou `WorkerType` estiver definido, `MaxCapacity` não poderá ser definido.
  + Se `MaxCapacity` estiver definido, nem `NumberOfWorkers` e nem `WorkerType` poderá ser definido.
  + Se `WorkerType` estiver definido, `NumberOfWorkers` será necessário (e vice-versa).
  + `MaxCapacity` e `NumberOfWorkers` devem ser pelo menos 1.

  Quando o campo `WorkerType` é definido como um valor diferente de `Standard`, o campo `MaxCapacity` é definido automaticamente e se torna somente leitura.

  Quando o campo `WorkerType` é definido como um valor diferente de `Standard`, o campo `MaxCapacity` é definido automaticamente e se torna somente leitura.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido que é alocado quando uma tarefa é executada. Aceita um valor de Standard (Padrão), G.1X ou G.2X.
  + Para o tipo de operador `Standard`, cada operador fornece 4 vCPU, 16 GB de memória e um disco de 50 GB e 2 executores por operador.
  + Para o tipo de operador `G.1X`, cada operador fornece 4 vCPU, 16 GB de memória e um disco e 64 GB, 1 executor por operador.
  + Para o tipo de operador `G.2X`, cada operador fornece 8 vCPU, 32 GB de memória e um disco de 128 GB e 1 executor por operador.

  `MaxCapacity` é uma opção mutuamente exclusiva com `NumberOfWorkers` e `WorkerType`.
  + Se `NumberOfWorkers` ou `WorkerType` estiver definido, `MaxCapacity` não poderá ser definido.
  + Se `MaxCapacity` estiver definido, nem `NumberOfWorkers` e nem `WorkerType` poderá ser definido.
  + Se `WorkerType` estiver definido, `NumberOfWorkers` será necessário (e vice-versa).
  + `MaxCapacity` e `NumberOfWorkers` devem ser pelo menos 1.
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de determinado `workerType` que são alocados quando uma tarefa é executada.

  Se `WorkerType` estiver definido, `NumberOfWorkers` será necessário (e vice-versa).
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite da execução de tarefa para essa transformação, em minutos. Esse é o tempo máximo durante o qual uma execução de tarefa para essa transformação pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. O padrão é 2.880 minutos (48 horas).
+ `MaxRetries` – Número (íntegro).

  O número máximo de vezes de novas tentativas dessa transformação após uma execução de tarefa falhar.
+ `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 a serem usadas com essa transformação de machine learning. É possível usar tags para limitar o acesso à transformação de machine learning. Para obter mais informações sobre tags no AWS Glue, consulte [Tags da AWS no AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) no guia do desenvolvedor.
+ `TransformEncryption` – Um objeto [TransformEncryption](#aws-glue-api-machine-learning-api-TransformEncryption).

  As configurações de criptografia em repouso da transformação que se aplicam ao acesso aos dados do usuário. As transformações de machine learning podem acessar dados do usuário criptografados no Amazon S3 usando o KMS.

**Resposta**
+ `TransformId` – 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 identificador exclusivo gerado para a transformação.

**Erros**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `AccessDeniedException`
+ `ResourceNumberLimitExceededException`
+ `IdempotentParameterMismatchException`

## Ação UpdateMLTransform (Python: update\$1ml\$1transform)
<a name="aws-glue-api-machine-learning-api-UpdateMLTransform"></a>

Atualiza uma transformação de machine learning existente. Chame esta operação para ajustar os parâmetros do algoritmo para atingir resultados melhores.

Depois de chamar essa operação, você pode chamar a operação `StartMLEvaluationTaskRun` para avaliar se os novos parâmetros alcançaram seus objetivos (como melhoria da qualidade da sua transformação de machine learning ou geração de um custo mais eficiente).

**Solicitação**
+ `TransformId`: *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).

  Um identificador exclusivo gerado quando a transformação foi criada.
+ `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 exclusivo que você atribuiu à transformação quando a criou.
+ `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 da transformação. O padrão é uma string vazia.
+ `Parameters` – Um objeto [TransformParameters](#aws-glue-api-machine-learning-api-TransformParameters).

  Os parâmetros de configuração específicos para o tipo de transformação (algoritmo) usado. Dependente condicionalmente do tipo de transformação.
+ `Role` – String UTF-8.

  O nome ou o nome de recurso da Amazon (ARN) da função do IAM com as permissões necessárias.
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Este valor determina com qual versão de AWS Glue essa transformação de machine learning é compatível. O Glue 1.0 é recomendado para a maioria dos clientes. Se o valor não for definido, a compatibilidade com o Glue 0.9 será definida como padrão. Para obter mais informações, consulte [Versões do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) no guia do desenvolvedor.
+ `MaxCapacity` – Número (duplo).

  O número de unidades de processamento de dados (DPUs) do AWS Glue alocadas para execuções de tarefas para essa transformação. Você pode alocar de 2 a 100 DPUs. O padrão é 10. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/). 

  Quando o campo `WorkerType` é definido como um valor diferente de `Standard`, o campo `MaxCapacity` é definido automaticamente e se torna somente leitura.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido que é alocado quando uma tarefa é executada. Aceita um valor de Standard (Padrão), G.1X ou G.2X.
  + Para o tipo de operador `Standard`, cada operador fornece 4 vCPU, 16 GB de memória e um disco de 50 GB e 2 executores por operador.
  + Para o tipo de operador `G.1X`, cada operador fornece 4 vCPU, 16 GB de memória e um disco e 64 GB, 1 executor por operador.
  + Para o tipo de operador `G.2X`, cada operador fornece 8 vCPU, 32 GB de memória e um disco de 128 GB e 1 executor por operador.
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de determinado `workerType` que são alocados quando uma tarefa é executada.
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite para uma tarefa executar essa transformação em minutos. Esse é o tempo máximo durante o qual uma execução de tarefa para essa transformação pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. O padrão é 2.880 minutos (48 horas).
+ `MaxRetries` – Número (íntegro).

  O número máximo de vezes de novas tentativas dessa transformação após uma execução de tarefa falhar.

**Resposta**
+ `TransformId` – 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 para a transformação que foi atualizada.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `AccessDeniedException`

## Ação DeleteMLTransform (Python: delete\$1ml\$1transform)
<a name="aws-glue-api-machine-learning-api-DeleteMLTransform"></a>

Exclui uma transformação de machine learning do AWS Glue. As transformações de machine learning são um tipo especial de transformação que usa machine learning para aprender os detalhes da transformação que será realizada pelo aprendizado com exemplos fornecidos por humanos. Essas transformações são então salvas pelo AWS Glue. Se você não precisar mais de uma transformação, pode excluí-la chamando `DeleteMLTransforms`. No entanto, qualquer trabalho do AWS Glue que ainda faça referência à transformação excluída não terá mais êxito.

**Solicitação**
+ `TransformId`: *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 identificador exclusivo da transformação que será excluída.

**Resposta**
+ `TransformId` – 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 transformação que foi excluída.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação GetMLTransform (Python: get\$1ml\$1transform)
<a name="aws-glue-api-machine-learning-api-GetMLTransform"></a>

Obtém um artefato de transformação de machine learning do AWS Glue e todos os seus metadados correspondentes. As transformações de machine learning são um tipo especial de transformação que usa machine learning para aprender os detalhes da transformação que será realizada pelo aprendizado com exemplos fornecidos por humanos. Essas transformações são então salvas pelo AWS Glue. Você pode recuperar os metadados chamando `GetMLTransform`.

**Solicitação**
+ `TransformId`: *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 identificador exclusivo da transformação, gerado no momento em que a transformação é criada.

**Resposta**
+ `TransformId` – 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 transformação, gerado no momento em que a transformação é criada.
+ `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 exclusivo atribuído à transformação quando ela foi criada.
+ `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 da transformação.
+ `Status` – string UTF-8 (valores válidos: `NOT_READY` \$1 `READY` \$1 `DELETING`).

  O último status conhecido da transformação (para indicar se pode ser usada ou não). Um dos "NOT\$1READY", "READY" ou "DELETING".
+ `CreatedOn` – Timestamp.

  A data e a hora em que a transformação foi criada.
+ `LastModifiedOn` – Timestamp.

  A data e a hora em que a transformação foi modificada pela última vez.
+ `InputRecordTables`: uma matriz de objetos [GlueTable](#aws-glue-api-machine-learning-api-GlueTable), não mais do que dez estruturas.

  Uma lista de definições de tabela do AWS Glue usadas pela transformação.
+ `Parameters` – Um objeto [TransformParameters](#aws-glue-api-machine-learning-api-TransformParameters).

  Os parâmetros de configuração específicos para o algoritmo usado.
+ `EvaluationMetrics` – Um objeto [EvaluationMetrics](#aws-glue-api-machine-learning-api-EvaluationMetrics).

  As métricas de avaliação mais recentes.
+ `LabelCount` – Número (íntegro).

  O número de rótulos disponíveis para essa transformação.
+ `Schema`: uma matriz de objetos [SchemaColumn](#aws-glue-api-machine-learning-api-SchemaColumn), não mais de 100 estruturas.

  O objeto `Map<Column, Type>` que representa o esquema aceito por essa transformação. Tem um limite superior de 100 colunas.
+ `Role` – String UTF-8.

  O nome ou o nome de recurso da Amazon (ARN) da função do IAM com as permissões necessárias.
+ `GlueVersion` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Este valor determina com qual versão de AWS Glue essa transformação de machine learning é compatível. O Glue 1.0 é recomendado para a maioria dos clientes. Se o valor não for definido, a compatibilidade com o Glue 0.9 será definida como padrão. Para obter mais informações, consulte [Versões do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) no guia do desenvolvedor.
+ `MaxCapacity` – Número (duplo).

  O número de unidades de processamento de dados (DPUs) do AWS Glue alocadas para execuções de tarefas para essa transformação. Você pode alocar de 2 a 100 DPUs. O padrão é 10. Uma DPU é uma medida relativa do poder de processamento que consiste em uma capacidade computacional de 4 vCPUs e 16 GB de memória. Para obter mais informações, consulte a [página de definição de preços do AWS Glue](https://aws.amazon.com/glue/pricing/). 

  Quando o campo `WorkerType` é definido como um valor diferente de `Standard`, o campo `MaxCapacity` é definido automaticamente e se torna somente leitura.
+ `WorkerType` – string UTF-8 (valores válidos: `Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`).

  O tipo de operador predefinido que é alocado quando uma tarefa é executada. Aceita um valor de Standard (Padrão), G.1X ou G.2X.
  + Para o tipo de operador `Standard`, cada operador fornece 4 vCPU, 16 GB de memória e um disco de 50 GB e 2 executores por operador.
  + Para o tipo de operador `G.1X`, cada operador fornece 4 vCPU, 16 GB de memória e um disco e 64 GB, 1 executor por operador.
  + Para o tipo de operador `G.2X`, cada operador fornece 8 vCPU, 32 GB de memória e um disco de 128 GB e 1 executor por operador.
+ `NumberOfWorkers` – Número (íntegro).

  O número de operadores de determinado `workerType` que são alocados quando uma tarefa é executada.
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite para uma tarefa executar essa transformação em minutos. Esse é o tempo máximo durante o qual uma execução de tarefa para essa transformação pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. O padrão é 2.880 minutos (48 horas).
+ `MaxRetries` – Número (íntegro).

  O número máximo de vezes de novas tentativas dessa transformação após uma execução de tarefa falhar.
+ `TransformEncryption` – Um objeto [TransformEncryption](#aws-glue-api-machine-learning-api-TransformEncryption).

  As configurações de criptografia em repouso da transformação que se aplicam ao acesso aos dados do usuário. As transformações de machine learning podem acessar dados do usuário criptografados no Amazon S3 usando o KMS.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação GetMLTransforms (Python: get\$1ml\$1transforms)
<a name="aws-glue-api-machine-learning-api-GetMLTransforms"></a>

Obtém uma lista filtrável e classificável de transformações de machine learning do AWS Glue existentes. As transformações de machine learning são um tipo especial de transformação que usa machine learning para aprender os detalhes da transformação que será realizada pelo aprendizado com exemplos fornecidos por humanos. Essas transformações são então salvas pelo AWS Glue e você pode recuperar os metadados delas chamando `GetMLTransforms`.

**Solicitação**
+ `NextToken` – String UTF-8.

  Um token paginado para equilibrar os resultados.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados.
+ `Filter` – Um objeto [TransformFilterCriteria](#aws-glue-api-machine-learning-api-TransformFilterCriteria).

  Os critérios da transformação de filtros
+ `Sort` – Um objeto [TransformSortCriteria](#aws-glue-api-machine-learning-api-TransformSortCriteria).

  Os critérios de classificação.

**Resposta**
+ `Transforms` – *Obrigatório:* uma matriz de objetos [MLTransform](#aws-glue-api-machine-learning-api-MLTransform).

  Uma lista de transformações de machine learning.
+ `NextToken` – String UTF-8.

  Um token de paginação, se houver mais resultados disponíveis.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação ListMLTransforms (Python: list\$1ml\$1transforms)
<a name="aws-glue-api-machine-learning-api-ListMLTransforms"></a>

 Recupera uma lista classificável e filtrável de transformações de machine learning do AWS Glue existentes nesta conta da AWS ou os recursos com a tag especificada. Essa operação aceita o campo `Tags` opcional, que pode ser usado como um filtro das respostas, para que recursos com tags possam ser recuperados como um grupo. Se você optar por usar a filtragem por tags, apenas os recursos com as tags serão recuperados. 

**Solicitação**
+ `NextToken` – String UTF-8.

  Um token de continuação, se esta for uma solicitação de continuação.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O tamanho máximo de uma lista a ser retornada.
+ `Filter` – Um objeto [TransformFilterCriteria](#aws-glue-api-machine-learning-api-TransformFilterCriteria).

  Os `TransformFilterCriteria` usados para filtrar as transformações de machine learning.
+ `Sort` – Um objeto [TransformSortCriteria](#aws-glue-api-machine-learning-api-TransformSortCriteria).

  Os `TransformSortCriteria` usados para classificar as transformações de machine learning.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do 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.

  Especifica apenas o retorno desses recursos com tags.

**Resposta**
+ `TransformIds`: *obrigatório:* uma matriz de strings UTF-8.

  Os identificadores de todas as transformações de machine learning na conta, ou as transformações de machine learning com as tags especificadas.
+ `NextToken` – String UTF-8.

  Um token de continuação, se a lista retornada não contiver a métrica mais recente disponível.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação StartMLEvaluationTaskRun (Python: start\$1ml\$1evaluation\$1task\$1run)
<a name="aws-glue-api-machine-learning-api-StartMLEvaluationTaskRun"></a>

Inicia uma tarefa para estimar a qualidade da transformação. 

Quando você fornece conjuntos de rótulos como exemplos de verdade, o machine learning do AWS Glue usa esses exemplos para aprender com eles. Os outros rótulos são usados como um teste para estimar a qualidade.

Retorna o identificador exclusivo da execução. Você pode chamar `GetMLTaskRun` para obter mais informações sobre as estatísticas de `EvaluationTaskRun`.

**Solicitação**
+ `TransformId`: *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 identificador exclusivo da transformação de machine learning.

**Resposta**
+ `TaskRunId` – 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 associado a essa execução.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ConcurrentRunsExceededException`
+ `MLTransformNotReadyException`

## Ação StartMLLabelingSetGenerationTaskRun (Python: start\$1ml\$1labeling\$1set\$1generation\$1task\$1run)
<a name="aws-glue-api-machine-learning-api-StartMLLabelingSetGenerationTaskRun"></a>

Inicia o fluxo de trabalho de aprendizado ativo da sua transformação de machine learning para melhorar a qualidade da transformação gerando conjuntos de dados e adicionando rótulos.

Quando `StartMLLabelingSetGenerationTaskRun` estiver concluído, o AWS Glue terá gerado um “conjunto de rótulos” ou um conjunto de questões para serem respondidas por humanos.

No caso da transformação `FindMatches`, essas perguntas são do tipo: "Qual é a maneira correta para agrupar essas linhas em grupos compostos inteiramente por registros correspondentes?" 

Depois que o processo de rotulação finalizar, você poderá fazer upload dos seus rótulos com uma chamada para `StartImportLabelsTaskRun`. Depois de `StartImportLabelsTaskRun` terminar, todas as execuções futuras da transformação de machine learning usarão os rótulos novos e melhorados para executar uma transformação de maior qualidade.

Observação: o perfil usado para gravar o conjunto de rótulos gerado no `OutputS3Path` é o perfil associado à transformação de machine learning, especificado na API `CreateMLTransform`.

**Solicitação**
+ `TransformId`: *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 identificador exclusivo da transformação de machine learning.
+ `OutputS3Path` – *Obrigatório:* string UTF-8.

  O caminho do Amazon Simple Storage Service (Amazon S3) de onde você gera o conjunto de rótulos.

**Resposta**
+ `TaskRunId` – 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 execução associado a essa execução de tarefa.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ConcurrentRunsExceededException`

## Ação GetMLTaskRun (Python: get\$1ml\$1task\$1run)
<a name="aws-glue-api-machine-learning-api-GetMLTaskRun"></a>

Obtém os detalhes de uma execução de tarefa em uma transformação de machine learning. As execuções de tarefas de machine learning são tarefas assíncronas executadas pelo AWS Glue em seu nome como parte de vários fluxos de trabalho de machine learning. Você pode verificar as estatísticas de qualquer execução de tarefa chamando `GetMLTaskRun` com o `TaskRunID` e o `TransformID` da sua transformação principal.

**Solicitação**
+ `TransformId`: *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 identificador exclusivo da transformação de machine learning.
+ `TaskRunId`: *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 identificador exclusivo da tarefa executada.

**Resposta**
+ `TransformId` – 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 tarefa executada.
+ `TaskRunId` – 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 de execução único associado a essa execução.
+ `Status` – string UTF-8 (valores válidos: `RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`).

  O status da execução dessa tarefa.
+ `LogGroupName` – String UTF-8.

  Os nomes dos grupos de logs associados à execução de tarefa.
+ `Properties` – Um objeto [TaskRunProperties](#aws-glue-api-machine-learning-api-TaskRunProperties).

  A lista de propriedades associadas à execução de tarefa.
+ `ErrorString` – String UTF-8.

  As strings de erro associadas à execução de tarefa.
+ `StartedOn` – Timestamp.

  A data e hora em que essa execução de tarefa foi iniciada.
+ `LastModifiedOn` – Timestamp.

  A data e hora em que essa execução de tarefa foi modificada pela última vez.
+ `CompletedOn` – Timestamp.

  A data e hora em que essa execução de tarefa foi finalizada.
+ `ExecutionTime` – Número (íntegro).

  A quantidade de tempo (em segundos) em que a tarefa executada consumiu recursos.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação GetMLTaskRuns (Python: get\$1ml\$1task\$1runs)
<a name="aws-glue-api-machine-learning-api-GetMLTaskRuns"></a>

Obtém uma lista de execuções para a transformação de machine learning. As execuções de tarefas de machine learning são tarefas assíncronas executadas pelo AWS Glue em seu nome como parte de vários fluxos de trabalho de machine learning. Você pode obter uma lista de execuções de tarefa de machine learning filtrável e classificável chamando `GetMLTaskRuns` com o `TransformID` da transformação principal e outros parâmetros opcionais conforme documentados nesta seção.

Essa operação retorna uma lista com de execuções históricas e deve ser paginada.

**Solicitação**
+ `TransformId`: *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 identificador exclusivo da transformação de machine learning.
+ `NextToken` – String UTF-8.

  Um token de paginação dos resultados. O padrão é vazio.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados. 
+ `Filter` – Um objeto [TaskRunFilterCriteria](#aws-glue-api-machine-learning-api-TaskRunFilterCriteria).

  Os critérios de filtro, na estrutura `TaskRunFilterCriteria`, da execução de tarefa.
+ `Sort` – Um objeto [TaskRunSortCriteria](#aws-glue-api-machine-learning-api-TaskRunSortCriteria).

  Os critérios de classificação, na estrutura `TaskRunSortCriteria`, da execução de tarefa.

**Resposta**
+ `TaskRuns`: um array de objetos [TaskRun](#aws-glue-api-machine-learning-api-TaskRun).

  Uma lista de execuções de tarefa que são associadas a transformação.
+ `NextToken` – String UTF-8.

  Um token de paginação, se houver mais resultados disponíveis.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação CancelMLTaskRun (Python: cancel\$1ml\$1task\$1run)
<a name="aws-glue-api-machine-learning-api-CancelMLTaskRun"></a>

Cancela (interrompe) a execução de uma tarefa. As execuções de tarefas de machine learning são tarefas assíncronas executadas pelo AWS Glue em seu nome como parte de vários fluxos de trabalho de machine learning. Você pode cancelar uma execução de tarefa de machine learning a qualquer momento chamando `CancelMLTaskRun` com um `TransformID` de transformação principal da execução de tarefa e o `TaskRunId` da execução de tarefa. 

**Solicitação**
+ `TransformId`: *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 identificador exclusivo da transformação de machine learning.
+ `TaskRunId`: *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).

  Um identificador exclusivo para a tarefa executada.

**Resposta**
+ `TransformId` – 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 transformação de machine learning.
+ `TaskRunId` – 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 tarefa executada.
+ `Status` – string UTF-8 (valores válidos: `RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`).

  O status dessa execução.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação StartExportLabelsTaskRun (Python: start\$1export\$1labels\$1task\$1run)
<a name="aws-glue-api-machine-learning-api-StartExportLabelsTaskRun"></a>

Inicia uma tarefa assíncrona para exportar todos os dados rotulados para uma determinada transformação. Essa tarefa é a única chamada de API relacionada ao rótulo e não faz parte do fluxo de trabalho típico de aprendizado ativo. Normalmente, você usa `StartExportLabelsTaskRun` quando quer trabalhar com todos os rótulos existentes ao mesmo tempo, por exemplo, quando deseja excluir ou alterar rótulos que foram enviados como verdade anteriormente. Esta operação de API aceita o `TransformId` do qual você deseja exportar rótulos e um caminho do Amazon Simple Storage Service (Amazon S3) para onde exportá-los. A operação retorna um `TaskRunId`. Você pode verificar o status da sua tarefa chamando a API `GetMLTaskRun`.

**Solicitação**
+ `TransformId`: *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 identificador exclusivo da transformação de machine learning.
+ `OutputS3Path` – *Obrigatório:* string UTF-8.

  O caminho do Amazon S3 para onde você exportará os rótulos.

**Resposta**
+ `TaskRunId` – 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 tarefa executada.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação StartImportLabelsTaskRun (Python: start\$1import\$1labels\$1task\$1run)
<a name="aws-glue-api-machine-learning-api-StartImportLabelsTaskRun"></a>

Permite que você forneça rótulos adicionais (exemplos de verdade) para serem usados no ensino da transformação de machine learning e na melhoria da qualidade. Essa operação de API é geralmente usada como parte do fluxo de aprendizagem ativo que começa com a chamada `StartMLLabelingSetGenerationTaskRun` e que, em última análise, resulta em melhorar a qualidade da sua transformação de machine learning. 

Quando `StartMLLabelingSetGenerationTaskRun` terminar, o machine learning do AWS Glue terá gerado várias questões para serem respondidas por humanos. (Responder a essas perguntas é muitas vezes chamado de ''rotulamento'' nos fluxos de machine learning). No caso da transformação `FindMatches`, essas perguntas são do tipo: "Qual é a maneira correta para agrupar essas linhas em grupos compostos inteiramente por registros correspondentes?" Após o término do processo de rotulamento, os usuários carregam suas respostas/rótulos com uma chamada para `StartImportLabelsTaskRun`. Depois que `StartImportLabelsTaskRun` terminar, todas as execuções futuras da transformação de machine learning usarão os rótulos novos e melhorados para executar uma transformação de maior qualidade.

Por padrão, `StartMLLabelingSetGenerationTaskRun` aprende continuamente e combina todos os rótulos do seu upload, a não ser que você defina `Replace` como true. Se você definir `Replace` como true, `StartImportLabelsTaskRun` exclui e esquece todos os rótulos previamente submetidos e aprende somente com o conjunto exato que você carregar. Substituir rótulos pode ser útil se você perceber que fez um upload incorreto de rótulos anteriormente e acredita que eles estão causando um efeito negativo na qualidade da transformação.

Você pode verificar o status da sua execução de tarefa chamando a operação `GetMLTaskRun`. 

**Solicitação**
+ `TransformId`: *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 identificador exclusivo da transformação de machine learning.
+ `InputS3Path` – *Obrigatório:* string UTF-8.

  O caminho do Amazon Simple Storage Service (Amazon S3) para onde você importará os rótulos.
+ `ReplaceAllLabels` – Booleano.

  Indica se você deve substituir os rótulos existentes.

**Resposta**
+ `TaskRunId` – 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 tarefa executada.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`

# API Data Quality API
<a name="aws-glue-api-data-quality-api"></a>

A API Data Quality descreve os tipos de dados de qualidade dos dados e inclui a API para criar, excluir ou atualizar conjuntos de dados, execuções e avaliações de qualidade de dados.

## Tipos de dados
<a name="aws-glue-api-data-quality-api-objects"></a>
+ [Estrutura DataSource](#aws-glue-api-data-quality-api-DataSource)
+ [Estrutura DataQualityRulesetListDetails](#aws-glue-api-data-quality-api-DataQualityRulesetListDetails)
+ [Estrutura DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable)
+ [Estrutura DataQualityRulesetEvaluationRunDescription](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription)
+ [Estrutura DataQualityRulesetEvaluationRunFilter](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter)
+ [Estrutura DataQualityEvaluationRunAdditionalRunOptions](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions)
+ [Estrutura DataQualityRuleRecommendationRunDescription](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription)
+ [Estrutura DataQualityRuleRecommendationRunFilter](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter)
+ [Estrutura DataQualityResult](#aws-glue-api-data-quality-api-DataQualityResult)
+ [Estrutura DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult)
+ [Estrutura DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation)
+ [Estrutura MetricBasedObservation](#aws-glue-api-data-quality-api-MetricBasedObservation)
+ [Estrutura DataQualityMetricValues](#aws-glue-api-data-quality-api-DataQualityMetricValues)
+ [Estrutura DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult)
+ [Estrutura DataQualityResultDescription](#aws-glue-api-data-quality-api-DataQualityResultDescription)
+ [Estrutura DataQualityResultFilterCriteria](#aws-glue-api-data-quality-api-DataQualityResultFilterCriteria)
+ [Estrutura DataQualityRulesetFilterCriteria](#aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria)
+ [Estrutura DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics)
+ [Estrutura StatisticAnotation](#aws-glue-api-data-quality-api-StatisticAnnotation)
+ [Estrutura TimestampedInclusionAnnotation](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation)
+ [Estrutura AnnotationError](#aws-glue-api-data-quality-api-AnnotationError)
+ [Estrutura DatapointInclusionAnnotation](#aws-glue-api-data-quality-api-DatapointInclusionAnnotation)
+ [Lista StatisticSummaryList](#aws-glue-api-data-quality-api-StatisticSummaryList)
+ [Estrutura StatisticSummary](#aws-glue-api-data-quality-api-StatisticSummary)
+ [Estrutura RunIdentifier](#aws-glue-api-data-quality-api-RunIdentifier)
+ [Estrutura StatisticModelResult](#aws-glue-api-data-quality-api-StatisticModelResult)
+ [Estrutura DataQualityGlueTable](#aws-glue-api-data-quality-api-DataQualityGlueTable)

## Estrutura DataSource
<a name="aws-glue-api-data-quality-api-DataSource"></a>

Uma fonte de dados (uma tabela do AWS Glue) para a qual você deseja resultados de qualidade de dados.

**Campos**
+ `GlueTable` – Um objeto [GlueTable](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GlueTable).

  Uma tabela do AWS Glue.
+ `DataQualityGlueTable` – Um objeto [DataQualityGlueTable](#aws-glue-api-data-quality-api-DataQualityGlueTable).

  Uma tabela AWS Glue para operações de qualidade de dados.

## Estrutura DataQualityRulesetListDetails
<a name="aws-glue-api-data-quality-api-DataQualityRulesetListDetails"></a>

Descreve um conjunto de regras de qualidade de dados retornado por `GetDataQualityRuleset`.

**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 do conjunto de regras de qualidade de dados.
+ `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 conjunto de regras de qualidade de dados.
+ `CreatedOn` – Timestamp.

  A data e hora da criação do conjunto de regras de qualidade de dados.
+ `LastModifiedOn` – Timestamp.

  A data e hora da modificação do conjunto de regras de qualidade de dados.
+ `TargetTable` – Um objeto [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable).

  Um objeto que representa uma tabela do AWS Glue.
+ `RecommendationRunId` – 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).

  Quando um conjunto de regras foi criado de execução de uma recomendação, esse ID de execução é gerado para vincular os dois.
+ `RuleCount` – Número (íntegro).

  O número de regras no conjunto de regras.

## Estrutura DataQualityTargetTable
<a name="aws-glue-api-data-quality-api-DataQualityTargetTable"></a>

Um objeto que representa uma tabela do AWS Glue.

**Campos**
+ `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 AWS Glue.
+ `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 em que a tabela do AWS Glue existe.
+ `CatalogId` – 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 do catálogo onde a tabela AWS Glue se encontra.

## Estrutura DataQualityRulesetEvaluationRunDescription
<a name="aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription"></a>

Descreve o resultado da avaliação de um conjunto de regras de qualidade de dados.

**Campos**
+ `RunId` – 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 de execução único associado a essa execução.
+ `Status` – String UTF-8 (valores válidos: `RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`).

  O status dessa execução.
+ `StartedOn` – Timestamp.

  A data e a hora de início da execução.
+ `DataSource` – Um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  A fonte de dados (uma tabela do AWS Glue) associada à execução.

## Estrutura DataQualityRulesetEvaluationRunFilter
<a name="aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter"></a>

Os critérios de filtro.

**Campos**
+ `DataSource` – *Obrigatório:* um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  Filtrar com base em uma fonte de dados (uma tabela do AWS Glue) associada à execução.
+ `StartedBefore` – Timestamp.

  Filtrar os resultados por execuções iniciadas antes desse horário.
+ `StartedAfter` – Timestamp.

  Filtrar os resultados por execuções iniciadas depois desse horário.

## Estrutura DataQualityEvaluationRunAdditionalRunOptions
<a name="aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions"></a>

Opções adicionais de execução que você pode especificar para uma execução de avaliação.

**Campos**
+ `CloudWatchMetricsEnabled` – Booleano.

  Se as métricas do CloudWatch devem ou não ser habilitadas.
+ `ResultsS3Prefix` – String UTF-8.

  Prefixo para o Amazon S3 para armazenar resultados.
+ `CompositeRuleEvaluationMethod`: string UTF-8 (valores válidos: `COLUMN` \$1 `ROW`).

  Definir o método de avaliação para regras compostas no conjunto de regras como ROW/COLUMN

## Estrutura DataQualityRuleRecommendationRunDescription
<a name="aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription"></a>

Descreve o resultado da avaliação de uma recomendação de regra de qualidade de dados.

**Campos**
+ `RunId` – 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 de execução único associado a essa execução.
+ `Status` – String UTF-8 (valores válidos: `RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`).

  O status dessa execução.
+ `StartedOn` – Timestamp.

  A data e hora em que essa execução foi iniciada.
+ `DataSource` – Um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  A fonte de dados (uma tabela do AWS Glue) associada à execução da recomendação.

## Estrutura DataQualityRuleRecommendationRunFilter
<a name="aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter"></a>

Um filtro para listar as execuções de recomendação de qualidade de dados.

**Campos**
+ `DataSource` – *Obrigatório:* um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  Filtrar com base em uma fonte de dados especificada (tabela do AWS Glue).
+ `StartedBefore` – Timestamp.

  Filtrar com base na hora dos resultados iniciados antes do horário fornecido.
+ `StartedAfter` – Timestamp.

  Filtrar com base na hora dos resultados iniciados depois do horário fornecido.

## Estrutura DataQualityResult
<a name="aws-glue-api-data-quality-api-DataQualityResult"></a>

Descreve um resultado de qualidade de dados.

**Campos**
+ `ResultId` – 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 ID de resultado exclusivo para o resultado de qualidade dos dados.
+ `ProfileId` – 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 do perfil para o resultado de qualidade dos dados.
+ `Score`: número (double), no máximo 1,0.

  Uma pontuação de qualidade de dados agregada. Representa a razão de regras que foram aproadas para o número total de regras.
+ `DataSource` – Um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  A tabela associada ao resultado de qualidade dos dados, se houver.
+ `RulesetName` – 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 conjunto de regras associado ao resultado de qualidade de dados.
+ `EvaluationContext` – String UTF-8.

  No contexto de um trabalho no AWS Glue Studio, cada nó na tela normalmente recebe algum tipo de nome e os nós de qualidade de dados terão nomes. No caso de vários nós, o `evaluationContext` pode diferenciar os nós.
+ `StartedOn` – Timestamp.

  A data e hora de início dessa execução de qualidade de dados.
+ `CompletedOn` – Timestamp.

  A data e hora de conclusão dessa execução de qualidade de dados.
+ `JobName` – 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 trabalho associado ao resultado de qualidade dos dados, se houver.
+ `JobRunId` – 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 de execução de trabalho associado ao resultado de qualidade dos dados, se houver.
+ `RulesetEvaluationRunId` – 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 de execução exclusivo para a avaliação do conjunto de regras para esse resultado de qualidade de dados.
+ `RuleResults`: uma matriz de objetos [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult), não mais de 2.000 estruturas.

  Uma lista de objetos do `DataQualityRuleResult` representando os resultados de cada regra. 
+ `AnalyzerResults`: uma matriz de objetos [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult), não mais de 2.000 estruturas.

  Uma lista de objetos `DataQualityAnalyzerResult` representando os resultados de cada analisador. 
+ `Observations` – Uma matriz de [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation) objetos, não mais de 50 estruturas.

  Uma lista de objetos `DataQualityObservation` representando as observações geradas após a avaliação das regras e dos analisadores. 
+ `AggregatedMetrics` – Um objeto [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics).

   Um resumo dos objetos `DataQualityAggregatedMetrics` mostrando as contagens totais de linhas e regras processadas, incluindo suas estatísticas de aprovação/reprovação com base nos resultados no nível de linha. 

## Estrutura DataQualityAnalyzerResult
<a name="aws-glue-api-data-quality-api-DataQualityAnalyzerResult"></a>

Descreve o resultado da avaliação de um analisador de qualidade 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 do analisador de qualidade de dados.
+ `Description`: string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma descrição do analisador de qualidade de dados.
+ `EvaluationMessage`: string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma mensagem de avaliação.
+ `EvaluatedMetrics` – 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 número (duplo).

  Um mapa das métricas associadas à avaliação do analisador.

## Estrutura DataQualityObservation
<a name="aws-glue-api-data-quality-api-DataQualityObservation"></a>

Descreve a observação gerada após a avaliação das regras e dos analisadores.

**Campos**
+ `Description`: string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma descrição da observação de qualidade de dados.
+ `MetricBasedObservation` – Um objeto [MetricBasedObservation](#aws-glue-api-data-quality-api-MetricBasedObservation).

  Um objeto do tipo `MetricBasedObservation` que representa a observação com base nas métricas de qualidade de dados avaliadas.

## Estrutura MetricBasedObservation
<a name="aws-glue-api-data-quality-api-MetricBasedObservation"></a>

Descreve a observação baseada em métricas gerada com base nas métricas de qualidade de dados avaliadas.

**Campos**
+ `MetricName` – 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 métrica de qualidade de dados usada para gerar a observação.
+ `StatisticId` – 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 estatística.
+ `MetricValues` – Um objeto [DataQualityMetricValues](#aws-glue-api-data-quality-api-DataQualityMetricValues).

  Um objeto do tipo `DataQualityMetricValues` que representa a análise do valor da métrica de qualidade de dados.
+ `NewRules` – Uma matriz de strings UTF-8.

  Uma lista de novas regras de qualidade de dados geradas como parte da observação com base no valor da métrica de qualidade de dados.

## Estrutura DataQualityMetricValues
<a name="aws-glue-api-data-quality-api-DataQualityMetricValues"></a>

Descreve o valor da métrica de qualidade de dados de acordo com a análise de dados históricos.

**Campos**
+ `ActualValue` – Número (duplo).

  O valor real da métrica de qualidade de dados.
+ `ExpectedValue` – Número (duplo).

  O valor esperado da métrica de qualidade de dados de acordo com a análise de dados históricos.
+ `LowerLimit` – Número (duplo).

  O limite inferior do valor da métrica de qualidade de dados de acordo com a análise de dados históricos.
+ `UpperLimit` – Número (duplo).

  O limite superior do valor da métrica de qualidade de dados de acordo com a análise de dados históricos.

## Estrutura DataQualityRuleResult
<a name="aws-glue-api-data-quality-api-DataQualityRuleResult"></a>

Descreve o resultado da avaliação de uma regra de qualidade 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 regra de qualidade de dados.
+ `Description`: string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma descrição da regras de qualidade de dados.
+ `EvaluationMessage`: string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma mensagem de avaliação.
+ `Result` – String UTF-8 (valores válidos: `PASS` \$1 `FAIL` \$1 `ERROR`).

  Um status de aprovação ou reprovação da regra.
+ `EvaluatedMetrics` – 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 número (duplo).

  Um mapa das métricas associadas à avaliação da regra.
+ `EvaluatedRule`: string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  A regra avaliada.
+ `RuleMetrics` – 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 número (duplo).

  Um mapa contendo métricas associadas à avaliação da regra com base nos resultados no nível de linha. 

## Estrutura DataQualityResultDescription
<a name="aws-glue-api-data-quality-api-DataQualityResultDescription"></a>

Descreve um resultado de qualidade de dados.

**Campos**
+ `ResultId` – 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 de resultado exclusivo para esse resultado de qualidade dos dados.
+ `DataSource` – Um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  O nome da tabela associada ao resultado de qualidade dos dados.
+ `JobName` – 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 trabalho associado ao resultado de qualidade dos dados.
+ `JobRunId` – 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 de execução de trabalho associado ao resultado de qualidade dos dados.
+ `StartedOn` – Timestamp.

  A hora de início da execução desse resultado de qualidade de dados.

## Estrutura DataQualityResultFilterCriteria
<a name="aws-glue-api-data-quality-api-DataQualityResultFilterCriteria"></a>

Critérios usados para retornar resultados de qualidade de dados.

**Campos**
+ `DataSource` – Um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  Filtrar os resultados pela fonte de dados especificada. Por exemplo, recuperar todos os resultados de uma tabela do AWS Glue.
+ `JobName` – 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).

  Filtrar os resultados pelo nome de trabalho especificado.
+ `JobRunId` – 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).

  Filtrar os resultados pelo ID e execução de trabalho especificado.
+ `StartedAfter` – Timestamp.

  Filtrar os resultados por execuções iniciadas depois desse horário.
+ `StartedBefore` – Timestamp.

  Filtrar os resultados por execuções iniciadas antes desse horário.

## Estrutura DataQualityRulesetFilterCriteria
<a name="aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria"></a>

Os critérios usados para filtrar conjuntos de regras de qualidade 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 dos critérios de filtro do conjunto de regras.
+ `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 dos critérios de filtro do conjunto de regras.
+ `CreatedBefore` – Timestamp.

  Filtrar por conjuntos de regras criados antes dessa data.
+ `CreatedAfter` – Timestamp.

  Filtrar por conjuntos de regras criados depois dessa data.
+ `LastModifiedBefore` – Timestamp.

  Filtrar por conjuntos de dados modificados antes dessa data.
+ `LastModifiedAfter` – Timestamp.

  Filtrar por conjuntos de dados modificados depois dessa data.
+ `TargetTable` – Um objeto [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable).

  O nome e o nome do banco de dados da tabela de destino.

## Estrutura DataQualityAggregatedMetrics
<a name="aws-glue-api-data-quality-api-DataQualityAggregatedMetrics"></a>

Um resumo de métricas mostrando as contagens totais de linhas e regras processadas, incluindo suas estatísticas de aprovação/reprovação com base nos resultados no nível de linha.

**Campos**
+ `TotalRowsProcessed` – Número (duplo).

  O número total de linhas que foram processadas durante a avaliação da qualidade dos dados.
+ `TotalRowsPassed` – Número (duplo).

  O número total de linhas que passaram por todas as regras aplicáveis de qualidade de dados.
+ `TotalRowsFailed` – Número (duplo).

  O número total de linhas que falharam em uma ou mais regras de qualidade de dados.
+ `TotalRulesProcessed` – Número (duplo).

  O número total de regras de qualidade de dados que foram avaliadas.
+ `TotalRulesPassed` – Número (duplo).

  O número total de regras de qualidade de dados que foram aprovadas em seus critérios de avaliação.
+ `TotalRulesFailed` – Número (duplo).

  O número total de regras de qualidade de dados que foram reprovadas em seus critérios de avaliação.

## Estrutura StatisticAnotation
<a name="aws-glue-api-data-quality-api-StatisticAnnotation"></a>

Uma anotação estatística.

**Campos**
+ `ProfileId` – 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 do perfil.
+ `StatisticId` – 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 estatística.
+ `StatisticRecordedOn` – Timestamp.

  O carimbo de data e hora de quando a estatística anotada foi registrada.
+ `InclusionAnnotation` – Um objeto [TimestampedInclusionAnnotation](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation).

  A anotação de inclusão aplicada à estatística.

## Estrutura TimestampedInclusionAnnotation
<a name="aws-glue-api-data-quality-api-TimestampedInclusionAnnotation"></a>

Uma anotação de inclusão com data e hora.

**Campos**
+ `Value`: string UTF-8 (valores válidos: `INCLUDE` \$1 `EXCLUDE`).

  O valor da anotação de inclusão.
+ `LastModifiedOn` – Timestamp.

  O carimbo de data e hora da última modificação da anotação de inclusão.

## Estrutura AnnotationError
<a name="aws-glue-api-data-quality-api-AnnotationError"></a>

Uma anotação com falha.

**Campos**
+ `ProfileId` – 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 do perfil da anotação com falha.
+ `StatisticId` – 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 estatística da anotação com falha.
+ `FailureReason`: 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).

  O motivo pelo qual a anotação falhou.

## Estrutura DatapointInclusionAnnotation
<a name="aws-glue-api-data-quality-api-DatapointInclusionAnnotation"></a>

Uma anotação de inclusão.

**Campos**
+ `ProfileId` – 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 do perfil de qualidade de dados ao qual a estatística pertence.
+ `StatisticId` – 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 estatística.
+ `InclusionAnnotation`: string UTF-8 (valores válidos: `INCLUDE` \$1 `EXCLUDE`).

  O valor da anotação de inclusão a ser aplicado à estatística.

## Lista StatisticSummaryList
<a name="aws-glue-api-data-quality-api-StatisticSummaryList"></a>

Uma lista de `StatisticSummary`.

Uma matriz de objetos [StatisticSummary](#aws-glue-api-data-quality-api-StatisticSummary).

Uma lista de `StatisticSummary`.

## Estrutura StatisticSummary
<a name="aws-glue-api-data-quality-api-StatisticSummary"></a>

Informações resumidas sobre uma estatística.

**Campos**
+ `StatisticId` – 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 estatística.
+ `ProfileId` – 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 do perfil.
+ `RunIdentifier` – Um objeto [RunIdentifier](#aws-glue-api-data-quality-api-RunIdentifier).

  O identificador da execução.
+ `StatisticName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #16](aws-glue-api-common.md#regex_16).

  O nome da estatística.
+ `DoubleValue` – Número (duplo).

  O valor da estatística.
+ `EvaluationLevel` – String UTF-8 (valores válidos: `Dataset="DATASET"` \$1 `Column="COLUMN"` \$1 `Multicolumn="MULTICOLUMN"`).

  O nível de avaliação da estatística. Valores possíveis: `Dataset`, `Column`, `Multicolumn`.
+ `ColumnsReferenced` – Uma matriz de strings UTF-8.

  A lista de colunas referenciadas pela estatística.
+ `ReferencedDatasets` – Uma matriz de strings UTF-8.

  A lista de conjuntos de dados referenciados pela estatística.
+ `StatisticProperties` – 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 é uma string de descrição, com não mais de 2048 de comprimento, correspondo a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma `StatisticPropertiesMap`, que contém uma `NameString` e uma `DescriptionString`
+ `RecordedOn` – Timestamp.

  O carimbo de data e hora de quando a estatística foi registrada.
+ `InclusionAnnotation` – Um objeto [TimestampedInclusionAnnotation](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation).

  A anotação de inclusão da estatística.

## Estrutura RunIdentifier
<a name="aws-glue-api-data-quality-api-RunIdentifier"></a>

Um identificador de execução.

**Campos**
+ `RunId` – 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 execução.
+ `JobRunId` – 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 execução do trabalho.

## Estrutura StatisticModelResult
<a name="aws-glue-api-data-quality-api-StatisticModelResult"></a>

O resultado do modelo estatístico.

**Campos**
+ `LowerBound` – Número (duplo).

  O limite inferior.
+ `UpperBound` – Número (duplo).

  O limite superior.
+ `PredictedValue` – Número (duplo).

  O valor previsto
+ `ActualValue` – Número (duplo).

  O valor real.
+ `Date` – Timestamp.

  A data.
+ `InclusionAnnotation`: string UTF-8 (valores válidos: `INCLUDE` \$1 `EXCLUDE`).

  A anotação de inclusão.

## Estrutura DataQualityGlueTable
<a name="aws-glue-api-data-quality-api-DataQualityGlueTable"></a>

O banco de dados e a tabela no AWS Glue Data Catalog usados para os dados de entrada ou saída em operações de qualidade de dados.

**Campos**
+ `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 AWS Glue Data Catalog.
+ `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 no AWS Glue Data Catalog.
+ `CatalogId` – 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 identificador exclusivo para o AWS Glue Data Catalog.
+ `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 AWS Glue Data Catalog.
+ `AdditionalOptions`: uma matriz de mapas de pares chave-valor, não menos que 1 o não mais que 10 pares.

  Cada chave é uma string UTF-8, com comprimento entre 1 e 255 bytes, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Cada valor é uma string de descrição, com não mais de 2048 de comprimento, correspondo a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Opções adicionais para a tabela. Atualmente, duas chaves são compatíveis:
  + `pushDownPredicate`: para filtrar por partições sem a necessidade de listar e ler todos os arquivos do conjunto de dados.
  + `catalogPartitionPredicate`: para usar a remoção de partições do lado do servidor usando índices de partição no AWS Glue Data Catalog.
+ `PreProcessingQuery`: string UTF-8 com no máximo 51.200 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Consulta SQL do formato SparkSQL que pode ser usada para pré-processar os dados da tabela AWS Glue Data Catalog antes da execução da operação de qualidade de dados.

## Operações
<a name="aws-glue-api-data-quality-api-actions"></a>
+ [Ação StartDataQualityRulesetEvaluationRun (Python: start\$1data\$1quality\$1ruleset\$1evaluation\$1run)](#aws-glue-api-data-quality-api-StartDataQualityRulesetEvaluationRun)
+ [Ação CancelDataQualityRulesetEvaluationRun (Python: cancel\$1data\$1quality\$1ruleset\$1evaluation\$1run)](#aws-glue-api-data-quality-api-CancelDataQualityRulesetEvaluationRun)
+ [Ação GetDataQualityRulesetEvaluationRun (Python: get\$1data\$1quality\$1ruleset\$1evaluation\$1run)](#aws-glue-api-data-quality-api-GetDataQualityRulesetEvaluationRun)
+ [Ação ListDataQualityRulesetEvaluationRuns (Python: list\$1data\$1quality\$1ruleset\$1evaluation\$1runs)](#aws-glue-api-data-quality-api-ListDataQualityRulesetEvaluationRuns)
+ [Ação StartDataQualityRuleRecommendationRun (Python: start\$1data\$1quality\$1rule\$1recommendation\$1run)](#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRun)
+ [Ação CancelDataQualityRuleRecommendationRun (Python: cancel\$1data\$1quality\$1rule\$1recommendation\$1run)](#aws-glue-api-data-quality-api-CancelDataQualityRuleRecommendationRun)
+ [Ação GetDataQualityRuleRecommendationRun (Python: get\$1data\$1quality\$1rule\$1recommendation\$1run)](#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRun)
+ [Ação ListDataQualityRuleRecommendationRuns (Python: list\$1data\$1quality\$1rule\$1recommendation\$1runs)](#aws-glue-api-data-quality-api-ListDataQualityRuleRecommendationRuns)
+ [Ação GetDataQualityResult (Python: get\$1data\$1quality\$1result)](#aws-glue-api-data-quality-api-GetDataQualityResult)
+ [Ação BatchGetDataQualityResult (Python: batch\$1get\$1data\$1quality\$1result)](#aws-glue-api-data-quality-api-BatchGetDataQualityResult)
+ [Ação ListDataQualityResults (Python: list\$1data\$1quality\$1results)](#aws-glue-api-data-quality-api-ListDataQualityResults)
+ [Ação CreateDataQualityRuleset (Python: create\$1data\$1quality\$1ruleset)](#aws-glue-api-data-quality-api-CreateDataQualityRuleset)
+ [Ação DeleteDataQualityRuleset (Python: delete\$1data\$1quality\$1ruleset)](#aws-glue-api-data-quality-api-DeleteDataQualityRuleset)
+ [Ação GetDataQualityRuleset (Python: get\$1data\$1quality\$1ruleset)](#aws-glue-api-data-quality-api-GetDataQualityRuleset)
+ [Ação ListDataQualityRulesets (Python: list\$1data\$1quality\$1rulesets)](#aws-glue-api-data-quality-api-ListDataQualityRulesets)
+ [Ação UpdateDataQualityRuleset (Python: update\$1data\$1quality\$1ruleset)](#aws-glue-api-data-quality-api-UpdateDataQualityRuleset)
+ [Ação ListDataQualityStatistics (Python: list\$1data\$1quality\$1statistics)](#aws-glue-api-data-quality-api-ListDataQualityStatistics)
+ [Estrutura TimestampFilter](#aws-glue-api-data-quality-api-TimestampFilter)
+ [Estrutura CreateDataQualityRulesetRequest](#aws-glue-api-data-quality-api-CreateDataQualityRulesetRequest)
+ [Estrutura GetDataQualityRulesetResponse](#aws-glue-api-data-quality-api-GetDataQualityRulesetResponse)
+ [Estrutura GetDataQualityResultResponse](#aws-glue-api-data-quality-api-GetDataQualityResultResponse)
+ [Estrutura StartDataQualityRuleRecommendationRunRequest](#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRunRequest)
+ [Estrutura GetDataQualityRuleRecommendationRunResponse](#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRunResponse)
+ [Ação BatchPutDataQualityStatisticAnnotation (Python: batch\$1put\$1data\$1quality\$1statistic\$1annotation)](#aws-glue-api-data-quality-api-BatchPutDataQualityStatisticAnnotation)
+ [Ação GetDataQualityModel (Python: get\$1data\$1quality\$1model)](#aws-glue-api-data-quality-api-GetDataQualityModel)
+ [Ação GetDataQualityModelResult (Python: get\$1data\$1quality\$1model\$1result)](#aws-glue-api-data-quality-api-GetDataQualityModelResult)
+ [Ação ListDataQualityStatisticAnnotations (Python: list\$1data\$1quality\$1statistic\$1annotations)](#aws-glue-api-data-quality-api-ListDataQualityStatisticAnnotations)
+ [Ação PutDataQualityProfileAnnotation (Python: put\$1data\$1quality\$1profile\$1annotation)](#aws-glue-api-data-quality-api-PutDataQualityProfileAnnotation)

## Ação StartDataQualityRulesetEvaluationRun (Python: start\$1data\$1quality\$1ruleset\$1evaluation\$1run)
<a name="aws-glue-api-data-quality-api-StartDataQualityRulesetEvaluationRun"></a>

Depois que você tem uma definição de conjunto de regras (recomendado ou seu própria conjunto), você chama essa operação para avaliar o conjunto de regras em relação a uma fonte de dados (tabela do AWS Glue). A avaliação calcula os resultados que você pode recuperar com a API `GetDataQualityResult`.

**Solicitação**
+ `DataSource` – *Obrigatório:* um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  A fonte de dados (uma tabela do AWS Glue) associada a essa execução.
+ `Role` – *Obrigatório:* string UTF-8.

  Um perfil do IAM fornecido para criptografar os resultados da execução.
+ `NumberOfWorkers` – Número (íntegro).

  O número de processadores do `G.1X` a serem usados na execução. O padrão é 5.
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite em minutos para uma execução. Esse é o tempo máximo durante o qual uma execução pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. O padrão é 2.880 minutos (48 horas).
+ `ClientToken` – 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).

  Usado para idempotência e é recomendado que seja definido como um ID aleatório (como um UUID) para evitar criar ou iniciar várias instâncias do mesmo recurso.
+ `AdditionalRunOptions` – Um objeto [DataQualityEvaluationRunAdditionalRunOptions](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions).

  Opções adicionais de execução que você pode especificar para uma execução de avaliação.
+ `RulesetNames` - *obrigatório:* uma matriz de strings UTF-8, não menos que 1 ou mais que 10 strings.

  Uma lista de nomes de conjuntos de regras.
+ `AdditionalDataSources` – 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 [DataSource](#aws-glue-api-data-quality-api-DataSource) A.

  Um mapa de strings de referência para fontes de dados adicionais que você pode especificar para uma execução de avaliação.

**Resposta**
+ `RunId` – 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 de execução único associado a essa execução.

**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ConflictException`

## Ação CancelDataQualityRulesetEvaluationRun (Python: cancel\$1data\$1quality\$1ruleset\$1evaluation\$1run)
<a name="aws-glue-api-data-quality-api-CancelDataQualityRulesetEvaluationRun"></a>

Cancela uma execução em que um conjunto de regras está sendo avaliado em relação a uma fonte de dados.

**Solicitação**
+ `RunId`: *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 identificador de execução único associado a essa execução.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação GetDataQualityRulesetEvaluationRun (Python: get\$1data\$1quality\$1ruleset\$1evaluation\$1run)
<a name="aws-glue-api-data-quality-api-GetDataQualityRulesetEvaluationRun"></a>

Cancela uma execução específica em que um conjunto de regras está sendo avaliado em relação a uma fonte de dados.

**Solicitação**
+ `RunId`: *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 identificador de execução único associado a essa execução.

**Resposta**
+ `RunId` – 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 de execução único associado a essa execução.
+ `DataSource` – Um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  A fonte de dados (uma tabela do AWS Glue) associada a essa avaliação.
+ `Role` – String UTF-8.

  Um perfil do IAM fornecido para criptografar os resultados da execução.
+ `NumberOfWorkers` – Número (íntegro).

  O número de processadores do `G.1X` a serem usados na execução. O padrão é 5.
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite em minutos para uma execução. Esse é o tempo máximo durante o qual uma execução pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. O padrão é 2.880 minutos (48 horas).
+ `AdditionalRunOptions` – Um objeto [DataQualityEvaluationRunAdditionalRunOptions](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions).

  Opções adicionais de execução que você pode especificar para uma execução de avaliação.
+ `Status` – String UTF-8 (valores válidos: `RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`).

  O status dessa execução.
+ `ErrorString` – String UTF-8.

  As strings de erro associadas à execução.
+ `StartedOn` – Timestamp.

  A data e hora em que essa execução foi iniciada.
+ `LastModifiedOn` – Timestamp.

  Um carimbo de data/hora. O último ponto em que essa recomendação de regra de qualidade de dados foi executada foi modificado.
+ `CompletedOn` – Timestamp.

  A data e hora de conclusão dessa execução.
+ `ExecutionTime` – Número (íntegro).

  A quantidade de tempo (em segundos) durante a qual a execução consumiu recursos.
+ `RulesetNames`: uma matriz de strings UTF-8, não menos que 1 ou mais que 10 strings.

  Uma lista de nomes de conjuntos de regras para a execução. Atualmente, este parâmetro pode ter apenas um nome de conjunto de regras.
+ `ResultIds`: uma matriz de strings UTF-8, não menos que 1 ou mais que 10 strings.

  Uma lista de IDs de resultado para os resultados de qualidade de dados da execução.
+ `AdditionalDataSources` – 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 [DataSource](#aws-glue-api-data-quality-api-DataSource) A.

  Um mapa de strings de referência para fontes de dados adicionais que você pode especificar para uma execução de avaliação.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação ListDataQualityRulesetEvaluationRuns (Python: list\$1data\$1quality\$1ruleset\$1evaluation\$1runs)
<a name="aws-glue-api-data-quality-api-ListDataQualityRulesetEvaluationRuns"></a>

Lista todas as execuções que atendem aos critérios de filtro, em que um conjunto de regras é avaliado em relação a uma fonte de dados.

**Solicitação**
+ `Filter` – Um objeto [DataQualityRulesetEvaluationRunFilter](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter).

  Os critérios de filtro.
+ `NextToken` – String UTF-8.

  Um token paginado para equilibrar os resultados.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados.

**Resposta**
+ `Runs`: um array de objetos [DataQualityRulesetEvaluationRunDescription](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription).

  Uma lista de objetos `DataQualityRulesetEvaluationRunDescription` que representam execuções de conjuntos de regras de qualidade de dados.
+ `NextToken` – String UTF-8.

  Um token de paginação, se houver mais resultados disponíveis.

**Erros**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação StartDataQualityRuleRecommendationRun (Python: start\$1data\$1quality\$1rule\$1recommendation\$1run)
<a name="aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRun"></a>

Inicia uma execução de recomendação que é usada para gerar regras quando você não sabe quais regras escrever. AWS Glue A Data Quality analisa os dados e gera recomendações para um possível conjunto de regras. Em seguida, você pode fazer a triagem do conjunto de regras e modificar o conjunto de regras gerado de acordo com sua preferência.

As execuções de recomendação são excluídas automaticamente após 90 dias.

**Solicitação**

A solicitação de recomendação da regra de qualidade dos dados.
+ `DataSource` – *Obrigatório:* um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  A fonte de dados (uma tabela do AWS Glue) associada a essa execução.
+ `Role` – *Obrigatório:* string UTF-8.

  Um perfil do IAM fornecido para criptografar os resultados da execução.
+ `NumberOfWorkers` – Número (íntegro).

  O número de processadores do `G.1X` a serem usados na execução. O padrão é 5.
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite em minutos para uma execução. Esse é o tempo máximo durante o qual uma execução pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. O padrão é 2.880 minutos (48 horas).
+ `CreatedRulesetName` – 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 o conjunto de regras.
+ `DataQualitySecurityConfiguration` – 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 configuração de segurança criada com a opção de criptografia de qualidade dos dados.
+ `ClientToken` – 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).

  Usado para idempotência e é recomendado que seja definido como um ID aleatório (como um UUID) para evitar criar ou iniciar várias instâncias do mesmo recurso.

**Resposta**
+ `RunId` – 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 de execução único associado a essa execução.

**Erros**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ConflictException`

## Ação CancelDataQualityRuleRecommendationRun (Python: cancel\$1data\$1quality\$1rule\$1recommendation\$1run)
<a name="aws-glue-api-data-quality-api-CancelDataQualityRuleRecommendationRun"></a>

Cancela a execução da recomendação especificada que estava sendo usada para gerar regras.

**Solicitação**
+ `RunId`: *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 identificador de execução único associado a essa execução.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação GetDataQualityRuleRecommendationRun (Python: get\$1data\$1quality\$1rule\$1recommendation\$1run)
<a name="aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRun"></a>

Obtém a execução da recomendação especificada que estava sendo usada para gerar regras.

**Solicitação**
+ `RunId`: *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 identificador de execução único associado a essa execução.

**Resposta**

A resposta para a execução de recomendação da regra de qualidade dos dados.
+ `RunId` – 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 de execução único associado a essa execução.
+ `DataSource` – Um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  A fonte de dados (uma tabela do AWS Glue) associada a essa execução.
+ `Role` – String UTF-8.

  Um perfil do IAM fornecido para criptografar os resultados da execução.
+ `NumberOfWorkers` – Número (íntegro).

  O número de processadores do `G.1X` a serem usados na execução. O padrão é 5.
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite em minutos para uma execução. Esse é o tempo máximo durante o qual uma execução pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. O padrão é 2.880 minutos (48 horas).
+ `Status` – String UTF-8 (valores válidos: `RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`).

  O status dessa execução.
+ `ErrorString` – String UTF-8.

  As strings de erro associadas à execução.
+ `StartedOn` – Timestamp.

  A data e hora em que essa execução foi iniciada.
+ `LastModifiedOn` – Timestamp.

  Um carimbo de data/hora. O último ponto em que essa recomendação de regra de qualidade de dados foi executada foi modificado.
+ `CompletedOn` – Timestamp.

  A data e hora de conclusão dessa execução.
+ `ExecutionTime` – Número (íntegro).

  A quantidade de tempo (em segundos) durante a qual a execução consumiu recursos.
+ `RecommendedRuleset`: string UTF-8, não menos do que 1 ou mais de 65536 bytes de comprimento.

  Quando uma execução de recomendação de regra inicial é concluída, ela cria um conjunto de regras recomendado. Esse membro tem essas regras no formato Data Quality Definition Language (DQDL).
+ `CreatedRulesetName` – 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 conjunto de regras que foi criado pela execução.
+ `DataQualitySecurityConfiguration` – 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 configuração de segurança criada com a opção de criptografia de qualidade dos dados.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação ListDataQualityRuleRecommendationRuns (Python: list\$1data\$1quality\$1rule\$1recommendation\$1runs)
<a name="aws-glue-api-data-quality-api-ListDataQualityRuleRecommendationRuns"></a>

Lista as execuções de recomendações que atendem aos critérios do filtro.

**Solicitação**
+ `Filter` – Um objeto [DataQualityRuleRecommendationRunFilter](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter).

  Os critérios de filtro.
+ `NextToken` – String UTF-8.

  Um token paginado para equilibrar os resultados.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados.

**Resposta**
+ `Runs`: um array de objetos [DataQualityRuleRecommendationRunDescription](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription).

  Uma lista dos objetos `DataQualityRuleRecommendationRunDescription`.
+ `NextToken` – String UTF-8.

  Um token de paginação, se houver mais resultados disponíveis.

**Erros**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação GetDataQualityResult (Python: get\$1data\$1quality\$1result)
<a name="aws-glue-api-data-quality-api-GetDataQualityResult"></a>

Recupera o resultado de uma avaliação da regra de qualidade de dados.

**Solicitação**
+ `ResultId`: *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).

  Um ID de resultado exclusivo para o resultado de qualidade dos dados.

**Resposta**

A resposta para o resultado de qualidade dos dados.
+ `ResultId` – 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 ID de resultado exclusivo para o resultado de qualidade dos dados.
+ `ProfileId` – 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 do perfil para o resultado de qualidade dos dados.
+ `Score`: número (double), no máximo 1,0.

  Uma pontuação de qualidade de dados agregada. Representa a razão de regras que foram aproadas para o número total de regras.
+ `DataSource` – Um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  A tabela associada ao resultado de qualidade dos dados, se houver.
+ `RulesetName` – 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 conjunto de regras associado ao resultado de qualidade de dados.
+ `EvaluationContext` – String UTF-8.

  No contexto de um trabalho no AWS Glue Studio, cada nó na tela normalmente recebe algum tipo de nome e os nós de qualidade de dados terão nomes. No caso de vários nós, o `evaluationContext` pode diferenciar os nós.
+ `StartedOn` – Timestamp.

  A data e hora de início da execução desse resultado de qualidade de dados.
+ `CompletedOn` – Timestamp.

  A data e hora de conclusão da execução desse resultado de qualidade de dados.
+ `JobName` – 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 trabalho associado ao resultado de qualidade dos dados, se houver.
+ `JobRunId` – 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 de execução de trabalho associado ao resultado de qualidade dos dados, se houver.
+ `RulesetEvaluationRunId` – 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 de execução exclusivo associado à avaliação do conjunto de regras.
+ `RuleResults`: uma matriz de objetos [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult), não mais de 2.000 estruturas.

  Uma lista de objetos do `DataQualityRuleResult` representando os resultados de cada regra. 
+ `AnalyzerResults`: uma matriz de objetos [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult), não mais de 2.000 estruturas.

  Uma lista de objetos `DataQualityAnalyzerResult` representando os resultados de cada analisador. 
+ `Observations` – Uma matriz de [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation) objetos, não mais de 50 estruturas.

  Uma lista de objetos `DataQualityObservation` representando as observações geradas após a avaliação das regras e dos analisadores. 
+ `AggregatedMetrics` – Um objeto [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics).

   Um resumo dos objetos `DataQualityAggregatedMetrics` mostrando as contagens totais de linhas e regras processadas, incluindo suas estatísticas de aprovação/reprovação com base nos resultados no nível de linha. 

**Erros**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `EntityNotFoundException`

## Ação BatchGetDataQualityResult (Python: batch\$1get\$1data\$1quality\$1result)
<a name="aws-glue-api-data-quality-api-BatchGetDataQualityResult"></a>

Recupera uma lista de resultados de qualidade de dados para os IDs de resultados especificados.

**Solicitação**
+ `ResultIds` - *obrigatório:* uma matriz de strings UTF-8, não menos que 1 ou mais que 100 strings.

  Uma lista de IDs de resultado exclusivas para os resultados de qualidade dos dados.

**Resposta**
+ `Results` – *Obrigatório:* uma matriz de objetos [DataQualityResult](#aws-glue-api-data-quality-api-DataQualityResult).

  Uma lista de objetos `DataQualityResult` que representam os resultados de qualidade dos dados.
+ `ResultsNotFound`: uma matriz de strings UTF-8, não menos que 1 ou mais que 100 strings.

  Uma lista de IDs de resultados para os quais resultados não foram encontrados.

**Erros**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação ListDataQualityResults (Python: list\$1data\$1quality\$1results)
<a name="aws-glue-api-data-quality-api-ListDataQualityResults"></a>

Retorna todos os resultados de execução de qualidade de dados para sua conta.

**Solicitação**
+ `Filter` – Um objeto [DataQualityResultFilterCriteria](#aws-glue-api-data-quality-api-DataQualityResultFilterCriteria).

  Os critérios de filtro.
+ `NextToken` – String UTF-8.

  Um token paginado para equilibrar os resultados.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados.

**Resposta**
+ `Results` – *Obrigatório:* uma matriz de objetos [DataQualityResultDescription](#aws-glue-api-data-quality-api-DataQualityResultDescription).

  Uma lista dos objetos `DataQualityResultDescription`.
+ `NextToken` – String UTF-8.

  Um token de paginação, se houver mais resultados disponíveis.

**Erros**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação CreateDataQualityRuleset (Python: create\$1data\$1quality\$1ruleset)
<a name="aws-glue-api-data-quality-api-CreateDataQualityRuleset"></a>

Cria um conjunto de regras de qualidade de dados com regras DQDL aplicadas a uma tabela do AWS Glue especificada.

Você cria o conjunto de regras usando a Data Quality Definition Language (DQDL). Para obter mais informações, consulte o Guia do desenvolvedor do AWS Glue.

**Solicitação**

Uma solicitação para criar um conjunto de regras de qualidade de dados
+ `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).

  Um nome exclusivo para o conjunto de regras de qualidade de dados.
+ `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 conjunto de regras de qualidade de dados.
+ `Ruleset` - *obrigatório:* string UTF-8, não menos que 1 ou mais que 65.536 bytes de comprimento.

  Um conjunto de regras em Data Quality Definition Language (DQDL). Para obter mais informações, consulte o Guia do desenvolvedor do AWS Glue.
+ `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.

  Uma lista de tags aplicadas ao conjunto de regras de qualidade de dados.
+ `TargetTable` – Um objeto [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable).

  Uma tabela de destino associada ao conjunto de regras de qualidade de dados.
+ `RecommendationRunId` – 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 ID de execução exclusivo para a execução da recomendação.
+ `DataQualitySecurityConfiguration` – 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 configuração de segurança criada com a opção de criptografia de qualidade dos dados.
+ `ClientToken` – 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).

  Usado para idempotência e é recomendado que seja definido como um ID aleatório (como um UUID) para evitar criar ou iniciar várias instâncias do mesmo recurso.

**Resposta**
+ `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).

  Um nome exclusivo para o conjunto de regras de qualidade de dados.

**Erros**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`

## Ação DeleteDataQualityRuleset (Python: delete\$1data\$1quality\$1ruleset)
<a name="aws-glue-api-data-quality-api-DeleteDataQualityRuleset"></a>

Exclui um conjunto de regras de qualidade de dados.

**Solicitaçã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).

  Um nome para o conjunto de regras de qualidade de dados.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação GetDataQualityRuleset (Python: get\$1data\$1quality\$1ruleset)
<a name="aws-glue-api-data-quality-api-GetDataQualityRuleset"></a>

Retorna um conjunto de regras existente por identificador ou um nome.

**Solicitaçã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 grupo de regras.

**Resposta**

Retorna a resposta do conjunto de regras de qualidade de dados.
+ `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 do grupo de regras.
+ `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 da predefinição.
+ `Ruleset`: string UTF-8, não menos do que 1 ou mais de 65536 bytes de comprimento.

  Um conjunto de regras em Data Quality Definition Language (DQDL). Para obter mais informações, consulte o Guia do desenvolvedor do AWS Glue.
+ `TargetTable` – Um objeto [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable).

  O nome e o nome do banco de dados da tabela de destino.
+ `CreatedOn` – Timestamp.

  Um carimbo de data/hora. A hora e a data de criação desse conjunto de regras de qualidade de dados.
+ `LastModifiedOn` – Timestamp.

  Um carimbo de data/hora. O último ponto em que esse conjunto de regras de qualidade de dados foi modificado.
+ `RecommendationRunId` – 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).

  Quando um conjunto de regras foi criado de execução de uma recomendação, esse ID de execução é gerado para vincular os dois.
+ `DataQualitySecurityConfiguration` – 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 configuração de segurança criada com a opção de criptografia de qualidade dos dados.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação ListDataQualityRulesets (Python: list\$1data\$1quality\$1rulesets)
<a name="aws-glue-api-data-quality-api-ListDataQualityRulesets"></a>

Retorna uma lista paginada dos conjuntos de regras para a lista de tabelas do AWS Glue especificadas.

**Solicitação**
+ `NextToken` – String UTF-8.

  Um token paginado para equilibrar os resultados.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados.
+ `Filter` – Um objeto [DataQualityRulesetFilterCriteria](#aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria).

  Os critérios de filtro. 
+ `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.

  Uma lista de tags de pares chave-valor.

**Resposta**
+ `Rulesets`: um array de objetos [DataQualityRulesetListDetails](#aws-glue-api-data-quality-api-DataQualityRulesetListDetails).

  Uma lista paginada dos conjuntos de regras para a lista de tabelas do AWS Glue especificadas.
+ `NextToken` – String UTF-8.

  Um token de paginação, se houver mais resultados disponíveis.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação UpdateDataQualityRuleset (Python: update\$1data\$1quality\$1ruleset)
<a name="aws-glue-api-data-quality-api-UpdateDataQualityRuleset"></a>

Atualiza o conjunto de regras de qualidade de dados especificado.

**Solicitaçã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 conjunto de regras de qualidade de dados.
+ `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 da predefinição.
+ `Ruleset`: string UTF-8, não menos do que 1 ou mais de 65536 bytes de comprimento.

  Um conjunto de regras em Data Quality Definition Language (DQDL). Para obter mais informações, consulte o Guia do desenvolvedor do AWS Glue.

**Resposta**
+ `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 do conjunto de regras de qualidade de dados.
+ `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 da predefinição.
+ `Ruleset`: string UTF-8, não menos do que 1 ou mais de 65536 bytes de comprimento.

  Um conjunto de regras em Data Quality Definition Language (DQDL). Para obter mais informações, consulte o Guia do desenvolvedor do AWS Glue.

**Erros**
+ `EntityNotFoundException`
+ `AlreadyExistsException`
+ `IdempotentParameterMismatchException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`

## Ação ListDataQualityStatistics (Python: list\$1data\$1quality\$1statistics)
<a name="aws-glue-api-data-quality-api-ListDataQualityStatistics"></a>

Recupera uma lista de estatísticas de qualidade dos dados.

**Solicitação**
+ `StatisticId` – 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 estatística.
+ `ProfileId` – 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 do perfil.
+ `TimestampFilter` – Um objeto [TimestampFilter](#aws-glue-api-data-quality-api-TimestampFilter).

  Um filtro de carimbo de data e hora.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados nesta solicitação.
+ `NextToken` – String UTF-8.

  Um token de paginação para solicitar a próxima página de resultados.

**Resposta**
+ `Statistics`: um array de objetos [StatisticSummary](#aws-glue-api-data-quality-api-StatisticSummary).

  O `StatisticSummaryList`.
+ `NextToken` – String UTF-8.

  Um token de paginação para solicitar a próxima página de resultados.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`

## Estrutura TimestampFilter
<a name="aws-glue-api-data-quality-api-TimestampFilter"></a>

Um filtro de carimbo de data e hora.

**Campos**
+ `RecordedBefore` – Timestamp.

  O registro de data e hora antes do qual as estatísticas devem ser incluídas nos resultados.
+ `RecordedAfter` – Timestamp.

  O registro de data e hora após o qual as estatísticas devem ser incluídas nos resultados.

## Estrutura CreateDataQualityRulesetRequest
<a name="aws-glue-api-data-quality-api-CreateDataQualityRulesetRequest"></a>

Uma solicitação para criar um conjunto de regras de qualidade 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).

  Um nome exclusivo para o conjunto de regras de qualidade de dados.
+ `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 conjunto de regras de qualidade de dados.
+ `Ruleset` - *obrigatório:* string UTF-8, não menos que 1 ou mais que 65.536 bytes de comprimento.

  Um conjunto de regras em Data Quality Definition Language (DQDL). Para obter mais informações, consulte o Guia do desenvolvedor do AWS Glue.
+ `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.

  Uma lista de tags aplicadas ao conjunto de regras de qualidade de dados.
+ `TargetTable` – Um objeto [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable).

  Uma tabela de destino associada ao conjunto de regras de qualidade de dados.
+ `RecommendationRunId` – 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 ID de execução exclusivo para a execução da recomendação.
+ `DataQualitySecurityConfiguration` – 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 configuração de segurança criada com a opção de criptografia de qualidade dos dados.
+ `ClientToken` – 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).

  Usado para idempotência e é recomendado que seja definido como um ID aleatório (como um UUID) para evitar criar ou iniciar várias instâncias do mesmo recurso.

## Estrutura GetDataQualityRulesetResponse
<a name="aws-glue-api-data-quality-api-GetDataQualityRulesetResponse"></a>

Retorna a resposta do conjunto de regras de qualidade 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 do grupo de regras.
+ `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 da predefinição.
+ `Ruleset`: string UTF-8, não menos do que 1 ou mais de 65536 bytes de comprimento.

  Um conjunto de regras em Data Quality Definition Language (DQDL). Para obter mais informações, consulte o Guia do desenvolvedor do AWS Glue.
+ `TargetTable` – Um objeto [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable).

  O nome e o nome do banco de dados da tabela de destino.
+ `CreatedOn` – Timestamp.

  Um carimbo de data/hora. A hora e a data de criação desse conjunto de regras de qualidade de dados.
+ `LastModifiedOn` – Timestamp.

  Um carimbo de data/hora. O último ponto em que esse conjunto de regras de qualidade de dados foi modificado.
+ `RecommendationRunId` – 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).

  Quando um conjunto de regras foi criado de execução de uma recomendação, esse ID de execução é gerado para vincular os dois.
+ `DataQualitySecurityConfiguration` – 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 configuração de segurança criada com a opção de criptografia de qualidade dos dados.

## Estrutura GetDataQualityResultResponse
<a name="aws-glue-api-data-quality-api-GetDataQualityResultResponse"></a>

A resposta para o resultado de qualidade dos dados.

**Campos**
+ `ResultId` – 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 ID de resultado exclusivo para o resultado de qualidade dos dados.
+ `ProfileId` – 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 do perfil para o resultado de qualidade dos dados.
+ `Score`: número (double), no máximo 1,0.

  Uma pontuação de qualidade de dados agregada. Representa a razão de regras que foram aproadas para o número total de regras.
+ `DataSource` – Um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  A tabela associada ao resultado de qualidade dos dados, se houver.
+ `RulesetName` – 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 conjunto de regras associado ao resultado de qualidade de dados.
+ `EvaluationContext` – String UTF-8.

  No contexto de um trabalho no AWS Glue Studio, cada nó na tela normalmente recebe algum tipo de nome e os nós de qualidade de dados terão nomes. No caso de vários nós, o `evaluationContext` pode diferenciar os nós.
+ `StartedOn` – Timestamp.

  A data e hora de início da execução desse resultado de qualidade de dados.
+ `CompletedOn` – Timestamp.

  A data e hora de conclusão da execução desse resultado de qualidade de dados.
+ `JobName` – 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 trabalho associado ao resultado de qualidade dos dados, se houver.
+ `JobRunId` – 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 de execução de trabalho associado ao resultado de qualidade dos dados, se houver.
+ `RulesetEvaluationRunId` – 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 de execução exclusivo associado à avaliação do conjunto de regras.
+ `RuleResults`: uma matriz de objetos [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult), não mais de 2.000 estruturas.

  Uma lista de objetos do `DataQualityRuleResult` representando os resultados de cada regra. 
+ `AnalyzerResults`: uma matriz de objetos [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult), não mais de 2.000 estruturas.

  Uma lista de objetos `DataQualityAnalyzerResult` representando os resultados de cada analisador. 
+ `Observations` – Uma matriz de [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation) objetos, não mais de 50 estruturas.

  Uma lista de objetos `DataQualityObservation` representando as observações geradas após a avaliação das regras e dos analisadores. 
+ `AggregatedMetrics` – Um objeto [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics).

   Um resumo dos objetos `DataQualityAggregatedMetrics` mostrando as contagens totais de linhas e regras processadas, incluindo suas estatísticas de aprovação/reprovação com base nos resultados no nível de linha. 

## Estrutura StartDataQualityRuleRecommendationRunRequest
<a name="aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRunRequest"></a>

A solicitação de recomendação da regra de qualidade dos dados.

**Campos**
+ `DataSource` – *Obrigatório:* um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  A fonte de dados (uma tabela do AWS Glue) associada a essa execução.
+ `Role` – *Obrigatório:* string UTF-8.

  Um perfil do IAM fornecido para criptografar os resultados da execução.
+ `NumberOfWorkers` – Número (íntegro).

  O número de processadores do `G.1X` a serem usados na execução. O padrão é 5.
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite em minutos para uma execução. Esse é o tempo máximo durante o qual uma execução pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. O padrão é 2.880 minutos (48 horas).
+ `CreatedRulesetName` – 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 o conjunto de regras.
+ `DataQualitySecurityConfiguration` – 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 configuração de segurança criada com a opção de criptografia de qualidade dos dados.
+ `ClientToken` – 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).

  Usado para idempotência e é recomendado que seja definido como um ID aleatório (como um UUID) para evitar criar ou iniciar várias instâncias do mesmo recurso.

## Estrutura GetDataQualityRuleRecommendationRunResponse
<a name="aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRunResponse"></a>

A resposta para a execução de recomendação da regra de qualidade dos dados.

**Campos**
+ `RunId` – 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 de execução único associado a essa execução.
+ `DataSource` – Um objeto [DataSource](#aws-glue-api-data-quality-api-DataSource).

  A fonte de dados (uma tabela do AWS Glue) associada a essa execução.
+ `Role` – String UTF-8.

  Um perfil do IAM fornecido para criptografar os resultados da execução.
+ `NumberOfWorkers` – Número (íntegro).

  O número de processadores do `G.1X` a serem usados na execução. O padrão é 5.
+ `Timeout` – Número (inteiro), pelo menos 1.

  O tempo limite em minutos para uma execução. Esse é o tempo máximo durante o qual uma execução pode consumir recursos antes de ser encerrada e entrar no status `TIMEOUT`. O padrão é 2.880 minutos (48 horas).
+ `Status` – String UTF-8 (valores válidos: `RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`).

  O status dessa execução.
+ `ErrorString` – String UTF-8.

  As strings de erro associadas à execução.
+ `StartedOn` – Timestamp.

  A data e hora em que essa execução foi iniciada.
+ `LastModifiedOn` – Timestamp.

  Um carimbo de data/hora. O último ponto em que essa recomendação de regra de qualidade de dados foi executada foi modificado.
+ `CompletedOn` – Timestamp.

  A data e hora de conclusão dessa execução.
+ `ExecutionTime` – Número (íntegro).

  A quantidade de tempo (em segundos) durante a qual a execução consumiu recursos.
+ `RecommendedRuleset`: string UTF-8, não menos do que 1 ou mais de 65536 bytes de comprimento.

  Quando uma execução de recomendação de regra inicial é concluída, ela cria um conjunto de regras recomendado. Esse membro tem essas regras no formato Data Quality Definition Language (DQDL).
+ `CreatedRulesetName` – 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 conjunto de regras que foi criado pela execução.
+ `DataQualitySecurityConfiguration` – 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 configuração de segurança criada com a opção de criptografia de qualidade dos dados.

## Ação BatchPutDataQualityStatisticAnnotation (Python: batch\$1put\$1data\$1quality\$1statistic\$1annotation)
<a name="aws-glue-api-data-quality-api-BatchPutDataQualityStatisticAnnotation"></a>

Anote os pontos de dados ao longo do tempo para obter uma estatística específica de qualidade dos dados. A API exige tanto profileID quanto statisticID como parte da entrada InclusionAnnotation. A API funciona apenas para um único statisticID em vários perfis.

**Solicitação**
+ `InclusionAnnotations` – *Obrigatório:* uma matriz de objetos [DatapointInclusionAnnotation](#aws-glue-api-data-quality-api-DatapointInclusionAnnotation).

  Uma lista de `DatapointInclusionAnnotation`. InclusionAnnotations deve incluir um profileID e um statisticID. Se houver várias anotações de inclusão, a lista deverá se referir a um único statisticID em vários profileIDs.
+ `ClientToken` – 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).

  Token cliente.

**Resposta**
+ `FailedInclusionAnnotations`: um array de objetos [AnnotationError](#aws-glue-api-data-quality-api-AnnotationError).

  Uma lista de `AnnotationError`.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`

## Ação GetDataQualityModel (Python: get\$1data\$1quality\$1model)
<a name="aws-glue-api-data-quality-api-GetDataQualityModel"></a>

Recupere o status de treinamento do modelo com mais informações (CompletedOn, StartedOn, FailureReason).

**Solicitação**
+ `StatisticId` – 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 estatística.
+ `ProfileId`: *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 do perfil.

**Resposta**
+ `Status` – String UTF-8 (valores válidos: `RUNNING` \$1 `SUCCEEDED` \$1 `FAILED`).

  O status do treinamento de modelo de qualidade dos dados.
+ `StartedOn` – Timestamp.

  A data e hora em que o treinamento de modelo de qualidade dos dados começou.
+ `CompletedOn` – Timestamp.

  O carimbo de data e hora de quando o treinamento do modelo de qualidade dos dados foi concluído.
+ `FailureReason` – 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 motivo da falha no treinamento.

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação GetDataQualityModelResult (Python: get\$1data\$1quality\$1model\$1result)
<a name="aws-glue-api-data-quality-api-GetDataQualityModelResult"></a>

Recupere as previsões de uma estatística para um determinado ID de perfil.

**Solicitação**
+ `StatisticId`: *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 estatística.
+ `ProfileId`: *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 do perfil.

**Resposta**
+ `CompletedOn` – Timestamp.

  O carimbo de data e hora de quando o treinamento do modelo de qualidade dos dados foi concluído.
+ `Model`: um array de objetos [StatisticModelResult](#aws-glue-api-data-quality-api-StatisticModelResult).

  Uma lista de `StatisticModelResult`

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## Ação ListDataQualityStatisticAnnotations (Python: list\$1data\$1quality\$1statistic\$1annotations)
<a name="aws-glue-api-data-quality-api-ListDataQualityStatisticAnnotations"></a>

Recupere anotações para uma estatística de qualidade dos dados.

**Solicitação**
+ `StatisticId` – 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 estatística.
+ `ProfileId` – 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 do perfil.
+ `TimestampFilter` – Um objeto [TimestampFilter](#aws-glue-api-data-quality-api-TimestampFilter).

  Um filtro de carimbo de data e hora.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados nesta solicitação.
+ `NextToken` – String UTF-8.

  Um token de paginação para recuperar o próximo conjunto de resultados.

**Resposta**
+ `Annotations`: um array de objetos [StatisticAnnotation](#aws-glue-api-data-quality-api-StatisticAnnotation).

  Uma lista de `StatisticAnnotation` aplicadas à estatística
+ `NextToken` – String UTF-8.

  Um token de paginação para recuperar o próximo conjunto de resultados.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`

## Ação PutDataQualityProfileAnnotation (Python: put\$1data\$1quality\$1profile\$1annotation)
<a name="aws-glue-api-data-quality-api-PutDataQualityProfileAnnotation"></a>

Anote todos os pontos de dados de um perfil.

**Solicitação**
+ `ProfileId`: *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 do perfil de monitoramento da qualidade dos dados a ser anotado.
+ `InclusionAnnotation` – *Obrigatório:* string UTF-8 (valores válidos: `INCLUDE` \$1 `EXCLUDE`).

  O valor da anotação de inclusão a ser aplicado ao perfil.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`

# API de detecção de dados sigilosos
<a name="aws-glue-api-sensitive-data-api"></a>

A API Sensitive data detection descreve as APIs usadas para detectar dados confidenciais nas colunas e linhas de seus dados estruturados. 

## Tipos de dados
<a name="aws-glue-api-sensitive-data-api-objects"></a>
+ [Estrutura CustomEntityType](#aws-glue-api-sensitive-data-api-CustomEntityType)

## Estrutura CustomEntityType
<a name="aws-glue-api-sensitive-data-api-CustomEntityType"></a>

Um objeto que representa um padrão personalizado para detectar dados sigilosos nas colunas e linhas dos dados estruturados.

**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).

  Um nome para o padrão personalizado que permite que ele seja recuperado ou excluído posteriormente. Esse nome deve ser exclusivo por conta AWS.
+ `RegexString`: *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 expressão regular usada para detectar dados sigilosos em um padrão personalizado.
+ `ContextWords`: uma matriz de strings UTF-8, não menos que 1 ou mais que 20 strings.

  Uma lista de palavras de contexto. Se nenhuma dessas palavras de contexto for encontrada nas proximidades da expressão regular, os dados não serão detectados como dados sigilosos.

  Se nenhuma palavra de contexto for passada, apenas uma expressão regular será marcada.

## Operações
<a name="aws-glue-api-sensitive-data-api-actions"></a>
+ [Ação CreateCustomEntityType (Python: create\$1custom\$1entity\$1type)](#aws-glue-api-sensitive-data-api-CreateCustomEntityType)
+ [Ação DeleteCustomEntityType (Python: delete\$1custom\$1entity\$1type)](#aws-glue-api-sensitive-data-api-DeleteCustomEntityType)
+ [Ação GetCustomEntityType (Python: get\$1custom\$1entity\$1type)](#aws-glue-api-sensitive-data-api-GetCustomEntityType)
+ [Ação BatchGetCustomEntityTypes (Python: batch\$1get\$1custom\$1entity\$1types)](#aws-glue-api-sensitive-data-api-BatchGetCustomEntityTypes)
+ [Ação ListCustomEntityTypes (Python: list\$1custom\$1entity\$1types)](#aws-glue-api-sensitive-data-api-ListCustomEntityTypes)

## Ação CreateCustomEntityType (Python: create\$1custom\$1entity\$1type)
<a name="aws-glue-api-sensitive-data-api-CreateCustomEntityType"></a>

Cria um padrão personalizado usado para detectar dados sigilosos nas colunas e linhas dos dados estruturados.

Cada padrão personalizado criado especifica uma expressão regular e uma lista opcional de palavras de contexto. Se nenhuma palavra de contexto for passada, apenas uma expressão regular será marcada.

**Solicitaçã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).

  Um nome para o padrão personalizado que permite que ele seja recuperado ou excluído posteriormente. Esse nome deve ser exclusivo por conta AWS.
+ `RegexString`: *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 expressão regular usada para detectar dados sigilosos em um padrão personalizado.
+ `ContextWords`: uma matriz de strings UTF-8, não menos que 1 ou mais que 20 strings.

  Uma lista de palavras de contexto. Se nenhuma dessas palavras de contexto for encontrada nas proximidades da expressão regular, os dados não serão detectados como dados sigilosos.

  Se nenhuma palavra de contexto for passada, apenas uma expressão regular será marcada.
+ `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.

  Uma lista de tags aplicadas ao tipo de entidade personalizada.

**Resposta**
+ `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 do padrão personalizado que você criou.

**Erros**
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `IdempotentParameterMismatchException`
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`

## Ação DeleteCustomEntityType (Python: delete\$1custom\$1entity\$1type)
<a name="aws-glue-api-sensitive-data-api-DeleteCustomEntityType"></a>

Exclui um padrão personalizado especificando seu nome.

**Solicitaçã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 padrão personalizado que você deseja excluir.

**Resposta**
+ `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 do padrão personalizado que você excluiu.

**Erros**
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## Ação GetCustomEntityType (Python: get\$1custom\$1entity\$1type)
<a name="aws-glue-api-sensitive-data-api-GetCustomEntityType"></a>

Recupera os detalhes de um padrão personalizado especificando o nome do mesmo.

**Solicitaçã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 padrão personalizado que você deseja recuperar.

**Resposta**
+ `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 do padrão personalizado que você recuperou.
+ `RegexString` – 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 string de expressão regular usada para detectar dados sigilosos em um padrão personalizado.
+ `ContextWords`: uma matriz de strings UTF-8, não menos que 1 ou mais que 20 strings.

  Uma lista de palavras de contexto, se especificada quando você criou o padrão personalizado. Se nenhuma dessas palavras de contexto for encontrada nas proximidades da expressão regular, os dados não serão detectados como dados sigilosos.

**Erros**
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## Ação BatchGetCustomEntityTypes (Python: batch\$1get\$1custom\$1entity\$1types)
<a name="aws-glue-api-sensitive-data-api-BatchGetCustomEntityTypes"></a>

Recupera os detalhes dos padrões personalizados especificados por uma lista de nomes.

**Solicitação**
+ `Names`: *obrigatório:* uma matriz de strings UTF-8, não menos de 1 ou mais de 50 strings.

  Uma lista de nomes dos padrões personalizados que você deseja recuperar.

**Resposta**
+ `CustomEntityTypes`: um array de objetos [CustomEntityType](#aws-glue-api-sensitive-data-api-CustomEntityType).

  Lista de objetos `CustomEntityType` que representam os padrões personalizados que foram criados.
+ `CustomEntityTypesNotFound` - Uma matriz de strings UTF-8, não menos que 1 ou mais que 50 strings.

  Uma lista dos nomes de padrões personalizados que não foram encontrados.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## Ação ListCustomEntityTypes (Python: list\$1custom\$1entity\$1types)
<a name="aws-glue-api-sensitive-data-api-ListCustomEntityTypes"></a>

Lista todos os padrões personalizados que foram criados.

**Solicitação**
+ `NextToken` – String UTF-8.

  Um token paginado para equilibrar os resultados.
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados.
+ `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.

  Uma lista de tags de pares chave-valor.

**Resposta**
+ `CustomEntityTypes`: um array de objetos [CustomEntityType](#aws-glue-api-sensitive-data-api-CustomEntityType).

  Lista de objetos `CustomEntityType` que representam os padrões personalizados.
+ `NextToken` – String UTF-8.

  Um token de paginação, se houver mais resultados disponíveis.

**Erros**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

# Marcação de APIs no AWS Glue
<a name="aws-glue-api-tags"></a>

## Tipos de dados
<a name="aws-glue-api-tags-objects"></a>
+ [Estrutura Tag](#aws-glue-api-tags-Tag)

## Estrutura Tag
<a name="aws-glue-api-tags-Tag"></a>

O objeto `Tag` representa um rótulo que pode ser atribuído a um recurso da AWS. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos.

Para obter mais informações sobre tags e como controlar o acesso aos recursos no AWS Glue, consulte [Marcações AWS no AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) e [Especificação de ARNs de recurso AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html) no guia do desenvolvedor.

**Campos**
+ `key` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.

  A chave de tags. A chave é necessária ao criar uma tag em um objeto. A chave diferencia maiúsculas de minúsculas e não deve conter o prefixo aws.
+ `value` – String UTF-8 com comprimento não superior a 256 bytes.

  O valor da tag. O valor é opcional ao criar uma tag em um objeto. O valor diferencia maiúsculas de minúsculas e não deve conter o prefixo aws.

## Operações
<a name="aws-glue-api-tags-actions"></a>
+ [Ação TagResource (Python: tag\$1resource)](#aws-glue-api-tags-TagResource)
+ [Ação UntagResource (Python: untag\$1resource)](#aws-glue-api-tags-UntagResource)
+ [Ação GetTags (Python: get\$1tags)](#aws-glue-api-tags-GetTags)

## Ação TagResource (Python: tag\$1resource)
<a name="aws-glue-api-tags-TagResource"></a>

Adiciona etiquetas a um recurso. Uma tag é um rótulo que pode ser atribuído a um recurso da AWS. No AWS Glue, apenas determinados recursos podem ser marcados. Para obter informações sobre quais recursos podem ser marcados, consulte [Tags da AWS no AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html).

Além das permissões de marcação para chamar APIs relacionadas a tags, você também precisa da permissão `glue:GetConnection` para chamar APIs de marcação em conexões e da permissão `glue:GetDatabase` para chamar APIs de marcação em bancos de dados.

**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 do AWS Glue ao qual se deseja adicionar as tags. Para obter mais informações sobre ARNs de recurso do AWS Glue, consulte o [padrão de string de ARN do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-aws-glue-arn-id).
+ `TagsToAdd`: *obrigatório:* uma matriz de mapa dos pares de chave-valor, no máximo 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 a serem adicionadas a esse recurso.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `ResourceNotFoundException`

## Ação UntagResource (Python: untag\$1resource)
<a name="aws-glue-api-tags-UntagResource"></a>

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 GetTags (Python: get\$1tags)
<a name="aws-glue-api-tags-GetTags"></a>

Recupera uma lista de tags associadas a um recurso.

**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 para o qual deseja recuperar as tags.

**Resposta**
+ `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 solicitadas.

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `EntityNotFoundException`

# Tipos de dados comuns
<a name="aws-glue-api-common"></a>

Tipos de dados comuns descrevem os diversos tipos de dados comuns no AWS Glue.

## Estrutura Tag
<a name="aws-glue-api-common-Tag"></a>

O objeto `Tag` representa um rótulo que pode ser atribuído a um recurso da AWS. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos.

Para obter mais informações sobre tags e como controlar o acesso aos recursos no AWS Glue, consulte [Marcações AWS no AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) e [Especificação de ARNs de recurso AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html) no guia do desenvolvedor.

**Campos**
+ `key` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.

  A chave de tags. A chave é necessária ao criar uma tag em um objeto. A chave diferencia maiúsculas de minúsculas e não deve conter o prefixo aws.
+ `value` – String UTF-8 com comprimento não superior a 256 bytes.

  O valor da tag. O valor é opcional ao criar uma tag em um objeto. O valor diferencia maiúsculas de minúsculas e não deve conter o prefixo aws.

## Estrutura DecimalNumber
<a name="aws-glue-api-common-DecimalNumber"></a>

Contém um valor numérico em formato decimal.

**Campos**
+ `UnscaledValue`: *obrigatório:* blob.

  O valor numérico não escalado.
+ `Scale`: *obrigatório:* número (inteiro).

  A escala que determina a posição do ponto decimal no valor não escalado.

## Estrutura ErrorDetail
<a name="aws-glue-api-common-ErrorDetail"></a>

Contém detalhes sobre um erro.

**Campos**
+ `ErrorCode` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](#aws-glue-api-regex-oneLine).

  O código associado a este erro.
+ `ErrorMessage` – 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-regex-uri).

  Uma mensagem descrevendo o erro.

## Estrutura PropertyPredicate
<a name="aws-glue-api-common-PropertyPredicate"></a>

Define um predicado de propriedade.

**Campos**
+ `Key`: string Value com no mínimo 1 e no máximo 1.024 bytes de comprimento.

  A chave da propriedade.
+ `Value`: string Value com no mínimo 1 e no máximo 1.024 bytes de comprimento.

  O valor da propriedade.
+ `Comparator` – string UTF-8 (valores válidos: `EQUALS` \$1 `GREATER_THAN` \$1 `LESS_THAN` \$1 `GREATER_THAN_EQUALS` \$1 `LESS_THAN_EQUALS`).

  O comparador costumava comparar esta propriedade com outras.

## Estrutura ResourceUri
<a name="aws-glue-api-common-ResourceUri"></a>

Os URIs para recursos de função.

**Campos**
+ `ResourceType` – string UTF-8 (valores válidos: `JAR` \$1 `FILE` \$1 `ARCHIVE`).

  O tipo de recurso.
+ `Uri` – 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-regex-uri).

  O URI para acessar o recurso.

## Estrutura ColumnStatistics
<a name="aws-glue-api-common-ColumnStatistics"></a>

Representa as estatísticas de nível de coluna geradas para uma tabela ou partição.

**Campos**
+ `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-regex-oneLine).

  Nome da coluna à qual as estatísticas pertencem.
+ `ColumnType`: *obrigatório:* nome do tipo, no máximo 20.000 bytes de comprimento, correspondente a [Single-line string pattern](#aws-glue-api-regex-oneLine).

  O tipo de dados da coluna.
+ `AnalyzedTime`: *obrigatório:* carimbo de data e hora.

  O carimbo de data e hora do momento em que as estatísticas de colunas foram geradas.
+ `StatisticsData` – *Obrigatório:* um objeto [ColumnStatisticsData](#aws-glue-api-common-ColumnStatisticsData).

  Um objeto `ColumnStatisticData` que contém os valores de dados de estatísticas.

## Estrutura ColumnStatisticsError
<a name="aws-glue-api-common-ColumnStatisticsError"></a>

Encapsula um objeto `ColumnStatistics` que tenha falhado e o motivo da falha.

**Campos**
+ `ColumnStatistics` – Um objeto [ColumnStatistics](#aws-glue-api-common-ColumnStatistics).

  As `ColumnStatistics` da coluna.
+ `Error` – Um objeto [ErrorDetail](#aws-glue-api-common-ErrorDetail).

  Uma mensagem de erro com o motivo da falha de uma operação.

## Estrutura ColumnError
<a name="aws-glue-api-common-ColumnError"></a>

Encapsula um nome de coluna que tenha falhado e o motivo da falha.

**Campos**
+ `ColumnName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](#aws-glue-api-regex-oneLine).

  O nome da coluna que falhou.
+ `Error` – Um objeto [ErrorDetail](#aws-glue-api-common-ErrorDetail).

  Uma mensagem de erro com o motivo da falha de uma operação.

## Estrutura ColumnStatisticsData
<a name="aws-glue-api-common-ColumnStatisticsData"></a>

Contém os tipos individuais de dados de estatísticas de coluna. Apenas um objeto de dados deve ser definido e indicado pelo atributo `Type`.

**Campos**
+ `Type`: *obrigatório:* string UTF-8 (valores válidos: `BOOLEAN` \$1 `DATE` \$1 `DECIMAL` \$1 `DOUBLE` \$1 `LONG` \$1 `STRING` \$1 `BINARY`).

  O tipo de dados de estatísticas de coluna.
+ `BooleanColumnStatisticsData` – Um objeto [BooleanColumnStatisticsData](#aws-glue-api-common-BooleanColumnStatisticsData).

  Dados de estatísticas de coluna booleanos.
+ `DateColumnStatisticsData` – Um objeto [DateColumnStatisticsData](#aws-glue-api-common-DateColumnStatisticsData).

  Dados de estatísticas de coluna de data.
+ `DecimalColumnStatisticsData` – Um objeto [DecimalColumnStatisticsData](#aws-glue-api-common-DecimalColumnStatisticsData).

   Dados de estatísticas de coluna decimais. UnscaledValues internos são objetos binários codificados na Base64 que armazenam representações big-endian de complemento de dois do valor da decimal sem escala. 
+ `DoubleColumnStatisticsData` – Um objeto [DoubleColumnStatisticsData](#aws-glue-api-common-DoubleColumnStatisticsData).

  Dados de estatísticas de coluna double.
+ `LongColumnStatisticsData` – Um objeto [LongColumnStatisticsData](#aws-glue-api-common-LongColumnStatisticsData).

  Dados de estatísticas de coluna inteiros longos.
+ `StringColumnStatisticsData` – Um objeto [StringColumnStatisticsData](#aws-glue-api-common-StringColumnStatisticsData).

  Dados de estatísticas de coluna de string.
+ `BinaryColumnStatisticsData` – Um objeto [BinaryColumnStatisticsData](#aws-glue-api-common-BinaryColumnStatisticsData).

  Dados de estatísticas de coluna binários.

## Estrutura BooleanColumnStatisticsData
<a name="aws-glue-api-common-BooleanColumnStatisticsData"></a>

Define estatísticas de coluna suportadas para colunas de dados booleanos.

**Campos**
+ `NumberOfTrues`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores true na coluna.
+ `NumberOfFalses`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores false na coluna.
+ `NumberOfNulls`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores nulos na coluna.

## Estrutura DateColumnStatisticsData
<a name="aws-glue-api-common-DateColumnStatisticsData"></a>

Define estatísticas de coluna suportadas para colunas de dados de carimbo de data e hora.

**Campos**
+ `MinimumValue` – Timestamp.

  O valor mais baixo na coluna.
+ `MaximumValue` – Timestamp.

  O valor mais alto na coluna.
+ `NumberOfNulls`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores nulos na coluna.
+ `NumberOfDistinctValues`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores distintos em uma coluna.

## Estrutura DecimalColumnStatisticsData
<a name="aws-glue-api-common-DecimalColumnStatisticsData"></a>

Define estatísticas de coluna suportadas para colunas de dados de números de ponto fixo.

**Campos**
+ `MinimumValue` – Um objeto [DecimalNumber](#aws-glue-api-common-DecimalNumber).

  O valor mais baixo na coluna.
+ `MaximumValue` – Um objeto [DecimalNumber](#aws-glue-api-common-DecimalNumber).

  O valor mais alto na coluna.
+ `NumberOfNulls`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores nulos na coluna.
+ `NumberOfDistinctValues`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores distintos em uma coluna.

## Estrutura DoubleColumnStatisticsData
<a name="aws-glue-api-common-DoubleColumnStatisticsData"></a>

Define estatísticas de coluna suportadas para colunas de dados de números de ponto flutuante.

**Campos**
+ `MinimumValue` – Número (duplo).

  O valor mais baixo na coluna.
+ `MaximumValue` – Número (duplo).

  O valor mais alto na coluna.
+ `NumberOfNulls`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores nulos na coluna.
+ `NumberOfDistinctValues`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores distintos em uma coluna.

## Estrutura LongColumnStatisticsData
<a name="aws-glue-api-common-LongColumnStatisticsData"></a>

Define estatísticas de coluna suportadas para colunas de dados inteiros.

**Campos**
+ `MinimumValue` – Número (extenso).

  O valor mais baixo na coluna.
+ `MaximumValue` – Número (extenso).

  O valor mais alto na coluna.
+ `NumberOfNulls`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores nulos na coluna.
+ `NumberOfDistinctValues`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores distintos em uma coluna.

## Estrutura StringColumnStatisticsData
<a name="aws-glue-api-common-StringColumnStatisticsData"></a>

Define estatísticas de coluna suportadas para valores de dados de sequência de caracteres.

**Campos**
+ `MaximumLength`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O tamanho da string mais longa na coluna.
+ `AverageLength`: *obrigatório:* número (double), no máximo nenhum.

  O comprimento médio da string na coluna.
+ `NumberOfNulls`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores nulos na coluna.
+ `NumberOfDistinctValues`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores distintos em uma coluna.

## Estrutura BinaryColumnStatisticsData
<a name="aws-glue-api-common-BinaryColumnStatisticsData"></a>

Define estatísticas de coluna suportadas para valores de dados de sequência de bits.

**Campos**
+ `MaximumLength`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O tamanho da sequência de bits mais longa na coluna.
+ `AverageLength`: *obrigatório:* número (double), no máximo nenhum.

  O comprimento médio da sequência de bits na coluna.
+ `NumberOfNulls`: *obrigatório:* número (inteiro longo), no máximo nenhum.

  O número de valores nulos na coluna.

## Padrões de string
<a name="aws-glue-api-common-_string-patterns"></a>

A API usa as seguintes expressões regulares para definir o que é conteúdo válido para vários membros e parâmetros de string:
+ Single-line string pattern – "`[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`"
+ Padrão de string com várias linhas de endereço URI – "`[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*`"
+ Um padrão de string Logstash Grok – "`[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\t]*`"
+ Padrão de string do identificador – "`[A-Za-z_][A-Za-z0-9_]*`"
+ Padrão de string do ARN da AWS IAM – "`arn:aws:iam::\d{12}:role/.*`"
+ Versão do padrão de string – "`^[a-zA-Z0-9-_]+$`"
+ Padrão de string do grupo de logs – "`[\.\-_/#A-Za-z0-9]+`"
+ Padrão de string do stream de logs – "`[^:*]*`"
+ Padrão de string personalizado n.º \$110 – "`[a-zA-Z0-9-_]+`"
+ Padrão de string personalizado n.º \$111 – "`[-a-zA-Z0-9+=/:_]*`"
+ Padrão de string personalizado n.º \$112 – "`[\S\s]*`"
+ Padrão de string personalizado n.º \$113 – "`.*\S.*`"
+ Padrão de string personalizado n.º \$114 – "`[a-zA-Z0-9-=._/@]+`"
+ Padrão de string personalizado n.º \$115 – "`[1-9][0-9]*|[1-9][0-9]*-[1-9][0-9]*`"
+ Padrão de string personalizado n.º \$116 – "`[A-Z][A-Za-z\.]+`"
+ Padrão de string personalizado n.º \$117 – "`[\S]*`"
+ Padrão de string personalizado n.º \$118 – "`[\w]*`"
+ Padrão de string personalizado n.º \$119 – "`arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`"
+ Padrão de string personalizado n.º \$120 – "`subnet-[a-z0-9]+`"
+ Padrão de string personalizado n.º \$121 – "`\d{12}`"
+ Padrão de string personalizado n.º \$122 – "`([a-z]+)-([a-z]+-)?([a-z]+)-[0-9]+[a-z]+`"
+ Padrão de string personalizado n.º \$123 – "`[a-zA-Z0-9.-]*`"
+ Padrão de string personalizado n.º \$124 – "`arn:aws[a-z0-9\-]*:lambda:[a-z0-9\-]+:\d{12}:function:([\w\-]{1,64})`"
+ Padrão de string personalizado n.º \$125 – "`^(?!(.*[.\/\\]|aws:)).*$`"
+ Padrão de string personalizado n.º \$126 – "`[^\r\n]`"
+ Padrão de string personalizado n.º \$127 – "`^\w+\.\w+\.\w+$`"
+ Padrão de string personalizado n.º \$128 – "`^\w+\.\w+$`"
+ Padrão de string personalizado n.º \$129 – "`^$|arn:aws[a-z0-9-]*:kms:.*`"
+ Padrão de string personalizado n.º \$130 – "`arn:aws[^:]*:iam::[0-9]*:role/.+`"
+ Padrão de string personalizado n.º \$131 – "`[\.\-_A-Za-z0-9]+`"
+ Padrão de string personalizado n.º \$132 – "`^s3://([^/]+)/([^/]+/)*([^/]+)$`"
+ Padrão de string personalizado n.º \$133 – "`.*`"
+ Padrão de string personalizado n.º \$134 – "`^(Sun|Mon|Tue|Wed|Thu|Fri|Sat):([01]?[0-9]|2[0-3])$`"
+ Padrão de string personalizado n.º \$135 – "`[a-zA-Z0-9_.-]+`"
+ Padrão de string personalizado n.º \$136 – "`^arn:aws(-(cn|us-gov|eusc|iso(-[bef])?))?:secretsmanager:.*$`"
+ Padrão de string personalizado n.º \$137 – "`\S+`"
+ Padrão de string personalizado n.º \$138 – "`^[\x20-\x7E]*$`"
+ Padrão de string personalizado n.º \$139 – "`^([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_\-\+\/=]*)`"
+ Padrão de string personalizado n.º \$140 – "`^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]`"
+ Padrão de string personalizado n.º \$141 – "`^(https?):\/\/[^\s/$.?#].[^\s]*$`"
+ Padrão de string personalizado n.º \$142 – "`arn:aws:kms:.*`"
+ Padrão de string personalizado n.º \$143 – "`^subnet-[a-z0-9]+$`"
+ Padrão de string personalizado n.º \$144 – "`[\p{L}\p{N}\p{P}]*`"
+ Padrão de string personalizado n.º \$145 – "`[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`"
+ Padrão de string personalizado n.º \$146 – "`[a-zA-Z0-9-_$#.]+`"
+ Padrão de string personalizado n.º \$147 – "`^\d{12}$`"
+ Padrão de string personalizado n.º \$148 – "`^(\w+\.)+\w+$`"
+ Padrão de string personalizado n.º \$149 – "`^([2-3]|3[.]9)$`"
+ Padrão de string personalizado n.º \$150 – "`arn:aws(-(cn|us-gov|eusc|iso(-[bef])?))?:glue:.*`"
+ Padrão de string personalizado n.º \$151 – "`[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`"
+ Padrão de string personalizado n.º \$152 – "`(^arn:aws(-(cn|us-gov|eusc|iso(-[bef])?))?:iam::\w{12}:root)`"
+ Padrão de string personalizado n.º \$153 – "`^arn:aws(-(cn|us-gov|eusc|iso(-[bef])?))?:iam::[0-9]{12}:role/.+`"
+ Padrão de string personalizado n.º \$154 – "`[\s\S]*`"
+ Padrão de string personalizado n.º \$155 – "`([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'= ;])*`"
+ Padrão de string personalizado n.º \$156 – "`^[A-Z\_]+$`"
+ Padrão de string personalizado n.º \$157 – "`^[A-Za-z0-9]+$`"
+ Padrão de string personalizado n.º \$158 – "`[*A-Za-z0-9_-]*`"
+ Padrão de string personalizado n.º \$159 – "`([\u0020-\u007E\r\s\n])*`"
+ Padrão de string personalizado n.º \$160 – "`[A-Za-z0-9_-]*`"
+ Padrão de string personalizado n.º \$161 – "`([\u0009\u000B\u000C\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF])*`"
+ Padrão de string personalizado n.º \$162 – "`([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\s])*`"
+ Padrão de string personalizado n.º \$163 – "`([^\r\n])*`"

# Exceções
<a name="aws-glue-api-exceptions"></a>

Esta seção descreve as exceções do AWS Glue que você pode usar para encontrar a origem dos problemas e corrigi-los. Para obter mais informações sobre códigos de erro HTTP e strings para exceções relacionadas a machine learning, consulte [Exceções de machine learning do AWS Glue](exceptions-machine-learning.md).

## Estrutura AccessDeniedException
<a name="aws-glue-api-exceptions-AccessDeniedException"></a>

O acesso a um recurso foi negado.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura AlreadyExistsException
<a name="aws-glue-api-exceptions-AlreadyExistsException"></a>

Um recurso a ser criado ou adicionado já existe.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura ConcurrentModificationException
<a name="aws-glue-api-exceptions-ConcurrentModificationException"></a>

Dois processos estão tentando modificar um recurso simultaneamente.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura ConcurrentRunsExceededException
<a name="aws-glue-api-exceptions-ConcurrentRunsExceededException"></a>

Muitos trabalhos estão sendo executados simultaneamente.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura CrawlerNotRunningException
<a name="aws-glue-api-exceptions-CrawlerNotRunningException"></a>

O crawler especificado não está sendo executado.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura CrawlerRunningException
<a name="aws-glue-api-exceptions-CrawlerRunningException"></a>

A operação não pode ser realizada porque o crawler já está sendo executado.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura CrawlerStoppingException
<a name="aws-glue-api-exceptions-CrawlerStoppingException"></a>

O crawler especificado está sendo interrompido.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura EntityNotFoundException
<a name="aws-glue-api-exceptions-EntityNotFoundException"></a>

Uma entidade especificada não existe

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.
+ `FromFederationSource` – Booleano.

  Indica se a exceção está relacionada ou não a uma fonte federada.

## Estrutura FederationSourceException
<a name="aws-glue-api-exceptions-FederationSourceException"></a>

Uma fonte de federação falhou.

**Campos**
+ `FederationSourceErrorCode`: string UTF-8 (valores válidos: `AccessDeniedException` \$1 `EntityNotFoundException` \$1 `InvalidCredentialsException` \$1 `InvalidInputException` \$1 `InvalidResponseException` \$1 `OperationTimeoutException` \$1 `OperationNotSupportedException` \$1 `InternalServiceException` \$1 `PartialFailureException` \$1 `ThrottlingException`).

  O código de erro do problema.
+ `Message` – String UTF-8.

  A mensagem descrevendo o problema.

## Estrutura FederationSourceRetryableException
<a name="aws-glue-api-exceptions-FederationSourceRetryableException"></a>

Uma fonte de federação falhou, mas a operação pode ser repetida.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura de GlueEncryptionException
<a name="aws-glue-api-exceptions-GlueEncryptionException"></a>

Uma operação de criptografia falhou.

**Campos**
+ `Message` – String UTF-8.

  A mensagem descrevendo o problema.

## Estrutura IdempotentParameterMismatchException
<a name="aws-glue-api-exceptions-IdempotentParameterMismatchException"></a>

O mesmo identificador exclusivo foi associado a dois registros diferentes.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura IllegalWorkflowStateException
<a name="aws-glue-api-exceptions-IllegalWorkflowStateException"></a>

O fluxo de trabalho está em um estado inválido para executar uma operação solicitada.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura InternalServiceException
<a name="aws-glue-api-exceptions-InternalServiceException"></a>

Ocorreu um erro interno de serviço.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura InvalidExecutionEngineException
<a name="aws-glue-api-exceptions-InvalidExecutionEngineException"></a>

Um mecanismo de execução desconhecido ou inválido foi especificado.

**Campos**
+ `message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura InvalidInputException
<a name="aws-glue-api-exceptions-InvalidInputException"></a>

A entrada fornecida não é válida.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.
+ `FromFederationSource` – Booleano.

  Indica se a exceção está relacionada ou não a uma fonte federada.

## Estrutura InvalidStateException
<a name="aws-glue-api-exceptions-InvalidStateException"></a>

Um erro que indica que seus dados estão em um estado inválido.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura InvalidTaskStatusTransitionException
<a name="aws-glue-api-exceptions-InvalidTaskStatusTransitionException"></a>

A transição adequada de uma tarefa para a próxima falhou.

**Campos**
+ `message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura JobDefinitionErrorException
<a name="aws-glue-api-exceptions-JobDefinitionErrorException"></a>

Uma definição de trabalho não é válida.

**Campos**
+ `message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura JobRunInTerminalStateException
<a name="aws-glue-api-exceptions-JobRunInTerminalStateException"></a>

O estado terminal de uma execução de trabalho sinaliza uma falha.

**Campos**
+ `message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura JobRunInvalidStateTransitionException
<a name="aws-glue-api-exceptions-JobRunInvalidStateTransitionException"></a>

Uma execução de trabalho encontrou uma transição inválida do estado de origem para o estado de destino.

**Campos**
+ `jobRunId` – 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 execução de trabalho em questão.
+ `message` – String UTF-8.

  Uma mensagem descrevendo o problema.
+ `sourceState`: string UTF-8 (valores válidos: `STARTING` \$1 `RUNNING` \$1 `STOPPING` \$1 `STOPPED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `TIMEOUT` \$1 `ERROR` \$1 `WAITING` \$1 `EXPIRED`).

  O estado de origem.
+ `targetState`: string UTF-8 (valores válidos: `STARTING` \$1 `RUNNING` \$1 `STOPPING` \$1 `STOPPED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `TIMEOUT` \$1 `ERROR` \$1 `WAITING` \$1 `EXPIRED`).

  O estado do destino.

## Estrutura JobRunNotInTerminalStateException
<a name="aws-glue-api-exceptions-JobRunNotInTerminalStateException"></a>

Uma execução de trabalho não está em um estado terminal.

**Campos**
+ `message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura LateRunnerException
<a name="aws-glue-api-exceptions-LateRunnerException"></a>

Um executor de trabalho está atrasado.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura NoScheduleException
<a name="aws-glue-api-exceptions-NoScheduleException"></a>

Não há uma programação aplicável.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura OperationTimeoutException
<a name="aws-glue-api-exceptions-OperationTimeoutException"></a>

A operação expirou.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura ResourceNotReadyException
<a name="aws-glue-api-exceptions-ResourceNotReadyException"></a>

Um recurso não estava pronto para uma transação.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura ResourceNumberLimitExceededException
<a name="aws-glue-api-exceptions-ResourceNumberLimitExceededException"></a>

Um limite numérico de recursos foi excedido.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura SchedulerNotRunningException
<a name="aws-glue-api-exceptions-SchedulerNotRunningException"></a>

O programador especificado não está sendo executado.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura SchedulerRunningException
<a name="aws-glue-api-exceptions-SchedulerRunningException"></a>

O programador especificado já está sendo executado.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura SchedulerTransitioningException
<a name="aws-glue-api-exceptions-SchedulerTransitioningException"></a>

O programador especificado está em transição.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura UnrecognizedRunnerException
<a name="aws-glue-api-exceptions-UnrecognizedRunnerException"></a>

O executor de trabalho não foi reconhecido.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura ValidationException
<a name="aws-glue-api-exceptions-ValidationException"></a>

Não foi possível validar um valor.

**Campos**
+ `Message` – String UTF-8.

  Uma mensagem descrevendo o problema.

## Estrutura VersionMismatchException
<a name="aws-glue-api-exceptions-VersionMismatchException"></a>

Houve um conflito de versão.

**Campos**
+ `message` – String UTF-8.

  Uma mensagem descrevendo o problema.