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

• Estructura ConnectionInput

• Estructura TestConnectionInput

• Estructura PhysicalConnectionRequirements

• Estructura GetConnectionsFilter

• Estructura AuthenticationConfiguration

• Estructura AuthenticationConfigurationInput

• Estructura OAuth2Properties

• Estructura OAuth2PropertiesInput

• Estructura OAuth2ClientApplication

• Estructura AuthorizationCodeProperties

• Estructura BasicAuthenticationCredentials

• Estructura 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.

  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.

  La descripción de la conexión.

• ConnectionType – Cadena UTF-8 (valores válidos: JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA | GOOGLEADS | GOOGLESHEETS | GOOGLEANALYTICS4 | SERVICENOW | MARKETO | SAPODATA | ZENDESK | JIRACLOUD | NETSUITEERP | HUBSPOT | FACEBOOKADS | INSTAGRAMADS | ZOHOCRM | SALESFORCEPARDOT | SALESFORCEMARKETINGCLOUD | SLACK | STRIPE | INTERCOM | SNAPCHATADS).

  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 | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | JDBC_DRIVER_JAR_URI | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES | INSTANCE_ID | JDBC_CONNECTION_URL | JDBC_ENFORCE_SSL | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | CUSTOM_JDBC_CERT_STRING | CONNECTION_URL | KAFKA_BOOTSTRAP_SERVERS | KAFKA_SSL_ENABLED | KAFKA_CUSTOM_CERT | KAFKA_SKIP_CUSTOM_CERT_VALIDATION | KAFKA_CLIENT_KEYSTORE | KAFKA_CLIENT_KEYSTORE_PASSWORD | KAFKA_CLIENT_KEY_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | KAFKA_SASL_MECHANISM | KAFKA_SASL_PLAIN_USERNAME | KAFKA_SASL_PLAIN_PASSWORD | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD | KAFKA_SASL_SCRAM_USERNAME | KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_SCRAM_SECRETS_ARN | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB | KAFKA_SASL_GSSAPI_KRB5_CONF | KAFKA_SASL_GSSAPI_SERVICE | KAFKA_SASL_GSSAPI_PRINCIPAL | SECRET_ID | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | ENDPOINT | ENDPOINT_TYPE | ROLE_ARN | REGION | WORKGROUP_NAME | CLUSTER_IDENTIFIER | 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: cadena booleana (true, false) que especifica si se aplicará la coincidencia de Capa de conexión segura (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 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 (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 (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.

  • 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 (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.

  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.

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

  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.

  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.

  La descripción de la conexión.

• ConnectionType – Obligatorio: cadena UTF-8 (valores válidos: JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA | GOOGLEADS | GOOGLESHEETS | GOOGLEANALYTICS4 | SERVICENOW | MARKETO | SAPODATA | ZENDESK | JIRACLOUD | NETSUITEERP | HUBSPOT | FACEBOOKADS | INSTAGRAMADS | ZOHOCRM | SALESFORCEPARDOT | SALESFORCEMARKETINGCLOUD | SLACK | STRIPE | INTERCOM | SNAPCHATADS).

  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.

  Además, el valor ConnectionType es compatible con los siguientes conectores de SaaS:

  • FACEBOOKADS - Designa una conexión con Facebook Ads.

  • GOOGLEADS - Designa una conexión con Google Ads.

  • GOOGLESHEETS - Designa una conexión con Hojas de cálculo de Google.

  • GOOGLEANALYTICS4 - Designa una conexión con Google Analytics 4.

  • HUBSPOT - Designa una conexión con HubSpot.

  • INSTAGRAMADS - Designa una conexión con Instagram Ads.

  • INTERCOM - Designa una conexión con Intercom.

  • JIRACLOUD - Designa una conexión con Jira Cloud.

  • MARKETO - Designa una conexión con Adobe Marketo Engage.

  • NETSUITEERP - Designa una conexión con Oracle NetSuite.

  • SALESFORCE: Designa una conexión con Salesforce mediante la autenticación de OAuth.

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

  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.

• 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 | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | JDBC_DRIVER_JAR_URI | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES | INSTANCE_ID | JDBC_CONNECTION_URL | JDBC_ENFORCE_SSL | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | CUSTOM_JDBC_CERT_STRING | CONNECTION_URL | KAFKA_BOOTSTRAP_SERVERS | KAFKA_SSL_ENABLED | KAFKA_CUSTOM_CERT | KAFKA_SKIP_CUSTOM_CERT_VALIDATION | KAFKA_CLIENT_KEYSTORE | KAFKA_CLIENT_KEYSTORE_PASSWORD | KAFKA_CLIENT_KEY_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | KAFKA_SASL_MECHANISM | KAFKA_SASL_PLAIN_USERNAME | KAFKA_SASL_PLAIN_PASSWORD | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD | KAFKA_SASL_SCRAM_USERNAME | KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_SCRAM_SECRETS_ARN | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB | KAFKA_SASL_GSSAPI_KRB5_CONF | KAFKA_SASL_GSSAPI_SERVICE | KAFKA_SASL_GSSAPI_PRINCIPAL | SECRET_ID | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | ENDPOINT | ENDPOINT_TYPE | ROLE_ARN | REGION | WORKGROUP_NAME | CLUSTER_IDENTIFIER | 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.

  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.

  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 | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA | GOOGLEADS | GOOGLESHEETS | GOOGLEANALYTICS4 | SERVICENOW | MARKETO | SAPODATA | ZENDESK | JIRACLOUD | NETSUITEERP | HUBSPOT | FACEBOOKADS | INSTAGRAMADS | ZOHOCRM | SALESFORCEPARDOT | SALESFORCEMARKETINGCLOUD | SLACK | STRIPE | INTERCOM | SNAPCHATADS).

  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: 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 | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | JDBC_DRIVER_JAR_URI | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES | INSTANCE_ID | JDBC_CONNECTION_URL | JDBC_ENFORCE_SSL | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | CUSTOM_JDBC_CERT_STRING | CONNECTION_URL | KAFKA_BOOTSTRAP_SERVERS | KAFKA_SSL_ENABLED | KAFKA_CUSTOM_CERT | KAFKA_SKIP_CUSTOM_CERT_VALIDATION | KAFKA_CLIENT_KEYSTORE | KAFKA_CLIENT_KEYSTORE_PASSWORD | KAFKA_CLIENT_KEY_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | KAFKA_SASL_MECHANISM | KAFKA_SASL_PLAIN_USERNAME | KAFKA_SASL_PLAIN_PASSWORD | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD | KAFKA_SASL_SCRAM_USERNAME | KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_SCRAM_SECRETS_ARN | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB | KAFKA_SASL_GSSAPI_KRB5_CONF | KAFKA_SASL_GSSAPI_SERVICE | KAFKA_SASL_GSSAPI_PRINCIPAL | SECRET_ID | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | ENDPOINT | ENDPOINT_TYPE | ROLE_ARN | REGION | WORKGROUP_NAME | CLUSTER_IDENTIFIER | 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.

  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.

  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.

  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 | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA | GOOGLEADS | GOOGLESHEETS | GOOGLEANALYTICS4 | SERVICENOW | MARKETO | SAPODATA | ZENDESK | JIRACLOUD | NETSUITEERP | HUBSPOT | FACEBOOKADS | INSTAGRAMADS | ZOHOCRM | SALESFORCEPARDOT | SALESFORCEMARKETINGCLOUD | SLACK | STRIPE | INTERCOM | SNAPCHATADS).

  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 | OAUTH2 | CUSTOM | IAM).

  Estructura que contiene la configuración de la autenticación.

• SecretArn: cadena UTF-8 que coincide con el Custom string pattern #36.

  El ARN de Secrets Manager para almacenar las credenciales.

• OAuth2Properties: un objeto 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 | OAUTH2 | CUSTOM | IAM).

  Estructura que contiene la configuración de la autenticación en la solicitud CreateConnection.

• OAuth2Properties: un objeto 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.

  El ARN de Secrets Manager para almacenar las credenciales en la solicitud CreateConnection.

• KmsKeyArn: cadena UTF-8 que coincide con el Custom string pattern #29.

  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.

  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 | CLIENT_CREDENTIALS | JWT_BEARER).

  El tipo de concesión de OAuth2. Por ejemplo, AUTHORIZATION_CODE, JWT_BEARER o CLIENT_CREDENTIALS.

• OAuth2ClientApplication: un objeto OAuth2ClientApplication.

  El tipo de aplicación cliente. 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.

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

  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.

  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.

  El conjunto de propiedades necesarias para el tipo de concesión AUTHORIZATION_CODE de OAuth2.

• OAuth2Credentials: un objeto 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.

  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.

  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.

  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.

  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

Objeto que contiene las credenciales que se utilizan cuando el tipo de autenticación es la autenticación básica.

Campos

• Username: Cadena UTF-8 con 512 bytes de largo como máximo, que coincide con Custom string pattern #37.

  Nombre de usuario de la autenticación básica.

• Password: Cadena UTF-8 con 512 bytes de largo como máximo, que coincide con Custom string pattern #33.

  Contraseña de la autenticación básica.

Estructura OAuth2Credentials

Objeto que contiene las credenciales que se utilizan cuando el tipo de autenticación es OAuth2.

Campos

• UserManagedClientApplicationClientSecret: Cadena UTF-8 con 512 bytes de largo como máximo, que coincide con Custom string pattern #38.

  El secreto de cliente de la aplicación de cliente 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.

  El token de acceso para la autenticación de OAuth2.

• RefreshToken: cadena UTF-8 con una extensión de 4096 bytes como máximo, que coincide con Custom string pattern #38.

  Token de actualización para la autenticación OAuth2.

• JwtToken: Cadena UTF-8 con una extensión de 8000 bytes como máximo, que coincide con Custom string pattern #39.

  El token web JSON (JWT) para la autenticación de OAuth2.

Operaciones

• Acción CreateConnection (Python: create_connection)

• Acción DeleteConnection (Python: delete_connection)

• Acción GetConnection (Python: get_connection)

• Acción GetConnections (Python: get_connections)

• Acción UpdateConnection (Python: update_connection)

• Acción TestConnection (Python: test_connection)

• Acción BatchDeleteConnection (Python: batch_delete_connection)

Acción CreateConnection (Python: create_connection)

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.

  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.

  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 | IN_PROGRESS | 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_connection)

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.

  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.

  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_connection)

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.

  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.

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

  La definición de la conexión solicitada.

Errores

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

Acción GetConnections (Python: get_connections)

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.

  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.

  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.

  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_connection)

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.

  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.

  El nombre de la definición de la conexión que se va a actualizar.

• ConnectionInput: obligatorio: objeto 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_connection)

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.

  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.

• TestConnectionInput: un objeto 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_delete_connection)

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.

  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.

  Cada valor es un objeto ErrorDetail.

  Una asignación de los nombres de conexiones que no se eliminaron con éxito a los detalles del error.

Errores

• InternalServiceException

• OperationTimeoutException