API de tipos de conexión

• Acción DescribeConnectionType (Python: describe_connection_type)

• Acción ListConnectionTypes (Python: list_connection_types)

• Estructura ConnectionTypeBrief

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.

  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.

  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.

  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.

  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.

  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.

  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.

  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.

  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.

  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.

  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.

  Propiedades de conexión específicas del entorno de computación de Spark.

Errores

• ValidationException

• InvalidInputException

• InternalServiceException

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.

  Token de continuación si se trata de una llamada de continuidad.

Respuesta

• ConnectionTypes: matriz de objetos 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.

  Un token de continuación, que está presente si el segmento de lista actual no es el último.

Errores

• InternalServiceException

Campos

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

  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.

  Los tipos de autenticación, los tipos de interfaz de datos (entornos de computación) y las operaciones de datos del conector compatibles.

• Estructura de Validación

• Estructura AuthConfiguration

• Estructura de capacidades

• Estructura de propiedad

• Estructura AllowedValue

• Estructura ComputeEnvironmentConfiguration

Campos

• ValidationType: obligatorio: cadena UTF-8 (valores válidos: REGEX | RANGE).

  El tipo de validación que se va a realizar, como REGEX.

• Patterns: matriz de cadenas UTF-8.

  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.

Campos

• AuthenticationType: obligatorio: objeto Propiedad.

  El tipo de autenticación de una conexión.

• SecretArn: un objeto Propiedad.

  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.

  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.

  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.

  Asignación de pares clave-valor para las propiedades de autenticación personalizadas. Cada valor es un objeto Property.

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.

Campos

• Name: obligatorio: 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: obligatorio: cadena UTF-8 con una extensión de 1024 bytes como máximo.

  Una descripción de la propiedad.

• DataType: obligatorio: cadena UTF-8 (valores válidos: STRING | INTEGER | BOOLEAN | STRING_LIST).

  El tipo de datos de la propiedad.

• Required – Obligatorio: Booleano.

  Indica si la propiedad es necesaria.

• DefaultValue: cadena UTF-8.

  El valor predeterminado de la propiedad.

• PropertyTypes: obligatorio: una matriz de cadenas UTF-8.

  Describe el tipo de propiedad.

• AllowedValues: matriz de objetos 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.

Campos

• Description: cadena UTF-8, no más de 1024 bytes de largo.

  Descripción del valor permitido.

• Value: obligatorio: 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.

Campos

• Name: obligatorio: 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: obligatorio: 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 | ATHENA | 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.

  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: obligatorio: una matriz de cadenas UTF-8.

  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.