Connessione API

• Struttura di connessione

• ConnectionInput struttura

• PhysicalConnectionRequirements struttura

• GetConnectionsFilter struttura

Campi

• Name— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

  Il nome della definizione di connessione.

• Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.

  La descrizione della connessione.

• ConnectionType— UTF -8 stringhe (valori validi: JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | | SALESFORCE VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

  Il tipo di connessione. Attualmente, SFTP non è supportato.

• MatchCriteria— Un array di UTF -8 stringhe, non più di 10 stringhe.

  Un elenco di criteri che possono essere utilizzati nella selezione di questa connessione.

• ConnectionProperties: una matrice di mappe con coppie chiave-valore, non superiore alle 100 coppie.

  Ogni chiave è una stringa di UTF -8 (valori validi: 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).

  Ogni valore è una stringa Value, lunga non più di 1024 byte.

  Queste coppie chiave-valore definiscono i parametri per la connessione:

  • HOST- L'hostURI: il nome di dominio completo (FQDN) o l'IPv4indirizzo dell'host del database.

  • PORT: il numero della porta, compreso tra 1024 e 65535, della porta su cui l'host del database ascolta le connessioni del database.

  • USER_NAME: il nome sotto il quale accedere al database. La stringa del valore per USER_NAME è USERNAME.

  • PASSWORD: una password, se usata, per il nome utente.

  • ENCRYPTED_PASSWORD: quando si abilita la protezione della password di connessione impostando ConnectionPasswordEncryption nelle impostazioni di crittografia del catalogo dati, questo campo memorizza la password crittografata.

  • JDBC_DRIVER_JAR_URI- Il percorso Amazon Simple Storage Service (Amazon S3) del file che contiene JAR JDBC il driver da utilizzare.

  • JDBC_DRIVER_CLASS_NAME- Il nome della classe del JDBC driver da utilizzare.

  • JDBC_ENGINE- Il nome del JDBC motore da utilizzare.

  • JDBC_ENGINE_VERSION- La versione del JDBC motore da utilizzare.

  • CONFIG_FILES: (Riservato per uso futuro).

  • INSTANCE_ID: l'ID istanza da utilizzare.

  • JDBC_CONNECTION_URL- URL Per il collegamento a una fonte di JDBC dati.

  • JDBC_ENFORCE_SSL- Una stringa booleana (true, false) che specifica se Secure Sockets Layer (SSL) con la corrispondenza del nome host è applicato per la connessione sul client. JDBC Il valore predefinito è false.

  • CUSTOM_JDBC_CERT- Una posizione Amazon S3 che specifica il certificato principale del cliente. AWS Glue utilizza questo certificato radice per convalidare il certificato del cliente durante la connessione al database dei clienti. AWS Glue gestisce solo certificati X.509. Il certificato fornito deve essere DER codificato e fornito nel formato di codifica Base64. PEM

  • SKIP_CUSTOM_JDBC_CERT_VALIDATION- Per impostazione predefinita, questo è. false AWS Glue convalida l'algoritmo Signature e Subject Public Key Algorithm per il certificato del cliente. Gli unici algoritmi consentiti per l'algoritmo Signature sonoSHA256withRSA, SHA384withRSA o. SHA512withRSA Per l'algoritmo della chiave pubblica oggetto, la lunghezza della chiave deve essere almeno 2048. Puoi impostare il valore di questa proprietà su true per ignorare la convalida di AWS Glue del certificato del cliente.

  • CUSTOM_JDBC_CERT_STRING- Una stringa di JDBC certificato personalizzata che viene utilizzata per la corrispondenza del dominio o la corrispondenza dei nomi distinti per prevenire un man-in-the-middle attacco. Nel database Oracle, viene utilizzato comeSSL_SERVER_CERT_DN; in Microsoft SQL Server, viene utilizzato comehostNameInCertificate.

  • CONNECTION_URL- URL Per la connessione a una fonte di dati generale (nonJDBC).

  • SECRET_ID: l'ID segreto utilizzato per il Secret Manager delle credenziali.

  • CONNECTOR_URL- Il connettore URL per una CUSTOM connessione MARKETPLACE or.

  • CONNECTOR_TYPE- Il tipo di connettore per una CUSTOM connessione MARKETPLACE or.

  • CONNECTOR_CLASS_NAME- Il nome della classe del connettore per una CUSTOM connessione MARKETPLACE or.

  • KAFKA_BOOTSTRAP_SERVERS: un elenco separato da virgole di coppie host e porte che sono gli indirizzi dei broker Apache Kafka in un cluster Kafka a cui un client Kafka si connetterà e si avvierà.

  • KAFKA_SSL_ENABLED- Se abilitare o disabilitare SSL su una connessione Apache Kafka. Il valore di default è "true".

  • KAFKA_CUSTOM_CERT- Amazon S3 URL per il file di certificato CA privato (formato.pem). L'impostazione predefinita è una stringa vuota.

  • KAFKA_SKIP_CUSTOM_CERT_VALIDATION- Se saltare o meno la convalida del file di certificato CA. AWS Glue convalida per tre algoritmi:, e. SHA256withRSA SHA384withRSA SHA512withRSA Il valore predefinito è "false".

  • KAFKA_CLIENT_KEYSTORE: la posizione Amazon S3 del file keystore del client per l'autenticazione lato client Kafka (facoltativo).

  • KAFKA_CLIENT_KEYSTORE_PASSWORD: la password per accedere al keystore fornito (facoltativo).

  • KAFKA_CLIENT_KEY_PASSWORD: un keystore può essere costituito da più chiavi, quindi questa è la password per accedere alla chiave client da utilizzare con la chiave lato server Kafka (facoltativo).

  • ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD- La versione crittografata della password del keystore del client Kafka (se l'utente ha selezionato l'impostazione di AWS Glue crittografia delle password).

  • ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD- La versione crittografata della password della chiave del client Kafka (se l'utente ha selezionato l'impostazione di crittografia delle password). AWS Glue

  • KAFKA_SASL_MECHANISM-"SCRAM-SHA-512",, o"GSSAPI". "AWS_MSK_IAM" "PLAIN" Questi sono i SASLmeccanismi supportati.

  • KAFKA_SASL_PLAIN_USERNAME- Un nome utente in testo semplice utilizzato per l'autenticazione con il meccanismo "»PLAIN.

  • KAFKA_SASL_PLAIN_PASSWORD- Una password in testo semplice utilizzata per l'autenticazione con il meccanismo "». PLAIN

  • ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD- La versione crittografata della SASL PLAIN password di Kafka (se l'utente ha selezionato l'impostazione di AWS Glue crittografia delle password).

  • KAFKA_SASL_SCRAM_USERNAME- Un nome utente in testo semplice utilizzato per l'autenticazione con il meccanismo "- -512". SCRAM SHA

  • KAFKA_SASL_SCRAM_PASSWORD- Una password in testo semplice utilizzata per l'autenticazione con il meccanismo "- -512". SCRAM SHA

  • ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD- La versione crittografata della password di Kafka (se l'utente ha selezionato l'impostazione di crittografia delle SASL SCRAM password). AWS Glue

  • KAFKA_SASL_SCRAM_SECRETS_ARN- Il nome di risorsa Amazon di un segreto in AWS Secrets Manager.

  • KAFKA_SASL_GSSAPI_KEYTAB: la posizione S3 di un file keytab Kerberos. Un keytab memorizza le chiavi a lungo termine per uno o più principali. Per ulteriori informazioni, consulta la documentazione MIT Kerberos: Keytab.

  • KAFKA_SASL_GSSAPI_KRB5_CONF: la posizione S3 di un file krb5.conf Kerberos. Un krb5.conf memorizza le informazioni di configurazione Kerberos, come la posizione del server. KDC Per ulteriori informazioni, consulta la documentazione Kerberos: krb5.conf. MIT

  • KAFKA_SASL_GSSAPI_SERVICE: il nome del servizio Kerberos, come impostato con sasl.kerberos.service.name nella Configurazione Kafka.

  • KAFKA_SASL_GSSAPI_PRINCIPAL- Il nome del kerberos princial utilizzato da. AWS Glue Per ulteriori informazioni, consulta la Documentazione di Kafka: configurazione dei broker Kafka.

  • ROLE_ARN- Il ruolo da utilizzare per eseguire le interrogazioni.

  • REGION- La AWS regione in cui verranno eseguite le interrogazioni.

  • WORKGROUP_NAME- Il nome di un gruppo di lavoro serverless Amazon Redshift o del gruppo di lavoro Amazon Athena in cui verranno eseguite le query.

  • CLUSTER_IDENTIFIER- L'identificatore del cluster di un cluster Amazon Redshift in cui verranno eseguite le query.

  • DATABASE- Il database Amazon Redshift a cui ti stai connettendo.

• PhysicalConnectionRequirements: un oggetto PhysicalConnectionRequirements.

  I requisiti di connessione fisica, ad esempio il cloud privato virtuale (VPC) eSecurityGroup, necessari per effettuare correttamente questa connessione.

• CreationTime: timestamp.

  Il timestamp dell'ora in cui è stata creata questa definizione di connessione.

• LastUpdatedTime: timestamp.

  Il timestamp dell'ultima volta che la definizione di connessione è stata aggiornata.

• LastUpdatedBy— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

  L'utente, gruppo o ruolo che ha aggiornato per ultimo questa definizione di connessione.

• Status— UTF -8 stringhe (valori validi: READY | IN_PROGRESS |FAILED).

  Lo stato della connessione. Può essere READY, IN_PROGRESS o FAILED.

• StatusReason— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 16384 byte.

  Il motivo dello stato della connessione.

• LastConnectionValidationTime: timestamp.

  Un timestamp dell'ora in cui questa connessione è stata convalidata l'ultima volta.

• AuthenticationConfiguration: un oggetto AuthenticationConfiguration.

  Le proprietà di autenticazione della connessione.

Campi

• Name— Obbligatorio: UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

  Il nome della connessione.

• Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.

  La descrizione della connessione.

• ConnectionType— Obbligatorio: UTF -8 stringhe (valori validi: JDBC SFTP MONGODB | KAFKA | | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

  Il tipo di connessione. Attualmente, sono supportati questi tipi:

  • JDBC- Indica una connessione a un database tramite Java Database Connectivity (JDBC).

    JDBCLe connessioni utilizzano quanto segue ConnectionParameters.

    • Obbligatorio: tutti (HOST, PORT, JDBC_ENGINE) o JDBC_CONNECTION_URL.

    • Obbligatorio: tutti (USERNAME, PASSWORD) o SECRET_ID.

    • Facoltativo: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. Questi parametri vengono utilizzati per configurare SSL conJDBC.

  • KAFKA: indica una connessione a una piattaforma di streaming Apache Kafka.

    KAFKALe connessioni utilizzano quanto segue ConnectionParameters.

    • Obbligatorio: KAFKA_BOOTSTRAP_SERVERS.

    • Facoltativo: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. Questi parametri vengono utilizzati per configurare SSL conKAFKA.

    • Facoltativo: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. Questi parametri vengono utilizzati per configurare la configurazione TLS del client con SSL inKAFKA.

    • Facoltativo:KAFKA_SASL_MECHANISM. Può essere specificato come SCRAM-SHA-512, GSSAPI o AWS_MSK_IAM.

    • Facoltativo: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. Questi parametri vengono utilizzati per configurare l'autenticazioneSASL/SCRAM- SHA -512 conKAFKA.

    • Facoltativo: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. Questi parametri vengono utilizzati per configurareSASL/GSSAPIl'autenticazione conKAFKA.

  • MONGODB: designa una connessione a un database di documenti MongoDB.

    MONGODBLe connessioni utilizzano quanto segue ConnectionParameters.

    • Obbligatorio: CONNECTION_URL.

    • Obbligatorio: tutti (USERNAME, PASSWORD) o SECRET_ID.

  • SALESFORCE- Indica una connessione a Salesforce utilizzando l'autenticazione. OAuth

    • Richiede la configurazione del membro. AuthenticationConfiguration

  • VIEW_VALIDATION_REDSHIFT- Indica una connessione utilizzata per la convalida delle visualizzazioni da parte di Amazon Redshift.

  • VIEW_VALIDATION_ATHENA- Indica una connessione utilizzata per la convalida delle visualizzazioni da parte di Amazon Athena.

  • NETWORK- Indica una connessione di rete a una fonte di dati all'interno di un ambiente Amazon Virtual Private Cloud (AmazonVPC).

    NETWORKLe connessioni non sono necessarie ConnectionParameters. Fornisci invece un PhysicalConnectionRequirements.

  • MARKETPLACE- Utilizza le impostazioni di configurazione contenute in un connettore acquistato Marketplace AWS per leggere e scrivere su archivi dati che non sono supportati nativamente da AWS Glue.

    MARKETPLACELe connessioni utilizzano quanto segue ConnectionParameters.

    • Obbligatorio: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.

    • Obbligatorio per le connessioni JDBC CONNECTOR_TYPE: tutti (USERNAME, PASSWORD) o SECRET_ID.

  • CUSTOM: utilizza le impostazioni di configurazione contenute in un connettore per leggere e scrivere in archivi dati non supportati nativamente da AWS Glue.

  SFTP non è supportato.

  Per ulteriori informazioni su come ConnectionProperties vengono utilizzate le opzioni opzionali per configurare le funzionalità in AWS Glue, consulta le proprietà di AWS Glue connessione.

  Per ulteriori informazioni su come ConnectionProperties vengono utilizzate le funzionalità opzionali per configurare le funzionalità in AWS Glue Studio, consulta Utilizzo di connettori e connessioni.

• MatchCriteria— Un array di UTF -8 stringhe, non più di 10 stringhe.

  Un elenco di criteri che possono essere utilizzati nella selezione di questa connessione.

• ConnectionProperties: obbligatorio: una matrice di mappe di coppie chiave-valore, non superiore a 100 coppie.

  Ogni chiave è una stringa di UTF -8 (valori validi: 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).

  Ogni valore è una stringa Value, lunga non più di 1024 byte.

  Queste coppie chiave-valore definiscono i parametri per la connessione.

• PhysicalConnectionRequirements: un oggetto PhysicalConnectionRequirements.

  I requisiti di connessione fisica, come il cloud privato virtuale (VPC) eSecurityGroup, necessari per effettuare correttamente questa connessione.

• AuthenticationConfiguration: un oggetto AuthenticationConfigurationInput.

  Le proprietà di autenticazione della connessione. Utilizzato per una connessione Salesforce.

• ValidateCredentials: booleano.

  Un flag per convalidare le credenziali durante la creazione della connessione. Utilizzato per una connessione Salesforce. Il valore predefinito è true.

Campi

• SubnetId— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

  L'ID della sottorete utilizzato dalla connessione.

• SecurityGroupIdList— Una matrice di UTF -8 stringhe, non più di 50 stringhe.

  L'elenco di ID del gruppo di sicurezza utilizzato dalla connessione.

• AvailabilityZone— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondenti a. Single-line string pattern

  La zona di disponibilità della connessione.

Campi

• MatchCriteria— Una matrice di UTF -8 stringhe, non più di 10 stringhe.

  Una stringa di criteri che deve corrispondere ai criteri registrati nella definizione di connessione affinché venga restituita quella definizione di connessione.

• ConnectionType— UTF -8 stringhe (valori validi: JDBC | SFTP | MONGODB | | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

  Il tipo di connessioni da restituire. Attualmente, SFTP non è supportato.

• CreateConnection azione (Python: create_connection)

• DeleteConnection azione (Python: delete_connection)

• GetConnection azione (Python: get_connection)

• GetConnections azione (Python: get_connections)

• UpdateConnection azione (Python: update_connection)

• BatchDeleteConnection azione (Python: batch_delete_connection)

Richiesta

• CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

  L'ID del catalogo dati in cui creare la connessione. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato l'ID dell' AWS account.

• ConnectionInput: obbligatorio: un oggetto ConnectionInput.

  Un oggetto ConnectionInput che definisce la connessione da creare.

• Tags: una matrice di mappe con coppie chiave-valore, non superiore alle 50 coppie.

  Ogni chiave è una stringa di UTF -8, lunga non meno di 1 o più di 128 byte.

  Ogni valore è una stringa di UTF -8, lunga non più di 256 byte.

  I tag assegnati alla connessione.

Risposta

• CreateConnectionStatus— UTF -8 stringhe (valori validi: READY | IN_PROGRESS |FAILED).

  Lo stato della richiesta di creazione della connessione. La richiesta può richiedere del tempo per determinati tipi di autenticazione, ad esempio quando si crea una OAuth connessione con token exchange overVPC.

Errori

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• GlueEncryptionException

Richiesta

• CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

  L'ID del catalogo dati in cui risiede la connessione. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato l'ID AWS dell'account.

• ConnectionName— Obbligatorio: UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

  Nome della connessione da eliminare.

Risposta

• Nessun parametro di risposta.

Errori

• EntityNotFoundException

• OperationTimeoutException

Richiesta

• CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

  L'ID del catalogo dati in cui risiede la connessione. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato l'ID AWS dell'account.

• Name— Obbligatorio: UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

  Il nome della definizione di connessione da recuperare.

• HidePassword: booleano.

  Consente di recuperare i metadati di connessione senza restituire la password. Ad esempio, la AWS Glue console utilizza questo flag per recuperare la connessione e non visualizza la password. Imposta questo parametro quando il chiamante potrebbe non avere l'autorizzazione per utilizzare la AWS KMS chiave per decrittografare la password, ma dispone dell'autorizzazione per accedere al resto delle proprietà della connessione.

Risposta

• Connection: un oggetto Connessione.

  La definizione di connessione richiesta.

Errori

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

Richiesta

• CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

  L'ID del catalogo dati in cui risiedono le connessioni. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato l'ID AWS dell'account.

• Filter: un oggetto GetConnectionsFilter.

  Un filtro che controlla quali connessioni vengono restituite.

• HidePassword: booleano.

  Consente di recuperare i metadati di connessione senza restituire la password. Ad esempio, la AWS Glue console utilizza questo flag per recuperare la connessione e non visualizza la password. Imposta questo parametro quando il chiamante potrebbe non avere l'autorizzazione per utilizzare la AWS KMS chiave per decrittografare la password, ma dispone dell'autorizzazione per accedere al resto delle proprietà della connessione.

• NextToken— -8 stringheUTF.

  Un token di continuazione, se si tratta di una chiamata di continuazione.

• MaxResults: numero (intero), non inferiore a 1 o superiore a 1000.

  Il numero massimo di connessioni da restituire in una risposta.

Risposta

• ConnectionList: una matrice di oggetti Connessione.

  Un elenco di definizioni di connessione richieste.

• NextToken— UTF -8 corde.

  Un token di continuazione, se l'elenco di connessioni restituite non include l'ultima delle connessioni filtrate.

Errori

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

Richiesta

• CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

  L'ID del catalogo dati in cui risiede la connessione. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato l'ID AWS dell'account.

• Name— Obbligatorio: UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

  Il nome della definizione di connessione da aggiornare.

• ConnectionInput: obbligatorio: un oggetto ConnectionInput.

  Un oggetto ConnectionInput che ridefinisce la connessione in questione.

Risposta

• Nessun parametro di risposta.

Errori

• InvalidInputException

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

Richiesta

• CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

  L'ID del catalogo dati in cui risiedono le connessioni. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato l'ID AWS dell'account.

• ConnectionNameList— Obbligatorio: un array di UTF -8 stringhe, non più di 25 stringhe.

  Un elenco di nomi delle connessioni da eliminare.

Risposta

• Succeeded— Un array di UTF -8 stringhe.

  Un elenco di nomi delle definizioni di connessione la cui eliminazione è riuscita.

• Errors: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una stringa di UTF -8, lunga non meno di 1 o più di 255 byte, che corrisponde a. Single-line string pattern

  Ogni valore è un oggetto ErrorDetail.

  Una mappa dei nomi delle connessioni la cui eliminazione non è riuscita per i dettagli di errore.

Errori

• InternalServiceException

• OperationTimeoutException

• AuthenticationConfiguration struttura

• AuthenticationConfigurationInput struttura

• OAuth2Propertiesstruttura

• OAuth2PropertiesInputstruttura

• OAuth2ClientApplicationstruttura

• AuthorizationCodeProperties struttura

Campi

• AuthenticationType— UTF -8 stringhe (valori validi: BASIC | OAUTH2 |CUSTOM).

  Una struttura contenente la configurazione di autenticazione.

• SecretArn— UTF -8 stringhe, corrispondenti aCustom string pattern #11.

  Il gestore segreto ARN per memorizzare le credenziali.

• OAuth2Properties: un oggetto OAuth2Properties.

  Le proprietà per l'OAuth2autenticazione.

Campi

• AuthenticationType— UTF -8 stringhe (valori validi: BASIC | OAUTH2 |CUSTOM).

  Una struttura contenente la configurazione di autenticazione nella CreateConnection richiesta.

• SecretArn— UTF -8 stringa, corrispondente aCustom string pattern #11.

  Il gestore segreto ARN per memorizzare le credenziali nella CreateConnection richiesta.

• OAuth2Properties: un oggetto OAuth2PropertiesInput.

  Le proprietà per OAuth2 l'autenticazione nella CreateConnection richiesta.

Campi

• OAuth2GrantType— UTF -8 stringhe (valori validi: AUTHORIZATION_CODE | CLIENT_CREDENTIALS |JWT_BEARER).

  Il tipo di OAuth2 sovvenzione. Ad esempio, AUTHORIZATION_CODE, JWT_BEARER o CLIENT_CREDENTIALS.

• OAuth2ClientApplication: un oggetto OAuth2ClientApplication.

  Il tipo di applicazione client. Ad esempio, AWS _ MANAGED o USER _MANAGED.

• TokenUrl— UTF -8 stringa, lunga non più di 256 byte, corrispondente a. Custom string pattern #12

  Il server URL di autenticazione del provider, per lo scambio di un codice di autorizzazione con un token di accesso.

• TokenUrlParametersMap: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una stringa di UTF -8, lunga non meno di 1 o più di 128 byte.

  Ogni valore è una stringa di UTF -8, lunga almeno 1 o più di 512 byte.

  Una mappa di parametri che vengono aggiunti alla GET richiesta del token.

Campi

• OAuth2GrantType— UTF -8 stringhe (valori validi: AUTHORIZATION_CODE | CLIENT_CREDENTIALS |JWT_BEARER).

  Il tipo di OAuth2 concessione nella CreateConnection richiesta. Ad esempio, AUTHORIZATION_CODE, JWT_BEARER o CLIENT_CREDENTIALS.

• OAuth2ClientApplication: un oggetto OAuth2ClientApplication.

  Il tipo di applicazione client nella CreateConnection richiesta. Ad esempio AWS_MANAGED o USER_MANAGED.

• TokenUrl— UTF -8 stringhe, di lunghezza non superiore a 256 byte, corrispondente a. Custom string pattern #12

  Il server URL di autenticazione del provider, per lo scambio di un codice di autorizzazione con un token di accesso.

• TokenUrlParametersMap: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una stringa di UTF -8, lunga non meno di 1 o più di 128 byte.

  Ogni valore è una stringa di UTF -8, lunga almeno 1 o più di 512 byte.

  Una mappa di parametri che vengono aggiunti alla GET richiesta del token.

• AuthorizationCodeProperties: un oggetto AuthorizationCodeProperties.

  L'insieme di proprietà richieste per il tipo di OAuth2 AUTHORIZATION_CODE concessione.

Campi

• UserManagedClientApplicationClientId— UTF -8 stringhe, di lunghezza non superiore a 2048 byte, corrispondente a. Custom string pattern #13

  L'applicazione client ClientId, se lo è ClientAppType . USER_MANAGED

• AWSManagedClientApplicationReference— UTF -8 stringhe, di lunghezza non superiore a 2048 byte, corrispondente a. Custom string pattern #13

  Il riferimento all'app client lato SaaS gestita. AWS

Campi

• AuthorizationCode— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 4096 byte, corrispondente a. Custom string pattern #13

  Un codice di autorizzazione da utilizzare nella terza fase del flusso di lavoro relativo alle AUTHORIZATION_CODE sovvenzioni. Si tratta di un codice monouso che diventa non valido una volta scambiato con un token di accesso, quindi è accettabile avere questo valore come parametro di richiesta.

• RedirectUri— UTF -8 stringhe, lunghe non più di 512 byte, corrispondenti a. Custom string pattern #14

  Il reindirizzamento a URI cui l'utente viene reindirizzato dal server di autorizzazione quando emette un codice di autorizzazione. URIViene successivamente utilizzato quando il codice di autorizzazione viene scambiato con un token di accesso.