Conexión API

• Estructura Connection

• ConnectionInput estructura

• PhysicalConnectionRequirements estructura

• GetConnectionsFilter estructura

Campos

• Name— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-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— UTF -8 cadenas (valores válidos: JDBC | SFTP | | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

  Tipo de la conexión. Actualmente, no se admite SFTP.

• MatchCriteria— Una matriz de UTF -8 cadenas, no más de 10 cadenas.

  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 de UTF 8 cadenas (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 | SECRET_ID CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | 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 | ROLE_ARN | REGION | WORKGROUP_NAME | CLUSTER_IDENTIFIER |DATABASE).

  Cada valor es una cadena de valor que no tiene más de 1024 bytes de largo.

  Estos pares de clave-valor definen parámetros para la conexión:

  • HOST- El servidorURI: el nombre de dominio completo (FQDN) o la IPv4 dirección del servidor 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 del Amazon Simple Storage Service (Amazon S3) del archivo que contiene JAR JDBC el controlador que se va a utilizar.

  • JDBC_DRIVER_CLASS_NAME- El nombre de clase del JDBC controlador que se va a utilizar.

  • JDBC_ENGINE- El nombre del JDBC motor que se va a utilizar.

  • JDBC_ENGINE_VERSION- La versión del JDBC motor 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- El URL para conectarse a una fuente JDBC de datos.

  • JDBC_ENFORCE_SSL- Una cadena booleana (true, false) que especifica si la JDBC conexión en el cliente requiere el uso de Secure Sockets Layer (SSL) con un nombre de host coincidente. El valor predeterminado es false.

  • CUSTOM_JDBC_CERT- Una ubicación de Amazon S3 que especifique 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 de clientes. AWS Glue solo gestiona los certificados X.509. El certificado proporcionado debe estar DER codificado y en formato de codificación Base64. PEM

  • SKIP_CUSTOM_JDBC_CERT_VALIDATION- De forma predeterminada, esto es. false AWS Glue valida el algoritmo de firma y el algoritmo de clave pública del asunto para el certificado del cliente. Los únicos algoritmos permitidos para el algoritmo de firma sonSHA256withRSA, SHA384withRSA oSHA512withRSA. 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- Una cadena de JDBC certificado personalizada que se utiliza para hacer coincidir el dominio o el nombre distintivo para evitar un man-in-the-middle ataque. En la base de datos Oracle, se usa comoSSL_SERVER_CERT_DN; en Microsoft SQL Server, se usa comohostNameInCertificate.

  • CONNECTION_URL- El URL para conectarse a una fuente de datos general (noJDBC).

  • SECRET_ID: la ID secreta utilizada para el administrador secreto de credenciales.

  • CONNECTOR_URL- El conector URL para una CUSTOM conexión MARKETPLACE O.

  • CONNECTOR_TYPE- El tipo de conector de una CUSTOM conexión MARKETPLACE o.

  • CONNECTOR_CLASS_NAME- El nombre de la clase de conector de una CUSTOM conexión MARKETPLACE o.

  • 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- Si se debe activar o desactivar SSL en una conexión de Apache Kafka. El valor predeterminado es “verdadero”.

  • KAFKA_CUSTOM_CERT- El Amazon S3 URL para el archivo de certificado de CA privado (formato.pem). El valor predeterminado es una cadena vacía.

  • KAFKA_SKIP_CUSTOM_CERT_VALIDATION- Si se debe omitir la validación del archivo de certificado de CA o no. AWS Glue valida para tres algoritmos:SHA256withRSA, ySHA384withRSA. 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 AWS Glue cifrado de contraseñas).

  • 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 AWS Glue cifrado de contraseñas).

  • KAFKA_SASL_MECHANISM: "SCRAM-SHA-512", "GSSAPI", "AWS_MSK_IAM" o "PLAIN". Estos son los mecanismos compatiblesSASL.

  • KAFKA_SASL_PLAIN_USERNAME- Un nombre de usuario en texto simple que se utiliza para autenticarse con el mecanismo «PLAIN».

  • KAFKA_SASL_PLAIN_PASSWORD- Una contraseña de texto simple que se utiliza para autenticarse con el mecanismo «». PLAIN

  • ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD- La versión cifrada de la SASL PLAIN contraseña de Kafka (si el usuario ha seleccionado la configuración de AWS Glue cifrado de contraseñas).

  • KAFKA_SASL_SCRAM_USERNAME- Un nombre de usuario en texto plano que se utiliza para autenticarse con el mecanismo "- -512"SCRAM. SHA

  • KAFKA_SASL_SCRAM_PASSWORD- Una contraseña de texto simple que se utiliza para autenticarse con el mecanismo «- -512". SCRAM SHA

  • ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD- La versión cifrada de la SASL SCRAM contraseña de Kafka (si el usuario ha seleccionado la configuración de AWS Glue cifrado de contraseñas).

  • KAFKA_SASL_SCRAM_SECRETS_ARN- El nombre del recurso de Amazon de un secreto de AWS Secrets Manager.

  • 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 la documentación de MIT Kerberos: Keytab.

  • KAFKA_SASL_GSSAPI_KRB5_CONF: la ubicación S3 de un archivo krb5.conf de Kerberos. Un archivo krb5.conf almacena la información de configuración de Kerberos, como la ubicación del servidor. KDC Para obtener más información, consulte MIT la documentación de 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 del principal de Kerberos utilizado por. 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 AWS región en la que se ejecutarán las consultas.

  • WORKGROUP_NAME- El nombre del grupo de trabajo sin servidor de Amazon Redshift 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.

• PhysicalConnectionRequirements: un objeto PhysicalConnectionRequirements.

  Los requisitos de conexión física, como una nube privada virtual (VPC) ySecurityGroup, que se necesitan para realizar esta 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— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.

  El usuario, el grupo o el rol que actualizaron por última vez la definición de esta conexión.

• Status— UTF -8 cadenas (valores válidos: READY | IN_PROGRESS |FAILED).

  El estado de la conexión. Puede ser: READY, IN_PROGRESS o FAILED.

• StatusReason— UTF -8 cadenas, de no menos de 1 ni más de 16384 bytes de longitud.

  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.

Campos

• Name— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes, que coincidan conSingle-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— UTFObligatorio: -8 cadenas (valores válidos: JDBC SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

  Tipo de la conexión. Actualmente, estos tipos son compatibles:

  • JDBC- Designa una conexión a una base de datos mediante la conectividad de bases de datos Java (JDBC).

    JDBCLas conexiones utilizan lo siguiente 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 conJDBC.

  • KAFKA: designa una conexión a una plataforma de streaming Apache Kafka.

    KAFKALas conexiones utilizan lo siguiente 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 conKAFKA.

    • 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 configurar la configuración del TLS cliente con SSL inKAFKA.

    • 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ónSASL/SCRAM- SHA -512 conKAFKA.

    • Opcionales: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. Estos parámetros se utilizan para configurarSASL/la GSSAPI autenticación conKAFKA.

  • MONGODB: designa una conexión a una base de datos de documentos MongoDB.

    MONGODBLas conexiones utilizan lo siguiente ConnectionParameters.

    • Obligatorio: CONNECTION_URL.

    • Obligatorios: todos estos: USERNAME, PASSWORD; o bien SECRET_ID.

  • SALESFORCE- Designa una conexión a Salesforce mediante OAuth la autenticación.

    • Requiere que se configure el miembro AuthenticationConfiguration.

  • 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 una fuente de datos dentro de un entorno de Amazon Virtual Private Cloud (AmazonVPC).

    NETWORKLas conexiones no son ConnectionParameters obligatorias. En su lugar, proporcione un PhysicalConnectionRequirements.

  • MARKETPLACE- Utiliza los ajustes de configuración incluidos en un conector adquirido AWS Marketplace para leer y escribir en almacenes de datos que no son compatibles AWS Glue de forma nativa con ellos.

    MARKETPLACELas conexiones utilizan lo siguiente 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.

  SFTP no se admite.

  Para obtener más información sobre cómo ConnectionProperties se utilizan las opciones opcionales para configurar las funciones AWS Glue, consulte las propiedades de la AWS Glue conexión.

  Para obtener más información sobre cómo se ConnectionProperties utilizan las opciones opcionales para configurar las funciones en AWS Glue Studio, consulte Uso de conectores y conexiones.

• MatchCriteria— Un conjunto de UTF -8 cadenas, no más de 10 cadenas.

  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 de UTF 8 cadenas (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 | SECRET_ID CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | 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 | ROLE_ARN | REGION | WORKGROUP_NAME | CLUSTER_IDENTIFIER |DATABASE).

  Cada valor es una cadena de valor que no tiene más de 1024 bytes de largo.

  Estos pares de clave-valor definen parámetros para la conexión.

• PhysicalConnectionRequirements: un objeto PhysicalConnectionRequirements.

  Los requisitos de conexión física, como una nube privada virtual (VPC) ySecurityGroup, que se necesitan para realizar esta conexión correctamente.

• AuthenticationConfiguration: un objeto AuthenticationConfigurationInput.

  Las propiedades de autenticación de la conexión. Se usa para una conexión de Salesforce.

• ValidateCredentials: booleano.

  Un indicador para validar las credenciales durante la creación de la conexión. Se usa para una conexión de Salesforce. El valor predeterminado es verdadero.

Campos

• SubnetId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.

  El ID de subred utilizado por la conexión.

• SecurityGroupIdList— Una matriz de UTF -8 cadenas, no más de 50 cadenas.

  La lista de ID de grupo de seguridad usados por la conexión.

• AvailabilityZone— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.

  La zona de disponibilidad de la conexión.

Campos

• MatchCriteria— Una matriz de UTF -8 cadenas, no más de 10 cadenas.

  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— UTF -8 cadenas (valores válidos: JDBC | SFTP | | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

  Tipo de conexiones que se van a devolver. Actualmente, no se admite SFTP.

• CreateConnection acción (Python: create_connection)

• DeleteConnection acción (Python: delete_connection)

• GetConnection acción (Python: get_connection)

• GetConnections acción (Python: get_connections)

• UpdateConnection acción (Python: update_connection)

• BatchDeleteConnection acción (Python: batch_delete_connection)

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 utiliza el ID de AWS cuenta de forma predeterminada.

• 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 de UTF -8 caracteres, con una longitud no inferior a 1 ni superior a 128 bytes.

  Cada valor es una cadena de UTF -8, con una longitud máxima de 256 bytes.

  Etiquetas que asigna a la conexión.

Respuesta

• CreateConnectionStatus— UTF -8 cadenas (valores válidos: READY | IN_PROGRESS |FAILED).

  El estado de la solicitud de creación de conexión. La solicitud puede tardar algún tiempo en algunos tipos de autenticación, por ejemplo, cuando se crea una OAuth conexión con un intercambio de fichasVPC.

Errores

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• GlueEncryptionException

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 utiliza el ID de AWS cuenta de forma predeterminada.

• ConnectionName— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan conSingle-line string pattern.

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

Respuesta

• Sin parámetros de respuesta.

Errores

• EntityNotFoundException

• OperationTimeoutException

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 utiliza el ID de la AWS cuenta de forma predeterminada.

• Name— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan conSingle-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 AWS Glue consola utiliza este indicador para recuperar la conexión y no muestra la contraseña. Establezca este parámetro cuando la persona que llama no tenga permiso para usar la AWS KMS clave para descifrar la contraseña, pero sí tenga permiso para acceder al resto de las propiedades de la conexión.

Respuesta

• Connection: un objeto Connection.

  La definición de la conexión solicitada.

Errores

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

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 utiliza el ID de la AWS cuenta de forma predeterminada.

• 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 AWS Glue consola usa este indicador para recuperar la conexión y no muestra la contraseña. Establezca este parámetro cuando la persona que llama no tenga permiso para usar la AWS KMS clave para descifrar la contraseña, pero sí tenga permiso para acceder al resto de las propiedades de la conexión.

• NextToken— UTF -8 cadenas.

  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— UTF -8 cuerdas.

  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

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 utiliza el ID de AWS cuenta de forma predeterminada.

• Name— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan conSingle-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

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 utiliza el ID de AWS cuenta de forma predeterminada.

• ConnectionNameList— Obligatorio: una matriz de UTF -8 cadenas, no más de 25 cadenas.

  Una lista de nombres de las conexiones que se van a eliminar.

Respuesta

• Succeeded— Un conjunto de UTF -8 cadenas.

  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 de UTF -8 caracteres, de no menos de 1 ni más de 255 bytes de longitud, que coincide conSingle-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

• AuthenticationConfiguration estructura

• AuthenticationConfigurationInput estructura

• OAuth2Propertiesestructura

• OAuth2PropertiesInputestructura

• OAuth2ClientApplicationestructura

• AuthorizationCodeProperties estructura

Campos

• AuthenticationType— UTF -8 cadenas (valores válidos: BASIC | OAUTH2 |CUSTOM).

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

• SecretArn— UTF -8 cadenas, que coinciden conCustom string pattern #11.

  El administrador secreto ARN para almacenar las credenciales.

• OAuth2Properties: un objeto OAuth2Properties.

  Las propiedades de OAuth2 autenticación.

Campos

• AuthenticationType— UTF -8 cadenas (valores válidos: BASIC | OAUTH2 |CUSTOM).

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

• SecretArn— UTF -8 cadenas, que coinciden conCustom string pattern #11.

  El administrador secreto ARN para almacenar las credenciales en la CreateConnection solicitud.

• OAuth2Properties: un objeto OAuth2PropertiesInput.

  Las propiedades de OAuth2 autenticación de la CreateConnection solicitud.

Campos

• OAuth2GrantType— UTF -8 cadenas (valores válidos: AUTHORIZATION_CODE | CLIENT_CREDENTIALS |JWT_BEARER).

  El tipo de OAuth2 subvención. 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— UTF -8 cadenas, de no más de 256 bytes, que coinciden conCustom string pattern #12.

  El 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 de UTF -8 caracteres, con una longitud no inferior a 1 ni superior a 128 bytes.

  Cada valor es una cadena de UTF -8, con una longitud no inferior a 1 ni superior a 512 bytes.

  Un mapa de parámetros que se añaden a la solicitud GET de token.

Campos

• OAuth2GrantType— UTF -8 cadenas (valores válidos: AUTHORIZATION_CODE | CLIENT_CREDENTIALS |JWT_BEARER).

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

• OAuth2ClientApplication: un objeto OAuth2ClientApplication.

  El tipo de aplicación de cliente de la CreateConnection solicitud. Por ejemplo, AWS_MANAGED o USER_MANAGED.

• TokenUrl— UTF -8 cadenas, de no más de 256 bytes, que coinciden conCustom string pattern #12.

  El 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 de UTF -8 caracteres, con una longitud no inferior a 1 ni superior a 128 bytes.

  Cada valor es una cadena de UTF -8, con una longitud no inferior a 1 ni superior a 512 bytes.

  Un mapa de parámetros que se añaden a la solicitud GET de token.

• AuthorizationCodeProperties: un objeto AuthorizationCodeProperties.

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

Campos

• UserManagedClientApplicationClientId— UTF -8 cadenas, de no más de 2048 bytes de longitud, que coinciden con. Custom string pattern #13

  El ClientiD de la aplicación cliente, si lo es. ClientAppType USER_MANAGED

• AWSManagedClientApplicationReference— UTF -8 cadenas, de no más de 2048 bytes de longitud, que coinciden con. Custom string pattern #13

  La referencia a la aplicación cliente del lado SaaS que se administra AWS .

Campos

• AuthorizationCode— UTF -8 cadenas, de no menos de 1 ni más de 4096 bytes de longitud, que coinciden con. Custom string pattern #13

  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— UTF -8 cadenas, de no más de 512 bytes de longitud, que coinciden con. Custom string pattern #14

  La redirección a la URI que el servidor de autorización redirige al usuario al emitir un código de autorización. URISe utiliza posteriormente cuando el código de autorización se intercambia por un token de acceso.