API Cataloghi

• Struttura del catalogo

• Struttura CatalogInput

• Struttura TargetRedshiftCatalogCatalog

• Struttura CatalogProperties

• Struttura CatalogPropertiesOutput

• Struttura DataLakeAccessProperties

• Struttura IcebergOptimizationProperties

• Struttura DataLakeAccessPropertiesOutput

• Struttura IcebergOptimizationPropertiesOutput

• Struttura FederatedCatalog

Campi

• 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. Per concedere l'accesso al catalogo predefinito, questo campo non deve essere fornito.

• Name: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 64 byte di lunghezza, corrispondente a Custom string pattern #25.

  Il nome del catalogo. Non può essere uguale all'ID account.

• ResourceArn: stringa UTF-8.

  Il nome della risorsa Amazon (ARN) assegnato alla risorsa del catalogo.

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

  Stringa di descrizione, non superiore a 2.048 byte di lunghezza, corrispondente al modello di stringa su più righe dell'indirizzo URI. Una descrizione del catalogo.

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

  Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

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

  Un array della mappa di coppie chiave-valore che definiscono parametri e proprietà del catalogo.

• CreateTime: timestamp.

  L'ora in cui è stato creato il catalogo.

• UpdateTime: timestamp.

  L'ora dell'ultimo aggiornamento del catalogo.

• TargetRedshiftCatalog: un oggetto TargetRedshiftCatalog.

  Un oggetto TargetRedshiftCatalog che descrive un catalogo di destinazione per il collegamento del database.

• FederatedCatalog: un oggetto FederatedCatalog.

  Un oggetto FederatedCatalog che punta a un'entità esterna al Catalogo dati AWS Glue.

• CatalogProperties: un oggetto CatalogPropertiesOutput.

  Un oggetto CatalogProperties che specifica le proprietà di accesso al data lake e altre proprietà personalizzate.

• CreateTableDefaultPermissions: una matrice di oggetti PrincipalPermissions.

  Un array di oggetti PrincipalPermissions. Crea un set di autorizzazioni predefinite sulle tabelle per i principali. Utilizzato da AWS Lake Formation. Non utilizzato nel corso delle normali operazioni di AWS Glue.

• CreateDatabaseDefaultPermissions: una matrice di oggetti PrincipalPermissions.

  Un array di oggetti PrincipalPermissions. Crea un set di autorizzazioni predefinite sui database per i principali. Utilizzato da AWS Lake Formation. Non utilizzato nel corso delle normali operazioni di AWS Glue.

• AllowFullTableExternalDataAccess: stringa UTF-8 (valori validi: True | False).

  Consente ai motori di terze parti di accedere ai dati nelle posizioni Amazon S3 registrate con Lake Formation.

Campi

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

  Stringa di descrizione, non superiore a 2.048 byte di lunghezza, corrispondente al modello di stringa su più righe dell'indirizzo URI. Una descrizione del catalogo.

• FederatedCatalog: un oggetto FederatedCatalog.

  Oggetto FederatedCatalog. Una struttura FederatedCatalog che fa riferimento a un'entità esterna al Catalogo dati AWS Glue, ad esempio un database Redshift.

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

  Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

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

  Un array della mappa di coppie chiave-valore che definiscono i parametri e le proprietà del catalogo.

• TargetRedshiftCatalog: un oggetto TargetRedshiftCatalog.

  Un oggetto TargetRedshiftCatalog che descrive un catalogo di destinazione per il collegamento delle risorse.

• CatalogProperties: un oggetto CatalogProperties.

  Un oggetto CatalogProperties che specifica le proprietà di accesso al data lake e altre proprietà personalizzate.

• CreateTableDefaultPermissions: una matrice di oggetti PrincipalPermissions.

  Un array di oggetti PrincipalPermissions. Crea un set di autorizzazioni predefinite sulle tabelle per i principali. Utilizzato da AWS Lake Formation. In genere dovrebbe essere impostato in modo esplicito come elenco vuoto.

• CreateDatabaseDefaultPermissions: una matrice di oggetti PrincipalPermissions.

  Un array di oggetti PrincipalPermissions. Crea un set di autorizzazioni predefinite sui database per i principali. Utilizzato da AWS Lake Formation. In genere dovrebbe essere impostato in modo esplicito come elenco vuoto.

• AllowFullTableExternalDataAccess: stringa UTF-8 (valori validi: True | False).

  Consente ai motori di terze parti di accedere ai dati nelle posizioni Amazon S3 registrate con Lake Formation.

Campi

• CatalogArn: obbligatorio: stringa UTF-8.

  Il nome della risorsa Amazon (ARN) della risorsa del catalogo.

Campi

• DataLakeAccessProperties: un oggetto DataLakeAccessProperties.

  Un oggetto DataLakeAccessProperties che specifica le proprietà per configurare l'accesso al data lake per la risorsa del catalogo nel Catalogo dati AWS Glue.

• IcebergOptimizationProperties: un oggetto IcebergOptimizationProperties.

  Una struttura che specifica le proprietà di ottimizzazione della tabella Iceberg per il catalogo. Ciò include la configurazione per le operazioni di compattazione, conservazione ed eliminazione dei file orfani che possono essere applicate alle tabelle Iceberg in questo catalogo.

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

  Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

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

  Proprietà chiave-valore aggiuntive per il catalogo, come le ottimizzazioni delle statistiche delle colonne.

Campi

• DataLakeAccessProperties: un oggetto DataLakeAccessPropertiesOutput.

  Un oggetto DataLakeAccessProperties con proprietà di input per configurare l'accesso al data lake per la risorsa del catalogo nel Catalogo dati AWS Glue.

• IcebergOptimizationProperties: un oggetto IcebergOptimizationPropertiesOutput.

  Un oggetto IcebergOptimizationPropertiesOutput che specifica le impostazioni di ottimizzazione delle tabelle Iceberg per il catalogo, incluse le configurazioni per le operazioni di compattazione, conservazione ed eliminazione dei file orfani.

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

  Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

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

  Proprietà chiave-valore aggiuntive per il catalogo, come le ottimizzazioni delle statistiche delle colonne.

Campi

• DataLakeAccess: booleano.

  Attiva o disattiva l'accesso al data lake per le applicazioni Apache Spark che accedono ai database Amazon Redshift nel Catalogo dati da qualsiasi motore non Redshift, come Amazon Athena, Amazon EMR o ETL di AWS Glue.

• DataTransferRole: stringa UTF-8, corrispondente a Custom string pattern #51.

  Un ruolo che verrà assunto da AWS Glue per il trasferimento dei dati da/verso il bucket di staging durante una query.

• KmsKey: stringa UTF-8.

  Una chiave di crittografia utilizzata per il bucket di staging che verrà creato insieme al catalogo.

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

  Specifica un tipo di catalogo federato per la risorsa del catalogo nativa. Il tipo attualmente supportato è aws:redshift.

Campi

• RoleArn: stringa UTF-8, corrispondente a Custom string pattern #51.

  Il nome della risorsa Amazon (ARN) del ruolo IAM che deve essere assunto per eseguire le operazioni di ottimizzazione delle tabelle Iceberg.

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

  Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

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

  Una mappa di coppie chiave-valore che specificano i parametri di configurazione per le operazioni di compattazione delle tabelle Iceberg, le quali ottimizzano il layout dei file di dati per migliorare le prestazioni delle query.

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

  Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

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

  Una mappa di coppie chiave-valore che specificano i parametri di configurazione per le operazioni di conservazione delle tabelle Iceberg, le quali gestiscono il ciclo di vita degli snapshot delle tabelle per controllare i costi di archiviazione.

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

  Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

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

  Una mappa di coppie chiave-valore che specificano i parametri di configurazione per le operazioni di eliminazione dei file orfani di Iceberg, i quali identificano e rimuovono i file a cui non fanno più riferimento i metadati della tabella.

Campi

• DataLakeAccess: booleano.

  Attiva o disattiva l'accesso al data lake per le applicazioni Apache Spark che accedono ai database Amazon Redshift nel Catalogo Dati.

• DataTransferRole: stringa UTF-8, corrispondente a Custom string pattern #51.

  Un ruolo che verrà assunto da AWS Glue per il trasferimento dei dati da/verso il bucket di staging durante una query.

• KmsKey: stringa UTF-8.

  Una chiave di crittografia utilizzata per il bucket di staging che verrà creato insieme al catalogo.

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

  Il nome del calcolo gestito di Redshift serverless creato per la risorsa del catalogo.

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

  Lo stato del calcolo gestito di Redshift serverless.

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

  Il nome predefinito della risorsa del database Redshift nel calcolo gestito.

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

  Un messaggio che fornisce informazioni più dettagliate sullo stato del gruppo di lavoro gestito.

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

  Specifica un tipo di catalogo federato per la risorsa del catalogo nativa. Il tipo attualmente supportato è aws:redshift.

Campi

• RoleArn: stringa UTF-8, corrispondente a Custom string pattern #51.

  Il nome della risorsa Amazon (ARN) del ruolo IAM utilizzato per eseguire le operazioni di ottimizzazione delle tabelle Iceberg.

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

  Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

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

  Una mappa di coppie chiave-valore che specificano i parametri di configurazione per le operazioni di compattazione delle tabelle Iceberg, le quali ottimizzano il layout dei file di dati per migliorare le prestazioni delle query.

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

  Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

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

  Una mappa di coppie chiave-valore che specificano i parametri di configurazione per le operazioni di conservazione delle tabelle Iceberg, le quali gestiscono il ciclo di vita degli snapshot delle tabelle per controllare i costi di archiviazione.

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

  Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

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

  Una mappa di coppie chiave-valore che specificano i parametri di configurazione per le operazioni di eliminazione dei file orfani di Iceberg, i quali identificano e rimuovono i file a cui non fanno più riferimento i metadati della tabella.

• LastUpdatedTime: timestamp.

  Il timestamp relativo al momento dell'ultimo aggiornamento delle proprietà di Iceberg.

Campi

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

  Un identificatore univoco per il catalogo federato.

• 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 a un'origine dati esterna, ad esempio un catalogo federato di Redshift.

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

  Il tipo di connessione utilizzato per accedere al catalogo federato, che specifica il protocollo o il metodo per la connessione all'origine dati esterna.

• Operazione CreateCatalog (Python: create_catalog)

• Operazione UpdateCatalog (Python: update_catalog)

• Operazione DeleteCatalog (Python: delete_catalog)

• Operazione GetCatalog (Python: get_catalog)

• Operazione GetCatalogs (Python: get_catalogs)

Richiesta

• Name: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 64 byte di lunghezza, corrispondente a Custom string pattern #25.

  Nome del catalogo da creare.

• CatalogInput: obbligatorio: un oggetto CatalogInput.

  Un oggetto CatalogInput che definisce i metadati per il catalogo.

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

  Ogni chiave è una stringa UTF-8, non inferiore a 1 o superiore a 128 byte di lunghezza.

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

  Una matrice di mappe con coppie chiave-valore, non superiore alle 50 coppie. Ogni chiave è una stringa UTF-8, non inferiore a 1 o superiore a 128 byte di lunghezza. Ogni valore è una stringa UTF-8, lunga non più di 256 byte. I tag assegnati al catalogo.

Risposta

• Nessun parametro di risposta.

Errori

• InvalidInputException

• AlreadyExistsException

• ResourceNumberLimitExceededException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• ConcurrentModificationException

• AccessDeniedException

• EntityNotFoundException

• FederatedResourceAlreadyExistsException

• FederationSourceException

Richiesta

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

  L'ID del catalogo.

• CatalogInput: obbligatorio: un oggetto CatalogInput.

  Un oggetto CatalogInput che specifica le nuove proprietà di un catalogo esistente.

Risposta

• Nessun parametro di risposta.

Errori

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• ConcurrentModificationException

• AccessDeniedException

• FederationSourceException

Richiesta

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

  L'ID del catalogo.

Risposta

• Nessun parametro di risposta.

Errori

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• ConcurrentModificationException

• AccessDeniedException

• FederationSourceException

Richiesta

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

  L'ID del catalogo padre in cui si trova il catalogo. Se non viene fornito, per impostazione predefinita viene utilizzato il numero dell'account AWS.

Risposta

• Catalog: un oggetto Catalogo.

  Oggetto Catalog. La definizione del catalogo specificato nel Catalogo dati AWS Glue.

Errori

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• AccessDeniedException

• EntityNotFoundException

• FederationSourceException

• FederationSourceRetryableException

Richiesta

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

  L'ID del catalogo padre in cui si trova il catalogo. Se non viene fornito, per impostazione predefinita viene utilizzato il numero dell'account AWS.

• NextToken: stringa UTF-8.

  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 cataloghi da restituire in una risposta.

• Recursive: booleano.

  Se elencare tutti i cataloghi nella gerarchia dei cataloghi, a partire da ParentCatalogId. L'impostazione predefinita è false. Quando true, tutti gli oggetti del catalogo nella gerarchia ParentCatalogID vengono enumerati nella risposta.

• IncludeRoot: booleano.

  Se elencare il catalogo predefinito nell'account e nella regione nella risposta. L'impostazione predefinita è false. Quando true e ParentCatalogId = NULL | AWS Account ID, tutti i cataloghi e il catalogo predefinito vengono enumerati nella risposta.

  Quando ParentCatalogId è diverso da nullo e questo attributo viene passato come false o true, viene generato un InvalidInputException.

Risposta

• CatalogList: obbligatorio: una matrice di oggetti Catalogo.

  Un array di oggetti Catalog. Un elenco di oggetti Catalog dal catalogo padre specificato.

• NextToken: stringa UTF-8.

  Un token di continuazione per impaginare l'elenco restituito di token, restituiti se il segmento corrente dell'elenco non è l'ultimo.

Errori

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• AccessDeniedException

• EntityNotFoundException

• FederationSourceException

• FederationSourceRetryableException