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à.
I cataloghi API descrivono le modalità APIs per creare, eliminare, individuare, aggiornare ed elencare i cataloghi.
Tipi di dati
Struttura del catalogo
L'oggetto catalogo rappresenta un raggruppamento logico di database nel AWS Glue Data Catalog o in una fonte federata. Ora puoi creare un catalogo federato Redshift o un catalogo contenente collegamenti a risorse ai database Redshift in un altro account o regione.
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: UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 64 byte, corrispondente a. Custom string pattern #25Il nome del catalogo. Non può essere uguale all'ID dell'account.
-
ResourceArn
— UTF -8 stringhe.L'Amazon Resource Name (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 descrittiva, lunga non più di 2048 byte, che corrisponde allo schema di stringa multilinea dell'URIindirizzo. 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 di UTF -8, lunga non più di 512000 byte.
Un array di mappe di coppie chiave-valore che definiscono i parametri e le 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
TargetRedshiftCatalog
oggetto che descrive un catalogo di destinazione per il collegamento delle risorse del database. -
FederatedCatalog
: un oggetto FederatedCatalog.Un
FederatedCatalog
oggetto che punta a un'entità esterna al AWS Glue Data Catalog. -
CatalogProperties
: un oggetto CatalogPropertiesOutput.Un
CatalogProperties
oggetto 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. Usato da. AWS Lake Formation Non utilizzato nel normale corso delle AWS Glue operazioni. -
CreateDatabaseDefaultPermissions
: una matrice di oggetti PrincipalPermissions.Un array di oggetti
PrincipalPermissions
. Crea un set di autorizzazioni predefinite sui database per i principali. Usato da. AWS Lake Formation Non utilizzato nel normale corso delle AWS Glue operazioni.
CatalogInput struttura
Una struttura che descrive le proprietà del catalogo.
Campi
-
Description
: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.Stringa di descrizione, lunga non più di 2048 byte, corrispondente allo schema di stringa multilinea dell'URIindirizzo. Una descrizione del catalogo.
-
FederatedCatalog
: un oggetto FederatedCatalog.Oggetto
FederatedCatalog
. UnaFederatedCatalog
struttura che fa riferimento a un'entità esterna al AWS Glue Data Catalog, 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 di UTF -8, lunga non più di 512000 byte.
Un array di mappe di coppie chiave-valore che definiscono i parametri e le proprietà del catalogo.
-
TargetRedshiftCatalog
: un oggetto TargetRedshiftCatalog.Un
TargetRedshiftCatalog
oggetto che descrive un catalogo di destinazione per il collegamento di risorse. -
CatalogProperties
: un oggetto CatalogProperties.Un
CatalogProperties
oggetto 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. Usato 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. Usato da. AWS Lake Formation In genere dovrebbe essere impostato in modo esplicito come elenco vuoto.
TargetRedshiftCatalog struttura
Una struttura che descrive un catalogo di destinazione per il collegamento delle risorse.
Campi
-
CatalogArn
— Richiesto: UTF -8 stringhe.L'Amazon Resource Name (ARN) della risorsa del catalogo.
CatalogProperties struttura
Una struttura che specifica le proprietà di accesso al data lake e altre proprietà personalizzate.
Campi
-
DataLakeAccessProperties
: un oggetto DataLakeAccessProperties.Un
DataLakeAccessProperties
oggetto che specifica le proprietà per configurare l'accesso al data lake per la risorsa del catalogo nel AWS Glue Data Catalog. -
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 di UTF -8, lunga non più di 512000 byte.
Proprietà chiave-valore aggiuntive per il catalogo, come le ottimizzazioni delle statistiche delle colonne.
CatalogPropertiesOutput struttura
Attributi di proprietà che includono le proprietà di configurazione per la risorsa del catalogo.
Campi
-
DataLakeAccessProperties
: un oggetto DataLakeAccessPropertiesOutput.Un
DataLakeAccessProperties
oggetto con proprietà di input per configurare l'accesso al data lake per la risorsa del catalogo nel AWS Glue Data Catalog. -
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 di UTF -8, lunga non più di 512000 byte.
Proprietà chiave-valore aggiuntive per il catalogo, come le ottimizzazioni delle statistiche delle colonne.
DataLakeAccessProperties struttura
Immetti le proprietà per configurare l'accesso al data lake per la risorsa del catalogo nel AWS Glue Data Catalog.
Campi
-
DataLakeAccess
: booleano.Attiva o disattiva l'accesso al data lake per le applicazioni Apache Spark che accedono ai database Amazon Redshift nel Data Catalog da qualsiasi motore non Redshift, come Amazon Athena, Amazon o. EMR AWS Glue ETL
-
DataTransferRole
— UTF -8 stringhe, corrispondenti a. Custom string pattern #51Un ruolo che verrà assunto AWS Glue per il trasferimento dei dati da/verso lo staging bucket durante una query.
-
KmsKey
UTF— -8 corde.Una chiave di crittografia che verrà utilizzata per lo staging bucket che verrà creato insieme al catalogo.
-
CatalogType
— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string patternSpeciifica un tipo di catalogo federato per la risorsa di catalogo nativa. Il tipo attualmente supportato è.
aws:redshift
DataLakeAccessPropertiesOutput struttura
Le proprietà di output della configurazione di accesso al data lake per la risorsa di catalogo nel AWS Glue Data Catalog.
Campi
-
DataLakeAccess
: booleano.Attiva o disattiva l'accesso al data lake per le applicazioni Apache Spark che accedono ai database Amazon Redshift nel Data Catalog.
-
DataTransferRole
— UTF -8 stringhe, corrispondenti a. Custom string pattern #51Un ruolo che verrà assunto AWS Glue per il trasferimento dei dati da/verso lo staging bucket durante una query.
-
KmsKey
UTF— -8 corde.Una chiave di crittografia che verrà utilizzata per lo staging bucket che verrà creato insieme al catalogo.
-
ManagedWorkgroupName
— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string patternIl nome di calcolo Redshift Serverless gestito creato per la risorsa del catalogo.
-
ManagedWorkgroupStatus
— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string patternLo stato di elaborazione gestita di Redshift Serverless.
-
RedshiftDatabaseName
— UTF -8 stringhe, lunghe non meno di 1 o più di 255 byte, corrispondenti a. Single-line string patternIl nome predefinito della risorsa del database Redshift nell'elaborazione gestita.
-
StatusMessage
— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string patternUn messaggio che fornisce informazioni più dettagliate sullo stato del gruppo di lavoro gestito.
-
CatalogType
— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string patternSpeciifica un tipo di catalogo federato per la risorsa di catalogo nativa. Il tipo attualmente supportato è.
aws:redshift
FederatedCatalog struttura
Un catalogo che punta a un'entità esterna al AWS Glue Data Catalog.
Campi
-
Identifier
— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 512 byte, corrispondente a. Single-line string patternUn identificatore univoco per il catalogo federato.
-
ConnectionName
— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string patternIl nome della connessione a un'origine dati esterna, ad esempio un catalogo federato con Redshift.
Operazioni
CreateCatalog azione (Python: create_catalog)
Crea un nuovo catalogo nel Data Catalog. AWS Glue
Richiesta
-
Name
— Obbligatorio: UTF -8 stringhe, di lunghezza non inferiore a 1 o più di 64 byte, corrispondente a. Custom string pattern #25Il nome del catalogo da creare.
-
CatalogInput
: obbligatorio: un oggetto CatalogInput.Un
CatalogInput
oggetto 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 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.
Un array di mappe di coppie chiave-valore, non più di 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 che assegni al catalogo.
Risposta
Nessun parametro di risposta.
Errori
InvalidInputException
AlreadyExistsException
ResourceNumberLimitExceededException
InternalServiceException
OperationTimeoutException
GlueEncryptionException
ConcurrentModificationException
AccessDeniedException
EntityNotFoundException
FederatedResourceAlreadyExistsException
FederationSourceException
UpdateCatalog azione (Python: update_catalog)
Aggiorna le proprietà di un catalogo esistente nel Data Catalog. AWS Glue
Richiesta
-
CatalogId
- Obbligatorio:: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string patternL'ID del catalogo.
-
CatalogInput
: obbligatorio: un oggetto CatalogInput.Un
CatalogInput
oggetto che specifica le nuove proprietà di un catalogo esistente.
Risposta
Nessun parametro di risposta.
Errori
EntityNotFoundException
InvalidInputException
InternalServiceException
OperationTimeoutException
GlueEncryptionException
ConcurrentModificationException
AccessDeniedException
FederationSourceException
DeleteCatalog azione (Python: delete_catalog)
Rimuove il catalogo specificato dal AWS Glue Data Catalog.
Dopo aver completato questa operazione, non è più possibile accedere ai database, alle tabelle (e a tutte le versioni e partizioni delle tabelle che potrebbero appartenere alle tabelle) e alle funzioni definite dall'utente nel catalogo eliminato. AWS Glue elimina queste risorse «orfane» in modo asincrono in modo tempestivo, a discrezione del servizio.
Per garantire l'eliminazione immediata di tutte le risorse correlate prima di richiamare l'DeleteCatalog
operazione, utilizza DeleteTableVersion
(orBatchDeleteTableVersion
), DeletePartition
(orBatchDeletePartition
), DeleteTable
(orBatchDeleteTable
) DeleteUserDefinedFunction
ed elimina tutte le risorse che appartengono DeleteDatabase
al catalogo.
Richiesta
-
CatalogId
- Obbligatorio:: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string patternL'ID del catalogo.
Risposta
Nessun parametro di risposta.
Errori
EntityNotFoundException
InvalidInputException
InternalServiceException
OperationTimeoutException
GlueEncryptionException
ConcurrentModificationException
AccessDeniedException
FederationSourceException
GetCatalog azione (Python: get_catalog)
Il nome del catalogo da recuperare. Dovrebbe essere tutto in minuscolo.
Richiesta
-
CatalogId
- Obbligatorio:: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string patternL'ID del catalogo principale in cui risiede il catalogo. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato il numero di AWS conto.
Risposta
-
Catalog
: un oggetto Catalogo.Oggetto
Catalog
. La definizione del catalogo specificato nel AWS Glue Data Catalog.
Errori
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
GlueEncryptionException
AccessDeniedException
EntityNotFoundException
FederationSourceException
FederationSourceRetryableException
GetCatalogs azione (Python: get_catalogs)
Recupera tutti i cataloghi definiti in un catalogo nel Data Catalog. AWS Glue Per un caso d'uso di un catalogo federato con Redshift, questa operazione restituisce l'elenco dei cataloghi mappati ai database Redshift nel catalogo dello spazio dei nomi Redshift.
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 principale in cui risiede il catalogo. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato il numero di AWS conto.
-
NextToken
— UTF -8 stringhe.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 specificato come true, esegue un'iterazione nell'account e restituisce tutte le risorse del catalogo (incluse le risorse di primo livello e le risorse secondarie)
Risposta
-
CatalogList
: obbligatorio: una matrice di oggetti Catalogo.Un array di oggetti
Catalog
. Un elenco diCatalog
oggetti dal catalogo principale specificato. -
NextToken
— UTF -8 stringhe.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