Metadati di connessione e API di anteprima - AWS Glue
 —  tipi di dati  —EntitàCampo —  operazioni  —ListEntities (list_entities)DescribeEntity (describe_entity)GetEntityRecords (get_entity_records)

Metadati di connessione e API di anteprima

Le seguenti API di connessione illustrano le operazioni per descrivere i metadati di connessione.

Tipi di dati

Struttura dell'entità

Un'entità supportata da un dato ConnectionType.

Campi

  • EntityName: stringa UTF-8.

    Il nome dell'entità.

  • Label: stringa UTF-8.

    Etichetta utilizzata per l'entità.

  • IsParentEntity: booleano.

    Un valore booleano che aiuta a determinare se ci sono oggetti secondari che possono essere elencati.

  • Description: stringa UTF-8.

    Una descrizione dell'entità.

  • Category: stringa UTF-8.

    Il tipo di entità presenti nella risposta. Questo valore dipende dalla connessione di origine. Ad esempio, questo è SObjects per Salesforce e databases, schemas o tables per origini come Amazon Redshift.

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

    Ogni chiave è una stringa UTF-8.

    Ogni valore è una stringa UTF-8.

    Una mappa facoltativa di chiavi che può essere restituita per un'entità da un connettore.

Struttura del campo

L'oggetto Field contiene informazioni sulle diverse proprietà associate a un campo nel connettore.

Campi

  • FieldName: stringa UTF-8.

    L'identificatore univoco del campo.

  • Label: stringa UTF-8.

    Un'etichetta leggibile utilizzata per il campo.

  • Description: stringa UTF-8.

    Una descrizione del campo.

  • FieldType: stringa UTF-8 (valori validi: INT | SMALLINT | BIGINT | FLOAT | LONG | DATE | BOOLEAN | MAP | ARRAY | STRING | TIMESTAMP | DECIMAL | BYTE | SHORT | DOUBLE | STRUCT).

    Il tipo di dati nel campo.

  • IsPrimaryKey: booleano.

    Indica se questo campo può essere utilizzato come chiave primaria per l'entità specificata.

  • IsNullable: booleano.

    Indica se questo campo può essere annullabile o meno.

  • IsRetrievable: booleano.

    Indica se questo campo può essere aggiunto nella clausola Select della query SQL o se è recuperabile o meno.

  • IsFilterable: booleano.

    Indica se questo campo può essere utilizzato in una clausola di filtro (clausola WHERE) di un'istruzione SQL durante l'esecuzione di query sui dati.

  • IsPartitionable: booleano.

    Indica se un determinato campo può essere utilizzato per partizionare la query eseguita su SaaS.

  • IsCreateable: booleano.

    Indica se questo campo può essere creato come parte di una scrittura di destinazione.

  • IsUpdateable: booleano.

    Indica se questo campo può essere aggiornato come parte di una scrittura di destinazione.

  • IsUpsertable: booleano.

    Indica se questo campo può essere alterato come parte di una scrittura di destinazione.

  • IsDefaultOnCreate: booleano.

    Indica se questo campo viene compilato automaticamente al momento della creazione dell'oggetto, ad esempio un timestamp Ora di creazione.

  • SupportedValues: una matrice di stringhe UTF-8.

    Un elenco di valori supportati per il campo.

  • SupportedFilterOperators: una matrice di stringhe UTF-8.

    Indica gli operatori di filtro di supporto per questo campo.

  • ParentField: stringa UTF-8.

    Un nome di campo principale per un campo annidato.

  • NativeDataType: stringa UTF-8.

    Il tipo di dati restituito dall'API SaaS, ad esempio “picklist” o “textarea” da Salesforce.

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

    Ogni chiave è una stringa UTF-8.

    Ogni valore è una stringa UTF-8.

    Mappa opzionale delle chiavi che possono essere restituite.

Operazioni

Operazione ListEntities (Python: list_entities)

Restituisce le entità disponibili supportate dal tipo di connessione.

Richiesta

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

    Un nome per la connessione che ha bisogno di credenziali per eseguire query su qualsiasi tipo di connessione.

  • 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 che contiene la connessione. Può essere nullo. Per impostazione predefinita, l'ID account di AWS è l'ID catalogo.

  • ParentEntityName: stringa UTF-8.

    Il nome dell'entità padre per la quale intendi elencare i figli. Questo parametro utilizza un percorso completo dell'entità per elencare le entità figlio.

  • NextToken: stringa UTF-8, non inferiore a 1 o superiore a 2048 byte di lunghezza, corrispondente a Custom string pattern #11.

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

  • DataStoreApiVersion: stringa UTF-8, non inferiore a 1 o superiore a 256 byte di lunghezza, corrispondente a Custom string pattern #23.

    La versione API del connettore SaaS.

Risposta

  • Entities: una matrice di oggetti Entità.

    Elenco di oggetti Entity.

  • NextToken: stringa UTF-8, non inferiore a 1 o superiore a 2048 byte di lunghezza, corrispondente a Custom string pattern #11.

    Un token di continuazione, presente se il segmento corrente non è l'ultimo.

Errori

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

  • ValidationException

  • FederationSourceException

  • AccessDeniedException

Operazione DescribeEntity (Python: describe_entity)

Fornisce dettagli sull'entità utilizzata con il tipo di connessione, con una descrizione del modello di dati per ogni campo dell'entità selezionata.

La risposta include tutti i campi che compongono l'entità.

Richiesta

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

    Il nome della connessione che contiene le credenziali del tipo di connessione.

  • 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 che contiene la connessione. Può essere nullo. Per impostazione predefinita, l'ID account di AWS è l'ID catalogo.

  • EntityName: obbligatorio: stringa UTF-8.

    Il nome dell'entità che desideri descrivere in base al tipo di connessione.

  • NextToken: stringa UTF-8, non inferiore a 1 o superiore a 2048 byte di lunghezza, corrispondente a Custom string pattern #11.

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

  • DataStoreApiVersion: stringa UTF-8, non inferiore a 1 o superiore a 256 byte di lunghezza, corrispondente a Custom string pattern #23.

    La versione dell'API utilizzata per il datastore.

Risposta

  • Fields: una matrice di oggetti Campo.

    Descrive i campi per tale entità del connettore. Questo è l'elenco degli oggetti Field. Field è molto simile alla colonna in un database. L'oggetto Field contiene informazioni sulle diverse proprietà associate ai campi del connettore.

  • NextToken: stringa UTF-8, non inferiore a 1 o superiore a 2048 byte di lunghezza, corrispondente a Custom string pattern #11.

    Un token di continuazione, presente se il segmento corrente non è l'ultimo.

Errori

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

  • ValidationException

  • FederationSourceException

  • AccessDeniedException

Operazione GetEntityRecords (Python: get_entity_records)

Questa API viene utilizzata per eseguire query sui dati di anteprima da un determinato tipo di connessione o da un Catalogo dati AWS Glue nativo basato su Amazon S3.

Restituisce i record sotto forma di un array di blob JSON. Ogni record è formattato utilizzando Jackson JsonNode in base al tipo di campo definito dall'API DescribeEntity.

I connettori Spark generano schemi in base alla stessa mappatura dei tipi di dati dell'API DescribeEntity. I connettori Spark convertono i dati nei tipi di dati appropriati che corrispondono allo schema quando restituiscono le righe.

Richiesta

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

    Il nome della connessione che contiene le credenziali del tipo di connessione.

  • 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 che contiene la connessione. Può essere nullo. Per impostazione predefinita, l'ID account di AWS è l'ID catalogo.

  • EntityName: obbligatorio: stringa UTF-8.

    Nome dell'entità per cui vogliamo eseguire le query sui dati di anteprima relativi al tipo di connessione specificato.

  • NextToken: stringa UTF-8, non inferiore a 1 o superiore a 2048 byte di lunghezza, corrispondente a Custom string pattern #11.

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

  • DataStoreApiVersion: stringa UTF-8, non inferiore a 1 o superiore a 256 byte di lunghezza, corrispondente a Custom string pattern #23.

    La versione API del connettore SaaS.

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

    Ogni chiave è una stringa UTF-8, non inferiore a 1 o superiore a 256 byte di lunghezza, corrispondente a Custom string pattern #18.

    Ogni valore è una stringa UTF-8, non inferiore a 1 o superiore a 256 byte di lunghezza, corrispondente a Custom string pattern #17.

    Opzioni di connettore necessarie per eseguire query sui dati.

  • FilterPredicate: stringa UTF-8, non inferiore a 1 o superiore a 100.000 byte di lunghezza.

    Un predicato di filtro che puoi applicare nella richiesta di query.

  • Limit: obbligatorio: numero (long), non inferiore a 1 o superiore a 1.000.

    Limita il numero di record recuperati con la richiesta.

  • OrderBy: stringa UTF-8.

    Un parametro che ordina i dati di anteprima della risposta.

  • SelectedFields: un array di stringhe UTF-8, non inferiore a 1 o superiore a 1.000 stringhe.

    Elenco di campi da recuperare come parte dei dati di anteprima.

Risposta

  • Records: un array di strutture.

    Un elenco di tutti gli oggetti richiesti.

  • NextToken: stringa UTF-8, non inferiore a 1 o superiore a 2048 byte di lunghezza, corrispondente a Custom string pattern #11.

    Un token di continuazione, presente se il segmento corrente non è l'ultimo.

Errori

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

  • ValidationException

  • FederationSourceException

  • AccessDeniedException