# API de objetos del catálogo La API de objetos del catálogo describe los tipos de datos y la API relacionada con el trabajo con catálogos en AWS Glue. **Topics** + [API de catálogos](aws-glue-api-catalog-catalogs.md) + [API de la base de datos](aws-glue-api-catalog-databases.md) + [API de tabla](aws-glue-api-catalog-tables.md) + [API de partición](aws-glue-api-catalog-partitions.md) + [API de conexión](aws-glue-api-catalog-connections.md) + [API de funciones definidas por el usuario](aws-glue-api-catalog-functions.md) + [Importación de un catálogo de Athena a AWS Glue](aws-glue-api-catalog-migration.md) # API de catálogos La API de catálogos describe las API de creación, eliminación, localización, actualización y creación de listados de catálogos. ## Tipos de datos + [Estructura del catálogo](#aws-glue-api-catalog-catalogs-Catalog) + [Estructura CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput) + [Estructura TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog) + [Estructura CatalogoProperties](#aws-glue-api-catalog-catalogs-CatalogProperties) + [Estructura CatalogPropertiesOutput](#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput) + [Estructura de DataLakeAccessProperties](#aws-glue-api-catalog-catalogs-DataLakeAccessProperties) + [Estructura IcebergOptimizationProperties](#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties) + [Estructura de DataLakeAccessPropertiesOutput](#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput) + [Estructura IcebergOptimizationPropertiesOutput](#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput) + [Estructura FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog) ## Estructura del catálogo El objeto de catálogo representa una agrupación lógica de bases de datos en el catálogo de datos de AWS Glue o en un origen federado. Puede crear un catálogo federado de Redshift o un catálogo que contenga enlaces de recursos a bases de datos de Redshift en otra cuenta o región. **Campos** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Es el ID del catálogo. Para permitir el acceso al catálogo predeterminado, no debe proporcionar este campo. + `Name` (*requerido*): cadena UTF-8, cuya extensión tenga 1 byte como mínimo y 64 bytes como máximo y que coincide con [Custom string pattern #25](aws-glue-api-common.md#regex_25). Es el nombre del catálogo. No puede ser el mismo que el ID de la cuenta. + `ResourceArn`: cadena UTF-8. Es el nombre de recurso de Amazon (ARN) asignado al recurso del catálogo. + `Description` – cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Cadena de descripción, cuya extensión no sea más de 2048 bytes y que coincida con el patrón de cadena de varias líneas de la dirección URI. Es una descripción del catálogo. + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Matriz de mapas de pares clave-valor que define los parámetros y las propiedades del catálogo. + `CreateTime`: marca temporal. Es la hora a la que se creó el catálogo. + `UpdateTime`: marca temporal. Es la hora en la que se actualizó el catálogo por última vez. + `TargetRedshiftCatalog`: un objeto [TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog). Objeto `TargetRedshiftCatalog` que describe un catálogo de destino para la vinculación de recursos de la base de datos. + `FederatedCatalog`: un objeto [FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog). Objeto `FederatedCatalog` que apunta a una entidad externa al catálogo de datos de AWS Glue. + `CatalogProperties`: un objeto [CatalogPropertiesOutput](#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput). Objeto `CatalogProperties` que especifica las propiedades de acceso al lago de datos y otras propiedades personalizadas. + `CreateTableDefaultPermissions`: matriz de objetos [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions). Una matriz de objetos `PrincipalPermissions`. Permite crear un conjunto de permisos predeterminados en las tablas de las entidades principales. Lo utiliza AWS Lake Formation. No se utiliza en el transcurso normal de las operaciones de AWS Glue. + `CreateDatabaseDefaultPermissions`: matriz de objetos [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions). Una matriz de objetos `PrincipalPermissions`. Permite crear un conjunto de permisos predeterminados en las bases de datos de las entidades principales. Lo utiliza AWS Lake Formation. No se utiliza en el transcurso normal de las operaciones de AWS Glue. + `AllowFullTableExternalDataAccess` – Cadena UTF-8 (valores válidos: `True` \$1 `False`). Permite que motores de terceros accedan a datos en ubicaciones de Amazon S3 registradas en Lake Formation. ## Estructura CatalogInput Estructura que describe las propiedades del catálogo. **Campos** + `Description` – cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Cadena de descripción, cuya extensión no sea más de 2048 bytes y que coincida con el patrón de cadena de varias líneas de la dirección URI. Es una descripción del catálogo. + `FederatedCatalog`: un objeto [FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog). Un objeto `FederatedCatalog`. Estructura `FederatedCatalog` que hace referencia a una entidad externa al catálogo de datos de AWS Glue; por ejemplo, una base de datos de Redshift. + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Matriz de mapas de pares clave-valor que define los parámetros y las propiedades del catálogo. + `TargetRedshiftCatalog`: un objeto [TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog). Objeto `TargetRedshiftCatalog` que describe un catálogo de destino para la vinculación de recursos. + `CatalogProperties`: un objeto [CatalogProperties](#aws-glue-api-catalog-catalogs-CatalogProperties). Objeto `CatalogProperties` que especifica las propiedades de acceso al lago de datos y otras propiedades personalizadas. + `CreateTableDefaultPermissions`: matriz de objetos [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions). Una matriz de objetos `PrincipalPermissions`. Permite crear un conjunto de permisos predeterminados en las tablas de las entidades principales. Lo utiliza AWS Lake Formation. Por lo general, se debe establecer de forma explícita como una lista vacía. + `CreateDatabaseDefaultPermissions`: matriz de objetos [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions). Una matriz de objetos `PrincipalPermissions`. Permite crear un conjunto de permisos predeterminados en las bases de datos de las entidades principales. Lo utiliza AWS Lake Formation. Por lo general, se debe establecer de forma explícita como una lista vacía. + `AllowFullTableExternalDataAccess` – Cadena UTF-8 (valores válidos: `True` \$1 `False`). Permite que motores de terceros accedan a datos en ubicaciones de Amazon S3 registradas en Lake Formation. ## Estructura TargetRedshiftCatalog Estructura que describe un catálogo de destino para la vinculación de recursos. **Campos** + `CatalogArn` – *Obligatorio:* cadena UTF-8. El nombre de recurso de Amazon (ARN) del recurso de catálogo. ## Estructura CatalogoProperties Estructura que especifica las propiedades de acceso al lago de datos y otras propiedades personalizadas. **Campos** + `DataLakeAccessProperties`: un objeto [DataLakeAccessProperties](#aws-glue-api-catalog-catalogs-DataLakeAccessProperties). Objeto `DataLakeAccessProperties` que especifica las propiedades para configurar el acceso al lago de datos del recurso de catálogo en el catálogo de datos de AWS Glue. + `IcebergOptimizationProperties`: un objeto [IcebergOptimizationProperties](#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties). Estructura que especifica las propiedades de optimización de la tabla de Iceberg para el catálogo. Esto incluye la configuración para las operaciones de compactación, retención y eliminación de archivos huérfanos que se pueden aplicar a las tablas de Iceberg de este catálogo. + `CustomProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Propiedades de valores clave adicionales para el catálogo, como las optimizaciones de las estadísticas de columnas. ## Estructura CatalogPropertiesOutput Atributos de propiedad que incluyen las propiedades de configuración del recurso del catálogo. **Campos** + `DataLakeAccessProperties`: un objeto [DataLakeAccessPropertiesOutput](#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput). Objeto `DataLakeAccessProperties` con propiedades de entrada para configurar el acceso al lago de datos del recurso de catálogo en el catálogo de datos de AWS Glue. + `IcebergOptimizationProperties`: un objeto [IcebergOptimizationPropertiesOutput](#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput). Un objeto `IcebergOptimizationPropertiesOutput` que especifica la configuración de optimización de las tablas de Iceberg para el catálogo, incluidas las configuraciones para las operaciones de compactación, retención y eliminación de archivos huérfanos. + `CustomProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Propiedades de valores clave adicionales para el catálogo, como las optimizaciones de las estadísticas de columnas. ## Estructura de DataLakeAccessProperties Propiedades de entrada para configurar el acceso al lago de datos del recurso de catálogo en el catálogo de datos de AWS Glue. **Campos** + `DataLakeAccess`: booleano. Permite activar o desactivar el acceso al lago de datos en las aplicaciones de Apache Spark que acceden a las bases de datos de Amazon Redshift del catálogo de datos desde cualquier motor que no sea Redshift, como Amazon Athena, Amazon EMR o ETL AWS Glue. + `DataTransferRole` – cadena UTF-8 que coincide con el [Custom string pattern #53](aws-glue-api-common.md#regex_53). Rol que asumirá AWS Glue para realizar la transferencia de datos hacia o desde el bucket transitorio durante una consulta. + `KmsKey`: cadena UTF-8. Clave de cifrado que se utilizará en el bucket transitorio y que se creará junto con el catálogo. + `CatalogType` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Especifica un tipo de catálogo federado para el recurso de catálogo nativo. El tipo que se admite actualmente es `aws:redshift`. ## Estructura IcebergOptimizationProperties Una estructura que especifica las propiedades de optimización de las tablas de Iceberg para el catálogo, incluidas las configuraciones para las operaciones de compactación, retención y eliminación de archivos huérfanos. **Campos** + `RoleArn` – cadena UTF-8 que coincide con el [Custom string pattern #53](aws-glue-api-common.md#regex_53). El nombre de recurso de Amazon (ARN) del rol de IAM que se asumirá para llevar a cabo las operaciones de optimización de la tabla de Iceberg. + `Compaction`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Un mapa de pares clave-valor que especifica los parámetros de configuración para las operaciones de compactación de tablas de Iceberg, que optimizan el diseño de los archivos de datos para mejorar el rendimiento de las consultas. + `Retention`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Un mapa de pares clave-valor que especifica los parámetros de configuración para las operaciones de retención de tablas de Iceberg, que gestionan el ciclo de vida de las instantáneas de las tablas para controlar los costos de almacenamiento. + `OrphanFileDeletion`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Un mapa de pares clave-valor que especifica los parámetros de configuración para las operaciones de eliminación de archivos huérfanos de Iceberg, que identifican y eliminan los archivos a los que los metadatos de la tabla ya no hacen referencia. ## Estructura de DataLakeAccessPropertiesOutput Propiedades de salida para configurar el acceso al lago de datos del recurso de catálogo en el catálogo de datos de AWS Glue. **Campos** + `DataLakeAccess`: booleano. Permite activar o desactivar el acceso al lago de datos en las aplicaciones de Apache Spark que acceden a las bases de datos de Amazon Redshift del catálogo de datos. + `DataTransferRole` – cadena UTF-8 que coincide con el [Custom string pattern #53](aws-glue-api-common.md#regex_53). Rol que asumirá AWS Glue para realizar la transferencia de datos hacia o desde el bucket transitorio durante una consulta. + `KmsKey`: cadena UTF-8. Clave de cifrado que se utilizará en el bucket transitorio y que se creará junto con el catálogo. + `ManagedWorkgroupName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Es el nombre de computación administrado de Redshift sin servidor que se crea para el recurso de catálogo. + `ManagedWorkgroupStatus` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Es el estado de computación administrado de Redshift sin servidor. + `RedshiftDatabaseName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Es el nombre predeterminado del recurso de base de datos de Redshift en la computación administrada. + `StatusMessage` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Mensaje que proporciona información más detallada sobre el estado del grupo de trabajo administrado. + `CatalogType` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Especifica un tipo de catálogo federado para el recurso de catálogo nativo. El tipo que se admite actualmente es `aws:redshift`. ## Estructura IcebergOptimizationPropertiesOutput Una estructura que contiene las propiedades de salida de la configuración de la optimización de la tabla de Iceberg para el recurso de catálogo en el Catálogo de datos de AWS Glue. **Campos** + `RoleArn` – cadena UTF-8 que coincide con el [Custom string pattern #53](aws-glue-api-common.md#regex_53). El nombre de recurso de Amazon (ARN) del rol de IAM que se asume para llevar a cabo las operaciones de optimización de la tabla de Iceberg. + `Compaction`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Un mapa de pares clave-valor que especifica los parámetros de configuración para las operaciones de compactación de tablas de Iceberg, que optimizan el diseño de los archivos de datos para mejorar el rendimiento de las consultas. + `Retention`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Un mapa de pares clave-valor que especifica los parámetros de configuración para las operaciones de retención de tablas de Iceberg, que gestionan el ciclo de vida de las instantáneas de las tablas para controlar los costos de almacenamiento. + `OrphanFileDeletion`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Un mapa de pares clave-valor que especifica los parámetros de configuración para las operaciones de eliminación de archivos huérfanos de Iceberg, que identifican y eliminan los archivos a los que los metadatos de la tabla ya no hacen referencia. + `LastUpdatedTime`: marca temporal. La marca de tiempo de la última actualización de las propiedades de optimización de Iceberg. ## Estructura FederatedCatalog Catálogo que apunta a una entidad externa al catálogo de datos de AWS Glue. **Campos** + `Identifier` – cadena UTF-8, con 1 byte de largo como mínimo y 512 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identificador único del catálogo federado. + `ConnectionName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Es el nombre de la conexión a un origen de datos externo; por ejemplo, un catálogo federado de Redshift. + `ConnectionType` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El tipo de conexión utilizado para acceder al catálogo federado, que especifica el protocolo o método de conexión con el origen de datos externo. ## Operaciones + [Acción CreateCatalog (Python: create\$1catalog)](#aws-glue-api-catalog-catalogs-CreateCatalog) + [Acción UpdateCatalog (Python: update\$1catalog)](#aws-glue-api-catalog-catalogs-UpdateCatalog) + [Acción DeleteCatalog (Python: delete\$1catalog)](#aws-glue-api-catalog-catalogs-DeleteCatalog) + [Acción GetCatalog (Python: get\$1catalog)](#aws-glue-api-catalog-catalogs-GetCatalog) + [Acción GetCatalogs (Python: get\$1catalogs)](#aws-glue-api-catalog-catalogs-GetCatalogs) ## Acción CreateCatalog (Python: create\$1catalog) Permite crear un nuevo catálogo en el catálogo de datos de AWS Glue. **Solicitud** + `Name` (*requerido*): cadena UTF-8, cuya extensión tenga 1 byte como mínimo y 64 bytes como máximo y que coincide con [Custom string pattern #25](aws-glue-api-common.md#regex_25). Nombre del catálogo que se va a crear. + `CatalogInput`: *obligatorio:* objeto [CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput). Objeto `CatalogInput` que define los metadatos del catálogo. + `Tags`: matriz de mapas de pares de clave-valor, con 50 pares como máximo. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo. Matriz de mapas de pares clave-valor, con 50 pares como máximo. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo. Son las etiquetas que asigna al catálogo. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `InvalidInputException` + `AlreadyExistsException` + `ResourceNumberLimitExceededException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `ConcurrentModificationException` + `AccessDeniedException` + `EntityNotFoundException` + `FederatedResourceAlreadyExistsException` + `FederationSourceException` ## Acción UpdateCatalog (Python: update\$1catalog) Permite actualizar las propiedades de un catálogo existente en el catálogo de datos de AWS Glue. **Solicitud** + `CatalogId`: *Obligatorio:* cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Es el ID del catálogo. + `CatalogInput`: *obligatorio:* objeto [CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput). Objeto `CatalogInput` que especifica las propiedades nuevas de un catálogo existente. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `ConcurrentModificationException` + `AccessDeniedException` + `FederationSourceException` ## Acción DeleteCatalog (Python: delete\$1catalog) Permite eliminar el catálogo especificado del catálogo de datos de AWS Glue. Después de completar esta operación, ya no tendrá acceso a las bases de datos, tablas (y todas las versiones y particiones de tabla que podrían pertenecer a las tablas) ni a las funciones definidas por el usuario en el catálogo eliminado. AWS Glue elimina estos recursos “huérfanos” de manera asíncrona y oportuna, según lo solicite el servicio. Para garantizar la eliminación inmediata de todos los recursos relacionados, antes de llamar a la operación `DeleteCatalog`, use `DeleteTableVersion` (o `BatchDeleteTableVersion`), `DeletePartition` (o `BatchDeletePartition`), `DeleteTable` (o `BatchDeleteTable`), `DeleteUserDefinedFunction` y `DeleteDatabase` para eliminar todos los recursos que pertenezcan al catálogo. **Solicitud** + `CatalogId`: *Obligatorio:* cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Es el ID del catálogo. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `ConcurrentModificationException` + `AccessDeniedException` + `FederationSourceException` ## Acción GetCatalog (Python: get\$1catalog) Es el nombre del catálogo que se va a recuperar. Debe estar todo en minúsculas. **Solicitud** + `CatalogId`: *Obligatorio:* cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID del catálogo principal donde reside el catálogo. Si no se proporciona ninguno, se usará de forma predeterminada el número de cuenta de AWS. **Respuesta** + `Catalog`: un objeto [Catálogo](#aws-glue-api-catalog-catalogs-Catalog). Un objeto `Catalog`. Definición del catálogo especificado en el catálogo de datos de AWS Glue. **Errores** + `InvalidInputException` + `EntityNotFoundException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `AccessDeniedException` + `EntityNotFoundException` + `FederationSourceException` + `FederationSourceRetryableException` ## Acción GetCatalogs (Python: get\$1catalogs) Permite recuperar todos los catálogos definidos en un catálogo del catálogo de datos de AWS Glue. Para un caso de uso de un catálogo federado por Redshift, esta operación devuelve la lista de catálogos asignados a las bases de datos de Redshift en el catálogo de espacios de nombres de Redshift. **Solicitud** + `ParentCatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID del catálogo principal donde reside el catálogo. Si no se proporciona ninguno, se usará de forma predeterminada el número de cuenta de AWS. + `NextToken`: cadena UTF-8. Token de continuación si se trata de una llamada de continuidad. + `MaxResults`: número (entero) que no es inferior a 1 ni es superior a 1000. Número máximo de catálogos que se devuelven en una respuesta. + `Recursive`: booleano. Indica si se deben listar todos los catálogos a lo largo de la jerarquía de catálogos, comenzando desde el `ParentCatalogId`. El valor predeterminado es `false` . Cuando `true`, todos los objetos de catálogo en la jerarquía `ParentCatalogID` se enumeran en la respuesta. + `IncludeRoot`: booleano. Indica si se debe listar el catálogo predeterminado de la cuenta y la región en la respuesta. El valor predeterminado es `false`. Cuando `true` y `ParentCatalogId = NULL | AWS Account ID`, todos los catálogos y el catálogo predeterminado se enumeran en la respuesta. Cuando el `ParentCatalogId` no es igual a nulo y este atributo se pasa como `false` o `true`, se lanza un `InvalidInputException`. **Respuesta** + `CatalogList` *(obligatorio):* una matriz de objetos [Catálogo](#aws-glue-api-catalog-catalogs-Catalog). Una matriz de objetos `Catalog`. Lista de objetos `Catalog` del catálogo principal especificado. + `NextToken`: cadena UTF-8. Token de continuación para paginar la lista de tokens obtenida; se devuelve si el segmento actual de la lista no es el último. **Errores** + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `AccessDeniedException` + `EntityNotFoundException` + `FederationSourceException` + `FederationSourceRetryableException` # API de la base de datos La API de la base de datos describe los tipos de datos de la base de datos e incluye la API de creación, eliminación, ubicación, actualización y enumeración de las bases de datos. ## Tipos de datos + [Estructura de base de datos](#aws-glue-api-catalog-databases-Database) + [Estructura DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput) + [Estructura PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions) + [Estructura DataLakePrincipal](#aws-glue-api-catalog-databases-DataLakePrincipal) + [Estructura DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier) + [Estructura de FederatedDatabase](#aws-glue-api-catalog-databases-FederatedDatabase) ## Estructura de base de datos El objeto `Database` representa una agrupación lógica de tablas que puede residir en un metaalmacén de Hive o en un RDBMS. **Campos** + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos. Para su compatibilidad con Hive, este se incorpora en minúsculas al almacenarse. + `Description`: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Una descripción de la base de datos. + `LocationUri`: identificador uniforme de recursos (uri), con 1 byte de largo como mínimo y 1024 bytes de largo como máximo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). La ubicación de la base de datos (por ejemplo, una ruta de HDFS). + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Estos pares de clave-valor definen los parámetros y las propiedades de la base de datos. + `CreateTime`: marca temporal. Hora de creación de la base de datos de metadatos en el catálogo. + `CreateTableDefaultPermissions`: matriz de objetos [PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions). Permite crear un conjunto de permisos predeterminados en la tabla para las entidades principales. Utilizado por AWS Lake Formation. No se utiliza en el transcurso normal de las operaciones de AWS Glue. + `TargetDatabase`: un objeto [DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier). Estructura `DatabaseIdentifier` que describe una base de datos de destino para la vinculación de recursos. + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la base de datos. + `FederatedDatabase`: un objeto [FederatedDatabase](#aws-glue-api-catalog-databases-FederatedDatabase). Una estructura `FederatedDatabase` que hace referencia a una entidad externa aAWS Glue Data Catalog. ## Estructura DatabaseInput Estructura usada para crear o actualizar una base de datos. **Campos** + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos. Para su compatibilidad con Hive, este se incorpora en minúsculas al almacenarse. + `Description`: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Una descripción de la base de datos. + `LocationUri`: identificador uniforme de recursos (uri), con 1 byte de largo como mínimo y 1024 bytes de largo como máximo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). La ubicación de la base de datos (por ejemplo, una ruta de HDFS). + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Estos pares de clave-valor definen los parámetros y las propiedades de la base de datos. Estos pares de clave-valor definen los parámetros y las propiedades de la base de datos. + `CreateTableDefaultPermissions`: matriz de objetos [PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions). Permite crear un conjunto de permisos predeterminados en la tabla para las entidades principales. Utilizado por AWS Lake Formation. No se utiliza en el transcurso normal de las operaciones de AWS Glue. + `TargetDatabase`: un objeto [DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier). Estructura `DatabaseIdentifier` que describe una base de datos de destino para la vinculación de recursos. + `FederatedDatabase`: un objeto [FederatedDatabase](#aws-glue-api-catalog-databases-FederatedDatabase). Una estructura `FederatedDatabase` que hace referencia a una entidad externa aAWS Glue Data Catalog. ## Estructura PrincipalPermissions Permisos concedidos a una entidad principal. **Campos** + `Principal`: un objeto [DataLakePrincipal](#aws-glue-api-catalog-databases-DataLakePrincipal). La entidad principal a la que se conceden los permisos. + `Permissions`: matriz de cadenas UTF-8. Los permisos que se conceden al principal. ## Estructura DataLakePrincipal La AWS Lake Formation principal. **Campos** + `DataLakePrincipalIdentifier`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo. Un identificador para la AWS Lake Formation principal. ## Estructura DatabaseIdentifier Estructura que describe una base de datos de destino para la vinculación de recursos. **Campos** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la base de datos. + `DatabaseName`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la base de datos del catálogo. + `Region`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Región de la base de datos objetivo. ## Estructura de FederatedDatabase Una base de datos que apunta a una entidad externa a AWS Glue Data Catalog. **Campos** + `Identifier`: cadena UTF-8, con 1 byte de largo como mínimo y 512 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Un identificador único para la base de datos federada. + `ConnectionName`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la conexión al metalmacén externo. + `ConnectionType`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El tipo de conexión utilizado para acceder a la base de datos federada, como JDBC, ODBC u otros protocolos de conexión compatibles. ## Operaciones + [Acción CreateDatabase (Python: create\$1database)](#aws-glue-api-catalog-databases-CreateDatabase) + [Acción UpdateDatabase (Python: update\$1database)](#aws-glue-api-catalog-databases-UpdateDatabase) + [Acción DeleteDatabase (Python: delete\$1database)](#aws-glue-api-catalog-databases-DeleteDatabase) + [Acción GetDatabase (Python: get\$1database)](#aws-glue-api-catalog-databases-GetDatabase) + [Acción GetDatabases (Python: get\$1databases)](#aws-glue-api-catalog-databases-GetDatabases) ## Acción CreateDatabase (Python: create\$1database) Crea una base de datos nueva en un Catálogo de datos. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde se crea la base de datos. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseInput`: *obligatorio:* objeto [DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput). Los metadatos de la base de datos. + `Tags`: matriz de mapas de pares de clave-valor, con 50 pares como máximo. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo. Las etiquetas que asigna a la base de datos. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `InvalidInputException` + `AlreadyExistsException` + `ResourceNumberLimitExceededException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `ConcurrentModificationException` + `FederatedResourceAlreadyExistsException` + `FederationSourceException` + `FederationSourceRetryableException` ## Acción UpdateDatabase (Python: update\$1database) Actualiza una definición de base de datos existente en un Catálogo de datos. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la base de datos de metadatos. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la base de datos que debe actualizarse en el catálogo. Para su compatibilidad con Hive, se convierte en minúsculas. + `DatabaseInput`: *obligatorio:* objeto [DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput). Objeto `DatabaseInput` que especifica la nueva definición de la base de datos de metadatos en el catálogo. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `ConcurrentModificationException` + `FederationSourceException` + `FederationSourceRetryableException` + `AlreadyExistsException` ## Acción DeleteDatabase (Python: delete\$1database) Elimina una base de datos especificada de un Catálogo de datos. **nota** Después de completar esta operación, ya no tendrá acceso a las tablas (y todas las versiones y particiones de tabla que podrían pertenecer a las tablas) ni a las funciones definidas por el usuario en la base de datos eliminada. AWS Glue elimina estos recursos “huérfanos” de manera asíncrona en forma oportuna, a discreción del servicio. Para asegurarse de la eliminación inmediata de todos los recursos relacionados, antes de llamar a `DeleteDatabase`, use `DeleteTableVersion` o `BatchDeleteTableVersion`, `DeletePartition` o `BatchDeletePartition`, `DeleteUserDefinedFunction` y `DeleteTable` o `BatchDeleteTable` para eliminar todos los recursos que pertenezcan a la base de datos. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la base de datos. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos que se va a eliminar. Para su compatibilidad con Hive, este debe estar completamente en minúsculas. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `ConcurrentModificationException` + `FederationSourceException` + `FederationSourceRetryableException` ## Acción GetDatabase (Python: get\$1database) Recupera la definición de una base de datos especificada. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la base de datos. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la base de datos que debe recuperarse. Para su compatibilidad con Hive, el nombre debe estar completamente en minúsculas. **Respuesta** + `Database`: un objeto [Base de datos](#aws-glue-api-catalog-databases-Database). La definición de la base de datos especificada en el catálogo. **Errores** + `InvalidInputException` + `EntityNotFoundException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `FederationSourceException` + `FederationSourceRetryableException` ## Acción GetDatabases (Python: get\$1databases) Recupera todas las bases de datos definidas en un Catálogo de datos determinado. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde se recuperará `Databases`. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `NextToken`: cadena UTF-8. Token de continuación si se trata de una llamada de continuidad. + `MaxResults`: número (entero) que no es inferior a 1 ni es superior a 100. Número máximo de bases de datos que se devuelven en una respuesta. + `ResourceShareType`: cadena UTF-8 (valores válidos: `FOREIGN` \$1 `ALL` \$1 `FEDERATED`). Le permite especificar que desea enumerar las bases de datos compartidas con su cuenta. Los valores permitidos son `FEDERATED`, `FOREIGN` o `ALL`. + Si se establece en `FEDERATED`, enumerará las bases de datos federadas (que hacen referencia a una entidad externa) compartidas con la cuenta. + Si se establece en `FOREIGN`, enumerará las bases de datos compartidas con su cuenta. + Si se establece en `ALL`, enumerará las bases de datos compartidas con su cuenta, así como las bases de datos de su cuenta local. + `AttributesToGet`: matriz de cadenas UTF-8. Especifica los campos de la base de datos devueltos por la llamada `GetDatabases`. Este parámetro no acepta una lista vacía. La solicitud debe incluir `NAME`. **Respuesta** + `DatabaseList` *(obligatorio):* una matriz de objetos [Base de datos](#aws-glue-api-catalog-databases-Database). Lista de objetos `Database` del catálogo especificado. + `NextToken`: cadena UTF-8. Token de continuación para paginar la lista de tokens obtenida; se devuelve si el segmento actual de la lista no es el último. **Errores** + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `EntityNotFoundException` + `FederationSourceException` + `FederationSourceRetryableException` # API de tabla La API de tabla describe los tipos de datos y las operaciones que se asocian a las tablas. ## Tipos de datos + [Estructura de tabla](#aws-glue-api-catalog-tables-Table) + [Estructura TableInput](#aws-glue-api-catalog-tables-TableInput) + [Estructura de FederatedTable](#aws-glue-api-catalog-tables-FederatedTable) + [Estructura de las columnas](#aws-glue-api-catalog-tables-Column) + [Estructura StorageDescriptor](#aws-glue-api-catalog-tables-StorageDescriptor) + [Estructura SchemaReference](#aws-glue-api-catalog-tables-SchemaReference) + [Estructura SerDeInfo](#aws-glue-api-catalog-tables-SerDeInfo) + [Estructura Order](#aws-glue-api-catalog-tables-Order) + [Estructura SkewedInfo](#aws-glue-api-catalog-tables-SkewedInfo) + [Estructura TableVersion](#aws-glue-api-catalog-tables-TableVersion) + [Estructura TableError](#aws-glue-api-catalog-tables-TableError) + [Estructura TableVersionError](#aws-glue-api-catalog-tables-TableVersionError) + [Estructura SortCriterion](#aws-glue-api-catalog-tables-SortCriterion) + [Estructura TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier) + [Estructura KeySchemaElement](#aws-glue-api-catalog-tables-KeySchemaElement) + [Estructura PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex) + [Estructura PartitionIndexDescriptor](#aws-glue-api-catalog-tables-PartitionIndexDescriptor) + [Estructura BackFillError](#aws-glue-api-catalog-tables-BackfillError) + [Estructura de IcebergInput](#aws-glue-api-catalog-tables-IcebergInput) + [Estructura de OpenTableFormatInput](#aws-glue-api-catalog-tables-OpenTableFormatInput) + [Estructura ViewDefinition](#aws-glue-api-catalog-tables-ViewDefinition) + [Estructura ViewDefinitionInput](#aws-glue-api-catalog-tables-ViewDefinitionInput) + [Estructura ViewRepresentation](#aws-glue-api-catalog-tables-ViewRepresentation) + [Estructura ViewRepresentationInput](#aws-glue-api-catalog-tables-ViewRepresentationInput) + [Estructura UpdateOpenTableFormatInput](#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput) + [Estructura UpdateIcebergInput](#aws-glue-api-catalog-tables-UpdateIcebergInput) + [Estructura CreateIcebergTableInput](#aws-glue-api-catalog-tables-CreateIcebergTableInput) + [Estructura UpdateIcebergTableInput](#aws-glue-api-catalog-tables-UpdateIcebergTableInput) + [Estructura IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder) + [Estructura IcebergSortField](#aws-glue-api-catalog-tables-IcebergSortField) + [Estructura IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec) + [Estructura IcebergPartitionField](#aws-glue-api-catalog-tables-IcebergPartitionField) + [Estructura IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema) + [Estructura IcebergStructField](#aws-glue-api-catalog-tables-IcebergStructField) + [Estructura IcebergTableUpdate](#aws-glue-api-catalog-tables-IcebergTableUpdate) + [Estructura de AuditContext](#aws-glue-api-catalog-tables-AuditContext) ## Estructura de tabla Representa una recopilación de datos relacionados organizados en columnas y filas. **Campos** + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla. Para su compatibilidad con Hive, este debe estar completamente en minúsculas. + `DatabaseName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de metadatos donde residen los metadatos de la tabla. Para su compatibilidad con Hive, este debe estar completamente en minúsculas. + `Description` – cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Una descripción de la tabla. + `Owner` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El propietario de la tabla. + `CreateTime`: marca temporal. La hora de creación de la definición de la tabla en el Catálogo de datos. + `UpdateTime`: marca temporal. La última vez que se actualizó la tabla. + `LastAccessTime`: marca temporal. La última vez que se accedió a tabla. Esta suele tomarse de HDFS y podría no ser de confianza. + `LastAnalyzedTime`: marca temporal. La última vez que se calcularon las estadísticas de columna para esta tabla. + `Retention`: número (entero), cero como máximo. El tiempo de retención para esta tabla. + `StorageDescriptor`: un objeto [StorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor). Un descriptor de almacenamiento que contiene información acerca del almacenamiento físico de esta tabla. + `PartitionKeys`: matriz de objetos [Columna](#aws-glue-api-catalog-tables-Column). Una lista de columnas por las que se particiona la tabla. Solo se admiten los tipos primitivos como claves de partición. Cuando se crea una tabla utilizada por Amazon Athena, y no especifica ninguna `partitionKeys`, al menos debe establecer el valor de `partitionKeys` en una lista vacía. Por ejemplo: `"PartitionKeys": []` + `ViewOriginalText`: cadena UTF-8 de 409600 bytes de largo como máximo. Se incluye para permitir la compatibilidad con Apache Hive. No se utiliza en el transcurso normal de las operaciones de AWS Glue. Si la tabla es una `VIRTUAL_VIEW`, ciertos parámetros de configuración de Athena se codifican en base64. + `ViewExpandedText`: cadena UTF-8 de 409600 bytes de largo como máximo. Se incluye para permitir la compatibilidad con Apache Hive. No se utiliza en el transcurso normal de las operaciones de AWS Glue. + `TableType`: cadena UTF-8 de 255 bytes de largo como máximo. El tipo de esta tabla. AWS Glue creará tablas del tipo `EXTERNAL_TABLE`. Es posible que otros servicios, como Athena, creen tablas de otros tipos. Tipos de tablas relacionados con AWS Glue: EXTERNAL\$1TABLE Atributo de compatibilidad con Hive: indica una tabla no gestionada por Hive. GOVERNED Utilizado por AWS Lake Formation. El Catálogo de datos de AWS Glue entiende `GOVERNED`. + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Estos pares clave-valor definen las propiedades asociadas a la tabla. + `CreatedBy` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La persona o entidad que creó la tabla. + `IsRegisteredWithLakeFormation`: booleano. Indica si la tabla se ha registrado con AWS Lake Formation. + `TargetTable`: un objeto [TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier). Estructura `TableIdentifier` que describe una tabla de destino para la vinculación de recursos. + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID del Catálogo de datos donde reside la tabla. + `VersionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID de la versión de la tabla. + `FederatedTable`: un objeto [FederatedTable](#aws-glue-api-catalog-tables-FederatedTable). Una estructura `FederatedTable` que hace referencia a una entidad externa aAWS Glue Data Catalog. + `ViewDefinition`: un objeto [ViewDefinition](#aws-glue-api-catalog-tables-ViewDefinition). Estructura que contiene toda la información que define la vista, incluidos el dialecto o los dialectos de la vista, y la consulta. + `IsMultiDialectView`: booleano. Especifica si la vista admite los dialectos SQL de uno o varios motores de consulta diferentes y, por lo tanto, si esos motores pueden leerla. ## Estructura TableInput Una estructura utilizada para definir una tabla. **Campos** + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla. Para su compatibilidad con Hive, este se incorpora en minúsculas al almacenarse. + `Description` – cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Una descripción de la tabla. + `Owner` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El propietario de la tabla. Se incluye para permitir la compatibilidad con Apache Hive. No se utiliza en el transcurso normal de las operaciones de AWS Glue. + `LastAccessTime`: marca temporal. La última vez que se accedió a tabla. + `LastAnalyzedTime`: marca temporal. La última vez que se calcularon las estadísticas de columna para esta tabla. + `Retention`: número (entero), cero como máximo. El tiempo de retención para esta tabla. + `StorageDescriptor`: un objeto [StorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor). Un descriptor de almacenamiento que contiene información acerca del almacenamiento físico de esta tabla. + `PartitionKeys`: matriz de objetos [Columna](#aws-glue-api-catalog-tables-Column). Una lista de columnas por las que se particiona la tabla. Solo se admiten los tipos primitivos como claves de partición. Cuando se crea una tabla utilizada por Amazon Athena, y no especifica ninguna `partitionKeys`, al menos debe establecer el valor de `partitionKeys` en una lista vacía. Por ejemplo: `"PartitionKeys": []` + `ViewOriginalText`: cadena UTF-8 de 409600 bytes de largo como máximo. Se incluye para permitir la compatibilidad con Apache Hive. No se utiliza en el transcurso normal de las operaciones de AWS Glue. Si la tabla es una `VIRTUAL_VIEW`, ciertos parámetros de configuración de Athena se codifican en base64. + `ViewExpandedText`: cadena UTF-8 de 409600 bytes de largo como máximo. Se incluye para permitir la compatibilidad con Apache Hive. No se utiliza en el transcurso normal de las operaciones de AWS Glue. + `TableType`: cadena UTF-8 de 255 bytes de largo como máximo. El tipo de esta tabla. AWS Glue creará tablas del tipo `EXTERNAL_TABLE`. Es posible que otros servicios, como Athena, creen tablas de otros tipos. Tipos de tablas relacionados con AWS Glue: EXTERNAL\$1TABLE Atributo de compatibilidad con Hive: indica una tabla no gestionada por Hive. GOVERNED Utilizado por AWS Lake Formation. El Catálogo de datos de AWS Glue entiende `GOVERNED`. + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Estos pares clave-valor definen las propiedades asociadas a la tabla. + `TargetTable`: un objeto [TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier). Estructura `TableIdentifier` que describe una tabla de destino para la vinculación de recursos. + `ViewDefinition`: un objeto [ViewDefinitionInput](#aws-glue-api-catalog-tables-ViewDefinitionInput). Estructura que contiene toda la información que define la vista, incluidos el dialecto o los dialectos de la vista, y la consulta. ## Estructura de FederatedTable Una tabla que apunta a una entidad externa a AWS Glue Data Catalog. **Campos** + `Identifier` – cadena UTF-8, con 1 byte de largo como mínimo y 512 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Un identificador único para la tabla federada. + `DatabaseIdentifier` – cadena UTF-8, con 1 byte de largo como mínimo y 512 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Un identificador único para la base de datos federada. + `ConnectionName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la conexión al metalmacén externo. + `ConnectionType` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El tipo de conexión utilizado para acceder a la tabla federada, que especifica el protocolo o método de conexión con el origen de datos externo. ## Estructura de las columnas Una columna en una `Table`. **Campos** + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre del elemento `Column`. + `Type` – cadena UTF-8 con un máximo de 131072 bytes de largo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El tipo de datos de la `Column`. + `Comment` – cadena de comentario de un máximo de 255 bytes de largo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Un comentario de texto de formato libre. + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Estos pares clave-valor. definen las propiedades asociadas a la columna. ## Estructura StorageDescriptor Describe el almacenamiento físico de los datos de la tabla. **Campos** + `Columns`: matriz de objetos [Columna](#aws-glue-api-catalog-tables-Column). Una lista de las `Columns` de la tabla. + `Location` – cadena de ubicación de un máximo de 2056 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Ubicación física de la tabla. De forma predeterminada, adopta la forma de la ubicación de almacén, seguida de la ubicación de la base de datos en el almacén, seguida del nombre de tabla. + `AdditionalLocations`: matriz de cadenas UTF-8. Lista de ubicaciones que apuntan a la ruta en la que se encuentra una tabla Delta. + `InputFormat` – cadena de formato de un máximo de 128 bytes de largo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Formato de entrada: `SequenceFileInputFormat` (binario), `TextInputFormat` o formato personalizado. + `OutputFormat` – cadena de formato de un máximo de 128 bytes de largo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Formato de salida: `SequenceFileOutputFormat` (binario), `IgnoreKeyTextOutputFormat` o formato personalizado. + `Compressed`: booleano. `True` si los datos de la tabla están comprimidos o `False` si no. + `NumberOfBuckets`: número (entero). Debe especificarse si la tabla contiene alguna columna de dimensión. + `SerdeInfo`: un objeto [SerDeInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SerDeInfo). La información de serialización y deserialización (SerDe). + `BucketColumns`: matriz de cadenas UTF-8. Lista de columnas de agrupamiento del reductor, columnas de clústeres y columnas de almacenamiento en bucket de la tabla. + `SortColumns`: matriz de objetos [Order](#aws-glue-api-catalog-tables-Order). Una lista donde se especifica el orden de clasificación de cada bucket en la tabla. + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Las propiedades facilitadas por el usuario en formato clave-valor. + `SkewedInfo`: un objeto [SkewedInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SkewedInfo). La información sobre los valores que aparecen con frecuencia en una columna (valores sesgados). + `StoredAsSubDirectories`: booleano. `True` si los datos de la tabla se almacenan en subdirectorios o `False` si no. + `SchemaReference`: un objeto [SchemaReference](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SchemaReference). Objeto que hace referencia a un esquema almacenado en AWS Glue Schema Registry. Al crear una tabla, puede pasar una lista vacía de columnas para el esquema y, en su lugar, utilizar una referencia de esquema. ## Estructura SchemaReference Objeto que hace referencia a un esquema almacenado en AWS Glue Schema Registry. **Campos** + `SchemaId`: un objeto [SchemaId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId). Estructura que contiene campos de identidad de esquema. Este o el `SchemaVersionId` tiene que ser proporcionado. + `SchemaVersionId` – cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el [Custom string pattern #45](aws-glue-api-common.md#regex_45). El ID único asignado a una versión del esquema. Este o el `SchemaId` tiene que ser proporcionado. + `SchemaVersionNumber`: número (largo) que no es inferior a 1 ni es superior a 100 000. El número de versión del esquema. ## Estructura SerDeInfo Información sobre un programa de serialización y deserialización (SerDe) que sirve de extractor y cargador. **Campos** + `Name` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre del SerDe. + `SerializationLibrary` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). En general, la clase que implementa el SerDe. Un ejemplo es: . `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`. + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Estos pares de clave-valor definen parámetros de inicialización para el SerDe. ## Estructura Order Especifica el orden de clasificación de una columna ordenada. **Campos** + `Column`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la columna. + `SortOrder` – *Obligatorio:* número (entero), uno como máximo. Indica que la columna se clasifica en orden ascendente (`== 1`) o descendente (`==0`). ## Estructura SkewedInfo Especifica valores sesgados en una tabla. Los valores sesgados son los que se producen con una frecuencia muy alta. **Campos** + `SkewedColumnNames`: matriz de cadenas UTF-8. Una lista de nombres de columnas que contienen valores de sesgado. + `SkewedColumnValues`: matriz de cadenas UTF-8. Una lista de valores que aparecen con tanta frecuencia como para considerarse de sesgado. + `SkewedColumnValueLocationMaps`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8. Cada valor es una cadena UTF-8. Un mapeo de valores de sesgado a las columnas que los contienen. ## Estructura TableVersion Especifica una versión de una tabla. **Campos** + `Table`: un objeto [Tabla](#aws-glue-api-catalog-tables-Table). La tabla en cuestión. + `VersionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El valor de ID que identifica la versión de esta tabla. Una `VersionId` es una representación de cadena de un número entero. Cada versión se incrementa en 1. ## Estructura TableError Un registro de error para las operaciones con tablas. **Campos** + `TableName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla. Para su compatibilidad con Hive, este debe estar completamente en minúsculas. + `ErrorDetail`: un objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail). Los detalles sobre el error. ## Estructura TableVersionError Un registro de error para las operaciones con versiones de tablas. **Campos** + `TableName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la tabla en cuestión. + `VersionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El valor de ID de la versión en cuestión. Una `VersionID` es una representación de cadena de un número entero. Cada versión se incrementa en 1. + `ErrorDetail`: un objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail). Los detalles sobre el error. ## Estructura SortCriterion Especifica un campo por el que se va a ordenar y un orden de clasificación. **Campos** + `FieldName`: cadena de valor con una extensión de 1 byte como mínimo o 1024 bytes como máximo. El nombre del campo en el que se va a ordenar. + `Sort` – Cadena UTF-8 (valores válidos: `ASC="ASCENDING"` \$1 `DESC="DESCENDING"`). Orden ascendente o descendente. ## Estructura TableIdentifier Estructura que describe una tabla de destino para la vinculación de recursos. **Campos** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID del Catálogo de datos donde reside la tabla. + `DatabaseName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la base de datos del catálogo que contiene la tabla de destino. + `Name` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla de destino. + `Region` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Región de la tabla objetivo. ## Estructura KeySchemaElement Un par de claves de partición que consta de un nombre y un tipo. **Campos** + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de una clave de partición. + `Type` – *Obligatorio:* cadena UTF-8, de 131 072 bytes de largo como máximo, que coincide con [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El tipo de una clave de partición. ## Estructura PartitionIndex Una estructura para un índice de partición. **Campos** + `Keys`: *obligatorio:* matriz de cadenas UTF-8, con una cadena como mínimo. Las claves para el índice de partición. + `IndexName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre del índice de partición. ## Estructura PartitionIndexDescriptor Un descriptor para un índice de partición en una tabla. **Campos** + `IndexName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre del índice de partición. + `Keys` – *Obligatorio:* una matriz de objetos [KeySchemaElement](#aws-glue-api-catalog-tables-KeySchemaElement), 1 estructura como mínimo. Una lista de una o más claves, como estructuras `KeySchemaElement`, para el índice de partición. + `IndexStatus` – *Obligatorio:* cadena UTF-8 (valores válidos: `CREATING` \$1 `ACTIVE` \$1 `DELETING` \$1 `FAILED`). El estado del índice de partición. Los posibles estados son: + CREACIÓN: el índice se está creando. Cuando el índice está en un estado CREACIÓN, el índice o su tabla no se pueden eliminar. + ACTIVO: la creación del índice se realiza correctamente. + ERROR: error en la creación del índice. + ELIMINACIÓN: el índice se elimina de la lista de índices. + `BackfillErrors`: matriz de objetos [BackFillError](#aws-glue-api-catalog-tables-BackfillError). Una lista de los errores que pueden producirse al registrar índices de particiones para una tabla existente. ## Estructura BackFillError Una lista de los errores que pueden producirse al registrar índices de particiones para una tabla existente. Estos errores dan los detalles acerca de por qué un registro de índice presentó error y proporcionan un número limitado de particiones en la respuesta, de modo que pueda corregir las particiones con errores e intentar registrar el índice de nuevo. El conjunto más común de errores que pueden ocurrir se clasifican de la siguiente manera: + EncryptedPartitionError: las particiones están cifradas. + InvalidPartitionTypeDataError: el valor de las particiones no coincide con el tipo de datos de esa columna de partición. + MissingPartitionValueError: las particiones están cifradas. + UnsupportedPartitionCharacterError: no se admiten caracteres dentro del valor de partición. Por ejemplo: U\$10000, U\$10001, U\$10002. + InternalError: cualquier error que no pertenezca a otros códigos de error. **Campos** + `Code` – Cadena 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`). Una lista de los errores que ocurrieron al registrar índices de particiones para una tabla existente. + `Partitions`: matriz de objetos [PartitionValueList](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionValueList). Una lista de un número limitado de particiones en la respuesta. ## Estructura de IcebergInput Una estructura que define una tabla de metadatos de Apache Iceberg para crearla en el catálogo. **Campos** + `MetadataOperation` – *Obligatorio:* cadena UTF-8 (valores válidos: `CREATE`). Una operación de metadatos obligatoria. Esto solo se puede configurar en `CREATE`. + `Version` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La versión de tabla para la tabla de Iceberg. El valor predeterminado es 2. + `CreateIcebergTableInput`: un objeto [CreateIcebergTableInput](#aws-glue-api-catalog-tables-CreateIcebergTableInput). Los parámetros de configuración necesarios para crear una nueva tabla de Iceberg en el Catálogo de datos de AWS Glue, incluidos las propiedades de la tabla y las especificaciones de metadatos. ## Estructura de OpenTableFormatInput Una estructura que representa una tabla de formato abierto. **Campos** + `IcebergInput`: un objeto [IcebergInput](#aws-glue-api-catalog-tables-IcebergInput). Especifica una estructura `IcebergInput` que define una tabla de metadatos de Apache Iceberg. ## Estructura ViewDefinition Estructura que contiene detalles para las representaciones. **Campos** + `IsProtected`: booleano. Puede establecer este indicador como verdadero para indicar al motor que no inserte las operaciones proporcionadas por el usuario en el plan lógico de la vista durante la planificación de las consultas. Sin embargo, establecer este indicador no garantiza que el motor cumpla con las normas. Consulte la documentación del motor para comprender las garantías que se ofrecen si las hubiera. + `Definer` – cadena UTF-8, con 20 bytes como mínimo o más de 2048 bytes de largo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El definidor de una vista en SQL. + `SubObjects`: matriz de cadenas UTF-8, con 10 cadenas como máximo. Una lista de los nombres de recursos de Amazon (ARN) de la tabla. + `Representations`: matriz de objetos [ViewRepresentation](#aws-glue-api-catalog-tables-ViewRepresentation), con una estructura como mínimo y 1000 estructuras como máximo. Una lista de representaciones. ## Estructura ViewDefinitionInput Estructura que contiene detalles para crear o actualizar una vista de AWS Glue. **Campos** + `IsProtected`: booleano. Puede establecer este indicador como verdadero para indicar al motor que no inserte las operaciones proporcionadas por el usuario en el plan lógico de la vista durante la planificación de las consultas. Sin embargo, establecer este indicador no garantiza que el motor cumpla con las normas. Consulte la documentación del motor para comprender las garantías que se ofrecen si las hubiera. + `Definer` – cadena UTF-8, con 20 bytes como mínimo o más de 2048 bytes de largo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El definidor de una vista en SQL. + `Representations`: Una matriz de objetos [ViewRepresentationInput](#aws-glue-api-catalog-tables-ViewRepresentationInput), con 1 estructura como mínimo y 10 como máximo. Lista de estructuras que contiene el dialecto de la vista y la consulta que define la vista. + `SubObjects`: matriz de cadenas UTF-8, con 10 cadenas como máximo. Una lista de los ARN de la tabla base que componen la vista. ## Estructura ViewRepresentation Estructura que contiene el dialecto de la vista y la consulta que define la vista. **Campos** + `Dialect` – Cadena UTF-8 (valores válidos: `REDSHIFT` \$1 `ATHENA` \$1 `SPARK`). El dialecto del motor de consultas. + `DialectVersion`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo. La versión del dialecto del motor de consultas. Por ejemplo, 3.0.0. + `ViewOriginalText`: cadena UTF-8 de 409600 bytes de largo como máximo. La consulta `SELECT` proporcionada por el cliente durante `CREATE VIEW DDL`. Este SQL no se usa durante una consulta en una vista (en su lugar, se usa `ViewExpandedText`). `ViewOriginalText` se usa en casos como `SHOW CREATE VIEW`, en los que los usuarios desean ver el comando DDL original que creó la vista. + `ViewExpandedText`: cadena UTF-8 de 409600 bytes de largo como máximo. El SQL expandido para la vista. Los motores utilizan este SQL para procesar una consulta en una vista. Es posible que los motores hagan operaciones durante la creación de la vista para transformar `ViewOriginalText` en `ViewExpandedText`. Por ejemplo: + Identificadores totalmente cualificados: `SELECT * from table1 -> SELECT * from db1.table1` + `ValidationConnection` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la conexión que se usará para validar la representación específica de la vista. + `IsStale`: booleano. Los dialectos marcados como obsoletos ya no son válidos y deben actualizarse para poder consultarlos en sus respectivos motores de consulta. ## Estructura ViewRepresentationInput Estructura que contiene detalles de una representación para actualizar o crear una vista de Lake Formation. **Campos** + `Dialect` – Cadena UTF-8 (valores válidos: `REDSHIFT` \$1 `ATHENA` \$1 `SPARK`). Parámetro que especifica el tipo de motor de una representación específica. + `DialectVersion`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo. Un parámetro que especifica la versión del motor de una representación específica. + `ViewOriginalText`: cadena UTF-8 de 409600 bytes de largo como máximo. Una cadena que representa la consulta SQL original que describe la vista. + `ValidationConnection` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la conexión que se usará para validar la representación específica de la vista. + `ViewExpandedText`: cadena UTF-8 de 409600 bytes de largo como máximo. Cadena que representa la consulta SQL que describe la vista con los ARN de recursos ampliados. ## Estructura UpdateOpenTableFormatInput Parámetros de entrada para actualizar tablas con formatos abiertos en el Catálogo de datos de AWS Glue, que sirven como envoltura para operaciones de actualización propias de cada formato, como Apache Iceberg. **Campos** + `UpdateIcebergInput`: un objeto [UpdateIcebergInput](#aws-glue-api-catalog-tables-UpdateIcebergInput). Parámetros de actualización específicos de Apache Iceberg que definen las modificaciones que se aplicarán a la tabla, incluidas los cambios de esquema, las especificaciones de partición y las propiedades de la tabla. ## Estructura UpdateIcebergInput Parámetros de entrada específicos para la actualización de tablas de Apache Iceberg en el Catálogo de datos de AWS Glue, que contienen las operaciones de actualización que se aplicarán a una tabla de Iceberg existente. **Campos** + `UpdateIcebergTableInput` – *Obligatorio:* objeto [UpdateIcebergTableInput](#aws-glue-api-catalog-tables-UpdateIcebergTableInput). Las operaciones de actualización específicas que se aplicarán a la tabla de Iceberg, que contienen una lista de actualizaciones que definen el nuevo estado de la tabla, incluidos el esquema, las particiones y las propiedades. ## Estructura CreateIcebergTableInput Los parámetros de configuración necesarios para crear una nueva tabla de Iceberg en el Catálogo de datos de AWS Glue, incluidos las propiedades de la tabla y las especificaciones de metadatos. **Campos** + `Location`: *obligatorio:* cadena de ubicación, con una longitud máxima de 2056 bytes, que coincida con [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). La ubicación en S3 donde se almacenarán los datos de la tabla de Iceberg. + `Schema` – *Obligatorio:* objeto [IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema). La definición de esquema que especifica la estructura, los tipos de campos y los metadatos de la tabla de Iceberg. + `PartitionSpec`: un objeto [IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec). La especificación de partición que define cómo se organizarán y particionarán los datos de la tabla de Iceberg para un rendimiento óptimo en las consultas. + `WriteOrder`: un objeto [IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder). La especificación de ordenación que define cómo se deben ordenar los datos dentro de cada partición para optimizar el rendimiento de las consultas. + `Properties` – Pares clave-valor de propiedades adicionales de la tabla y configuraciones para la tabla de Iceberg. ## Estructura UpdateIcebergTableInput Contiene las operaciones de actualización que se aplican a una tabla de Iceberg existente en el Catálogo de datos de AWS Glue y definen el nuevo estado de los metadatos de la tabla. **Campos** + `Updates` *(obligatorio):* una matriz de objetos [IcebergTableUpdate](#aws-glue-api-catalog-tables-IcebergTableUpdate). La lista de operaciones de actualización de la tabla que especifican los cambios que se deben aplicar a la tabla de Iceberg, incluidas las modificaciones del esquema, las especificaciones de partición y las propiedades de la tabla. ## Estructura IcebergSortOrder Define la especificación de ordenación de una tabla de Iceberg y determina cómo se ordenan los datos dentro de las particiones para optimizar el rendimiento de las consultas. **Campos** + `OrderId` – *Obligatorio:* número (entero). El identificador único de esta especificación de ordenación dentro de los metadatos de la tabla de Iceberg. + `Fields` *(obligatorio):* una matriz de objetos [IcebergSortField](#aws-glue-api-catalog-tables-IcebergSortField). La lista de campos y sus direcciones de orden que establecen los criterios de ordenación de los datos de la tabla de Iceberg. ## Estructura IcebergSortField Define un solo campo dentro de una especificación de ordenación de Iceberg e incluye el campo de origen, la transformación, la dirección de orden y el orden de los valores nulos. **Campos** + `SourceId` – *Obligatorio:* número (entero). El identificador del campo de origen del esquema de la tabla en el que se basa este campo de ordenación. + `Transform` – *Obligatorio:* cadena UTF-8. La función de transformación aplicada al campo de origen antes de la ordenación, como identidad, bucket o truncamiento. + `Direction`: *obligatorio:* cadena UTF-8 (valores válidos: `asc="ASC"` \$1 `desc="DESC"`). La dirección de orden de este campo, ya sea ascendente o descendente. + `NullOrder`: *obligatorio:* cadena UTF-8 (valores válidos: `nulls-first="NULLS_FIRST"` \$1 `nulls-last="NULLS_LAST"`). El comportamiento de ordenación de los valores nulos en este campo, que especifica si los nulos deben aparecer al principio o al final del orden. ## Estructura IcebergPartitionSpec Define la especificación de partición de una tabla de Iceberg y determina cómo se organiza y particiona la información de la tabla para lograr un rendimiento óptimo en las consultas. **Campos** + `Fields` *(obligatorio):* una matriz de objetos [IcebergPartitionField](#aws-glue-api-catalog-tables-IcebergPartitionField). La lista de campos de partición que definen cómo se deben particionar los datos de la tabla, incluidos los campos de origen y sus transformaciones. + `SpecId`: número (entero). El identificador único de esta especificación de partición dentro del historial de metadatos de la tabla de Iceberg. ## Estructura IcebergPartitionField Define un solo campo de partición dentro de una especificación de partición de Iceberg e incluye el campo de origen, la función de transformación, el nombre de la partición y el identificador único. **Campos** + `SourceId` – *Obligatorio:* número (entero). El identificador del campo de origen del esquema de la tabla en el que se basa este campo de partición. + `Transform` – *Obligatorio:* cadena UTF-8. La función de transformación aplicada al campo de origen para crear la partición, como identidad, bucket, truncamiento, año, mes, día u hora. + `Name` – *Obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 1024 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre del campo de partición tal como aparecerá en la estructura de la tabla particionada. + `FieldId`: número (entero). El identificador único asignado a este campo de partición dentro de la especificación de partición de la tabla de Iceberg. ## Estructura IcebergSchema Define la estructura de esquema de una tabla de Iceberg e incluye las definiciones de campos, los tipos de datos y los metadatos del esquema. **Campos** + `SchemaId`: número (entero). El identificador único de esta versión del esquema dentro del historial de evolución del esquema de la tabla de Iceberg. + `IdentifierFieldIds`: una matriz de enteros con signo de 32 bits. La lista de identificadores de campos que identifican de forma única los registros en la tabla, utilizada para operaciones a nivel de fila y eliminación de duplicados. + `Type` – Cadena UTF-8 (valores válidos: `struct="STRUCT"`). El tipo raíz de la estructura del esquema, que suele ser “estructura” en los esquemas de tablas de Iceberg. + `Fields` *(obligatorio):* una matriz de objetos [IcebergStructField](#aws-glue-api-catalog-tables-IcebergStructField). La lista de definiciones de campos que conforman el esquema de la tabla, incluidos los nombres de los campos, los tipos y los metadatos. ## Estructura IcebergStructField Define un solo campo dentro del esquema de una tabla de Iceberg e incluye su identificador, nombre, tipo de dato, posibilidad de nulo y documentación. **Campos** + `Id` – *Obligatorio:* número (entero). El identificador único asignado a este campo dentro del esquema de la tabla de Iceberg, utilizado para la evolución del esquema y el seguimiento de campos. + `Name` – *Obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 1024 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre del campo tal como aparece en el esquema de la tabla y en las operaciones de consulta. + `Type`: *Obligatorio:* una estructura vacía llamada `IcebergDocument`. La definición del tipo de dato de este campo, que especifica la estructura y el formato de los datos que contiene. + `Required` – *Obligatorio:* Booleano. Indica si este campo es obligatorio (no admite valores nulos) u opcional (admite valores nulos) en el esquema de la tabla. + `Doc` – cadena de comentario de un máximo de 255 bytes de largo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Documentación o texto descriptivo opcional que proporciona contexto adicional sobre el propósito y el uso de este campo. ## Estructura IcebergTableUpdate Define un conjunto completo de actualizaciones que se aplican a una tabla de Iceberg, incluidos los cambios de esquema, las modificaciones de particiones, los ajustes del orden de clasificación, las actualizaciones de ubicación y los cambios de propiedades. **Campos** + `Schema` – *Obligatorio:* objeto [IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema). La definición actualizada del esquema de la tabla de Iceberg, que especifica los cambios en la estructura de los campos, los tipos de datos o los metadatos del esquema. + `PartitionSpec`: un objeto [IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec). La especificación de partición actualizada que define cómo se deben reorganizar y particionar los datos de la tabla. + `SortOrder`: un objeto [IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder). La especificación de ordenación actualizada que define cómo se deben ordenar los datos dentro de las particiones para lograr un rendimiento óptimo en las consultas. + `Location`: *obligatorio:* cadena de ubicación, con una longitud máxima de 2056 bytes, que coincida con [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). La ubicación actualizada en S3 donde se almacenarán los datos de la tabla de Iceberg. + `Properties` – Pares clave-valor actualizados de propiedades de la tabla y configuraciones de la tabla de Iceberg. ## Estructura de AuditContext Estructura que contiene el contexto de auditoría de Lake Formation. **Campos** + `AdditionalAuditContext`: cadena UTF-8, no más de 2048 bytes de largo. Una cadena que contiene la información adicional del contexto de auditoría. + `RequestedColumns`: matriz de cadenas UTF-8. Las columnas solicitadas para la auditoría. + `AllColumnsRequested`: booleano. Todas las columnas solicitan una auditoría. ## Operaciones + [Acción CreateTable (Python: create\$1table)](#aws-glue-api-catalog-tables-CreateTable) + [Acción UpdateTable (Python: update\$1table)](#aws-glue-api-catalog-tables-UpdateTable) + [Acción DeleteTable (Python: delete\$1table)](#aws-glue-api-catalog-tables-DeleteTable) + [Acción BatchDeleteTable (Python: batch\$1delete\$1table)](#aws-glue-api-catalog-tables-BatchDeleteTable) + [Acción GetTable (Python: get\$1table)](#aws-glue-api-catalog-tables-GetTable) + [Acción GetTables (Python: get\$1tables)](#aws-glue-api-catalog-tables-GetTables) + [Acción GetTableVersion (Python: get\$1table\$1version)](#aws-glue-api-catalog-tables-GetTableVersion) + [Acción GetTableVersions (Python: get\$1table\$1versions)](#aws-glue-api-catalog-tables-GetTableVersions) + [Acción DeleteTableVersion (Python: delete\$1table\$1version)](#aws-glue-api-catalog-tables-DeleteTableVersion) + [Acción BatchDeleteTableVersion (Python: batch\$1delete\$1table\$1version)](#aws-glue-api-catalog-tables-BatchDeleteTableVersion) + [Acción SearchTables (Python: search\$1tables)](#aws-glue-api-catalog-tables-SearchTables) + [Acción GetPartitionIndexes (Python: get\$1partition\$1indexes)](#aws-glue-api-catalog-tables-GetPartitionIndexes) + [Acción CreatePartitionIndex (Python: create\$1partition\$1index)](#aws-glue-api-catalog-tables-CreatePartitionIndex) + [Acción DeletePartitionIndex (Python: delete\$1partition\$1index)](#aws-glue-api-catalog-tables-DeletePartitionIndex) + [Acción GetColumnStatisticsForTable (Python: get\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-GetColumnStatisticsForTable) + [Acción UpdateColumnStatisticsForTable (Python: update\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-UpdateColumnStatisticsForTable) + [Acción DeleteColumnStatisticsForTable (Python: delete\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-DeleteColumnStatisticsForTable) ## Acción CreateTable (Python: create\$1table) Crea una nueva definición de tabla en el Catálogo de datos. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde se crea la `Table`. Si no se proporciona ninguno, el ID de cuenta de AWS se usará de forma predeterminada. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La base de datos de catálogos en la que se crea la nueva tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `Name` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El identificador único de la tabla dentro de la base de datos especificada que se creará en el Catálogo de datos de AWS Glue. + `TableInput`: un objeto [TableInput](#aws-glue-api-catalog-tables-TableInput). Objeto `TableInput` que define la tabla de metadatos que se va a crear en el catálogo. + `PartitionIndexes`: matriz de objetos [PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex), con 3 estructuras como máximo. Una lista de índices de particiones, estructuras `PartitionIndex`, para crear en la tabla. + `TransactionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Custom string pattern #44](aws-glue-api-common.md#regex_44). El ID de la transacción. + `OpenTableFormatInput`: un objeto [OpenTableFormatInput](#aws-glue-api-catalog-tables-OpenTableFormatInput). Especifica una estructura `OpenTableFormatInput` al crear una tabla de formato abierto. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `AlreadyExistsException` + `InvalidInputException` + `EntityNotFoundException` + `ResourceNumberLimitExceededException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `ConcurrentModificationException` + `ResourceNotReadyException` + `FederationSourceException` + `FederationSourceRetryableException` ## Acción UpdateTable (Python: update\$1table) Actualiza una tabla de metadatos en el Catálogo de datos. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la tabla. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde reside la tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `Name` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El identificador único de la tabla dentro de la base de datos especificada que se creará en el Catálogo de datos de AWS Glue. + `TableInput`: un objeto [TableInput](#aws-glue-api-catalog-tables-TableInput). Objeto `TableInput` actualizado para definir la tabla de metadatos en el catálogo. + `SkipArchive`: booleano. De forma predeterminada, `UpdateTable` crea siempre una versión archivada de la tabla antes de actualizarla. Si `skipArchive` se establece en true, sin embargo, `UpdateTable` no crea la versión archivada. + `TransactionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Custom string pattern #44](aws-glue-api-common.md#regex_44). ID de transacción en el que se va a actualizar el contenido de la tabla. + `VersionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID de la versión a la que se actualizará el contenido de la tabla. + `ViewUpdateAction` – Cadena UTF-8 (valores válidos: `ADD` \$1 `REPLACE` \$1 `ADD_OR_REPLACE` \$1 `DROP`). La operación que se llevará a cabo al actualizar la vista. + `Force`: booleano. Un indicador que se puede establecer como verdadero para ignorar los requisitos de coincidencia entre el descriptor de almacenamiento y el subobjeto. + `UpdateOpenTableFormatInput`: un objeto [UpdateOpenTableFormatInput](#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput). Parámetros de entrada para actualizar tablas con formatos abiertos en el Catálogo de datos de AWS Glue, que sirven como envoltura para operaciones de actualización propias de cada formato, como Apache Iceberg. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `ConcurrentModificationException` + `ResourceNumberLimitExceededException` + `GlueEncryptionException` + `ResourceNotReadyException` + `FederationSourceException` + `FederationSourceRetryableException` + `AlreadyExistsException` ## Acción DeleteTable (Python: delete\$1table) Quita una definición de tabla del Catálogo de datos. **nota** Después de completar esta operación, ya no tendrá acceso a las versiones de la tabla y a las particiones que pertenecen a la tabla. AWS Glue elimina estos recursos “huérfanos” de manera asíncrona en forma oportuna, a discreción del servicio. Para asegurarse de la eliminación inmediata de todos los recursos relacionados, antes de llamar a `DeleteTable`, use `DeleteTableVersion` o `BatchDeleteTableVersion` y `DeletePartition` o `BatchDeletePartition`, para eliminar todos los recursos que pertenezcan a la tabla. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la tabla. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde reside la tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla que se eliminará. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `TransactionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Custom string pattern #44](aws-glue-api-common.md#regex_44). ID de transacción en el que se va a eliminar el contenido de la tabla. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `ConcurrentModificationException` + `ResourceNotReadyException` + `FederationSourceException` + `FederationSourceRetryableException` ## Acción BatchDeleteTable (Python: batch\$1delete\$1table) Elimina varias tablas a la vez. **nota** Después de completar esta operación, ya no tendrá acceso a las versiones de la tabla y a las particiones que pertenecen a la tabla. AWS Glue elimina estos recursos “huérfanos” de manera asíncrona en forma oportuna, a discreción del servicio. Para asegurarse de la eliminación inmediata de todos los recursos relacionados, antes de llamar a `BatchDeleteTable`, use `DeleteTableVersion` o `BatchDeleteTableVersion` y `DeletePartition` o `BatchDeletePartition`, para eliminar todos los recursos que pertenezcan a la tabla. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la tabla. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde residen las tablas que se van a eliminar. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `TablesToDelete` – *Obligatorio:* matriz de cadenas UTF-8, con 100 cadenas como máximo. Una lista de las tablas que se van a eliminar. + `TransactionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Custom string pattern #44](aws-glue-api-common.md#regex_44). ID de transacción en el que se va a eliminar el contenido de la tabla. **Respuesta** + `Errors`: matriz de objetos [TableError](#aws-glue-api-catalog-tables-TableError). Una lista de errores encontrados al intentar eliminar las tablas especificadas. **Errores** + `InvalidInputException` + `EntityNotFoundException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `ResourceNotReadyException` ## Acción GetTable (Python: get\$1table) Recupera la definición de `Table` en un Catálogo de datos para una tabla especificada. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la tabla. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos en el catálogo donde reside la tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla para la que recuperar la definición. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `TransactionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Custom string pattern #44](aws-glue-api-common.md#regex_44). ID de transacción en el que se va a leer el contenido de la tabla. + `QueryAsOfTime`: marca temporal. El momento a partir del que se debe leer el contenido de la tabla. Si no se establece, se utilizará el tiempo de confirmación de la transacción más reciente. No se puede especificar junto con `TransactionId`. + `AuditContext`: un objeto [AuditContext](#aws-glue-api-catalog-tables-AuditContext). Estructura que contiene el [contexto de auditoría de Lake Formation](https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html). + `IncludeStatusDetails`: booleano. Especifica si se deben incluir los detalles de estado relacionados con una solicitud de creación o actualización de una vista del catálogo de datos AWS Glue. **Respuesta** + `Table`: un objeto [Tabla](#aws-glue-api-catalog-tables-Table). Objeto `Table` que define la tabla especificada. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `ResourceNotReadyException` + `FederationSourceException` + `FederationSourceRetryableException` ## Acción GetTables (Python: get\$1tables) Recupera las definiciones de algunas o de todas las tablas en una determinada `Database`. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las tablas. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La base de datos del catálogo cuyas tablas se van a listar. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `Expression` – cadena UTF-8 con un máximo de 2048 bytes de largo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Un patrón de expresiones regulares. Si están presentes, solo se devuelven esas tablas cuyos nombres coinciden con el patrón. + `NextToken`: cadena UTF-8. Token de continuación, incluido si se trata de una llamada de continuidad. + `MaxResults`: número (entero) que no es inferior a 1 ni es superior a 100. El número máximo de tablas que se devuelven en una única respuesta. + `TransactionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Custom string pattern #44](aws-glue-api-common.md#regex_44). ID de transacción en el que se va a leer el contenido de la tabla. + `QueryAsOfTime`: marca temporal. El momento a partir del que se debe leer el contenido de la tabla. Si no se establece, se utilizará el tiempo de confirmación de la transacción más reciente. No se puede especificar junto con `TransactionId`. + `AuditContext`: un objeto [AuditContext](#aws-glue-api-catalog-tables-AuditContext). Estructura que contiene el [contexto de auditoría de Lake Formation](https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html). + `IncludeStatusDetails`: booleano. Especifica si se deben incluir los detalles de estado relacionados con una solicitud de creación o actualización de una vista del catálogo de datos AWS Glue. + `AttributesToGet`: matriz de cadenas UTF-8. Especifica los campos de la tabla devueltos por la llamada `GetTables`. Este parámetro no acepta una lista vacía. La solicitud debe incluir el `NAME`. Las siguientes son combinaciones de valores válidas: + `NAME`: nombres de todas las tablas de la base de datos. + `NAME`, `TABLE_TYPE`: nombres de todas las tablas y tipos de tablas. **Respuesta** + `TableList`: matriz de objetos [Tabla](#aws-glue-api-catalog-tables-Table). Una lista de los objetos `Table` solicitados. + `NextToken`: cadena UTF-8. Un token de continuación, presente si el segmento de lista actual no es el último. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` + `GlueEncryptionException` + `FederationSourceException` + `FederationSourceRetryableException` ## Acción GetTableVersion (Python: get\$1table\$1version) Recupera una versión especificada de una tabla. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las tablas. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La base de datos del catálogo donde reside la tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `VersionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El valor de ID de la versión de la tabla que se va a recuperar. Una `VersionID` es una representación de cadena de un número entero. Cada versión se incrementa en 1. **Respuesta** + `TableVersion`: un objeto [TableVersion](#aws-glue-api-catalog-tables-TableVersion). La versión de la tabla solicitada. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción GetTableVersions (Python: get\$1table\$1versions) Recupera una lista de cadenas que identifican las versiones disponibles de una tabla especificada. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las tablas. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La base de datos del catálogo donde reside la tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `NextToken`: cadena UTF-8. Token de continuación si no se trata de la primera llamada. + `MaxResults`: número (entero) que no es inferior a 1 ni es superior a 100. El número máximo de versiones de la tabla que se devuelven en una respuesta. **Respuesta** + `TableVersions`: matriz de objetos [TableVersion](#aws-glue-api-catalog-tables-TableVersion). Una lista de cadenas que identifican las versiones disponibles de la tabla especificada. + `NextToken`: cadena UTF-8. Token de continuación, si la lista de versiones disponibles no incluye la última. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción DeleteTableVersion (Python: delete\$1table\$1version) Elimina una versión especificada de una tabla. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las tablas. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La base de datos del catálogo donde reside la tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `VersionId`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID de la versión de la tabla que se va a eliminar. Una `VersionID` es una representación de cadena de un número entero. Cada versión se incrementa en 1. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` ## Acción BatchDeleteTableVersion (Python: batch\$1delete\$1table\$1version) Elimina un lote especificado de versiones de una tabla. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las tablas. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La base de datos del catálogo donde reside la tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla. Para compatibilidad con Hive, este nombre está completamente en minúsculas. + `VersionIds` – *Obligatorio:* matriz de cadenas UTF-8, con 100 cadenas como máximo. Una lista de los ID de versiones que se van a eliminar. Una `VersionId` es una representación de cadena de un número entero. Cada versión se incrementa en 1. **Respuesta** + `Errors`: matriz de objetos [TableVersionError](#aws-glue-api-catalog-tables-TableVersionError). Una lista de errores encontrados mientras se intentan eliminar las versiones de la tabla especificadas. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` ## Acción SearchTables (Python: search\$1tables) Busca un conjunto de tablas basado en las propiedades de los metadatos de la tabla, así como en la base de datos principal. Puede realizar búsquedas en condiciones de texto o filtro. Solo puede obtener tablas a las que tiene acceso en función de las políticas de seguridad definidas en Lake Formation. Necesita al menos un acceso de solo lectura a la tabla para que se devuelva. Si no tiene acceso a todas las columnas de la tabla, estas columnas no se buscarán cuando le devuelva la lista de tablas. Si tiene acceso a las columnas, pero no a los datos de las columnas, esas columnas y los metadatos asociados para esas columnas se incluirán en la búsqueda. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Un identificador único, que consta de `account_id`. + `NextToken`: cadena UTF-8. Token de continuación, incluido si se trata de una llamada de continuidad. + `Filters`: matriz de objetos [PropertyPredicate](aws-glue-api-common.md#aws-glue-api-common-PropertyPredicate). Una lista de pares clave-valor y un comparador utilizado para filtrar los resultados de búsqueda. Devuelve todas las entidades que coinciden con el predicado. El miembro `Comparator` de la estructura `PropertyPredicate` se usa solo para campos de tiempo y se puede omitir para otros tipos de campos. Además, al comparar valores de cadena, como `Key=Name`, se utiliza un algoritmo de coincidencia aproximada. El campo `Key` (por ejemplo, el valor del campo `Name`) se divide en tokens con determinados caracteres de puntuación, por ejemplo, -, :, \$1, etc. Luego, cada token es una coincidencia exacta en comparación con el miembro `Value` de `PropertyPredicate`. Por ejemplo, para `Key=Name` y `Value=link`, se devuelven las tablas denominadas `customer-link` y `xx-link-yy`, pero no se devuelve `xxlinkyy`. + `SearchText`: cadena de valor con una extensión de 1 byte como mínimo o 1024 bytes como máximo. Una cadena utilizada para una búsqueda de texto. Especificar un valor entre comillas filtra en base a una coincidencia exacta con el valor. + `SortCriteria`: matriz de objetos [SortCriterion](#aws-glue-api-catalog-tables-SortCriterion), con 1 estructura como máximo. Una lista de criterios para ordenar los resultados por nombre de campo, en orden ascendente o descendente. + `MaxResults`: número (entero) que no es inferior a 1 ni es superior a 1000. El número máximo de tablas que se devuelven en una única respuesta. + `ResourceShareType` – Cadena UTF-8 (valores válidos: `FOREIGN` \$1 `ALL` \$1 `FEDERATED`). Le permite especificar que desea buscar en las tablas compartidas con su cuenta. Los valores permitidos son `FOREIGN` o `ALL`. + Si se establece en `FOREIGN`, buscará en las tablas compartidas con su cuenta. + Si se establece en `ALL`, buscará en las tablas compartidas con su cuenta, así como en las tablas de su cuenta local. + `IncludeStatusDetails`: booleano. Especifica si se deben incluir los detalles de estado relacionados con una solicitud de creación o actualización de una vista del catálogo de datos AWS Glue. **Respuesta** + `NextToken`: cadena UTF-8. Un token de continuación, presente si el segmento de lista actual no es el último. + `TableList`: matriz de objetos [Tabla](#aws-glue-api-catalog-tables-Table). Una lista de los objetos `Table` solicitados. La respuesta `SearchTables` devuelve solo las tablas a las que tiene acceso. **Errores** + `InternalServiceException` + `InvalidInputException` + `OperationTimeoutException` ## Acción GetPartitionIndexes (Python: get\$1partition\$1indexes) Recupera los índices de partición asociados a una tabla. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo donde reside la tabla. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Especifica el nombre de una base de datos desde la que desea recuperar índices de particiones. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Especifica el nombre de una base de datos para la que desea recuperar índices de particiones. + `NextToken`: cadena UTF-8. Token de continuación, incluido si se trata de una llamada de continuidad. **Respuesta** + `PartitionIndexDescriptorList`: matriz de objetos [PartitionIndexDescriptor](#aws-glue-api-catalog-tables-PartitionIndexDescriptor). Una lista de descriptores de índice. + `NextToken`: cadena UTF-8. Un token de continuación, presente si el segmento de lista actual no es el último. **Errores** + `InternalServiceException` + `OperationTimeoutException` + `InvalidInputException` + `EntityNotFoundException` + `ConflictException` ## Acción CreatePartitionIndex (Python: create\$1partition\$1index) Crea un índice de partición especificado en una tabla existente. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo donde reside la tabla. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Especifica el nombre de una base de datos en la que desea crear un índice de particiones. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Especifica el nombre de una tabla en la que desea crear un índice de particiones. + `PartitionIndex`: *obligatorio:* objeto [PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex). Especifica una estructura de `PartitionIndex` para crear un índice de partición en una tabla existente. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `AlreadyExistsException` + `InvalidInputException` + `EntityNotFoundException` + `ResourceNumberLimitExceededException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción DeletePartitionIndex (Python: delete\$1partition\$1index) Elimina un índice de partición especificado de una tabla existente. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo donde reside la tabla. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Especifica el nombre de una base de datos desde la que desea eliminar un índice de particiones. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Especifica el nombre de una tabla desde la que desea eliminar un índice de particiones. + `IndexName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre del índice de partición que se eliminará. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `InternalServiceException` + `OperationTimeoutException` + `InvalidInputException` + `EntityNotFoundException` + `ConflictException` + `GlueEncryptionException` ## Acción GetColumnStatisticsForTable (Python: get\$1column\$1statistics\$1for\$1table) Recupera estadísticas de las columnas de las tablas. El permiso de Identity and Access Management (IAM) necesario para esta operación es `GetTable`. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las particiones en cuestión. Si no se proporciona ninguno, el ID de cuenta de AWS se usará de forma predeterminada. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde residen las particiones. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la tabla de las particiones. + `ColumnNames` – *Obligatorio:* matriz de cadenas UTF-8, con 100 cadenas como máximo. Una lista de los nombres de las columnas. **Respuesta** + `ColumnStatisticsList`: matriz de objetos [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics). Lista de ColumnStatistics. + `Errors`: matriz de objetos [ColumnError](aws-glue-api-common.md#aws-glue-api-common-ColumnError). Lista de ColumnStatistics que no se pudieron recuperar. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción UpdateColumnStatisticsForTable (Python: update\$1column\$1statistics\$1for\$1table) Crea o actualiza las estadísticas de las columnas de la tabla. El permiso de Identity and Access Management (IAM) necesario para esta operación es `UpdateTable`. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las particiones en cuestión. Si no se proporciona ninguno, el ID de cuenta de AWS se usará de forma predeterminada. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde residen las particiones. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la tabla de las particiones. + `ColumnStatisticsList` – *Obligatorio:* matriz de objetos [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics), con 25 estructuras como máximo. Una lista de las estadísticas de las columnas. **Respuesta** + `Errors`: matriz de objetos [ColumnaStatisticsError](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError). Lista de ColumnStatisticsErrors. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción DeleteColumnStatisticsForTable (Python: delete\$1column\$1statistics\$1for\$1table) Recupera estadísticas de las columnas de las tablas. El permiso de Identity and Access Management (IAM) necesario para esta operación es `DeleteTable`. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las particiones en cuestión. Si no se proporciona ninguno, el ID de cuenta de AWS se usará de forma predeterminada. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde residen las particiones. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la tabla de las particiones. + `ColumnName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la columna. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` # API de partición La API de partición describe los tipos de datos y las operaciones que se utilizan para trabajar con particiones. ## Tipos de datos + [Estructura Partition](#aws-glue-api-catalog-partitions-Partition) + [Estructura PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput) + [Estructura PartitionSpecWithSharedStorageDescriptor](#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor) + [Estructura PartitionListComposingSpec](#aws-glue-api-catalog-partitions-PartitionListComposingSpec) + [Estructura PartitionSpecProxy](#aws-glue-api-catalog-partitions-PartitionSpecProxy) + [Estructura PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList) + [Estructura Segment](#aws-glue-api-catalog-partitions-Segment) + [Estructura PartitionError](#aws-glue-api-catalog-partitions-PartitionError) + [Estructura BatchUpdatePartitionFailureEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry) + [Estructura BatchUpdatePartitionRequestEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry) + [Estructura StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor) + [Estructura SchemaReference](#aws-glue-api-catalog-partitions-SchemaReference) + [Estructura SerDeInfo](#aws-glue-api-catalog-partitions-SerDeInfo) + [Estructura SkewedInfo](#aws-glue-api-catalog-partitions-SkewedInfo) ## Estructura Partition Representa un sector de los datos de la tabla. **Campos** + `Values`: matriz de cadenas UTF-8. Los valores de la partición. + `DatabaseName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde se crea la partición. + `TableName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla de base de datos en la que se desea crear la partición. + `CreationTime`: marca temporal. La hora a la que se creó la partición. + `LastAccessTime`: marca temporal. La última vez que se obtuvo acceso a la partición. + `StorageDescriptor`: un objeto [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor). Ofrece información sobre la ubicación física donde se almacena la partición. + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Estos pares de clave-valor definen los parámetros de partición. + `LastAnalyzedTime`: marca temporal. La última vez que se calcularon las estadísticas de columna para esta partición. + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID del Data Catalog donde reside la partición. ## Estructura PartitionInput La estructura que se utiliza para crear y actualizar una partición. **Campos** + `Values`: matriz de cadenas UTF-8. Los valores de la partición. Aunque este parámetro no lo requiere el SDK, debe especificarlo para una entrada válida. Los valores de las claves de la nueva partición deben pasarse como una matriz de objetos String que deben ordenarse en el mismo orden que las claves de partición que aparecen en el prefijo de Amazon S3. De lo contrario, AWS Glue agregará los valores a las claves erróneas. + `LastAccessTime`: marca temporal. La última vez que se obtuvo acceso a la partición. + `StorageDescriptor`: un objeto [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor). Ofrece información sobre la ubicación física donde se almacena la partición. + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Estos pares de clave-valor definen los parámetros de partición. + `LastAnalyzedTime`: marca temporal. La última vez que se calcularon las estadísticas de columna para esta partición. ## Estructura PartitionSpecWithSharedStorageDescriptor Especificación de partición para las particiones que comparten una ubicación física. **Campos** + `StorageDescriptor`: un objeto [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor). La información compartida sobre el almacenamiento físico. + `Partitions`: matriz de objetos [Partición](#aws-glue-api-catalog-partitions-Partition). Lista de las particiones que comparten esta ubicación física. ## Estructura PartitionListComposingSpec Muestra las particiones relacionadas. **Campos** + `Partitions`: matriz de objetos [Partición](#aws-glue-api-catalog-partitions-Partition). Lista de las particiones en la especificación de composición. ## Estructura PartitionSpecProxy Ofrece una ruta hacia las particiones especificadas. **Campos** + `DatabaseName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La base de datos de catálogos donde residen las particiones. + `TableName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla que contiene las particiones. + `RootPath` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La ruta raíz del proxy para abordar las particiones. + `PartitionSpecWithSharedSD`: un objeto [PartitionSpecWithSharedStorageDescriptor](#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor). Especificación de las particiones que comparten la misma ubicación de almacenamiento física. + `PartitionListComposingSpec`: un objeto [PartitionListComposingSpec](#aws-glue-api-catalog-partitions-PartitionListComposingSpec). Especifica una lista de particiones. ## Estructura PartitionValueList Contiene una lista de valores que definen particiones. **Campos** + `Values` – *Obligatorio:* una matriz de cadenas UTF-8. La lista de valores. ## Estructura Segment Define una región de particiones de una tabla que no se solapa, lo que permite ejecutar varias solicitudes a la vez. **Campos** + `SegmentNumber` – *Obligatorio:* número (entero), cero como máximo. El número de índice de base cero del segmento. Por ejemplo, si el número total de segmentos es de 4, los valores `SegmentNumber` van de 0 a 3. + `TotalSegments` – *Obligatorio:* número (entero), uno como mínimo o 10 como máximo. El número total de segmentos. ## Estructura PartitionError Contiene información sobre un error de partición. **Campos** + `PartitionValues`: matriz de cadenas UTF-8. Los valores que definen la partición. + `ErrorDetail`: un objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail). Detalles sobre el error de la partición. ## Estructura BatchUpdatePartitionFailureEntry Contiene información sobre un error de partición de actualización por lotes. **Campos** + `PartitionValueList`: matriz de cadenas UTF-8, con 100 cadenas como máximo. Una lista de los valores que definen las particiones. + `ErrorDetail`: un objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail). Los detalles sobre el error de partición del actualización por lotes. ## Estructura BatchUpdatePartitionRequestEntry Una estructura que contiene los valores y la estructura utilizados para actualizar una partición. **Campos** + `PartitionValueList` – *Obligatorio:* matriz de cadenas UTF-8, con 100 cadenas como máximo. Una lista de los valores que definen las particiones. + `PartitionInput`: *obligatorio:* objeto [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput). La estructura que se utiliza para actualizar una partición. ## Estructura StorageDescriptor Describe el almacenamiento físico de los datos de la tabla. **Campos** + `Columns`: matriz de objetos [Columna](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Column). Una lista de las `Columns` de la tabla. + `Location` – cadena de ubicación de un máximo de 2056 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Ubicación física de la tabla. De forma predeterminada, adopta la forma de la ubicación de almacén, seguida de la ubicación de la base de datos en el almacén, seguida del nombre de tabla. + `AdditionalLocations`: matriz de cadenas UTF-8. Lista de ubicaciones que apuntan a la ruta en la que se encuentra una tabla Delta. + `InputFormat` – cadena de formato de un máximo de 128 bytes de largo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Formato de entrada: `SequenceFileInputFormat` (binario), `TextInputFormat` o formato personalizado. + `OutputFormat` – cadena de formato de un máximo de 128 bytes de largo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Formato de salida: `SequenceFileOutputFormat` (binario), `IgnoreKeyTextOutputFormat` o formato personalizado. + `Compressed`: booleano. `True` si los datos de la tabla están comprimidos o `False` si no. + `NumberOfBuckets`: número (entero). Debe especificarse si la tabla contiene alguna columna de dimensión. + `SerdeInfo`: un objeto [SerDeInfo](#aws-glue-api-catalog-partitions-SerDeInfo). La información de serialización y deserialización (SerDe). + `BucketColumns`: matriz de cadenas UTF-8. Lista de columnas de agrupamiento del reductor, columnas de clústeres y columnas de almacenamiento en bucket de la tabla. + `SortColumns`: matriz de objetos [Order](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Order). Una lista donde se especifica el orden de clasificación de cada bucket en la tabla. + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Las propiedades facilitadas por el usuario en formato clave-valor. + `SkewedInfo`: un objeto [SkewedInfo](#aws-glue-api-catalog-partitions-SkewedInfo). La información sobre los valores que aparecen con frecuencia en una columna (valores sesgados). + `StoredAsSubDirectories`: booleano. `True` si los datos de la tabla se almacenan en subdirectorios o `False` si no. + `SchemaReference`: un objeto [SchemaReference](#aws-glue-api-catalog-partitions-SchemaReference). Objeto que hace referencia a un esquema almacenado en AWS Glue Schema Registry. Al crear una tabla, puede pasar una lista vacía de columnas para el esquema y, en su lugar, utilizar una referencia de esquema. ## Estructura SchemaReference Objeto que hace referencia a un esquema almacenado en AWS Glue Schema Registry. **Campos** + `SchemaId`: un objeto [SchemaId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId). Estructura que contiene campos de identidad de esquema. Este o el `SchemaVersionId` tiene que ser proporcionado. + `SchemaVersionId` – cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el [Custom string pattern #45](aws-glue-api-common.md#regex_45). El ID único asignado a una versión del esquema. Este o el `SchemaId` tiene que ser proporcionado. + `SchemaVersionNumber`: número (largo) que no es inferior a 1 ni es superior a 100 000. El número de versión del esquema. ## Estructura SerDeInfo Información sobre un programa de serialización y deserialización (SerDe) que sirve de extractor y cargador. **Campos** + `Name` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre del SerDe. + `SerializationLibrary` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). En general, la clase que implementa el SerDe. Un ejemplo es: . `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`. + `Parameters`: matriz de mapas de pares clave-valor. Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo. Estos pares de clave-valor definen parámetros de inicialización para el SerDe. ## Estructura SkewedInfo Especifica valores sesgados en una tabla. Los valores sesgados son los que se producen con una frecuencia muy alta. **Campos** + `SkewedColumnNames`: matriz de cadenas UTF-8. Una lista de nombres de columnas que contienen valores de sesgado. + `SkewedColumnValues`: matriz de cadenas UTF-8. Una lista de valores que aparecen con tanta frecuencia como para considerarse de sesgado. + `SkewedColumnValueLocationMaps`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8. Cada valor es una cadena UTF-8. Un mapeo de valores de sesgado a las columnas que los contienen. ## Operaciones + [Acción CreatePartition (Python: create\$1partition)](#aws-glue-api-catalog-partitions-CreatePartition) + [Acción BatchCreatePartition (Python: batch\$1create\$1partition)](#aws-glue-api-catalog-partitions-BatchCreatePartition) + [Acción UpdatePartition (Python: update\$1partition)](#aws-glue-api-catalog-partitions-UpdatePartition) + [Acción DeletePartition (Python: delete\$1partition)](#aws-glue-api-catalog-partitions-DeletePartition) + [Acción BatchDeletePartition (Python: batch\$1delete\$1partition)](#aws-glue-api-catalog-partitions-BatchDeletePartition) + [Acción GetPartition (Python: get\$1partition)](#aws-glue-api-catalog-partitions-GetPartition) + [Acción GetPartitions (Python: get\$1partitions)](#aws-glue-api-catalog-partitions-GetPartitions) + [Acción BatchGetPartition (Python: batch\$1get\$1partition)](#aws-glue-api-catalog-partitions-BatchGetPartition) + [Acción BatchUpdatePartition (Python: batch\$1update\$1partition)](#aws-glue-api-catalog-partitions-BatchUpdatePartition) + [Acción GetColumnStatisticsForPartition (Python: get\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-GetColumnStatisticsForPartition) + [Acción UpdateColumnStatisticsForPartition (Python: update\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-UpdateColumnStatisticsForPartition) + [Acción DeleteColumnStatisticsForPartition (Python: delete\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-DeleteColumnStatisticsForPartition) ## Acción CreatePartition (Python: create\$1partition) Crea una partición nueva. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID de cuenta de AWS del catálogo en el que se creará la partición. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de metadatos donde se va a crear la partición. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla de datos de metadatos donde se va a crear la partición. + `PartitionInput`: *obligatorio:* objeto [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput). Estructura `PartitionInput` que define la partición que se va a crear. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `InvalidInputException` + `AlreadyExistsException` + `ResourceNumberLimitExceededException` + `InternalServiceException` + `EntityNotFoundException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción BatchCreatePartition (Python: batch\$1create\$1partition) Crea una o varias particiones en una operación por lotes. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo en el que se va a crear la partición. En la actualidad, debe ser el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de metadatos donde se va a crear la partición. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla de datos de metadatos donde se va a crear la partición. + `PartitionInputList` – *Obligatorio:* matriz de objetos [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput), con 100 estructuras como máximo. Lista de estructuras `PartitionInput` que definen las particiones que se van a crear. **Respuesta** + `Errors`: matriz de objetos [PartitionError](#aws-glue-api-catalog-partitions-PartitionError). Los errores encontrados al intentar crear las particiones solicitadas. **Errores** + `InvalidInputException` + `AlreadyExistsException` + `ResourceNumberLimitExceededException` + `InternalServiceException` + `EntityNotFoundException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción UpdatePartition (Python: update\$1partition) Actualiza una partición. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo de datos donde reside la partición que se va a actualizar. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde reside la tabla relevante. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla donde se encuentra la partición que se va a actualizar. + `PartitionValueList` – *Obligatorio:* matriz de cadenas UTF-8, con 100 cadenas como máximo. Lista de valores de clave de partición que definen la partición que se va a actualizar. + `PartitionInput`: *obligatorio:* objeto [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput). El nuevo objeto de la partición para el que se actualiza la partición. La propiedad `Values` no puede modificarse. Si desea modificar los valores de clave de partición de una partición, elimine y vuelva a crear la partición. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción DeletePartition (Python: delete\$1partition) Elimina la partición especificada. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo de datos donde reside la partición que se va a eliminar. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde reside la tabla relevante. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla que contiene la partición que se va a eliminar. + `PartitionValues` – *Obligatorio:* una matriz de cadenas UTF-8. Los valores que definen la partición. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` ## Acción BatchDeletePartition (Python: batch\$1delete\$1partition) Elimina una o varias particiones en una operación por lotes. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo de datos donde reside la partición que se va a eliminar. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde reside la tabla relevante. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla que contiene las particiones que se van a eliminar. + `PartitionsToDelete` – *Obligatorio:* matriz de objetos [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList), con 25 estructuras como máximo. Lista de estructuras `PartitionInput` que definen las particiones que se van a eliminar. **Respuesta** + `Errors`: matriz de objetos [PartitionError](#aws-glue-api-catalog-partitions-PartitionError). Los errores encontrados al intentar eliminar las particiones solicitadas. **Errores** + `InvalidInputException` + `EntityNotFoundException` + `InternalServiceException` + `OperationTimeoutException` ## Acción GetPartition (Python: get\$1partition) Recupera información sobre una partición especificada. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo de datos donde reside la partición en cuestión. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde reside la partición. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la tabla de particiones. + `PartitionValues` – *Obligatorio:* una matriz de cadenas UTF-8. Los valores que definen la partición. **Respuesta** + `Partition`: un objeto [Partición](#aws-glue-api-catalog-partitions-Partition). La información solicitada, con formato de objeto `Partition`. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` + `FederationSourceException` + `FederationSourceRetryableException` ## Acción GetPartitions (Python: get\$1partitions) Recupera información acerca de las particiones de una tabla. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las particiones en cuestión. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde residen las particiones. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la tabla de las particiones. + `Expression` – cadena de predicado de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Una expresión que filtra las particiones que se van a devolver. La expresión usa una sintaxis SQL similar a la cláusula de filtro `WHERE` de SQL. El analizador de instrucciones SQL [JSQLParser](http://jsqlparser.sourceforge.net/home.php) analiza la expresión. *Operadores*: estos son los operadores que puede usar en la llamada a la API `Expression`: = Comprueba si los valores de los dos operandos son iguales o no; en caso afirmativo, la condición será "true". Ejemplo: supongamos que la "variable a" tiene 10 y, la "variable b", 20. (a = b) no es "true". < > Comprueba si los valores de los dos operandos son iguales o no; en caso negativo, la condición será "true". Ejemplo: (a < > b) es "true". > Comprueba si el valor del operando izquierdo es mayor que el valor del operando derecho; en caso afirmativo, la condición será "true". Ejemplo: (a > b) no es "true". < Comprueba si el valor del operando izquierdo es menor que el valor del operando derecho; en caso afirmativo, la condición será "true". Ejemplo: (a < b) es "true". >= Comprueba si el valor del operando izquierdo es mayor o igual que el valor del operando derecho; en caso afirmativo, la condición será "true". Ejemplo: (a >= b) no es "true". <= Comprueba si el valor del operando izquierdo es menor o igual que el valor del operando derecho; en caso afirmativo, la condición será "true". Ejemplo: (a <= b) es "true". AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL Operadores lógicos. *Tipos de clave de partición admitidos*: estas son las claves de partición admitidas. + `string` + `date` + `timestamp` + `int` + `bigint` + `long` + `tinyint` + `smallint` + `decimal` Si se encuentra un tipo no válido, se produce una excepción. En la siguiente lista se muestran todos los tipos de operador válido. Al definir un rastreador, se crea el tipo `partitionKey` como `STRING`, para ser compatible con las particiones del catálogo. *Ejemplo de llamada a la API*: **Example** La tabla `twitter_partition` tiene tres particiones: ``` year = 2015 year = 2016 year = 2017 ``` **Example** Get Partition `year` equivale a 2015 ``` aws glue get-partitions --database-name dbname --table-name twitter_partition --expression "year*=*'2015'" ``` **Example** Get Partition `year` entre 2016 y 2018 (exclusivo) ``` aws glue get-partitions --database-name dbname --table-name twitter_partition --expression "year>'2016' AND year<'2018'" ``` **Example** Get Partition `year` entre 2015 y 2018 (incluido). Las siguientes llamadas a la API son equivalentes entre sí: ``` 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** Filtro comodín de partición, donde la siguiente salida de llamadas será el año de partición, 2017. No se admite una expresión regular en `LIKE`. ``` aws glue get-partitions --database-name dbname --table-name twitter_partition --expression "year LIKE '%7'" ``` + `NextToken`: cadena UTF-8. Token de continuación, si no es la primera llamada para recuperar estas particiones. + `Segment`: un objeto [Segmento](#aws-glue-api-catalog-partitions-Segment). El segmento de las particiones de la tabla que se va a analizar en esta solicitud. + `MaxResults`: número (entero) que no es inferior a 1 ni es superior a 1000. El número máximo de particiones que se devuelven en una única respuesta. + `ExcludeColumnSchema`: booleano. Si es verdadero, especifica no devolver el esquema de columna de partición. Es útil cuando solo está interesado en otros atributos de partición, como valores de partición o ubicación. Este enfoque evita el problema de una respuesta grande al no devolver datos duplicados. + `TransactionId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Custom string pattern #44](aws-glue-api-common.md#regex_44). ID de transacción en el que se va a leer el contenido de la partición. + `QueryAsOfTime`: marca temporal. El momento a partir del que se debe leer el contenido de la partición. Si no se establece, se utilizará el tiempo de confirmación de la transacción más reciente. No se puede especificar junto con `TransactionId`. **Respuesta** + `Partitions`: matriz de objetos [Partición](#aws-glue-api-catalog-partitions-Partition). Lista de particiones solicitadas. + `NextToken`: cadena UTF-8. Un token de continuación, si la lista de particiones que se devuelve no incluye la última. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` + `GlueEncryptionException` + `InvalidStateException` + `ResourceNotReadyException` + `FederationSourceException` + `FederationSourceRetryableException` ## Acción BatchGetPartition (Python: batch\$1get\$1partition) Recupera particiones en una solicitud por lotes. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las particiones en cuestión. Si no se proporciona ninguno, el ID de cuenta de AWS se usará de forma predeterminada. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde residen las particiones. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la tabla de las particiones. + `PartitionsToGet` – *Obligatorio:* matriz de objetos [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList), con 1000 estructuras como máximo. Lista de los valores de partición que identifican las particiones que se van a recuperar. **Respuesta** + `Partitions`: matriz de objetos [Partición](#aws-glue-api-catalog-partitions-Partition). Lista de las particiones solicitadas. + `UnprocessedKeys`: matriz de objetos [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList), con 1000 estructuras como máximo. Una lista de los valores de partición en la solicitud para la que no se devolvieron particiones. **Errores** + `InvalidInputException` + `EntityNotFoundException` + `OperationTimeoutException` + `InternalServiceException` + `GlueEncryptionException` + `InvalidStateException` + `FederationSourceException` + `FederationSourceRetryableException` ## Acción BatchUpdatePartition (Python: batch\$1update\$1partition) Actualiza una o varias particiones en una operación por lotes. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo en el que se va a actualizar la partición. En la actualidad, debe ser el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de metadatos donde se va a actualizar la partición. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la tabla de metadatos donde se va a actualizar la partición. + `Entries` – *Obligatorio:* una matriz de objetos [BatchUpdatePartitionRequestEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry), con 1 estructura como mínimo y 100 estructuras como máximo. Lista de hasta 100 objetos `BatchUpdatePartitionRequestEntry` que se van a actualizar. **Respuesta** + `Errors`: matriz de objetos [BatchUpdatePartitionFailureEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry). Los errores encontrados al intentar actualizar las particiones solicitadas. Una lista de objetos `BatchUpdatePartitionFailureEntry`. **Errores** + `InvalidInputException` + `EntityNotFoundException` + `OperationTimeoutException` + `InternalServiceException` + `GlueEncryptionException` ## Acción GetColumnStatisticsForPartition (Python: get\$1column\$1statistics\$1for\$1partition) Recupera estadísticas de las columnas de las particiones. El permiso de Identity and Access Management (IAM) necesario para esta operación es `GetPartition`. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las particiones en cuestión. Si no se proporciona ninguno, el ID de cuenta de AWS se usará de forma predeterminada. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde residen las particiones. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la tabla de las particiones. + `PartitionValues` – *Obligatorio:* una matriz de cadenas UTF-8. Una lista de los valores de las particiones que identifican la partición. + `ColumnNames` – *Obligatorio:* matriz de cadenas UTF-8, con 100 cadenas como máximo. Una lista de los nombres de las columnas. **Respuesta** + `ColumnStatisticsList`: matriz de objetos [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics). Lista de ColumnStatistics que no se pudieron recuperar. + `Errors`: matriz de objetos [ColumnError](aws-glue-api-common.md#aws-glue-api-common-ColumnError). Error al recuperar los datos estadísticos de la columna. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción UpdateColumnStatisticsForPartition (Python: update\$1column\$1statistics\$1for\$1partition) Crea o actualiza las estadísticas de las columnas de las particiones. El permiso de Identity and Access Management (IAM) necesario para esta operación es `UpdatePartition`. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las particiones en cuestión. Si no se proporciona ninguno, el ID de cuenta de AWS se usará de forma predeterminada. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde residen las particiones. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la tabla de las particiones. + `PartitionValues` – *Obligatorio:* una matriz de cadenas UTF-8. Una lista de los valores de las particiones que identifican la partición. + `ColumnStatisticsList` – *Obligatorio:* matriz de objetos [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics), con 25 estructuras como máximo. Una lista de las estadísticas de las columnas. **Respuesta** + `Errors`: matriz de objetos [ColumnaStatisticsError](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError). Error al actualizar los datos de estadísticas de columna. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción DeleteColumnStatisticsForPartition (Python: delete\$1column\$1statistics\$1for\$1partition) Elimine las estadísticas de columnas de la partición de una columna. El permiso de Identity and Access Management (IAM) necesario para esta operación es `DeletePartition`. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las particiones en cuestión. Si no se proporciona ninguno, el ID de cuenta de AWS se usará de forma predeterminada. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde residen las particiones. + `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la tabla de las particiones. + `PartitionValues` – *Obligatorio:* una matriz de cadenas UTF-8. Una lista de los valores de las particiones que identifican la partición. + `ColumnName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la columna. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` # API de conexión La API de conexión describe los tipos de datos y las API relacionadas con el trabajo con conexiones en AWS Glue. **Topics** + [API de conexión](aws-glue-api-catalog-connections-connections.md) + [API de tipos de conexión](aws-glue-api-catalog-connections-connections-type.md) + [API de vista previa y metadatos de conexión](aws-glue-api-catalog-connections-connections-metadata.md) # API de conexión La API de conexión describe los tipos de datos de conexión de AWS Glue y la API de creación, eliminación, actualización y creación de listados de conexiones. ## Tipos de datos + [Estructura Connection](#aws-glue-api-catalog-connections-connections-Connection) + [Estructura ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput) + [Estructura TestConnectionInput](#aws-glue-api-catalog-connections-connections-TestConnectionInput) + [Estructura PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements) + [Estructura GetConnectionsFilter](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter) + [Estructura AuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration) + [Estructura AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput) + [Estructura OAuth2Properties](#aws-glue-api-catalog-connections-connections-OAuth2Properties) + [Estructura OAuth2PropertiesInput](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput) + [Estructura OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication) + [Estructura AuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties) + [Estructura BasicAuthenticationCredentials](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials) + [Estructura OAuth2Credentials](#aws-glue-api-catalog-connections-connections-OAuth2Credentials) ## Estructura Connection Define una conexión a un origen de datos. **Campos** + `Name` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la definición de la conexión. + `Description` – cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). La descripción de la conexión. + `ConnectionType` – Cadena 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`). Tipo de la conexión. Actualmente, SFTP no es compatible. + `MatchCriteria`: matriz de cadenas UTF-8, con 10 cadenas como máximo. Una lista de criterios que se pueden usar para seleccionar esta conexión. + `ConnectionProperties`: matriz de mapas de pares de clave-valor, con 100 pares como máximo. Cada clave es una cadena 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 valor es una cadena Valor con una extensión de 1 byte como mínimo o 1024 bytes como máximo. Estos pares de clave-valor definen los parámetros de la conexión cuando se utiliza el esquema de conexión de la versión 1: + `HOST`: el URI de host, ya sea el nombre de dominio completo (FQDN) o la dirección IPv4 del host de la base de datos. + `PORT`: el número de puerto, entre 1024 y 65535, del puerto en el que el host de la base de datos escucha las conexiones de la base de datos. + `USER_NAME`: el nombre con el que iniciar sesión en la base de datos. La cadena de valor de `USER_NAME` es “`USERNAME`”. + `PASSWORD`: contraseña, si se utiliza una, del nombre de usuario. + `ENCRYPTED_PASSWORD`: cuando habilita la protección de la contraseña de conexión al establecer `ConnectionPasswordEncryption` en la configuración de cifrado del Catálogo de datos, este campo almacena la contraseña cifrada. + `JDBC_DRIVER_JAR_URI`: la ruta de Amazon Simple Storage Service (Amazon S3) al archivo JAR que contiene el controlador JDBC que se va a utilizar. + `JDBC_DRIVER_CLASS_NAME`: el nombre de la clase de controlador de JDBC que se va a utilizar. + `JDBC_ENGINE`: nombre del motor JDBC que se va a utilizar. + `JDBC_ENGINE_VERSION`: la versión del motor JDBC que se va a utilizar. + `CONFIG_FILES`: (reservado para uso futuro). + `INSTANCE_ID`: la ID de instancia que se va a utilizar. + `JDBC_CONNECTION_URL`: la URL para conectarse a un origen de datos JDBC. + `JDBC_ENFORCE_SSL`: una cadena booleana que no distingue mayúsculas de minúsculas (true, false) que especifica si se aplicará la coincidencia de capa de sockets seguros (SSL) con el nombre de host para la conexión JDBC en el cliente. El valor predeterminado es false. + `CUSTOM_JDBC_CERT`: una ubicación de Amazon S3 que especifica el certificado raíz del cliente. AWS Glue utiliza este certificado raíz para validar el certificado del cliente al conectarse a la base de datos del cliente. AWS Glue solo gestiona certificados X.509. El certificado proporcionado debe estar codificado en DER y suministrarse en formato PEM de codificación Base64. + `SKIP_CUSTOM_JDBC_CERT_VALIDATION`: predeterminado en `false`. AWS Glue valida el algoritmo de firma y el algoritmo de clave pública de sujeto para el certificado de cliente. Los únicos algoritmos permitidos para el algoritmo de firma son SHA256withRSA, SHA384withRSA o SHA512withRSA. Para el algoritmo de clave pública del sujeto, la longitud de la clave debe ser de al menos 2048. Puede establecer el valor de esta propiedad en para `true` omitir la validación del certificado de cliente por parte de AWS Glue. + `CUSTOM_JDBC_CERT_STRING` : cadena de certificado JDBC personalizada que se utiliza para la coincidencia de dominio o la coincidencia de nombre distinguido para evitar un ataque man-in-the-middle. En la base de datos de Oracle, se utiliza como `SSL_SERVER_CERT_DN`; en Microsoft SQL Server, se utiliza como `hostNameInCertificate`. + `CONNECTION_URL`: la URL para conectarse a un origen de datos general (no JDBC). + `SECRET_ID`: la ID secreta utilizada para el administrador secreto de credenciales. + `CONNECTOR_URL`: la URL del conector para una conexión MARKETPLACE o CUSTOM. + `CONNECTOR_TYPE`: el tipo de conector para una conexión MARKETPLACE o CUSTOM. + `CONNECTOR_CLASS_NAME`: el nombre de la clase del conector para una conexión MARKETPLACE o CUSTOM. + `KAFKA_BOOTSTRAP_SERVERS`: una lista separada por comas de los pares de hosts y puertos que son las direcciones de los agentes de Apache Kafka en un clúster de Kafka al que un cliente Kafka se conectará y se arrancará. + `KAFKA_SSL_ENABLED`: para habilitar o desactivar SSL en una conexión de Apache Kafka. El valor predeterminado es “verdadero”. + `KAFKA_CUSTOM_CERT`: la URL de Amazon S3 para el archivo de certificado de CA privado (formato .pem). El valor predeterminado es una cadena vacía. + `KAFKA_SKIP_CUSTOM_CERT_VALIDATION`: para omitir la validación del archivo certificado de CA o no. AWS Glue valida para tres algoritmos: SHA256withRSA, SHA384withRSA y SHA512withRSA. El valor predeterminado es “falso”. + `KAFKA_CLIENT_KEYSTORE`: la ubicación de Amazon S3 del archivo de almacén de claves del cliente para la autenticación del lado del cliente Kafka (opcional). + `KAFKA_CLIENT_KEYSTORE_PASSWORD`: la contraseña para acceder al almacén de claves proporcionado (opcional). + `KAFKA_CLIENT_KEY_PASSWORD`: un almacén de claves puede consistir en varias claves, por lo que esta es la contraseña para acceder a la clave del cliente que se utilizará con la clave del lado del servidor Kafka (opcional). + `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD`: la versión cifrada de la contraseña del almacén de claves del cliente de Kafka (si el usuario ha seleccionado la configuración de cifrar contraseñas de AWS Glue). + `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD`: la versión cifrada de la contraseña de la clave del cliente de Kafka (si el usuario ha seleccionado la configuración de cifrar contraseñas de AWS Glue). + `KAFKA_SASL_MECHANISM`: `"SCRAM-SHA-512"`, `"GSSAPI"`, `"AWS_MSK_IAM"` o `"PLAIN"`. Estos son los [mecanismos SASL](https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml) compatibles. + `KAFKA_SASL_PLAIN_USERNAME`: un nombre de usuario sin formato utilizado para la autenticación con el mecanismo “PLAIN”. + `KAFKA_SASL_PLAIN_PASSWORD`: una contraseña sin formato utilizada para la autenticación con el mecanismo “PLAIN”. + `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD`: la versión cifrada de la contraseña de SASL PLAIN de Kafka (si el usuario seleccionó la configuración de cifrado de contraseñas de AWS Glue). + `KAFKA_SASL_SCRAM_USERNAME`: nombre de usuario de texto sin formato utilizado para autenticarse con el mecanismo “SCRAM-SHA-512”. + `KAFKA_SASL_SCRAM_PASSWORD`: contraseña de texto sin formato utilizada para autenticarse con el mecanismo “SCRAM-SHA-512”. + `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD`: la versión cifrada de la contraseña SASL SCRAM de Kafka (si el usuario ha seleccionado la configuración de cifrado de contraseñas de AWS Glue). + `KAFKA_SASL_SCRAM_SECRETS_ARN`: El nombre de recurso de Amazon (ARN) de un secreto en Secrets Manager AWS. + `KAFKA_SASL_GSSAPI_KEYTAB`: la ubicación S3 de un archivo `keytab` de Kerberos. Una keytab almacena claves a largo plazo para uno o varias entidades principales. Para obtener más información, consulte [MIT Kerberos Documentation: Keytab](https://web.mit.edu/kerberos/krb5-latest/doc/basic/keytab_def.html) (Documentación de MIT Kerberos: Keytab). + `KAFKA_SASL_GSSAPI_KRB5_CONF`: la ubicación S3 de un archivo `krb5.conf` de Kerberos. Un krb5.conf almacena información de configuración de Kerberos, como la ubicación del servidor KDC. Para obtener más información, consulte [MIT Kerberos Documentation: krb5.conf](https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html) (Documentación de MIT Kerberos: krb5.conf). + `KAFKA_SASL_GSSAPI_SERVICE`: el nombre del servicio Kerberos, tal como se establece con `sasl.kerberos.service.name` en la [configuración de Kafka](https://kafka.apache.org/documentation/#brokerconfigs_sasl.kerberos.service.name). + `KAFKA_SASL_GSSAPI_PRINCIPAL` - el nombre de la entidad principal de Kerberos que utiliza AWS Glue. Para obtener más información, consulte [Kafka Documentation: Configuring Kafka Brokers](https://kafka.apache.org/documentation/#security_sasl_kerberos_clientconfig) (Documentación de Kafka: Configuración de los agentes de Kafka). + `ROLE_ARN`: el rol que se utilizará para ejecutar consultas. + `REGION`: la región de AWS en la que se ejecutarán las consultas. + `WORKGROUP_NAME`: el nombre del grupo de trabajo de Amazon Redshift sin servidor o del grupo de trabajo de Amazon Athena en el que se ejecutarán las consultas. + `CLUSTER_IDENTIFIER`: el identificador de clúster de un clúster de Amazon Redshift en el que se ejecutarán las consultas. + `DATABASE`: la base de datos de Amazon Redshift a la que se está conectando. + `SparkProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo. Propiedades de conexión específicas del entorno de computación de Spark. + `AthenaProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo. Propiedades de conexión específicas del entorno de computación de Athena. + `PythonProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo. Propiedades de conexión específicas del entorno de computación de Python. + `PhysicalConnectionRequirements`: un objeto [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements). Los requisitos de conexión física, como la nube privada virtual (VPC) y `SecurityGroup`, que se necesitan para crear la conexión correctamente. + `CreationTime`: marca temporal. La marca temporal del momento en que se creó esta definición de conexión. + `LastUpdatedTime`: marca temporal. La marca temporal de la última vez que se actualizó la definición de conexión. + `LastUpdatedBy` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El usuario, el grupo o el rol que actualizaron por última vez la definición de esta conexión. + `Status` – Cadena UTF-8 (valores válidos: `READY` \$1 `IN_PROGRESS` \$1 `FAILED`). El estado de la conexión. Puede ser: `READY`, `IN_PROGRESS` o `FAILED`. + `StatusReason`: Cadena UTF-8 con 1 byte de largo como mínimo o 16 384 como máximo. Motivo del estado de la conexión. + `LastConnectionValidationTime`: marca temporal. Una marca temporal de la última vez que se validó esta conexión. + `AuthenticationConfiguration`: un objeto [AuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration). Las propiedades de autenticación de la conexión. + `ConnectionSchemaVersion`: número (entero), mayor que 1 y menor que 2. La versión del esquema de conexión de esta conexión. La versión 2 admite propiedades para entornos de computación específicos. + `CompatibleComputeEnvironments`: matriz de cadenas UTF-8. Una lista de entornos de computación compatibles con la conexión. ## Estructura ConnectionInput Una estructura que se usa para especificar una conexión que se va a crear o a actualizar. **Campos** + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la conexión. + `Description` – cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). La descripción de la conexión. + `ConnectionType` – *Obligatorio:* cadena 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`). Tipo de la conexión. Actualmente, estos tipos son compatibles: + `JDBC`: designa una conexión a una base de datos a través de Java Database Connectivity (JDBC). Las conexiones `JDBC` utilizan los siguientes parámetros ConnectionParameters. + Obligatorios: todos estos: `HOST`, `PORT`, `JDBC_ENGINE`; o bien `JDBC_CONNECTION_URL`. + Obligatorios: todos estos: `USERNAME`, `PASSWORD`; o bien `SECRET_ID`. + Opcionales: `JDBC_ENFORCE_SSL`, `CUSTOM_JDBC_CERT`, `CUSTOM_JDBC_CERT_STRING`, `SKIP_CUSTOM_JDBC_CERT_VALIDATION`. Estos parámetros se utilizan para configurar SSL con JDBC. + `KAFKA`: designa una conexión a una plataforma de streaming Apache Kafka. Las conexiones `KAFKA` utilizan los siguientes parámetros ConnectionParameters. + Obligatorio: `KAFKA_BOOTSTRAP_SERVERS`. + Opcionales: `KAFKA_SSL_ENABLED`, `KAFKA_CUSTOM_CERT`, `KAFKA_SKIP_CUSTOM_CERT_VALIDATION`. Estos parámetros se utilizan para configurar SSL con `KAFKA`. + Opcionales: `KAFKA_CLIENT_KEYSTORE`, `KAFKA_CLIENT_KEYSTORE_PASSWORD`, `KAFKA_CLIENT_KEY_PASSWORD`, `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD`, `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD`. Estos parámetros se utilizan para establecer la configuración del cliente TLS con SSL en `KAFKA`. + Opcional: `KAFKA_SASL_MECHANISM`. Se puede especificar como `SCRAM-SHA-512`, `GSSAPI` o `AWS_MSK_IAM`. + Opcionales: `KAFKA_SASL_SCRAM_USERNAME`, `KAFKA_SASL_SCRAM_PASSWORD`, `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD`. Estos parámetros se utilizan para configurar la autenticación SASL/SCRAM-SHA-512 con `KAFKA`. + Opcionales: `KAFKA_SASL_GSSAPI_KEYTAB`, `KAFKA_SASL_GSSAPI_KRB5_CONF`, `KAFKA_SASL_GSSAPI_SERVICE`, `KAFKA_SASL_GSSAPI_PRINCIPAL`. Estos parámetros se utilizan para configurar la autenticación SASL/GSSAPI con `KAFKA`. + `MONGODB`: designa una conexión a una base de datos de documentos MongoDB. Las conexiones `MONGODB` utilizan los siguientes parámetros ConnectionParameters. + Obligatorio: `CONNECTION_URL`. + Obligatorios: todos estos: `USERNAME`, `PASSWORD`; o bien `SECRET_ID`. + `VIEW_VALIDATION_REDSHIFT`: designa una conexión que Amazon Redshift utiliza para la validación de vistas. + `VIEW_VALIDATION_ATHENA`: designa una conexión que Amazon Athena utiliza para la validación de vistas. + `NETWORK`: designa una conexión de red a un origen de datos dentro de un entorno de Amazon Virtual Private Cloud (Amazon VPC). Las conexiones `NETWORK` no requieren parámetros ConnectionParameters. En su lugar, proporcione un requisito PhysicalConnectionRequirements. + `MARKETPLACE`: utiliza los ajustes de configuración contenidos en un conector adquirido de AWS Marketplace para leer y escribir en almacenes de datos que no son soportados de forma nativa por AWS Glue. Las conexiones `MARKETPLACE` utilizan los siguientes parámetros ConnectionParameters. + Obligatorios: `CONNECTOR_TYPE`, `CONNECTOR_URL`, `CONNECTOR_CLASS_NAME`, `CONNECTION_URL`. + Obligatorios para conexiones `JDBC` `CONNECTOR_TYPE`: todos estos: `USERNAME`, `PASSWORD`; o bien `SECRET_ID`. + `CUSTOM` - utiliza los ajustes de configuración contenidos en un conector personalizado para leer y escribir en almacenes de datos que no son soportados de forma nativa por AWS Glue. Si quiere obtener más información sobre los parámetros de conexión necesarios para un conector concreto, consulte la documentación del conector en [Añadir una conexión AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/console-connections.html) en la Guía del usuario AWS Glue. `SFTP` no se admite. Para obtener más información sobre cómo se pueden utilizar propiedades ConnectionProperties opcionales para configurar características en AWS Glue, consulte [Propiedades de las conexiones de AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html). Para obtener más información sobre cómo se pueden utilizar propiedades ConnectionProperties opcionales para configurar características en AWS Glue Studio, consulte [Uso de conectores y conexiones](https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html). + `MatchCriteria`: matriz de cadenas UTF-8, con 10 cadenas como máximo. Una lista de criterios que se pueden usar para seleccionar esta conexión. + `ConnectionProperties` – *Obligatorio:* matriz de mapas de pares clave-valor, con 100 pares como máximo. Cada clave es una cadena 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 valor es una cadena Valor con una extensión de 1 byte como mínimo o 1024 bytes como máximo. Estos pares de clave-valor definen parámetros para la conexión. + `SparkProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo. Propiedades de conexión específicas del entorno de computación de Spark. + `AthenaProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo. Propiedades de conexión específicas del entorno de computación de Athena. + `PythonProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo. Propiedades de conexión específicas del entorno de computación de Python. + `PhysicalConnectionRequirements`: un objeto [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements). Los requisitos de conexión física, como la nube privada virtual (VPC) y `SecurityGroup`, que se necesitan para crear esta conexión correctamente. + `AuthenticationConfiguration`: un objeto [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput). Las propiedades de autenticación de la conexión. + `ValidateCredentials`: booleano. Un indicador para validar las credenciales durante la creación de la conexión. El valor predeterminado es verdadero. + `ValidateForComputeEnvironments`: matriz de cadenas UTF-8. Entornos de computación en los que se validan las propiedades de conexión especificadas. ## Estructura TestConnectionInput Estructura que se usa para especificar la prueba de una conexión a un servicio. **Campos** + `ConnectionType` – *Obligatorio:* cadena 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`). Tipo de conexión que se va a probar. Esta operación solo está disponible para los tipos de conexión `JDBC` o `SALESFORCE`. + `ConnectionProperties` – *Obligatorio:* matriz de mapas de pares clave-valor, con 100 pares como máximo. Cada clave es una cadena 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 valor es una cadena Valor con una extensión de 1 byte como mínimo o 1024 bytes como máximo. Estos pares de clave-valor definen parámetros para la conexión. Las conexiones JDBC utilizan las siguientes propiedades de conexión: + Obligatorios: todos estos: `HOST`, `PORT`, `JDBC_ENGINE`; o bien `JDBC_CONNECTION_URL`. + Obligatorios: todos estos: `USERNAME`, `PASSWORD`; o bien `SECRET_ID`. + Opcionales: `JDBC_ENFORCE_SSL`, `CUSTOM_JDBC_CERT`, `CUSTOM_JDBC_CERT_STRING`, `SKIP_CUSTOM_JDBC_CERT_VALIDATION`. Estos parámetros se utilizan para configurar SSL con JDBC. Las conexiones de SALESFORCE requieren que se configure el miembro `AuthenticationConfiguration`. + `AuthenticationConfiguration`: un objeto [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput). Estructura que contiene la configuración de la autenticación en la solicitud TestConnection. Es necesario para realizar una conexión a Salesforce mediante la autenticación OAuth. ## Estructura PhysicalConnectionRequirements La aplicación cliente de OAuth en la respuesta GetConnection. **Campos** + `SubnetId` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID de subred utilizado por la conexión. + `SecurityGroupIdList`: matriz de cadenas UTF-8, con 50 cadenas como máximo. La lista de ID de grupo de seguridad usados por la conexión. + `AvailabilityZone` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La zona de disponibilidad de la conexión. ## Estructura GetConnectionsFilter Filtra las definiciones de conexión que devuelve la operación de la API `GetConnections`. **Campos** + `MatchCriteria`: matriz de cadenas UTF-8, con 10 cadenas como máximo. Una cadena de criterios que debe coincidir con los criterios registrados en la definición de la conexión para que dicha definición se devuelva. + `ConnectionType` – Cadena 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`). Tipo de conexiones que se van a devolver. Actualmente, SFTP no es compatible. + `ConnectionSchemaVersion`: número (entero), mayor que 1 y menor que 2. Indica si la conexión se creó con la versión 1 o 2 del esquema. ## Estructura AuthenticationConfiguration Estructura que contiene la configuración de la autenticación. **Campos** + `AuthenticationType` – Cadena UTF-8 (valores válidos: `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`). Estructura que contiene la configuración de la autenticación. + `SecretArn` – cadena UTF-8 que coincide con el [Custom string pattern #36](aws-glue-api-common.md#regex_36). El ARN de Secrets Manager para almacenar las credenciales. + `KmsKeyArn` – cadena UTF-8 que coincide con el [Custom string pattern #42](aws-glue-api-common.md#regex_42). Nombre de recurso de Amazon (ARN) de la clave de KMS usada para cifrar la información confidencial de autenticación. Esta clave protege las credenciales y otros datos confidenciales almacenados en la configuración de autenticación. + `OAuth2Properties`: un objeto [OAuth2Properties](#aws-glue-api-catalog-connections-connections-OAuth2Properties). Las propiedades para la autenticación de OAuth2. ## Estructura AuthenticationConfigurationInput Estructura que contiene la configuración de la autenticación en la solicitud CreateConnection. **Campos** + `AuthenticationType` – Cadena UTF-8 (valores válidos: `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`). Estructura que contiene la configuración de la autenticación en la solicitud CreateConnection. + `OAuth2Properties`: un objeto [OAuth2PropertiesInput](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput). Las propiedades de la autenticación de OAuth2 en la solicitud CreateConnection. + `SecretArn` – cadena UTF-8 que coincide con el [Custom string pattern #36](aws-glue-api-common.md#regex_36). El ARN de Secrets Manager para almacenar las credenciales en la solicitud CreateConnection. + `KmsKeyArn` – cadena UTF-8 que coincide con el [Custom string pattern #42](aws-glue-api-common.md#regex_42). El ARN de la clave de KMS que se utiliza para cifrar la conexión. Solo se usa como entrada en la solicitud y se almacena en Secret Manager. + `BasicAuthenticationCredentials`: un objeto [BasicAuthenticationCredentials](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials). Credenciales que se usan cuando el tipo de autenticación es la autenticación básica. + `CustomAuthenticationCredentials`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo. Credenciales que se usan cuando el tipo de autenticación es una autenticación personalizada. ## Estructura OAuth2Properties Una estructura que contiene propiedades para la autenticación de OAuth2. **Campos** + `OAuth2GrantType` – Cadena UTF-8 (valores válidos: `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`). El tipo de concesión de OAuth2. Por ejemplo, `AUTHORIZATION_CODE`, `JWT_BEARER` o `CLIENT_CREDENTIALS`. + `OAuth2ClientApplication`: un objeto [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication). El tipo de aplicación cliente. Por ejemplo, AWS\$1MANAGED o USER\$1MANAGED. + `TokenUrl` – cadena UTF-8, de 256 bytes de largo como máximo, que coincide con [Custom string pattern #40](aws-glue-api-common.md#regex_40). La URL del servidor de autenticación del proveedor para intercambiar un código de autorización por un token de acceso. + `TokenUrlParametersMap`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 con 1 byte de largo como mínimo o 512 como máximo. Un mapa de parámetros que se añaden a la solicitud `GET` de token. ## Estructura OAuth2PropertiesInput Estructura que contiene las propiedades para OAuth2 en la solicitud CreateConnection. **Campos** + `OAuth2GrantType` – Cadena UTF-8 (valores válidos: `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`). El tipo de concesión de OAuth2 en la solicitud CreateConnection. Por ejemplo, `AUTHORIZATION_CODE`, `JWT_BEARER` o `CLIENT_CREDENTIALS`. + `OAuth2ClientApplication`: un objeto [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication). El tipo de aplicación cliente en la solicitud CreateConnection. Por ejemplo, `AWS_MANAGED` o `USER_MANAGED`. + `TokenUrl` – cadena UTF-8, de 256 bytes de largo como máximo, que coincide con [Custom string pattern #40](aws-glue-api-common.md#regex_40). La URL del servidor de autenticación del proveedor para intercambiar un código de autorización por un token de acceso. + `TokenUrlParametersMap`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 con 1 byte de largo como mínimo o 512 como máximo. Un mapa de parámetros que se añaden a la solicitud `GET` de token. + `AuthorizationCodeProperties`: un objeto [AuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties). El conjunto de propiedades necesarias para el tipo de concesión `AUTHORIZATION_CODE` de OAuth2. + `OAuth2Credentials`: un objeto [OAuth2Credentials](#aws-glue-api-catalog-connections-connections-OAuth2Credentials). Credenciales que se usan cuando el tipo de autenticación es una autenticación OAuth2. ## Estructura OAuth2ClientApplication La aplicación cliente de OAuth2 que se usa para la conexión. **Campos** + `UserManagedClientApplicationClientId` – cadena UTF-8 con un máximo de 2048 bytes de largo, que coincide con el [Custom string pattern #37](aws-glue-api-common.md#regex_37). El ClientID de la aplicación cliente si el tipo de aplicación cliente es `USER_MANAGED`. + `AWSManagedClientApplicationReference` – cadena UTF-8 con un máximo de 2048 bytes de largo, que coincide con el [Custom string pattern #37](aws-glue-api-common.md#regex_37). La referencia a la aplicación cliente del lado SaaS administrada por AWS. ## Estructura AuthorizationCodeProperties El conjunto de propiedades necesario para el flujo de trabajo del tipo de concesión `AUTHORIZATION_CODE` de OAuth2. **Campos** + `AuthorizationCode` – Cadena UTF-8 con 1 byte de largo como mínimo o 4096 como máximo, que coincide con [Custom string pattern #37](aws-glue-api-common.md#regex_37). Un código de autorización que se usará en la tercera fase del flujo de trabajo de la concesión `AUTHORIZATION_CODE`. Se trata de un código de un solo uso que deja de ser válido una vez que se intercambia por un token de acceso, por lo que es aceptable tener este valor como parámetro de solicitud. + `RedirectUri` – Cadena UTF-8 con 512 bytes de largo como máximo, que coincide con [Custom string pattern #41](aws-glue-api-common.md#regex_41). El URI de redireccionamiento al que el servidor de autorización redirige al usuario al emitir un código de autorización. El URI se usa posteriormente cuando el código de autorización se intercambia por un token de acceso. ## Estructura BasicAuthenticationCredentials Para proporcionar credenciales de autenticación básica cuando no se suministra un valor `SecretArn`. **Campos** + `Username` – Cadena UTF-8 con 512 bytes de largo como máximo, que coincide con [Custom string pattern #37](aws-glue-api-common.md#regex_37). El nombre de usuario para conectarse al origen de datos. + `Password` – Cadena UTF-8 con 512 bytes de largo como máximo, que coincide con [Custom string pattern #33](aws-glue-api-common.md#regex_33). La contraseña para conectarse al origen de datos. ## Estructura OAuth2Credentials Credenciales que se usan cuando el tipo de autenticación es una autenticación OAuth2. **Campos** + `UserManagedClientApplicationClientSecret` – Cadena UTF-8 con 512 bytes de largo como máximo, que coincide con [Custom string pattern #38](aws-glue-api-common.md#regex_38). El secreto del cliente de la aplicación si la aplicación cliente es administrada por el usuario. + `AccessToken`: cadena UTF-8 con una extensión de 4096 bytes como máximo, que coincide con [Custom string pattern #38](aws-glue-api-common.md#regex_38). El token de acceso que se utiliza cuando el tipo de autenticación es OAuth2. + `RefreshToken`: cadena UTF-8 con una extensión de 4096 bytes como máximo, que coincide con [Custom string pattern #38](aws-glue-api-common.md#regex_38). El token de actualización que se utiliza cuando el tipo de autenticación es OAuth2. + `JwtToken`: Cadena UTF-8 con una extensión de 8000 bytes como máximo, que coincide con [Custom string pattern #39](aws-glue-api-common.md#regex_39). El token web JSON (JWT) que se utiliza cuando el tipo de autenticación es OAuth2. ## Operaciones + [Acción CreateConnection (Python: create\$1connection)](#aws-glue-api-catalog-connections-connections-CreateConnection) + [Acción DeleteConnection (Python: delete\$1connection)](#aws-glue-api-catalog-connections-connections-DeleteConnection) + [Acción GetConnection (Python: get\$1connection)](#aws-glue-api-catalog-connections-connections-GetConnection) + [Acción GetConnections (Python: get\$1connections)](#aws-glue-api-catalog-connections-connections-GetConnections) + [Acción UpdateConnection (Python: update\$1connection)](#aws-glue-api-catalog-connections-connections-UpdateConnection) + [Acción TestConnection (Python: test\$1connection)](#aws-glue-api-catalog-connections-connections-TestConnection) + [Acción BatchDeleteConnection (Python: batch\$1delete\$1connection)](#aws-glue-api-catalog-connections-connections-BatchDeleteConnection) ## Acción CreateConnection (Python: create\$1connection) Crea una definición de la conexión en el Catálogo de datos. Las conexiones utilizadas para crear recursos federados requieren el permiso `glue:PassConnection` de IAM. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde se crea la conexión. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `ConnectionInput`: *obligatorio:* objeto [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput). Objeto `ConnectionInput` que define la conexión que se va a crear. + `Tags`: matriz de mapas de pares de clave-valor, con 50 pares como máximo. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo. Etiquetas que asigna a la conexión. **Respuesta** + `CreateConnectionStatus` – Cadena UTF-8 (valores válidos: `READY` \$1 `IN_PROGRESS` \$1 `FAILED`). El estado de la solicitud de creación de conexión. La solicitud puede llevar tiempo en algunos tipos de autenticación, por ejemplo, cuando se crea una conexión OAuth con intercambio de tokens por medio de una VPC. **Errores** + `AlreadyExistsException` + `InvalidInputException` + `OperationTimeoutException` + `ResourceNumberLimitExceededException` + `GlueEncryptionException` ## Acción DeleteConnection (Python: delete\$1connection) Elimina una conexión del Catálogo de datos. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la conexión. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `ConnectionName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la conexión que se va a eliminar. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `OperationTimeoutException` ## Acción GetConnection (Python: get\$1connection) Recupera una definición de la conexión del Catálogo de datos. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la conexión. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la definición de la conexión que se va a recuperar. + `HidePassword`: booleano. Le permite recuperar los metadatos de conexión sin devolver la contraseña. Por ejemplo, la consola de AWS Glue utiliza esta marca para recuperar la conexión y no muestra la contraseña. Establezca este parámetro cuando es posible que el que realiza la llamada no tenga permiso para usar la clave AWS KMS para descifrar la contraseña, pero tenga permiso para acceder al resto de las propiedades de conexión. + `ApplyOverrideForComputeEnvironment` – Cadena UTF-8 (valores válidos: `SPARK` \$1 `ATHENA` \$1 `PYTHON`). En el caso de las conexiones que se pueden utilizar en varios servicios, especifica las propiedades que se devuelven para el entorno de computación especificado. **Respuesta** + `Connection`: un objeto [Connection](#aws-glue-api-catalog-connections-connections-Connection). La definición de la conexión solicitada. **Errores** + `EntityNotFoundException` + `OperationTimeoutException` + `InvalidInputException` + `GlueEncryptionException` ## Acción GetConnections (Python: get\$1connections) Recupera una lista de definiciones de la conexión del Catálogo de datos. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las conexiones. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `Filter`: un objeto [GetConnectionsFilter](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter). Un filtro que controla las conexiones que se devolverán. + `HidePassword`: booleano. Le permite recuperar los metadatos de conexión sin devolver la contraseña. Por ejemplo, la consola de AWS Glue utiliza esta marca para recuperar la conexión y no muestra la contraseña. Establezca este parámetro cuando es posible que el que realiza la llamada no tenga permiso para usar la clave AWS KMS para descifrar la contraseña, pero tenga permiso para acceder al resto de las propiedades de conexión. + `NextToken`: cadena UTF-8. Token de continuación si se trata de una llamada de continuidad. + `MaxResults`: número (entero) que no es inferior a 1 ni es superior a 1000. El número máximo de conexiones que se devuelven en una respuesta. **Respuesta** + `ConnectionList`: matriz de objetos [Connection](#aws-glue-api-catalog-connections-connections-Connection). Una lista de definiciones de la conexión solicitadas. + `NextToken`: cadena UTF-8. Un token de continuación, si la lista de conexiones que se devuelve no incluye la última conexión filtrada. **Errores** + `EntityNotFoundException` + `OperationTimeoutException` + `InvalidInputException` + `GlueEncryptionException` ## Acción UpdateConnection (Python: update\$1connection) Actualiza una definición de la conexión en el Catálogo de datos. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la conexión. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `Name`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la definición de la conexión que se va a actualizar. + `ConnectionInput`: *obligatorio:* objeto [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput). Un objeto `ConnectionInput` que redefine la conexión en cuestión. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `InvalidInputException` + `EntityNotFoundException` + `OperationTimeoutException` + `InvalidInputException` + `GlueEncryptionException` ## Acción TestConnection (Python: test\$1connection) Prueba una conexión a un servicio para validar las credenciales de servicio que proporcione. Puede proporcionar un nombre de conexión existente o `TestConnectionInput` para probar una entrada de conexión que no exista. Si proporciona ambos elementos al mismo tiempo, se producirá un error. Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200. **Solicitud** + `ConnectionName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Opcional. Es el nombre de la conexión que se va a probar. Si solo proporciona el nombre, la operación obtendrá la conexión y la usará para realizar las pruebas. + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo donde se encuentra la conexión. + `TestConnectionInput`: un objeto [TestConnectionInput](#aws-glue-api-catalog-connections-connections-TestConnectionInput). Estructura que se usa para especificar la prueba de una conexión a un servicio. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `InvalidInputException` + `OperationTimeoutException` + `ResourceNumberLimitExceededException` + `GlueEncryptionException` + `FederationSourceException` + `AccessDeniedException` + `EntityNotFoundException` + `ConflictException` + `InternalServiceException` ## Acción BatchDeleteConnection (Python: batch\$1delete\$1connection) Elimina una lista de definiciones de la conexión del Catálogo de datos. **Solicitud** + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde residen las conexiones. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `ConnectionNameList` – *Obligatorio:* matriz de cadenas UTF-8, con 25 cadenas como máximo. Una lista de nombres de las conexiones que se van a eliminar. **Respuesta** + `Succeeded`: matriz de cadenas UTF-8. Una lista de nombres de las definiciones de la conexión que se eliminaron con éxito. + `Errors`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cada valor es un objeto [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail). Una asignación de los nombres de conexiones que no se eliminaron con éxito a los detalles del error. **Errores** + `InternalServiceException` + `OperationTimeoutException` # API de tipos de conexión La API de tipos de conexión describe las API AWS Glue relacionadas con la descripción de los tipos de conexión. ## API de administración de conexiones + [Acción DescribeConnectionType (Python: describe\$1connection\$1type)](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType) + [Acción ListConnectionTypes (Python: list\$1connection\$1types)](#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes) + [Estructura ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief) + [Estructura ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant) ## Acción DescribeConnectionType (Python: describe\$1connection\$1type) La API `DescribeConnectionType` proporciona todos los detalles de las opciones admitidas para un tipo de conexión determinado en AWS Glue. **Solicitud** + `ConnectionType`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre del tipo de conexión que se va a describir. **Respuesta** + `ConnectionType` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre del tipo de conexión. + `Description`: cadena UTF-8, no más de 1024 bytes de largo. Descripción del tipo de conexión. + `Capabilities`: un objeto [Capacidades](#aws-glue-api-catalog-connections-connections-type-Capabilities). Los tipos de autenticación, los tipos de interfaz de datos (entornos de computación) y las operaciones de datos del conector compatibles. + `ConnectionProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es un objeto A [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). Propiedades de conexión que son comunes en todos los entornos de computación. + `ConnectionOptions`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es un objeto A [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). Devuelve las propiedades que se pueden establecer al crear una conexión en `ConnectionInput.ConnectionProperties`. `ConnectionOptions` define los parámetros que se pueden configurar en un script ETL de Spark en el mapa de opciones de conexión que se pasa a un marco de datos. + `AuthenticationConfiguration`: un objeto [AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration). El tipo de autenticación que se va a utilizar para la conexión. + `ComputeEnvironmentConfigurations`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es un objeto A [ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration). Entornos de computación compatibles con la conexión. + `PhysicalConnectionRequirements`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es un objeto A [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). Requisitos físicos de una conexión, como las especificaciones de VPC, subred y grupo de seguridad. + `AthenaConnectionProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es un objeto A [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). Propiedades de conexión específicas del entorno de computación de Athena. + `PythonConnectionProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es un objeto A [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). Propiedades de conexión específicas del entorno de computación de Python. + `SparkConnectionProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es un objeto A [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). Propiedades de conexión específicas del entorno de computación de Spark. **Errores** + `ValidationException` + `InvalidInputException` + `InternalServiceException` ## Acción ListConnectionTypes (Python: list\$1connection\$1types) La API `ListConnectionTypes` proporciona un mecanismo de detección para saber cuáles son los tipos de conexión disponibles en AWS Glue. La respuesta contiene una lista de tipos de conexión con información extremadamente detallada sobre qué se admite en cada tipo de conexión. Los tipos de conexión que se muestran son el un conjunto de opciones compatibles para el valor `ConnectionType` de la API `CreateConnection`. **Solicitud** + `MaxResults`: número (entero) que no es inferior a 1 ni es superior a 1000. El número máximo de resultados que devolver. + `NextToken` – cadena UTF-8, con 1 byte de largo como mínimo y 2048 bytes de largo como máximo, que coincide con el [Custom string pattern #11](aws-glue-api-common.md#regex_11). Token de continuación si se trata de una llamada de continuidad. **Respuesta** + `ConnectionTypes`: matriz de objetos [ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief). Una lista de objetos `ConnectionTypeBrief` que contiene información breve sobre los tipos de conexión compatibles. + `NextToken` – cadena UTF-8, con 1 byte de largo como mínimo y 2048 bytes de largo como máximo, que coincide con el [Custom string pattern #11](aws-glue-api-common.md#regex_11). Un token de continuación, que está presente si el segmento de lista actual no es el último. **Errores** + `InternalServiceException` ## Estructura ConnectionTypeBrief Información breve sobre un tipo de conexión compatible que devuelve la API `ListConnectionTypes`. **Campos** + `ConnectionType` – Cadena 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`). El nombre del tipo de conexión. + `DisplayName`: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo. El nombre en formato legible para humanos del tipo de conexión que aparece en la consola de AWS Glue. + `Vendor`: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo. El nombre del vendedor o proveedor que creó o mantiene este tipo de conexión. + `Description`: cadena UTF-8, no más de 1024 bytes de largo. Descripción del tipo de conexión. + `Categories` – . Lista de las categorías a las que pertenece este tipo de conexión. Las categorías permiten a los usuarios filtrar y encontrar los tipos de conexión adecuados según los casos de uso. + `Capabilities`: un objeto [Capacidades](#aws-glue-api-catalog-connections-connections-type-Capabilities). Los tipos de autenticación, los tipos de interfaz de datos (entornos de computación) y las operaciones de datos del conector compatibles. + `LogoUrl`: cadena UTF-8. URL del logotipo asociado a un tipo de conexión. + `ConnectionTypeVariants`: matriz de objetos [ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant). Lista de variantes disponibles para este tipo de conexión. Las distintas variantes pueden ofrecer configuraciones especializadas para casos de uso específicos o implementaciones dentro del mismo tipo general de conexión. ## Estructura ConnectionTypeVariant Representa una variante de un tipo de conexión en el Catálogo de datos de AWS Glue. Las variantes de tipo de conexión ofrecen configuraciones y comportamientos específicos para distintas implementaciones del mismo tipo general de conexión. **Campos** + `ConnectionTypeVariantName`: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo. Identificador único de la variante de tipo de conexión. Este nombre se usa internamente para identificar la variante específica de un tipo de conexión. + `DisplayName`: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo. El nombre en formato legible para humanos de la variante del tipo de conexión que aparece en la consola de AWS Glue. + `Description`: cadena UTF-8, no más de 1024 bytes de largo. Descripción detallada de la variante del tipo de conexión, que incluye su propósito, casos de uso y cualquier requisito de configuración específico. + `LogoUrl`: cadena UTF-8. URL del logotipo asociado a una variante de tipo de conexión. ## datatypes + [Estructura de Validación](#aws-glue-api-catalog-connections-connections-type-Validation) + [Estructura AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration) + [Estructura de capacidades](#aws-glue-api-catalog-connections-connections-type-Capabilities) + [Estructura de propiedad](#aws-glue-api-catalog-connections-connections-type-Property) + [Estructura AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue) + [Estructura ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration) ## Estructura de Validación Define cómo se realiza una validación en una propiedad de conexión. **Campos** + `ValidationType`: *obligatorio:* cadena UTF-8 (valores válidos: `REGEX` \$1 `RANGE`). El tipo de validación que se va a realizar, como `REGEX`. + `Patterns` – . Una lista con los patrones que se aplican a la validación. + `Description`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 1024 como máximo. Una descripción de la validación. + `MaxLength`: número (entero). Longitud máxima de una propiedad de conexión de cadenas. + `Maximum`: número (entero). Valor máximo al especificar un tipo de validación `RANGE`. + `Minimum`: número (entero). Valor mínimo al especificar un tipo de validación `RANGE`. ## Estructura AuthConfiguration Es la configuración de autenticación de una conexión que devuelve la API `DescribeConnectionType`. **Campos** + `AuthenticationType`: *obligatorio:* objeto [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). El tipo de autenticación de una conexión. + `SecretArn`: un objeto [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). El nombre de recurso de Amazon (ARN) de Secrets Manager. + `OAuth2Properties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es un objeto A [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). Asignación de pares clave-valor para las propiedades de OAuth2. Cada valor es un objeto `Property`. + `BasicAuthenticationProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es un objeto A [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). Asignación de pares clave-valor para las propiedades de OAuth2. Cada valor es un objeto `Property`. + `CustomAuthenticationProperties`: matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es un objeto A [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). Asignación de pares clave-valor para las propiedades de autenticación personalizadas. Cada valor es un objeto `Property`. ## Estructura de capacidades Especifica los tipos de autenticación compatibles que devuelve la API `DescribeConnectionType`. **Campos** + `SupportedAuthenticationTypes`: *obligatorio:* una matriz de cadenas UTF-8. Una lista de los tipos de autenticación compatibles. + `SupportedDataOperations`: *obligatorio:* una matriz de cadenas UTF-8. Una lista de las operaciones de datos compatibles. + `SupportedComputeEnvironments`: *obligatorio:* una matriz de cadenas UTF-8. Una lista de los entornos de computación compatibles. ## Estructura de propiedad Objeto que define un tipo de conexión para un entorno de computación. **Campos** + `Name`: *requerido:* cadena UTF-8 con una extensión de 1 byte como mínimo y 128 bytes como máximo. El nombre de la propiedad. + `Description`: *requerido:* cadena UTF-8 con una extensión de 1024 bytes como máximo. Una descripción de la propiedad. + `Required` – *Obligatorio:* Booleano. Indica si la propiedad es necesaria. + `PropertyTypes`: *obligatorio:* una matriz de cadenas UTF-8. Describe el tipo de propiedad. + `AllowedValues`: matriz de objetos [AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue). Lista de objetos `AllowedValue` que representan los valores permitidos en la propiedad. + `DataOperationScopes`: matriz de cadenas UTF-8. Indica qué operaciones de datos se aplican a la propiedad. ## Estructura AllowedValue Objeto que representa un valor permitido en la propiedad. **Campos** + `Description`: cadena UTF-8, no más de 1024 bytes de largo. Descripción del valor permitido. + `Value`: *requerido:* cadena UTF-8 con una extensión de 1 byte como mínimo y 128 bytes como máximo. El valor permitido de la propiedad. ## Estructura ComputeEnvironmentConfiguration Un objeto que contiene la configuración de un entorno de computación (como Spark, Python o Athena) y que devuelve la API `DescribeConnectionType`. **Campos** + `Name`: *requerido:* cadena UTF-8 con una extensión de 1 byte como mínimo y 128 bytes como máximo. Nombre para la configuración del entorno de computación. + `Description`: *requerido:* cadena UTF-8 con una extensión de 1024 bytes como máximo. La descripción del entorno de computación. + `ComputeEnvironment` – *Obligatorio:* cadena UTF-8 (valores válidos: `SPARK` \$1 `ATHENA` \$1 `PYTHON`). El tipo de entorno de computación. + `SupportedAuthenticationTypes`: *obligatorio:* una matriz de cadenas UTF-8. Tipos de autenticación compatibles en el entorno de computación. + `ConnectionOptions` – *Obligatorio:* matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es un objeto A [Propiedad](#aws-glue-api-catalog-connections-connections-type-Property). Parámetros que se usan como opciones de conexión en el entorno de computación. + `ConnectionPropertyNameOverrides` – *Obligatorio:* matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 con una extensión de 1 byte como mínimo o 128 bytes como máximo. El nombre de la propiedad de conexión se anula en el entorno de computación. + `ConnectionOptionNameOverrides` – *Obligatorio:* matriz de mapas de pares clave-valor. Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes. Cada valor es una cadena UTF-8 con una extensión de 1 byte como mínimo o 128 bytes como máximo. El nombre de la opción de conexión se anula en el entorno de computación. + `ConnectionPropertiesRequiredOverrides` – *Requerido:* . Propiedades de conexión que son necesarias para realizar anulaciones en el entorno de computación. + `PhysicalConnectionPropertiesRequired`: booleano. Indica si `PhysicalConnectionProperties` son necesarias en el entorno de computación. # API de vista previa y metadatos de conexión Las siguientes API de conexión describen las operaciones que se utilizan para describir los metadatos de conexión. ## Tipos de datos + [Estructura de la entidad](#aws-glue-api-catalog-connections-connections-metadata-Entity) + [Estructura de campo](#aws-glue-api-catalog-connections-connections-metadata-Field) ## Estructura de la entidad Entidad respaldada por un elemento `ConnectionType`. **Campos** + `EntityName`: cadena UTF-8. El nombre de la entidad. + `Label`: cadena UTF-8. Etiqueta que se utiliza en la entidad. + `IsParentEntity`: booleano. Un valor booleano que le permite determinar si hay objetos secundarios que se puedan enumerar. + `Description`: cadena UTF-8. Descripción de la entidad. + `Category`: cadena UTF-8. El tipo de entidades que están presentes en la respuesta. Este valor depende del origen de la conexión. Por ejemplo, esto es `SObjects` para Salesforce y `databases` o `schemas` o `tables` para orígenes como Amazon Redshift. + `CustomProperties` – Mapa opcional de claves que un conector puede devolver a una entidad. ## Estructura de campo El objeto `Field` contiene información sobre las distintas propiedades asociadas a un campo del conector. **Campos** + `FieldName`: cadena UTF-8. Identificador único del campo. + `Label`: cadena UTF-8. Etiqueta legible que se utiliza en el campo. + `Description`: cadena UTF-8. Descripción del campo. + `FieldType` – Cadena 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`). Tipo de datos en el campo. + `IsPrimaryKey`: booleano. Indica si este campo se puede utilizar como clave principal en la entidad determinada. + `IsNullable`: booleano. Indica si este campo se puede anular o no. + `IsRetrievable`: booleano. Indica si este campo se puede agregar a la cláusula Select de una consulta de SQL o si se puede recuperar. + `IsFilterable`: booleano. Indica si este campo se puede utilizar en una cláusula de filtro (cláusula `WHERE`) de una instrucción de SQL al consultar datos. + `IsPartitionable`: booleano. Indica si un campo determinado se puede utilizar para particionar la consulta realizada en SaaS. + `IsCreateable`: booleano. Indica si este campo se puede crear como parte de una escritura de destino. + `IsUpdateable`: booleano. Indica si este campo se puede actualizar como parte de una escritura de destino. + `IsUpsertable`: booleano. Indica si este campo se puede actualizar o insertar como parte de una escritura de destino. + `IsDefaultOnCreate`: booleano. Indica si este campo se rellena automáticamente cuando se crea el objeto; por ejemplo, si se crea en una marca de tiempo. + `SupportedValues` – . Lista de valores admitidos para el campo especificado. + `SupportedFilterOperators`: matriz de cadenas UTF-8. Indica los operadores de filtro compatibles con este campo. + `CustomProperties` – Mapa opcional de claves que se pueden devolver. ## Operaciones + [Acción ListEntities (Python: list\$1entities)](#aws-glue-api-catalog-connections-connections-metadata-ListEntities) + [Acción DescribeEntity (Python: describe\$1entity)](#aws-glue-api-catalog-connections-connections-metadata-DescribeEntity) + [Acción GetEntityRecords (Python: get\$1entity\$1records)](#aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords) ## Acción ListEntities (Python: list\$1entities) Devuelve las entidades disponibles que admite el tipo de conexión. **Solicitud** + `ConnectionName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la conexión que tiene las credenciales necesarias para consultar cualquier tipo de conexión. + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identificador del catálogo que contiene la conexión. Puede ser nulo, pero, de forma predeterminada, el ID de cuenta de AWS es el ID del catálogo. + `ParentEntityName`: cadena UTF-8. Nombre de la entidad principal para la que desea enumerar todas las entidades secundarias. Este parámetro toma una ruta completa de la entidad para enumerar las entidades secundarias. + `NextToken` – cadena UTF-8, con 1 byte de largo como mínimo y 2048 bytes de largo como máximo, que coincide con el [Custom string pattern #11](aws-glue-api-common.md#regex_11). Token de continuación, incluido si se trata de una llamada de continuidad. + `DataStoreApiVersion` – cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el [Custom string pattern #23](aws-glue-api-common.md#regex_23). Versión API del conector de SaaS. **Respuesta** + `Entities`: matriz de objetos [Entidad](#aws-glue-api-catalog-connections-connections-metadata-Entity). Una lista de objetos `Entity`. + `NextToken` – cadena UTF-8, con 1 byte de largo como mínimo y 2048 bytes de largo como máximo, que coincide con el [Custom string pattern #11](aws-glue-api-common.md#regex_11). Un token de continuación, presente si el segmento de lista actual no es el último. **Errores** + `EntityNotFoundException` + `OperationTimeoutException` + `InvalidInputException` + `GlueEncryptionException` + `ValidationException` + `FederationSourceException` + `AccessDeniedException` ## Acción DescribeEntity (Python: describe\$1entity) Proporciona detalles sobre la entidad que se utiliza con el tipo de conexión, además de una descripción del modelo de datos para cada campo de la entidad seleccionada. La respuesta incluye todos los campos que componen la entidad. **Solicitud** + `ConnectionName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la conexión que contiene las credenciales del tipo de conexión. + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identificador del catálogo que contiene la conexión. Puede ser nulo, pero, de forma predeterminada, el ID de cuenta de AWS es el ID del catálogo. + `EntityName` – *Obligatorio:* cadena UTF-8. El nombre de la entidad que desea describir desde el tipo de conexión. + `NextToken` – cadena UTF-8, con 1 byte de largo como mínimo y 2048 bytes de largo como máximo, que coincide con el [Custom string pattern #11](aws-glue-api-common.md#regex_11). Token de continuación, incluido si se trata de una llamada de continuidad. + `DataStoreApiVersion` – cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el [Custom string pattern #23](aws-glue-api-common.md#regex_23). La versión de la API que se utiliza en el almacén de datos. **Respuesta** + `Fields`: matriz de objetos [Campo](#aws-glue-api-catalog-connections-connections-metadata-Field). Describe los campos de esa entidad de conector. Esta es la lista de objetos `Field`. `Field` es muy similar a una columna de una base de datos. El objeto `Field` contiene información sobre las distintas propiedades asociadas a los campos del conector. + `NextToken` – cadena UTF-8, con 1 byte de largo como mínimo y 2048 bytes de largo como máximo, que coincide con el [Custom string pattern #11](aws-glue-api-common.md#regex_11). Un token de continuación, presente si el segmento de lista actual no es el último. **Errores** + `EntityNotFoundException` + `OperationTimeoutException` + `InvalidInputException` + `GlueEncryptionException` + `ValidationException` + `FederationSourceException` + `AccessDeniedException` ## Acción GetEntityRecords (Python: get\$1entity\$1records) Esta API se utiliza para consultar datos de vista previa de un tipo de conexión determinado o de un catálogo de datos nativo AWS Glue basado en Amazon S3. Devuelve los registros como una matriz de blobs de JSON. Cada registro se formatea mediante el nodo JSON de Jackson en función del tipo de campo que haya definido la API `DescribeEntity`. Los conectores de Spark generan esquemas siguiendo la misma asignación de tipos de datos que tiene la API `DescribeEntity`. Los conectores de Spark convierten los datos en los tipos de datos adecuados que coinciden con el esquema al devolver filas. **Solicitud** + `ConnectionName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la conexión que contiene las credenciales del tipo de conexión. + `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identificador del catálogo que contiene la conexión. Puede ser nulo, pero, de forma predeterminada, el ID de cuenta de AWS es el ID del catálogo. + `EntityName` – *Obligatorio:* cadena UTF-8. Nombre de la entidad en la que quiere consultar los datos de vista previa de un tipo de conexión determinado. + `NextToken` – cadena UTF-8, con 1 byte de largo como mínimo y 2048 bytes de largo como máximo, que coincide con el [Custom string pattern #11](aws-glue-api-common.md#regex_11). Token de continuación, incluido si se trata de una llamada de continuidad. + `DataStoreApiVersion` – cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el [Custom string pattern #23](aws-glue-api-common.md#regex_23). Versión API del conector de SaaS. + `ConnectionOptions`: matriz de mapas de pares de clave-valor, con 100 pares como máximo. Cada clave es una cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo y que coincide con [Custom string pattern #18](aws-glue-api-common.md#regex_18). Cada valor es una cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo y que coincide con [Custom string pattern #17](aws-glue-api-common.md#regex_17). Opciones de conector que se requieren para consultar los datos. + `FilterPredicate`: Cadena UTF-8 con una extensión de 1 byte como mínimo o 100 000 como máximo. Predicado de filtro que puede aplicar en la solicitud de consulta. + `Limit` (*requerido*): número (largo) que no es menor que 1 ni mayor que 1000. Limita el número de registros que se obtienen en cada solicitud. + `SelectedFields`: matriz de cadenas UTF-8 que no tiene menos de 1 cadena ni más de 1000. Lista de los campos que quiere obtener como parte de los datos de vista previa. **Respuesta** + `Records`: un conjunto de estructuras. Una lista de los objetos solicitados. + `NextToken` – cadena UTF-8, con 1 byte de largo como mínimo y 2048 bytes de largo como máximo, que coincide con el [Custom string pattern #11](aws-glue-api-common.md#regex_11). Un token de continuación, presente si el segmento de lista actual no es el último. **Errores** + `EntityNotFoundException` + `OperationTimeoutException` + `InvalidInputException` + `GlueEncryptionException` + `ValidationException` + `FederationSourceException` + `AccessDeniedException` # API de funciones definidas por el usuario La API de funciones definidas por el usuario describe los tipos de datos y las operaciones de AWS Glue que se utilizan para trabajar con funciones. ## Tipos de datos + [Estructura UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction) + [Estructura UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput) ## Estructura UserDefinedFunction Representa el equivalente a una definición de función Hive definida por el usuario (`UDF`). **Campos** + `FunctionName`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la función. + `DatabaseName`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nombre de la base de datos del catálogo que contiene la función. + `ClassName`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La clase de Java que contiene el código de la función. + `OwnerName`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El propietario de la función. + `OwnerType`: cadena UTF-8 (valores válidos: `USER` \$1 `ROLE` \$1 `GROUP`). El tipo de propietario. + `CreateTime`: marca temporal. La hora a la que se creó la función. + `ResourceUris`: matriz de objetos [ResourceUri](aws-glue-api-common.md#aws-glue-api-common-ResourceUri), con 1000 estructuras como máximo. Los URI del recurso para la función. + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde reside la función. ## Estructura UserDefinedFunctionInput Un estructura que se utiliza para crear o actualizar funciones definidas por el usuario. **Campos** + `FunctionName`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la función. + `ClassName`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). La clase de Java que contiene el código de la función. + `OwnerName`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El propietario de la función. + `OwnerType`: cadena UTF-8 (valores válidos: `USER` \$1 `ROLE` \$1 `GROUP`). El tipo de propietario. + `ResourceUris`: matriz de objetos [ResourceUri](aws-glue-api-common.md#aws-glue-api-common-ResourceUri), con 1000 estructuras como máximo. Los URI del recurso para la función. ## Operaciones + [Acción CreateUserDefinedFunction (Python: create\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-CreateUserDefinedFunction) + [Acción UpdateUserDefinedFunction (Python: update\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-UpdateUserDefinedFunction) + [Acción DeleteUserDefinedFunction (Python: delete\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-DeleteUserDefinedFunction) + [Acción GetUserDefinedFunction (Python: get\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-GetUserDefinedFunction) + [Acción GetUserDefinedFunctions (Python: get\$1user\$1defined\$1functions)](#aws-glue-api-catalog-functions-GetUserDefinedFunctions) ## Acción CreateUserDefinedFunction (Python: create\$1user\$1defined\$1function) Crea una nueva definición de función en el Catálogo de datos. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde se crea la función. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde se crea la función. + `FunctionInput` – *Obligatorio:* objeto [UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput). Objeto `FunctionInput` que define la función que se va a crear en el Catálogo de datos. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `AlreadyExistsException` + `InvalidInputException` + `InternalServiceException` + `EntityNotFoundException` + `OperationTimeoutException` + `ResourceNumberLimitExceededException` + `GlueEncryptionException` ## Acción UpdateUserDefinedFunction (Python: update\$1user\$1defined\$1function) Actualiza una definición de función existente en el Catálogo de datos. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde se encuentra la función que se va a actualizar. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde se encuentra la función que se va a actualizar. + `FunctionName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la función. + `FunctionInput` – *Obligatorio:* objeto [UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput). Un objeto `FunctionInput` que redefine la función que en el Catálogo de datos. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción DeleteUserDefinedFunction (Python: delete\$1user\$1defined\$1function) Elimina una definición de función existente del Catálogo de datos. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde se encuentra la función que se va a eliminar. Si no se proporciona ninguno, el ID de cuenta de AWS se usará de forma predeterminada. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde se encuentra la función. + `FunctionName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la definición de la función que se va a eliminar. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` ## Acción GetUserDefinedFunction (Python: get\$1user\$1defined\$1function) Recupera una definición de función especificada del Catálogo de datos. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde se encuentra la función que se va a recuperar. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde se encuentra la función. + `FunctionName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la función. **Respuesta** + `UserDefinedFunction`: un objeto [UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction). La definición de la función solicitada. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `GlueEncryptionException` ## Acción GetUserDefinedFunctions (Python: get\$1user\$1defined\$1functions) Recupera varias definiciones de función del Catálogo de datos. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del Catálogo de datos donde se encuentran las funciones que se van a recuperar. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS. + `DatabaseName`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la base de datos de catálogos donde se encuentra las funciones. Si no se proporciona ninguno, se devolverán las funciones de todas las bases de datos del catálogo. + `Pattern`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Cadena con patrón nombre-de-función opcional que filtra las definiciones de función que se devuelven. + `NextToken`: cadena UTF-8. Token de continuación si se trata de una llamada de continuidad. + `MaxResults`: número (entero) que no es inferior a 1 ni es superior a 100. El número máximo de funciones que se devuelven en una respuesta. **Respuesta** + `UserDefinedFunctions`: matriz de objetos [UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction). Lista de las definiciones de función solicitadas. + `NextToken`: cadena UTF-8. Token de continuación, si la lista de funciones que se devuelve no incluye la última función solicitada. **Errores** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` + `GlueEncryptionException` # Importación de un catálogo de Athena a AWS Glue La API de migración describe los tipos de datos y las operaciones de AWS Glue relativos a la migración de un Catálogo de datos de Athena a AWS Glue. ## Tipos de datos + [Estructura CatalogImportStatus](#aws-glue-api-catalog-migration-CatalogImportStatus) ## Estructura CatalogImportStatus Estructura que contiene información sobre el estado de la migración. **Campos** + `ImportCompleted`: booleano. `True` si la migración se ha completado; o `False` en caso contrario,. + `ImportTime`: marca temporal. La hora en que comenzó la migración. + `ImportedBy`: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El nombre de la persona que inició la migración. ## Operaciones + [Acción ImportCatalogToGlue (Python: import\$1catalog\$1to\$1glue)](#aws-glue-api-catalog-migration-ImportCatalogToGlue) + [Acción GetCatalogImportStatus (Python: get\$1catalog\$1import\$1status)](#aws-glue-api-catalog-migration-GetCatalogImportStatus) ## Acción ImportCatalogToGlue (Python: import\$1catalog\$1to\$1glue) Importa un Catálogo de datos de Amazon Athena existente a AWS Glue. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo que se va a importar. En la actualidad, debe ser el ID de cuenta de AWS. **Respuesta** + *Sin parámetros de respuesta.* **Errores** + `InternalServiceException` + `OperationTimeoutException` ## Acción GetCatalogImportStatus (Python: get\$1catalog\$1import\$1status) Recupera el estado de una operación de migración. **Solicitud** + `CatalogId`: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). El ID del catálogo que se va a migrar. En la actualidad, debe ser el ID de cuenta de AWS. **Respuesta** + `ImportStatus`: un objeto [CatalogImportStatus](#aws-glue-api-catalog-migration-CatalogImportStatus). El estado de la migración del catálogo especificado. **Errores** + `InternalServiceException` + `OperationTimeoutException`