Conexão API

• Estrutura Connection

• ConnectionInput estrutura

• PhysicalConnectionRequirements estrutura

• GetConnectionsFilter estrutura

Campos

• Name— UTF -8 string, não menos que 1 ou mais de 255 bytes de comprimento, correspondendo a. Single-line string pattern

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

• Description – String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.

  A descrição da conexão.

• ConnectionType— UTF -8 string (valores válidos: JDBC | SFTP | MONGODB | KAFKA | NETWORK | | MARKETPLACE | CUSTOM | SALESFORCE VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

  O tipo da conexão. Atualmente, SFTP não é suportado.

• MatchCriteria— Uma matriz de UTF -8 strings, não mais que 10 strings.

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

• ConnectionProperties: uma matriz de mapa dos pares de chave-valor, 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 | 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 é um string de valor, com não superior a 1024 bytes.

  Esses pares de chave-valor definem parâmetros para a conexão:

  • HOST- O hostURI: o nome de domínio totalmente qualificado (FQDN) ou o IPv4 endereço 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 que contém JAR JDBC o driver a ser usado.

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

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

  • JDBC_ENGINE_VERSION- A versão do JDBC motor a ser usada.

  • CONFIG_FILES – (reservado para uso futuro.)

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

  • JDBC_CONNECTION_URL- O URL para se conectar a uma fonte JDBC de dados.

  • JDBC_ENFORCE_SSL- Uma string booleana (true, false) especificando se o Secure Sockets Layer (SSL) com correspondência de nome de host é aplicado para a conexão no JDBC cliente. O padrão é falso.

  • CUSTOM_JDBC_CERT- Um local do Amazon S3 especificando o certificado raiz do cliente. AWS Glue usa esse certificado raiz para validar o certificado do cliente ao se conectar ao banco de dados do cliente. AWS Glue só lida com certificados X.509. O certificado fornecido deve ser DER codificado e fornecido no formato de codificação Base64. PEM

  • SKIP_CUSTOM_JDBC_CERT_VALIDATION- Por padrão, isso éfalse. AWS Glue valida o algoritmo de assinatura e o algoritmo de chave pública de assunto para o certificado do cliente. Os únicos algoritmos permitidos para o algoritmo de assinatura sãoSHA256withRSA, SHA384withRSA ouSHA512withRSA. 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 JDBC certificado personalizada que é usada para correspondência de domínio ou correspondência de nome distinto para evitar um man-in-the-middle ataque. No banco de dados Oracle, isso é usado como o. no Microsoft SQL Server, isso é usado como hostNameInCertificate o. SSL_SERVER_CERT_DN

  • CONNECTION_URL- O URL para se conectar a uma fonte de dados geral (nãoJDBC).

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

  • CONNECTOR_URL- O conector URL para uma CUSTOM conexão MARKETPLACE or.

  • CONNECTOR_TYPE- O tipo de conector para uma CUSTOM conexão MARKETPLACE ou.

  • CONNECTOR_CLASS_NAME- O nome da classe do conector para uma CUSTOM conexão MARKETPLACE ou.

  • 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- Se deve ser ativado ou desativado SSL em uma conexão Apache Kafka. O valor padrão é “true” (verdadeiro).

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

  • KAFKA_SKIP_CUSTOM_CERT_VALIDATION- Se deve pular a validação do arquivo de certificado CA ou nã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 keystore do cliente Kafka (se o usuário tiver a configuração de AWS Glue criptografia de senhas 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 AWS Glue criptografia de senhas selecionada).

  • KAFKA_SASL_MECHANISM: "SCRAM-SHA-512", "GSSAPI", "AWS_MSK_IAM" ou "PLAIN". Esses são os SASLmecanismos suportados.

  • KAFKA_SASL_PLAIN_USERNAME- Um nome de usuário em texto simples usado para autenticação com o mecanismo "”PLAIN.

  • KAFKA_SASL_PLAIN_PASSWORD- Uma senha em texto simples usada para autenticar com o mecanismo "”PLAIN.

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

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

  • KAFKA_SASL_SCRAM_PASSWORD- Uma senha em texto simples usada para autenticação com o mecanismo "SCRAM- SHA -512".

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

  • KAFKA_SASL_SCRAM_SECRETS_ARN- O nome de recurso da Amazon de um segredo no 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 a 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 a 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 principio 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 AWS região onde as consultas serão executadas.

  • WORKGROUP_NAME- O nome de um grupo de trabalho sem servidor do Amazon Redshift 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.

• PhysicalConnectionRequirements – Um objeto PhysicalConnectionRequirements.

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

• 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— UTF -8 string, não menos que 1 ou mais de 255 bytes de comprimento, correspondendo a. Single-line string pattern

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

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

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

• StatusReason— UTF -8 string, não menos que 1 ou mais que 16384 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.

Campos

• Name— Obrigatório: UTF -8 string, não menos que 1 ou mais de 255 bytes de comprimento, correspondendo a. Single-line string pattern

  O nome da conexão.

• Description – String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.

  A descrição da conexão.

• ConnectionType— Obrigatório: UTF -8 string (valores válidos: JDBC SFTP | | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | | SALESFORCE VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

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

    JDBCAs conexões 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 SSL comJDBC.

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

    KAFKAAs conexões 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 SSL comKAFKA.

    • 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 do TLS cliente SSL dentroKAFKA.

    • 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çãoSASL/SCRAM- SHA -512 comKAFKA.

    • 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 configurarSASL/GSSAPIauthentication comKAFKA.

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

    MONGODBAs conexões usam o seguinte ConnectionParameters.

    • Obrigatório: CONNECTION_URL.

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

  • SALESFORCE- Designa uma conexão com o Salesforce usando autenticação. OAuth

    • Requer que o membro AuthenticationConfiguration seja configurado.

  • 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 com uma fonte de dados dentro de um ambiente Amazon Virtual Private Cloud (AmazonVPC).

    NETWORKAs conexões não são necessárias ConnectionParameters. Em vez disso, forneça um PhysicalConnectionRequirements.

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

    MARKETPLACEAs conexões 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.

  Não há suporte ao SFTP.

  Para obter mais informações sobre como ConnectionProperties os opcionais são usados para configurar recursos em AWS Glue, consulte as propriedades da AWS Glue conexão.

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

• MatchCriteria— Uma matriz de UTF -8 strings, não mais que 10 strings.

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

• ConnectionProperties: obrigatório: uma matriz de mapa dos pares de chave-valor, no máximo 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 | 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 é um string de valor, com não superior a 1024 bytes.

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

• PhysicalConnectionRequirements – Um objeto PhysicalConnectionRequirements.

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

• AuthenticationConfiguration – Um objeto AuthenticationConfigurationInput.

  As propriedades de autenticação da conexão. Usadas para conexão com o Salesforce.

• ValidateCredentials – Booleano.

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

Campos

• SubnetId— UTF -8 string, não menos que 1 ou mais de 255 bytes de comprimento, correspondendo a. Single-line string pattern

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

• SecurityGroupIdList— Uma matriz de UTF -8 strings, não mais que 50 strings.

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

• AvailabilityZone— UTF -8 string, não menos que 1 ou mais de 255 bytes de comprimento, correspondendo a. Single-line string pattern

  A zona de disponibilidade da conexão.

Campos

• MatchCriteria— Uma matriz de UTF -8 strings, não mais que 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— UTF -8 string (valores válidos: JDBC | SFTP | MONGODB | KAFKA | NETWORK | | MARKETPLACE | CUSTOM | SALESFORCE VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

  O tipo de conexão a ser retornada. Atualmente, SFTP não é suportado.

• CreateConnection ação (Python: create_connection)

• DeleteConnection ação (Python: delete_connection)

• GetConnection ação (Python: get_connection)

• GetConnections ação (Python: get_connections)

• UpdateConnection ação (Python: update_connection)

• BatchDeleteConnection ação (Python: batch_delete_connection)

Solicitação

• CatalogId – String de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, 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 AWS conta 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 pelo menos 1 ou mais de 128 bytes de comprimento.

  Cada valor é uma string UTF de -8, com no máximo 256 bytes.

  As tags que você atribui à conexão.

Resposta

• CreateConnectionStatus— UTF -8 string (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 OAuth conexão com o token exchange overVPC.

Erros

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• GlueEncryptionException

Solicitação

• CatalogId – String de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, 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 AWS conta será usado por padrão.

• ConnectionName— Obrigatório: UTF -8 string, não menos que 1 ou mais de 255 bytes de comprimento, correspondendo 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, superior a 1 e inferior a 255 bytes de comprimento, 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 AWS conta será usado por padrão.

• Name— Obrigatório: UTF -8 string, não menos que 1 ou mais de 255 bytes de comprimento, correspondendo 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 AWS Glue console usa esse sinalizador para recuperar a conexão e não exibe a senha. Defina esse parâmetro quando o chamador não tiver permissão para usar a AWS KMS chave para descriptografar a senha, mas tiver permissão para acessar o restante das propriedades da conexão.

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, superior a 1 e inferior a 255 bytes de comprimento, 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 AWS conta 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 AWS Glue console usa esse sinalizador para recuperar a conexão e não exibe a senha. Defina esse parâmetro quando o chamador não tiver permissão para usar a AWS KMS chave para descriptografar a senha, mas tiver permissão para acessar o restante das propriedades da conexão.

• NextToken— UTF -8 cordas.

  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 – Uma matriz de objetos Conexão.

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

• NextToken— UTF -8 cordas.

  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, superior a 1 e inferior a 255 bytes de comprimento, 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 AWS conta será usado por padrão.

• Name— Obrigatório: UTF -8 string, não menos que 1 ou mais de 255 bytes de comprimento, correspondendo 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

• CatalogId – String de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, 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 AWS conta será usado por padrão.

• ConnectionNameList— Obrigatório: uma matriz de UTF -8 strings, não mais que 25 strings.

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

Resposta

• Succeeded— Uma matriz de UTF -8 cordas.

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

• Errors – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF -8, com pelo menos 1 ou mais de 255 bytes de comprimento, correspondendo 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

• AuthenticationConfiguration estrutura

• AuthenticationConfigurationInput estrutura

• OAuth2Propertiesestrutura

• OAuth2PropertiesInputestrutura

• OAuth2ClientApplicationestrutura

• AuthorizationCodeProperties estrutura

Campos

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

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

• SecretArn— UTF -8 string, correspondendo a. Custom string pattern #11

  O gerente secreto ARN para armazenar as credenciais.

• OAuth2Properties – Um objeto OAuth2Properties.

  As propriedades da OAuth2 autenticação.

Campos

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

  Uma estrutura contendo a configuração de autenticação na CreateConnection solicitação.

• SecretArn— UTF -8 string, correspondendo a. Custom string pattern #11

  O gerente secreto ARN para armazenar as credenciais na CreateConnection solicitação.

• OAuth2Properties – Um objeto OAuth2PropertiesInput.

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

Campos

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

  O tipo de OAuth2 concessão. 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— UTF -8 string, com não mais de 256 bytes de comprimento, correspondendo a. Custom string pattern #12

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

  Cada chave é uma string UTF -8, com pelo menos 1 ou mais de 128 bytes de comprimento.

  Cada valor é uma string UTF de -8, com pelo menos 1 ou mais de 512 bytes de comprimento.

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

Campos

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

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

• OAuth2ClientApplication – Um objeto OAuth2ClientApplication.

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

• TokenUrl— UTF -8 string, com não mais de 256 bytes de comprimento, correspondendo a. Custom string pattern #12

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

  Cada chave é uma string UTF -8, com pelo menos 1 ou mais de 128 bytes de comprimento.

  Cada valor é uma string UTF de -8, com pelo menos 1 ou mais de 512 bytes de comprimento.

  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 OAuth2 AUTHORIZATION_CODE concessão.

Campos

• UserManagedClientApplicationClientId— UTF -8 string, com no máximo 2048 bytes de comprimento, correspondendo a. Custom string pattern #13

  O ClientID do aplicativo cliente, se for. ClientAppType USER_MANAGED

• AWSManagedClientApplicationReference— UTF -8 string, com no máximo 2048 bytes de comprimento, correspondendo a. Custom string pattern #13

  A referência ao aplicativo cliente do lado SaaS que é gerenciado AWS .

Campos

• AuthorizationCode— UTF -8 string, não menos que 1 ou mais de 4096 bytes de comprimento, correspondendo a. Custom string pattern #13

  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— UTF -8 string, com não mais de 512 bytes de comprimento, correspondendo a. Custom string pattern #14

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