API de conexão

• Estrutura Connection

• Estrutura ConnectionInput

• Estrutura TestConnectionInput

• Estrutura PhysicalConnectionRequirements

• Estrutura GetConnectionsFilter

• Estrutura AuthenticationConfiguration

• Estrutura AuthenticationConfigurationInput

• Estrutura OAuth2Properties

• Estrutura OAuth2PropertiesInput

• Estrutura OAuth2ClientApplication

• Estrutura AuthorizationCodeProperties

• Estrutura BasicAuthenticationCredentials

• Estrutura OAuth2Credentials

Campos

• Name: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O nome da definição da conexão.

• Description: string de descrição com no máximo 2.048 bytes de comprimento e correspondente a URI address multi-line string pattern.

  A descrição da conexão.

• ConnectionType: string 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).

  O tipo da conexão. No momento, o SFTP não é compatível.

• MatchCriteria – Uma matriz de strings UTF-8, no máximo 10 strings.

  Uma lista de critérios que podem ser usados na seleção dessa conexão.

• ConnectionProperties: um array de mapa dos pares de chave-valor com não mais do que 100 pares.

  Cada chave é uma string UTF-8 (valores válidos: HOST | 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 chave é uma string Value com no mínimo 1 e no máximo 1.024 bytes de comprimento.

  Esses pares de chave-valor definem parâmetros para a conexão ao usar o esquema de conexão versão 1:

  • HOST - O URI do host: o nome de domínio totalmente qualificado (FQDN) ou o endereço IPv4 do host do banco de dados.

  • PORT - O número da porta, entre 1024 e 65535, da porta na qual o host do banco de dados está escutando conexões de banco de dados.

  • USER_NAME - O nome com o qual realizar login no banco de dados. O valor da string para USER_NAME é "USERNAME".

  • PASSWORD - Uma senha, se for usada, para o nome do usuário.

  • ENCRYPTED_PASSWORD - Ao habilitar a proteção por senha de conexão, definindo as configurações de criptografia ConnectionPasswordEncryption no Catálogo de dados, este campo armazena a senha criptografada.

  • JDBC_DRIVER_JAR_URI – o caminho do Amazon Simple Storage Service (Amazon S3) do arquivo JAR que contém o driver JDBC a ser usado.

  • JDBC_DRIVER_CLASS_NAME - A classe do nome do driver do JDBC a ser usado.

  • JDBC_ENGINE - O nome do mecanismo JDBC a ser usado.

  • JDBC_ENGINE_VERSION - A versão do nome do mecanismo JDBC a ser usado.

  • CONFIG_FILES – (reservado para uso futuro.)

  • INSTANCE_ID - O ID da instância a ser usada.

  • JDBC_CONNECTION_URL – o URL para conexão com uma fonte de dados JDBC.

  • JDBC_ENFORCE_SSL: uma string booliana (true, false) que especifica se a correspondência Secure Sockets Layer (SSL) com o hostname será aplicada para a conexão JDBC no cliente. O padrão é falso.

  • CUSTOM_JDBC_CERT: um local do Amazon S3 que especifica o certificado raiz do cliente. O AWS Glue usa esse certificado raiz para validar o certificado do cliente ao se conectar ao banco de dados do cliente. O AWS Glue processa somente certificados X.509. O certificado fornecido deve ter codificação DER e ser fornecido no formato PEM de codificação Base64.

  • SKIP_CUSTOM_JDBC_CERT_VALIDATION: Por padrão, é false. O AWS Glue valida o algoritmo de assinatura e o algoritmo de chave pública de requerente para o certificado do cliente. Os únicos algoritmos permitidos para o algoritmo de assinatura são SHA256withRSA, SHA384withRSA ou SHA512withRSA. Para o algoritmo de chave pública do assunto, o comprimento da chave deve ser pelo menos 2048. Você pode definir o valor dessa propriedade como true para ignorar a validação do certificado do cliente pelo AWS Glue.

  • CUSTOM_JDBC_CERT_STRING — uma string de certificado JDBC personalizado que é usada para correspondência de domínio ou correspondência de nome distinto para evitar um ataque “man-in-the-middle”. No banco de dados Oracle, ela é usada como SSL_SERVER_CERT_DN; no Microsoft SQL Server, ela é usada como hostNameInCertificate.

  • CONNECTION_URL – o URL para conexão com uma fonte de dados geral (não JDBC).

  • SECRET_ID: o ID secreto usado para o gerente secreto de credenciais.

  • CONNECTOR_URL: o URL do conector para uma conexão MARKETPLACE ou CUSTOM (personalizada).

  • CONNECTOR_TYPE: o tipo do conector para uma conexão MARKETPLACE ou CUSTOM (personalizada).

  • CONNECTOR_CLASS_NAME: o nome da classe do conector para uma conexão MARKETPLACE ou CUSTOM (personalizada).

  • KAFKA_BOOTSTRAP_SERVERS – Uma lista separada por vírgulas de pares de host e porta que são os endereços dos agentes do Apache Kafka em um cluster do Kafka ao qual um cliente Kafka se conectará e se executará o próprio bootstrap.

  • KAFKA_SSL_ENABLED: para habilitar ou desabilitar o SSL em uma conexão Apache Kafka. O valor padrão é “true” (verdadeiro).

  • KAFKA_CUSTOM_CERT: o URL do Amazon S3 para o arquivo de certificado CA privado (formato.pem). O padrão é uma string vazia.

  • KAFKA_SKIP_CUSTOM_CERT_VALIDATION: para ignorar ou não a validação do arquivo de certificado CA. O AWS Glue valida para três algoritmos: SHA256withRSA, SHA384withRSA e SHA512withRSA. O valor padrão é “false” (falso).

  • KAFKA_CLIENT_KEYSTORE: a localização do Amazon S3 do arquivo de repositório de chaves do cliente para autenticação do lado do cliente Kafka (opcional).

  • KAFKA_CLIENT_KEYSTORE_PASSWORD: a senha para acessar o repositório de chaves fornecido (opcional).

  • KAFKA_CLIENT_KEY_PASSWORD: um repositório de chaves pode consistir em várias chaves, então essa é a senha para acessar a chave do cliente a ser usada com a chave do lado do servidor Kafka (opcional).

  • ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD: a versão criptografada da senha do repositório de chaves do cliente Kafka (se o usuário tiver a configuração de senhas de criptografia do AWS Glue selecionada).

  • ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD: a versão criptografada da senha da chave do cliente Kafka (se o usuário tiver a configuração de senhas de criptografia do AWS Glue selecionada).

  • KAFKA_SASL_MECHANISM: "SCRAM-SHA-512", "GSSAPI", "AWS_MSK_IAM" ou "PLAIN". Esses são os mecanismos SASL compatíveis.

  • KAFKA_SASL_PLAIN_USERNAME: um nome de usuário em texto simples usado para autenticar com o mecanismo "PLAIN".

  • KAFKA_SASL_PLAIN_PASSWORD: uma senha em texto simples usado para autenticar com o mecanismo "PLAIN".

  • ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD: a versão criptografada da senha Kafka SASL PLAIN (se o usuário tiver a configuração de senhas de criptografia AWS Glue selecionada).

  • KAFKA_SASL_SCRAM_USERNAME - Um nome de usuário em texto simples usado para autenticar com o mecanismo "SCRAM-SHA-512".

  • KAFKA_SASL_SCRAM_PASSWORD - Uma senha de texto simples usada para autenticar com o mecanismo "SCRAM-SHA-512".

  • ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - A versão criptografada da senha Kafka SASL SCRAM (se o usuário tiver a configuração de senhas de criptografia AWS Glue selecionada).

  • KAFKA_SASL_SCRAM_SECRETS_ARN: o nome do recurso da Amazon de um segredo do AWS Secrets Manager.

  • KAFKA_SASL_GSSAPI_KEYTAB - A localização S3 de um arquivo Kerberos keytab. Um keytab armazena chaves de longo prazo para um ou mais principais. Para obter mais informações, consulte Documentação do MIT Kerberos: Keytab.

  • KAFKA_SASL_GSSAPI_KRB5_CONF - A localização S3 de um arquivo Kerberos krb5.conf. Um krb5.conf armazena informações de configuração do Kerberos, como a localização do servidor KDC. Para obter mais informações, consulte Documentação do MIT Kerberos: krb5.conf.

  • KAFKA_SASL_GSSAPI_SERVICE - O nome do serviço Kerberos, conforme definido com sasl.kerberos.service.name na sua Configuração do Kafka.

  • KAFKA_SASL_GSSAPI_PRINCIPAL- O nome do princial Kerberos usado por AWS Glue. Para obter mais informações, consulte Documentação do Kafka: Configurando agentes do Kafka.

  • ROLE_ARN: a função a ser usada para executar consultas.

  • REGION: a região da AWS onde as consultas serão executadas.

  • WORKGROUP_NAME: o nome de um grupo de trabalho do Amazon Redshift sem servidor ou grupo de trabalho do Amazon Athena no qual as consultas serão executadas.

  • CLUSTER_IDENTIFIER: o identificador de cluster de um cluster do Amazon Redshift no qual as consultas serão executadas.

  • DATABASE: o banco de dados do Amazon Redshift ao qual você está se conectando.

• SparkProperties: um array de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  Propriedades de conexão específicas para o ambiente computacional Spark.

• AthenaProperties: um array de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  Propriedades de conexão específicas para o ambiente computacional Athena.

• PythonProperties: um array de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  Propriedades de conexão específicas para o ambiente computacional Python.

• PhysicalConnectionRequirements: um objeto PhysicalConnectionRequirements.

  Os requisitos de conexão física, como nuvem virtual privada (VPC) e SecurityGroup, que são necessários para fazer essa conexão com êxito.

• CreationTime – Timestamp.

  A marca de data e hora em que essa definição de conexão foi criada.

• LastUpdatedTime – Timestamp.

  A marca de data e hora em que a definição de conexão foi atualizada pela última vez.

• LastUpdatedBy: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O usuário, grupo ou função que atualizou pela última vez essa definição de conexão.

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

  O status da conexão. Pode ser READY, IN_PROGRESS ou FAILED.

• StatusReason: string UTF-8 com não menos que 1 nem mais que 16.384 bytes de comprimento.

  O motivo do status da conexão.

• LastConnectionValidationTime – Timestamp.

  Uma marca de data e hora da última validação dessa conexão.

• AuthenticationConfiguration – Um objeto AuthenticationConfiguration.

  As propriedades de autenticação da conexão.

• ConnectionSchemaVersion: número (inteiro) não inferior a 1 nem superior a 2.

  A versão do esquema de conexão para esta conexão. A versão 2 oferece suporte a propriedades para ambientes computacionais específicos.

• CompatibleComputeEnvironments – Uma matriz de strings UTF-8.

  Uma lista de ambientes computacionais compatíveis com a conexão.

Campos

• Name: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O nome da conexão.

• Description: string de descrição com no máximo 2.048 bytes de comprimento e correspondente a URI address multi-line string pattern.

  A descrição da conexão.

• ConnectionType: Obrigatório: string 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).

  O tipo da conexão. No momento, estes tipos são compatíveis:

  • JDBC – Designa uma conexão com um banco de dados por meio do Java Database Connectivity (JDBC).

    As conexões de JDBC usam o seguinte ConnectionParameters.

    • Obrigatório: todos (HOST, PORT, JDBC_ENGINE) ou JDBC_CONNECTION_URL.

    • Obrigatório: todos (USERNAME, PASSWORD) ou SECRET_ID.

    • Opcional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. Esses parâmetros são usados para configurar o SSL com o JDBC.

  • KAFKA – Designa uma conexão com uma plataforma de streaming do Apache Kafka.

    As conexões de KAFKA usam o seguinte ConnectionParameters.

    • Obrigatório: KAFKA_BOOTSTRAP_SERVERS.

    • Opcional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. Esses parâmetros são usados para configurar o SSL com o KAFKA.

    • Opcional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. Esses parâmetros são usados para definir a configuração de cliente TLS com SSL no KAFKA.

    • (Opcional): KAFKA_SASL_MECHANISM. Pode ser especificado como SCRAM-SHA-512, GSSAPI ou AWS_MSK_IAM.

    • Opcional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. Esses parâmetros são usados para configurar a autenticação SASL/SCRAM-SHA-512 com o KAFKA.

    • Opcional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. Esses parâmetros são usados para configurar a autenticação SASL/GSSAPI com o KAFKA.

  • MONGODB – Designa uma conexão com um banco de dados de documentos do MongoDB.

    As conexões de MONGODB usam o seguinte ConnectionParameters.

    • Obrigatório: CONNECTION_URL.

    • Obrigatório: todos (USERNAME, PASSWORD) ou SECRET_ID.

  • VIEW_VALIDATION_REDSHIFT: designa uma conexão usada para validação de visualizações pelo Amazon Redshift.

  • VIEW_VALIDATION_ATHENA: designa uma conexão usada para validação de visualizações pelo Amazon Athena.

  • NETWORK: designa uma conexão de rede a uma fonte de dados dentro de um ambiente do Amazon Virtual Private Cloud (Amazon VPC).

    As conexões de NETWORK não exigem ConnectionParameters. Em vez disso, forneça PhysicalConnectionRequirements.

  • MARKETPLACE: usa as definições de configurações contidas em um conector adquirido de AWS Marketplace para ler e gravar em armazenamentos de dados que não são suportados nativamente pelo AWS Glue.

    As conexões de MARKETPLACE usam o seguinte ConnectionParameters.

    • Obrigatório: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.

    • Obrigatório para conexões de JDBC CONNECTOR_TYPE: todos (USERNAME, PASSWORD) ou SECRET_ID.

  • CUSTOM: usa as definições de configurações contidas em um conector personalizado para ler e gravar em armazenamentos de dados que não são suportados nativamente pelo AWS Glue.

  Além disso, há suporte a um ConnectionType para os seguintes conectores SaaS:

  • FACEBOOKADS: define uma conexão com o Facebook Ads.

  • GOOGLEADS: define uma conexão com o Google Ads.

  • GOOGLESHEETS: define uma conexão com o Planilhas Google.

  • GOOGLEANALYTICS4: define uma conexão com o Google Analytics 4.

  • HUBSPOT: define uma conexão com o HubSpot.

  • INSTAGRAMADS: define uma conexão com o Instagram Ads.

  • INTERCOM: define uma conexão com a Intercom.

  • JIRACLOUD: define uma conexão com o Jira Cloud.

  • MARKETO: define uma conexão com o Adobe Marketo Engage.

  • NETSUITEERP: define uma conexão com o Oracle NetSuite.

  • SALESFORCE: define uma conexão com o Salesforce usando a autenticação OAuth.

  Para obter mais informações sobre os parâmetros de conexão necessários para um conector específico, consulte a documentação do conector em Adicionar uma conexão do AWS Glue no Guia do usuário do AWS Glue.

  Não há suporte ao SFTP.

  Para obter mais informações sobre como ConnectionProperties opcionais são usadas para configurar recursos no AWS Glue, consulte Propriedades da conexão do AWS Glue.

  Para obter mais informações sobre como ConnectionProperties opcionais são usadas para configurar recursos no AWS Glue Studio, consulte Usar conectores e conexões.

• MatchCriteria – Uma matriz de strings UTF-8, no máximo 10 strings.

  Uma lista de critérios que podem ser usados na seleção dessa conexão.

• ConnectionProperties: um array de mapa dos pares de chave-valor com não mais do que 100 pares.

  Cada chave é uma string UTF-8 (valores válidos: HOST | 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 chave é uma string Value com no mínimo 1 e no máximo 1.024 bytes de comprimento.

  Esses pares de chave/valor definem parâmetros para a conexão.

• SparkProperties: um array de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  Propriedades de conexão específicas para o ambiente computacional Spark.

• AthenaProperties: um array de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  Propriedades de conexão específicas para o ambiente computacional Athena.

• PythonProperties: um array de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  Propriedades de conexão específicas para o ambiente computacional Python.

• PhysicalConnectionRequirements: um objeto PhysicalConnectionRequirements.

  Os requisitos de conexão física, como nuvem privada virtual (VPC) e SecurityGroup, que são necessários para estabelecer essa conexão com êxito.

• AuthenticationConfiguration – Um objeto AuthenticationConfigurationInput.

  As propriedades de autenticação da conexão.

• ValidateCredentials: booleano.

  Um sinalizador para validar as credenciais durante a criação da conexão. O padrão é true (verdadeiro).

• ValidateForComputeEnvironments – Uma matriz de strings UTF-8.

  Os ambientes computacionais em relação aos quais as propriedades de conexão especificadas são validadas.

Campos

• ConnectionType: Obrigatório: string 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).

  O tipo da conexão a ser testada. Essa operação está disponível somente para os tipos de conexão JDBC ou SALESFORCE.

• ConnectionProperties: um array de mapa dos pares de chave-valor com não mais do que 100 pares.

  Cada chave é uma string UTF-8 (valores válidos: HOST | 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 chave é uma string Value com no mínimo 1 e no máximo 1.024 bytes de comprimento.

  Os pares de chave-valor que definem parâmetros para a conexão.

  As conexões do JDBC usam as seguintes propriedades de conexão:

  • Obrigatório: todos (HOST, PORT, JDBC_ENGINE) ou JDBC_CONNECTION_URL.

  • Obrigatório: todos (USERNAME, PASSWORD) ou SECRET_ID.

  • Opcional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. Esses parâmetros são usados para configurar o SSL com o JDBC.

  As conexões do SALESFORCE exigem que o membro AuthenticationConfiguration seja configurado.

• AuthenticationConfiguration – Um objeto AuthenticationConfigurationInput.

  Uma estrutura que contém a configuração de autenticação na solicitação TestConnection. Necessária para uma conexão ao Salesforce usando a autenticação OAuth.

Campos

• SubnetId: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O ID da sub-rede usada pela conexão.

• SecurityGroupIdList – Uma matriz de strings UTF-8, no máximo 50 strings.

  A lista de IDs de security group usada pela conexão.

• AvailabilityZone: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  A zona de disponibilidade da conexão.

Campos

• MatchCriteria – Uma matriz de strings UTF-8, no máximo 10 strings.

  Uma cadeia de critérios que deve corresponder aos critérios registrados na definição de conexão para a definição de conexão a ser retornada.

• ConnectionType: string UTF-8 (valores válidos: JDBC | 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).

  O tipo de conexão a ser retornada. No momento, o SFTP não é compatível.

• ConnectionSchemaVersion: número (inteiro) não inferior a 1 nem superior a 2.

  Indica se a conexão foi criada com a versão 1 ou 2 do esquema.

Campos

• AuthenticationType – String UTF-8 (valores válidos: BASIC | OAUTH2 | CUSTOM | IAM).

  Uma estrutura que contém a configuração de autenticação.

• SecretArn: string UTF-8 correspondente a Custom string pattern #36.

  O ARN do gerenciador de segredos para armazenar credenciais.

• OAuth2Properties – Um objeto OAuth2Properties.

  As propriedades da autenticação OAuth2.

Campos

• AuthenticationType – String UTF-8 (valores válidos: BASIC | OAUTH2 | CUSTOM | IAM).

  Uma estrutura que contém a configuração de autenticação na solicitação CreateConnection.

• OAuth2Properties – Um objeto OAuth2PropertiesInput.

  As propriedades da autenticação OAuth2 na solicitação CreateConnection.

• SecretArn: string UTF-8 correspondente a Custom string pattern #36.

  O ARN do gerenciador de segredos para armazenar as credenciais na solicitação CreateConnection.

• KmsKeyArn: string UTF-8 correspondente a Custom string pattern #29.

  O ARN da chave do KMS usada para criptografar a conexão. Recebida somente como entrada na solicitação e armazenada no Secret Manager.

• BasicAuthenticationCredentials: um objeto BasicAuthenticationCredentials.

  As credenciais usadas quando o tipo de autenticação é autenticação básica.

• CustomAuthenticationCredentials: um array de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

  As credenciais usadas quando o tipo de autenticação é autenticação personalizada.

Campos

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

  O tipo de concessão de OAuth2. Por exemplo, AUTHORIZATION_CODE, JWT_BEARER ou CLIENT_CREDENTIALS.

• OAuth2ClientApplication – Um objeto OAuth2ClientApplication.

  O tipo de aplicação do cliente. Por exemplo, AWS_MANAGED ou USER_MANAGED.

• TokenUrl: string UTF-8 com no máximo 256 bytes de comprimento e correspondente a Custom string pattern #40.

  O URL do servidor de autenticação do provedor para trocar um código de autorização por um token de acesso.

• TokenUrlParametersMap: um array de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com comprimento mínimo de 1 e comprimento máximo de 512 bytes.

  Um mapa de parâmetros que são adicionados à solicitação de token GET.

Campos

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

  O tipo de concessão OAuth2 na solicitação CreateConnection. Por exemplo, AUTHORIZATION_CODE, JWT_BEARER ou CLIENT_CREDENTIALS.

• OAuth2ClientApplication – Um objeto OAuth2ClientApplication.

  O tipo de aplicação cliente na solicitação CreateConnection. Por exemplo, o AWS_MANAGED ou o USER_MANAGED.

• TokenUrl: string UTF-8 com no máximo 256 bytes de comprimento e correspondente a Custom string pattern #40.

  O URL do servidor de autenticação do provedor para trocar um código de autorização por um token de acesso.

• TokenUrlParametersMap: um array de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com comprimento mínimo de 1 e comprimento máximo de 512 bytes.

  Um mapa de parâmetros que são adicionados à solicitação de token GET.

• AuthorizationCodeProperties – Um objeto AuthorizationCodeProperties.

  O conjunto de propriedades necessárias para o tipo de concessão AUTHORIZATION_CODE de OAuth2.

• OAuth2Credentials – Um objeto OAuth2Credentials.

  As credenciais usadas quando o tipo de autenticação é autenticação OAuth2.

Campos

• UserManagedClientApplicationClientId: string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a Custom string pattern #37.

  O ClientID da aplicação cliente se ClientAppType for USER_MANAGED.

• AWSManagedClientApplicationReference: string UTF-8 com comprimento máximo de 2.048 bytes e correspondente a Custom string pattern #37.

  A referência à aplicação cliente do lado SaaS que é gerenciada pela AWS.

Campos

• AuthorizationCode: string UTF-8 com no mínimo 1 e no máximo 4.096 bytes de comprimento e correspondente a Custom string pattern #37.

  Um código de autorização a ser usado na terceira etapa do fluxo de trabalho de concessão de AUTHORIZATION_CODE. Esse é um código de uso único que se torna inválido quando trocado por um token de acesso, portanto, é aceitável ter esse valor como parâmetro de solicitação.

• RedirectUri: string UTF-8 com no máximo 512 bytes de comprimento e correspondente a Custom string pattern #41.

  O URI de redirecionamento para o qual o usuário é redirecionado pelo servidor de autorização ao emitir um código de autorização. O URI é usado posteriormente quando o código de autorização é trocado por um token de acesso.

Campos

• Username: string UTF-8 com no máximo 512 bytes de comprimento e correspondente a Custom string pattern #37.

  O nome de usuário para a autenticação básica.

• Password: string UTF-8 com no máximo 512 bytes de comprimento e correspondente a Custom string pattern #33.

  A senha para a autenticação básica.

Campos

• UserManagedClientApplicationClientSecret: string UTF-8 com no máximo 512 bytes de comprimento e correspondente a Custom string pattern #38.

  O segredo do cliente para a aplicação do cliente gerenciada pelo usuário.

• AccessToken: string UTF-8 com no máximo 4.096 bytes de comprimento e correspondente a Custom string pattern #38.

  O token de acesso para a autenticação OAuth2.

• RefreshToken: string UTF-8 com no máximo 4.096 bytes de comprimento e correspondente a Custom string pattern #38.

  O token de atualização para a autenticação OAuth2.

• JwtToken: string UTF-8 com no máximo 8.000 bytes de comprimento e correspondente a Custom string pattern #39.

  O JSON Web Token (JWT) para autenticação OAuth2.

• Ação CreateConnection (Python: create_connection)

• Ação DeleteConnection (Python: delete_connection)

• Ação GetConnection (Python: get_connection)

• Ação GetConnections (Python: get_connections)

• Ação UpdateConnection (Python: update_connection)

• Ação TestConnection (Python: test_connection)

• Ação BatchDeleteConnection (Python: batch_delete_connection)

Solicitação

• CatalogId: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O ID do catálogo de dados em que a conexão será criada. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.

• ConnectionInput – Obrigatório: um objeto ConnectionInput.

  Um objeto ConnectionInput que define a conexão a ser criada.

• Tags: uma matriz de mapa dos pares de chave-valor, não mais que 50 pares.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento.

  As tags que você atribui à conexão.

Resposta

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

  O status da solicitação de criação da conexão. A solicitação pode levar algum tempo para determinados tipos de autenticação, por exemplo, ao criar uma conexão OAuth com troca de tokens via VPC.

Erros

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• GlueEncryptionException

Solicitação

• CatalogId: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O ID do catálogo de dados em que a conexão residirá. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.

• ConnectionName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O nome da conexão a ser excluída.

Resposta

• Nenhum parâmetro de resposta.

Erros

• EntityNotFoundException

• OperationTimeoutException

Solicitação

• CatalogId: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O ID do catálogo de dados em que a conexão residirá. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.

• Name: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O nome da definição de conexão a ser recuperada.

• HidePassword: booleano.

  Permite recuperar os metadados de conexão sem retornar a senha. Por exemplo, o console do AWS Glue usa esse sinalizador para recuperar a conexão e não exibe a senha. Defina esse parâmetro quando o autor da chamada não tem permissão para usar a chave do AWS KMS para descriptografar a senha, mas tem permissão para acessar o restante das propriedades da conexão.

• ApplyOverrideForComputeEnvironment – String UTF-8 (valores válidos: SPARK | ATHENA | PYTHON).

  Para conexões que podem ser usadas em vários serviços, especifica as propriedades de retorno para o ambiente computacional especificado.

Resposta

• Connection: um objeto Conexão.

  A definição de conexão solicitada.

Erros

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

Solicitação

• CatalogId: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O ID do catálogo de dados em que as conexões residirão. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.

• Filter: um objeto GetConnectionsFilter.

  Um filtro que controla quais conexões são retornadas.

• HidePassword: booleano.

  Permite recuperar os metadados de conexão sem retornar a senha. Por exemplo, o console do AWS Glue usa esse sinalizador para recuperar a conexão e não exibe a senha. Defina esse parâmetro quando o autor da chamada não tem permissão para usar a chave do AWS KMS para descriptografar a senha, mas tem permissão para acessar o restante das propriedades da conexão.

• NextToken: string UTF-8.

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

• MaxResults – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de conexões a ser retornado em uma resposta.

Resposta

• ConnectionList: um array de objetos Conexão.

  Uma lista das definições de conexão solicitadas.

• NextToken: string UTF-8.

  Um token de continuação, se a lista de conexões retornada não incluir a última das conexões filtradas.

Erros

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

Solicitação

• CatalogId: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O ID do catálogo de dados em que a conexão residirá. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.

• Name: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O nome da definição de conexão a ser atualizada.

• ConnectionInput – Obrigatório: um objeto ConnectionInput.

  Um objeto ConnectionInput que redefine a conexão em questão.

Resposta

• Nenhum parâmetro de resposta.

Erros

• InvalidInputException

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

Solicitação

• ConnectionName: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  Opcional. O nome da conexão a ser testada. Se apenas o nome for fornecido, a operação obterá a conexão e a usará para o teste.

• CatalogId: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

• TestConnectionInput: um objeto TestConnectionInput.

  Uma estrutura usada para especificar o teste de uma conexão para um serviço.

Resposta

• Nenhum parâmetro de resposta.

Erros

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• GlueEncryptionException

• FederationSourceException

• AccessDeniedException

• EntityNotFoundException

• ConflictException

• InternalServiceException

Solicitação

• CatalogId: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O ID do catálogo de dados em que as conexões residirão. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.

• ConnectionNameList – Obrigatório: uma matriz de strings UTF-8, no máximo 25 strings.

  Uma lista de nomes das conexões a serem excluídas.

Resposta

• Succeeded – Uma matriz de strings UTF-8.

  Uma lista de nomes das definições de conexão que foram excluídas com sucesso.

• Errors: um array de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  Cada valor é um objeto ErrorDetail.

  Um mapa dos nomes das conexões que não foram excluídas com sucesso (para acessar detalhes do erro).

Erros

• InternalServiceException

• OperationTimeoutException