Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà. # Metadati di connessione e API di anteprima La seguente connessione APIs descrive le operazioni per descrivere i metadati di connessione. ## Tipi di dati + [Struttura dell'entità](#aws-glue-api-catalog-connections-connections-metadata-Entity) + [Struttura del campo](#aws-glue-api-catalog-connections-connections-metadata-Field) ## 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 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` \$1 `SMALLINT` \$1 `BIGINT` \$1 `FLOAT` \$1 `LONG` \$1 `DATE` \$1 `BOOLEAN` \$1 `MAP` \$1 `ARRAY` \$1 `STRING` \$1 `TIMESTAMP` \$1 `DECIMAL` \$1 `BYTE` \$1 `SHORT` \$1 `DOUBLE` \$1 `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` – . 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. + `CustomProperties` – Mappa opzionale delle chiavi che possono essere restituite. ## Operazioni + [ListEntities azione (Python: list\$1entities)](#aws-glue-api-catalog-connections-connections-metadata-ListEntities) + [DescribeEntity azione (Python: describe\$1entity)](#aws-glue-api-catalog-connections-connections-metadata-DescribeEntity) + [GetEntityRecords azione (Python: get\$1entity\$1records)](#aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords) ## ListEntities azione (Python: list\$1entities) 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine). 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L'ID del catalogo che contiene la connessione. Questo può essere nullo. Per impostazione predefinita, l'ID AWS account è l'ID del 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](aws-glue-api-common.md#regex_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](aws-glue-api-common.md#regex_23). La versione API del connettore SaaS. **Risposta** + `Entities`: una matrice di oggetti [Entità](#aws-glue-api-catalog-connections-connections-metadata-Entity). 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](aws-glue-api-common.md#regex_11). Un token di continuazione, presente se il segmento corrente non è l'ultimo. **Errori** + `EntityNotFoundException` + `OperationTimeoutException` + `InvalidInputException` + `GlueEncryptionException` + `ValidationException` + `FederationSourceException` + `AccessDeniedException` ## DescribeEntity azione (Python: describe\$1entity) 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine). 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L'ID del catalogo che contiene la connessione. Questo può essere nullo. Per impostazione predefinita, l'ID AWS account è l'ID del 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](aws-glue-api-common.md#regex_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](aws-glue-api-common.md#regex_23). La versione dell'API utilizzata per il datastore. **Risposta** + `Fields`: una matrice di oggetti [Campo](#aws-glue-api-catalog-connections-connections-metadata-Field). 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](aws-glue-api-common.md#regex_11). Un token di continuazione, presente se il segmento corrente non è l'ultimo. **Errori** + `EntityNotFoundException` + `OperationTimeoutException` + `InvalidInputException` + `GlueEncryptionException` + `ValidationException` + `FederationSourceException` + `AccessDeniedException` ## GetEntityRecords azione (Python: get\$1entity\$1records) Questa API viene utilizzata per interrogare i dati di anteprima da un determinato tipo di connessione o da un catalogo AWS Glue dati 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'`DescribeEntity`API. 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine). 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L'ID del catalogo che contiene la connessione. Questo può essere nullo. Per impostazione predefinita, l'ID AWS account è l'ID del 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](aws-glue-api-common.md#regex_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](aws-glue-api-common.md#regex_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](aws-glue-api-common.md#regex_18). Ogni valore è una stringa UTF-8, non inferiore a 1 o superiore a 256 byte di lunghezza, corrispondente a [Custom string pattern #17](aws-glue-api-common.md#regex_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. + `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](aws-glue-api-common.md#regex_11). Un token di continuazione, presente se il segmento corrente non è l'ultimo. **Errori** + `EntityNotFoundException` + `OperationTimeoutException` + `InvalidInputException` + `GlueEncryptionException` + `ValidationException` + `FederationSourceException` + `AccessDeniedException`