View a markdown version of this page

API del contesto aziendale - AWS Aderenza
 - tipi di dati -AssetFormEntryAssetTypeFormReferenceIterableFormEntryIterableFormItemIterableFormListItemSearchResultItemSearchSortSearchFilterClauseSearchAttributeFilterSearchMapFilterSearchMapFilterValueSearchFilterValueItemErrorAssetTypeItemFormTypeItemGlossaryItemGlossaryTermItemGetAssetOutputSearchAssetsOutputExportEncryptionConfigurationGetDataCatalogExportConfigurationOutputPutDataCatalogExportConfigurationOutput - operazioni -GetAsset (get_asset)PutAsset (put_asset)DeleteAsset (delete_asset)PutAssetType (put_asset_type)GetAssetType (get_asset_type)DeleteAssetType (delete_asset_type)ListAssetTypes (list_asset_types)PutFormType (put_form_type)GetFormType (get_form_type)DeleteFormType (delete_form_type)ListFormTypes (list_form_types)PutAttachment (put_attachment)DeleteAttachment (cancella_allegato)ListIterableForms (list_iterable_forms)BatchGetIterableForms (batch_get_iterable_forms)CreateGlossary (create_glossary)GetGlossary (get_glossary)UpdateGlossary (update_glossary)DeleteGlossary (delete_glossary)ListGlossaries (list_glossaries)CreateGlossaryTerm (create_glossary_term)GetGlossaryTerm (get_glossary_term)UpdateGlossaryTerm (update_glossary_term)DeleteGlossaryTerm (delete_glossary_term)ListGlossaryTerms (list_glossary_terms)AssociateGlossaryTerms (associate_glossary_terms)DisassociateGlossaryTerms (disassociate_glossary_terms)SearchAssets (search_assets)GetDataCatalogExportConfiguration (get_data_catalog_export_configuration)PutDataCatalogExportConfiguration (put_data_catalog_export_configuration)

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à.

API del contesto aziendale

L'API del contesto aziendale descrive i tipi di dati e le operazioni per la gestione delle risorse, dei tipi di risorse, dei tipi di modulo, dei glossari, dei termini del glossario, degli allegati e della ricerca nel catalogo dei dati. AWS Glue

Tipi di dati

AssetFormEntry struttura

Un modulo su una risorsa, costituito dall'identificatore del tipo di modulo e dal relativo contenuto JSON.

Campi
  • FormTypeId— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di modulo che definisce lo schema di questo modulo.

  • Content— UTF-8 stringa.

    Il contenuto JSON del modulo, conforme allo schema del tipo di modulo specificato.

AssetTypeFormReference struttura

Un riferimento a un tipo di modulo incluso in un tipo di risorsa.

Campi
  • FormTypeIdentifier Obbligatorio: UTF-8 stringa, lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di modulo a cui si fa riferimento.

IterableFormEntry struttura

Un modulo iterabile disponibile su una risorsa, identificato dal tipo di modulo.

Campi
  • FormTypeId— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di modulo del modulo iterabile (ad esempio,columns), utilizzato per recuperare i suoi elementi tramite o. ListIterableForms BatchGetIterableForms

IterableFormItem struttura

Un elemento del modulo iterabile completo con i relativi moduli.

Campi
  • ItemId— UTF-8 stringa.

    L'identificatore univoco dell'articolo.

  • ItemName— UTF-8 stringa.

    Nome dell'elemento.

  • GlossaryTerms— Una matrice di UTF-8 stringhe, non meno di 1 o più di 10 stringhe.

    Gli identificatori dei termini del glossario associati all'elemento.

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

    Ogni chiave è una stringa. UTF-8

    Ogni valore è un oggetto AssetFormEntry.

    I moduli sull'elemento, digitati in base al nome del modulo.

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

    Ogni chiave è una UTF-8 stringa.

    Ogni valore è un oggetto AssetFormEntry.

    Allegati aggiuntivi sull'elemento per un maggiore contesto, digitati in base al nome dell'allegato.

IterableFormListItem struttura

Un riepilogo di un elemento in forma iterabile.

Campi
  • ItemId— UTF-8 stringa.

    L'identificatore univoco dell'articolo.

  • ItemName— UTF-8 stringa.

    Nome dell'elemento.

  • Description— UTF-8 corda.

    La descrizione dell'articolo.

  • GlossaryTerms— Una serie di UTF-8 stringhe, non meno di 1 o più di 10 stringhe.

    Gli identificatori dei termini del glossario associati all'elemento.

SearchResultItem struttura

Un singolo elemento del risultato di ricerca che rappresenta una risorsa corrispondente.

Campi
  • Id— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa corrispondente.

  • AssetName— UTF-8 stringa.

    Il nome della risorsa corrispondente.

  • AssetDescription— UTF-8 stringa.

    La descrizione della risorsa corrispondente.

  • UpdatedAt: timestamp.

    L'indicatore temporale in cui la risorsa corrispondente è stata aggiornata l'ultima volta.

  • AssetTypeId— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di risorsa per la risorsa corrispondente.

SearchSort struttura

I criteri di ordinamento per i risultati della ricerca.

Campi
  • Attribute UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 128 byte.

    L'attributo in base al quale effettuare l'ordinamento.

  • Order— UTF-8 stringa (valori validi: ASCENDING |DESCENDING).

    L'ordinamento. I valori validi sono ASCENDING e DESCENDING.

SearchFilterClause struttura

Una clausola di filtro che supporta la logica booleana annidata. È necessario specificare esattamente uno tra andAllFiltersorAnyFilters,attributeFilter, omapFilter.

Campi
  • AndAllFilters— Una serie di SearchFilterClause oggetti, non meno di 1 o più di 10 strutture.

    Un elenco di clausole di filtro che devono corrispondere tutte (AND logico).

  • OrAnyFilters— Una serie di SearchFilterClause oggetti, non meno di 1 o più di 10 strutture.

    Un elenco di clausole di filtro in cui almeno una deve corrispondere (OR logico).

  • AttributeFilter: un oggetto SearchAttributeFilter.

    Un filtro su un singolo valore di attributo.

  • MapFilter: un oggetto SearchMapFilter.

    Un filtro sulla coppia chiave-valore di un attributo della mappa.

SearchAttributeFilter struttura

Un filtro che confronta il valore di un attributo utilizzando un operatore.

Campi
  • Attribute Obbligatorio: UTF-8 stringa lunga non meno di 1 o più di 128 byte.

    Il nome dell'attributo in base al quale filtrare.

  • Operator Obbligatorio: UTF-8 stringa (valori validi: equals greaterThan | greaterThanOrEquals | lessThan | lessThanOrEquals | |notExists).

    L'operatore di confronto. I valori validi sono equals greaterThangreaterThanOrEquals,lessThan,lessThanOrEquals, enotExists.

  • Value: un oggetto SearchFilterValue.

    Il valore con cui confrontare.

SearchMapFilter struttura

Un filtro sulla coppia chiave-valore di un attributo della mappa.

Campi
  • Attribute UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 128 byte.

    Il nome dell'attributo della mappa su cui filtrare.

  • Key Obbligatorio: UTF-8 stringa, lunga non meno di 1 o più di 128 byte.

    La chiave all'interno dell'attributo della mappa su cui filtrare.

  • Value - obbligatorio: un oggetto SearchMapFilterValue.

    Il valore con cui confrontare.

SearchMapFilterValue struttura

Un valore del filtro della mappa. Attualmente supporta solo il confronto tra stringhe.

Campi
  • StringValue— UTF-8 stringa lunga non più di 256 byte.

    Un valore di filtro a forma di stringa.

SearchFilterValue struttura

Un valore di filtro. Esattamente uno dei due stringValue o longValue deve essere specificato.

Campi
  • StringValue— UTF-8 stringa lunga non più di 256 byte.

    Un valore di filtro a forma di stringa.

  • LongValue: numero (lungo).

    Un valore di filtro intero lungo.

ItemError struttura

Un errore che si è verificato durante il recupero di un elemento del modulo iterabile.

Campi
  • ItemIdentifier— UTF-8 stringa lunga non meno di 1 o più di 1087 byte.

    L'identificatore dell'elemento che ha causato l'errore.

  • Code— UTF-8 stringa.

    Il codice di errore.

  • Message— UTF-8 corda.

    Messaggio di errore.

AssetTypeItem struttura

Un riepilogo di un tipo di asset.

Campi
  • Id— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di risorsa.

  • Name— UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #75

    Il nome del tipo di risorsa.

FormTypeItem struttura

Un riepilogo di un tipo di modulo.

Campi
  • Id— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di modulo.

  • Name— UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #77

    Il nome del tipo di modulo.

GlossaryItem struttura

Un riepilogo di un glossario aziendale.

Campi
  • Id— UTF-8 stringa.

    L'identificatore univoco del glossario.

  • Name— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    Il nome del glossario.

  • Description— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 2048 byte.

    La descrizione del glossario.

GlossaryTermItem struttura

Un riassunto di un termine del glossario.

Campi
  • Id— UTF-8 stringa.

    L'identificatore univoco del termine del glossario.

  • Name— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    Il nome del termine del glossario.

  • ShortDescription— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 1024 byte.

    Breve descrizione del termine del glossario.

GetAssetOutput struttura

I metadati delle risorse restituiti dall'GetAssetoperazione.

Campi
  • Id Obbligatorio: UTF-8 stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa.

  • Name— UTF-8 stringa.

    Il nome della risorsa.

  • Description— UTF-8 stringa.

    La descrizione della risorsa.

  • CreatedAt: timestamp.

    Il timestamp in cui è stata creata la risorsa.

  • UpdatedAt: timestamp.

    Il timestamp in cui la risorsa è stata aggiornata l'ultima volta.

  • AssetTypeId UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di risorsa per questa risorsa.

  • GlossaryTerms— Una serie di UTF-8 stringhe, non meno di 1 o più di 10 stringhe.

    Gli identificatori dei termini del glossario associati alla risorsa.

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

    Ogni chiave è una stringa. UTF-8

    Ogni valore è un oggetto AssetFormEntry.

    I moduli sulla risorsa, digitati in base al nome del modulo.

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

    Ogni chiave è una UTF-8 stringa.

    Ogni valore è un oggetto AssetFormEntry.

    Allegati aggiuntivi sulla risorsa per un maggiore contesto, digitati in base al nome dell'allegato.

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

    Ogni chiave è una UTF-8 stringa.

    Ogni valore è un oggetto IterableFormEntry.

    I moduli iterabili disponibili sulla risorsa, digitati in base al nome del modulo (ad esempio,columns). Usa il nome del modulo con ListIterableForms o BatchGetIterableForms per recuperare gli elementi del modulo.

SearchAssetsOutput struttura

I risultati della ricerca restituiti dall'SearchAssetsoperazione.

Campi
  • Items: una matrice di oggetti SearchResultItem.

    L'elenco delle risorse che corrispondono ai criteri di ricerca.

  • NextToken— UTF-8 stringa.

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

ExportEncryptionConfiguration struttura

La configurazione di crittografia per i metadati del catalogo di dati esportati.

Campi
  • SseAlgorithm— stringa. UTF-8

    L'algoritmo di crittografia lato server utilizzato per i dati esportati. I valori validi sono AES256 e aws:kms.

  • KmsKeyArn— UTF-8 stringa, corrispondente a. Custom string pattern #72

    L'ARN della chiave KMS utilizzata per crittografare i dati esportati.

GetDataCatalogExportConfigurationOutput struttura

La configurazione di esportazione restituita dall'GetDataCatalogExportConfigurationoperazione.

Campi
  • ExportSetting— UTF-8 stringa (valori validi: ENABLED |DISABLED).

    L'impostazione di esportazione per il catalogo dati. I valori validi sono ENABLED e DISABLED.

  • Status— UTF-8 stringa (valori validi: ENABLING | ENABLED | DISABLING | DISABLED |FAILED).

    Lo stato attuale dell'esportazione. I valori validi sono ENABLING, ENABLED, DISABLING, DISABLED e FAILED.

  • EncryptionConfiguration: un oggetto ExportEncryptionConfiguration.

    La configurazione di crittografia per i dati esportati.

  • S3TableBucketArn— UTF-8 stringa.

    L'ARN del bucket S3 Tables in cui vengono esportati i metadati del catalogo.

  • CreatedAt: timestamp.

    Il timestamp in cui è stata creata la configurazione di esportazione.

  • UpdatedAt: timestamp.

    Il timestamp in cui la configurazione di esportazione è stata aggiornata l'ultima volta.

PutDataCatalogExportConfigurationOutput struttura

La configurazione di esportazione restituita dall'PutDataCatalogExportConfigurationoperazione.

Campi
  • ExportSetting— UTF-8 stringa (valori validi: ENABLED |DISABLED).

    L'impostazione di esportazione per il catalogo dati.

  • EncryptionConfiguration: un oggetto ExportEncryptionConfiguration.

    La configurazione di crittografia per i dati esportati.

Operazioni

GetAsset azione (Python: get_asset)

Recupera i metadati di una risorsa in AWS Glue Data Catalog, inclusi i relativi moduli, gli allegati aggiuntivi e i termini del glossario associati.

Esempio

L'esempio seguente recupera una risorsa in base al relativo identificatore.

aws glue get-asset --identifier quarterly-sales-2026q1 { "Id": "quarterly-sales-2026q1", "Name": "Quarterly Sales 2026 Q1", "Description": "Aggregated quarterly sales metrics", "CreatedAt": "2026-06-16T06:42:00.442Z", "AssetTypeId": "DataSet", "GlossaryTerms": [], "Forms": { "DataClassification": { "FormTypeId": "DataClassification", "Content": "{\"classification\":\"internal\",\"owner\":\"data-platform-team\"}" } }, "Attachments": {}, "IterableForms": {} }
Richiesta
  • Identifier UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa da recuperare.

Risposta

I metadati della risorsa restituiti dall'operazione. GetAsset

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • ThrottlingException

  • InvalidInputException

PutAsset azione (Python: put_asset)

Crea o aggiorna una risorsa in AWS Glue Data Catalog. Se la risorsa esiste già, questa operazione la aggiorna; in caso contrario, viene creata una nuova risorsa.

Esempio

L'esempio seguente crea una risorsa con un modulo.

aws glue put-asset \ --asset-type-id DataSet \ --identifier quarterly-sales-2026q1 \ --name "Quarterly Sales 2026 Q1" \ --description "Aggregated quarterly sales metrics" \ --forms '{"DataClassification":{"FormTypeId":"DataClassification","Content":"{\"classification\":\"internal\",\"owner\":\"data-platform-team\"}"}}' { "Id": "quarterly-sales-2026q1", "Name": "Quarterly Sales 2026 Q1", "Description": "Aggregated quarterly sales metrics", "CreatedAt": "2026-06-16T06:42:00.442Z", "Forms": { "DataClassification": { "FormTypeId": "DataClassification", "Content": "{\"classification\":\"internal\",\"owner\":\"data-platform-team\"}" } } }
Richiesta
  • AssetTypeId UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di risorsa per la risorsa.

  • Identifier Obbligatorio: UTF-8 stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa. Se esiste già una risorsa con questo identificatore, viene aggiornata.

  • Name Obbligatorio: UTF-8 stringa.

    Il nome della risorsa.

  • Description— UTF-8 stringa.

    La descrizione della risorsa.

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

    Ogni chiave è una UTF-8 stringa.

    Ogni valore è un oggetto AssetFormEntry.

    I moduli da impostare sulla risorsa, digitati in base al nome del modulo. Ogni voce specifica il tipo di modulo e il relativo contenuto JSON.

  • ClientToken— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

    Un identificatore univoco (con distinzione tra maiuscole e minuscole) che fornisci per assicurare l'idempotenza della richiesta.

Risposta
  • Id UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa.

  • Name Obbligatorio: UTF-8 stringa.

    Il nome della risorsa.

  • Description— UTF-8 stringa.

    La descrizione della risorsa.

  • CreatedAt: timestamp.

    Il timestamp in cui è stata creata la risorsa.

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

    Ogni chiave è una UTF-8 stringa.

    Ogni valore è un oggetto AssetFormEntry.

    I moduli allegati alla risorsa, digitati in base al nome del modulo.

Errori
  • AccessDeniedException

  • ConcurrentModificationException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

DeleteAsset azione (Python: delete_asset)

Elimina una risorsa da Data Catalog. AWS Glue

Esempio

L'esempio seguente elimina una risorsa in base al relativo identificatore.

aws glue delete-asset --identifier quarterly-sales-2026q1
Richiesta
  • Identifier UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa da eliminare.

Risposta
  • Nessun parametro di risposta.

Errori
  • AccessDeniedException

  • ConcurrentModificationException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

PutAssetType azione (Python: put_asset_type)

Crea o aggiorna un tipo di risorsa in Data Catalog. AWS Glue Un tipo di risorsa definisce la struttura delle risorse specificando i moduli che includono. Se esiste già un tipo di asset con il nome specificato, viene aggiornato.

Esempio

L'esempio seguente crea un tipo di risorsa che fa riferimento a un tipo di modulo.

aws glue put-asset-type \ --name DataSet \ --forms '{"DataClassification":{"FormTypeIdentifier":"DataClassification"}}' { "Id": "DataSet", "Name": "DataSet", "Forms": { "DataClassification": { "FormTypeIdentifier": "DataClassification" } } }
Richiesta
  • Name UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #75

    Il nome del tipo di risorsa.

  • Forms Obbligatorio: un array di mappe di coppie chiave-valore, non meno di 1 o più di 100 coppie.

    Ogni chiave è una UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #75

    Ogni valore è un oggetto AssetTypeFormReference.

    I moduli che costituiscono il tipo di risorsa, digitati in base al nome del modulo. Ogni voce fa riferimento al tipo di modulo che definisce lo schema del modulo.

  • ClientToken— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

    Un identificatore univoco (con distinzione tra maiuscole e minuscole) che fornisci per assicurare l'idempotenza della richiesta.

Risposta
  • Id— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 256 byte.

    L'identificatore del tipo di risorsa.

  • Name— UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #75

    Il nome del tipo di risorsa.

  • Forms— Una matrice cartografica di coppie chiave-valore, non meno di 1 o più di 100 coppie.

    Ogni chiave è una UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #75

    Ogni valore è un oggetto AssetTypeFormReference.

    I moduli che costituiscono il tipo di risorsa, digitati in base al nome del modulo.

Errori
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • EntityNotFoundException

  • ConcurrentModificationException

  • ThrottlingException

GetAssetType azione (Python: get_asset_type)

Recupera un tipo di asset in Data Catalog in AWS Glue base al relativo identificatore.

Esempio

L'esempio seguente recupera un tipo di risorsa in base al relativo identificatore.

aws glue get-asset-type --identifier DataSet { "Id": "DataSet", "Name": "DataSet", "Forms": { "DataClassification": { "FormTypeIdentifier": "DataClassification" } } }
Richiesta
  • Identifier UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di risorsa da recuperare.

Risposta
  • Id— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di risorsa.

  • Name— UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #75

    Il nome del tipo di risorsa.

  • Forms— Una matrice cartografica di coppie chiave-valore, non meno di 1 o più di 100 coppie.

    Ogni chiave è una UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #75

    Ogni valore è un oggetto AssetTypeFormReference.

    I moduli che costituiscono il tipo di risorsa, digitati in base al nome del modulo.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

DeleteAssetType azione (Python: delete_asset_type)

Elimina un tipo di risorsa da Data Catalog. AWS Glue

Esempio

L'esempio seguente elimina un tipo di risorsa in base al relativo identificatore.

aws glue delete-asset-type --identifier DataSet
Richiesta
  • Identifier UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di risorsa da eliminare.

Risposta
  • Nessun parametro di risposta.

Errori
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

ListAssetTypes azione (Python: list_asset_types)

Elenca i tipi di asset definiti in Data Catalog. AWS Glue

Esempio

L'esempio seguente elenca i tipi di asset nell'account.

aws glue list-asset-types --max-results 20 { "Items": [ { "Id": "DataSet", "Name": "DataSet" } ] }
Richiesta
  • MaxResults: numero (intero), non inferiore a 1 o superiore a 1.000.

    Il numero massimo di risultati da restituire nella risposta.

  • NextToken— UTF-8 stringa.

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

Risposta
  • Items: una matrice di oggetti AssetTypeItem.

    L'elenco degli elementi del tipo di risorsa.

  • NextToken— UTF-8 stringa.

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

Errori
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

PutFormType azione (Python: put_form_type)

Crea o aggiorna un tipo di modulo in Data Catalog. AWS Glue Un tipo di modulo definisce lo schema per i metadati strutturati che possono essere allegati alle risorse.

Esempio

L'esempio seguente crea un tipo di modulo con uno schema Smithy.

aws glue put-form-type \ --name DataClassification \ --schema 'structure DataClassification { classification: String owner: String }' { "Id": "DataClassification", "Name": "DataClassification", "Schema": "structure DataClassification {\n classification: String\n owner: String\n}" }
Richiesta
  • Name UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #77

    Il nome del tipo di modulo. Deve iniziare con una lettera maiuscola.

  • Schema UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 100000 byte.

    La definizione dello schema IDL di Smithy per il tipo di modulo.

  • ClientToken— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

    Un identificatore univoco (con distinzione tra maiuscole e minuscole) che fornisci per assicurare l'idempotenza della richiesta.

Risposta
  • Id— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 256 byte.

    L'identificatore del tipo di modulo.

  • Name— UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #77

    Il nome del tipo di modulo.

  • Schema— UTF-8 stringa lunga non meno di 1 o più di 100000 byte.

    Lo schema IDL di Smithy del tipo di modulo.

Errori
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

GetFormType azione (Python: get_form_type)

Recupera un tipo di modulo in AWS Glue Data Catalog in base al relativo identificatore.

Esempio

L'esempio seguente recupera un tipo di modulo in base al relativo identificatore.

aws glue get-form-type --identifier DataClassification { "Id": "DataClassification", "Name": "DataClassification", "Schema": "structure DataClassification {\n classification: String\n owner: String\n}" }
Richiesta
  • Identifier UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di modulo da recuperare.

Risposta
  • Id— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di modulo.

  • Name— UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #77

    Il nome del tipo di modulo.

  • Schema— UTF-8 stringa lunga non meno di 1 o più di 100000 byte.

    Lo schema IDL di Smithy del tipo di modulo.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

DeleteFormType azione (Python: delete_form_type)

Elimina un tipo di modulo da Data Catalog. AWS Glue Un tipo di modulo non può essere eliminato se è ancora referenziato da un tipo di risorsa.

Esempio

L'esempio seguente elimina un tipo di modulo tramite il relativo identificatore.

aws glue delete-form-type --identifier DataClassification
Richiesta
  • Identifier UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di modulo da eliminare.

Risposta
  • Nessun parametro di risposta.

Errori
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ConflictException

  • ThrottlingException

ListFormTypes azione (Python: list_form_types)

Elenca i tipi di modulo definiti in Data Catalog. AWS Glue

Esempio

L'esempio seguente elenca i tipi di modulo nell'account.

aws glue list-form-types --max-results 20 { "Items": [ { "Id": "DataClassification", "Name": "DataClassification" } ] }
Richiesta
  • MaxResults: numero (intero), non inferiore a 1 o superiore a 1.000.

    Il numero massimo di risultati da restituire nella risposta.

  • NextToken— UTF-8 stringa.

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

Risposta
  • Items - obbligatorio: una matrice di oggetti FormTypeItem.

    L'elenco degli elementi del tipo di modulo.

  • NextToken— UTF-8 corda.

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

Errori
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

PutAttachment azione (Python: put_attachment)

Allega un modulo a una risorsa o a un elemento del modulo iterabile in Data Catalog. AWS Glue Se esiste già un allegato con lo stesso nome, viene sovrascritto.

Esempio

L'esempio seguente allega un modulo a una risorsa.

aws glue put-attachment \ --asset-identifier quarterly-sales-2026q1 \ --attachment-name reviewNote \ --form-type-id DataClassification \ --content '{"classification":"internal","owner":"analytics-team"}' { "AssetIdentifier": "quarterly-sales-2026q1", "AttachmentName": "reviewNote", "FormTypeId": "DataClassification" }
Richiesta
  • AssetIdentifier UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa a cui allegare il modulo.

  • IterableFormName— UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #73

    Il nome del modulo iterabile. Se specificato insieme aitemIdentifier, l'allegato è destinato a un elemento all'interno del modulo iterabile anziché alla risorsa stessa.

  • ItemIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte.

    L'identificatore dell'elemento all'interno del modulo iterabile. Opzione obbligatoria quando specifichi iterableFormName.

  • AttachmentName Obbligatorio: UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #76

    Il nome dell'allegato.

  • Content Obbligatorio: UTF-8 stringa.

    Il contenuto JSON del modulo, conforme allo schema del tipo di modulo specificato.

  • FormTypeId Obbligatorio: UTF-8 stringa, lunga non meno di 1 o più di 256 byte.

    L'identificatore del tipo di modulo per questo allegato.

  • ClientToken— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

    Un identificatore univoco (con distinzione tra maiuscole e minuscole) che fornisci per assicurare l'idempotenza della richiesta.

Risposta
  • AssetIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa.

  • IterableFormName— UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #73

    Il nome del modulo iterabile, se l'allegato è destinato a un elemento.

  • ItemIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte.

    L'identificatore dell'elemento all'interno del modulo iterabile, se applicabile.

  • AttachmentName— UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #76

    Il nome dell'allegato.

  • FormTypeId— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 256 byte.

    L'identificatore del tipo di modulo per questo allegato.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

DeleteAttachment azione (Python: delete_attachment)

Elimina un allegato al modulo da una risorsa in Data Catalog. AWS Glue

Esempio

L'esempio seguente elimina un allegato da una risorsa.

aws glue delete-attachment \ --asset-identifier quarterly-sales-2026q1 \ --attachment-name reviewNote { "AssetIdentifier": "quarterly-sales-2026q1" }
Richiesta
  • AssetIdentifier UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa da cui eliminare l'allegato.

  • IterableFormName— UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #73

    Il nome del modulo iterabile. Se specificato insieme aitemIdentifier, l'allegato viene eliminato da un elemento all'interno del modulo iterabile anziché dalla risorsa stessa.

  • ItemIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte.

    L'identificatore dell'elemento all'interno del modulo iterabile. Opzione obbligatoria quando specifichi iterableFormName.

  • AttachmentName Obbligatorio: UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #76

    Il nome dell'allegato da eliminare.

Risposta
  • AssetIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa.

  • IterableFormName— UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #73

    Il nome del modulo iterabile, se l'eliminazione riguarda un elemento.

  • ItemIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte.

    L'identificatore dell'elemento all'interno del modulo iterabile, se applicabile.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

ListIterableForms azione (Python: list_iterable_forms)

Elenca gli elementi in forma iterabile su una risorsa in Data Catalog. AWS Glue Ad esempio, elenca le colonne di una risorsa della tabella.

Esempio

L'esempio seguente elenca le colonne di una risorsa.

aws glue list-iterable-forms \ --asset-identifier quarterly-sales-2026q1 \ --iterable-form-name columns \ --max-results 20 { "AssetId": "quarterly-sales-2026q1", "IterableFormName": "columns", "Items": [ { "ItemId": "quarterly-sales-2026q1#region", "ItemName": "region", "Description": "AWS region of the sales record", "GlossaryTerms": [] }, { "ItemId": "quarterly-sales-2026q1#amount", "ItemName": "amount", "Description": "Sales amount in USD", "GlossaryTerms": [] } ] }
Richiesta
  • AssetIdentifier UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 1087 byte, corrispondente al. Custom string pattern #69

    L'identificatore univoco della risorsa.

  • IterableFormName Obbligatorio: UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #73

    Il nome del modulo iterabile da cui elencare gli elementi.

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

    Il numero massimo di risultati da restituire nella risposta.

  • NextToken— UTF-8 stringa.

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

Risposta
  • AssetId— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa.

  • IterableFormName— UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #73

    Il nome del modulo iterabile.

  • Items: una matrice di oggetti IterableFormListItem.

    L'elenco degli elementi del modulo iterabili.

  • NextToken— UTF-8 stringa.

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

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • ThrottlingException

  • InvalidInputException

BatchGetIterableForms azione (Python: batch_get_iterable_forms)

Recupera più elementi da un modulo iterabile su una risorsa in Data Catalog in un'unica richiesta. AWS Glue

Esempio

L'esempio seguente recupera colonne specifiche in base all'identificatore.

aws glue batch-get-iterable-forms \ --asset-identifier quarterly-sales-2026q1 \ --iterable-form-name columns \ --item-identifiers region amount { "Items": [ { "ItemId": "quarterly-sales-2026q1#region", "ItemName": "region", "GlossaryTerms": [], "Forms": { "columns": { "FormTypeId": "amazon.glue::Column", "Content": "{\"type\":\"string\"}" } }, "Attachments": {} }, { "ItemId": "quarterly-sales-2026q1#amount", "ItemName": "amount", "GlossaryTerms": [], "Forms": { "columns": { "FormTypeId": "amazon.glue::Column", "Content": "{\"type\":\"double\"}" } }, "Attachments": {} } ], "Errors": [] }
Richiesta
  • AssetIdentifier UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa.

  • IterableFormName Obbligatorio: UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #73

    Il nome del modulo iterabile da cui recuperare gli elementi.

  • ItemIdentifiers Obbligatorio: un array di UTF-8 stringhe, non meno di 1 o più di 100 stringhe.

    L'elenco degli identificatori degli elementi da recuperare. Ogni identificatore può essere un ID o un nome di elemento.

Risposta
  • Items: una matrice di oggetti IterableFormItem.

    L'elenco degli elementi del modulo iterabili recuperati.

  • Errors: una matrice di oggetti ItemError.

    L'elenco degli errori per gli elementi che non è stato possibile recuperare.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

CreateGlossary azione (Python: create_glossary)

Crea un glossario aziendale in Data Catalog. AWS Glue Un glossario è un contenitore di termini del glossario che definiscono concetti aziendali.

Esempio

L'esempio seguente crea un glossario aziendale.

aws glue create-glossary \ --name "Sales Terms" \ --description "Glossary of sales-domain business terms" { "Id": "6n5f21s641nbjb", "Name": "Sales Terms", "Description": "Glossary of sales-domain business terms" }
Richiesta
  • Name UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 256 byte.

    Il nome del glossario.

  • Description— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 2048 byte.

    La descrizione del glossario.

  • ClientToken— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

    Un identificatore univoco (con distinzione tra maiuscole e minuscole) che fornisci per assicurare l'idempotenza della richiesta.

Risposta
  • Id— UTF-8 stringa.

    L'identificatore univoco del glossario.

  • Name— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    Il nome del glossario.

  • Description— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 2048 byte.

    La descrizione del glossario.

Errori
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

  • AlreadyExistsException

GetGlossary azione (Python: get_glossary)

Recupera un glossario aziendale in AWS Glue Data Catalog in base al relativo identificatore.

Esempio

L'esempio seguente recupera un glossario in base al relativo identificatore.

aws glue get-glossary --identifier 6n5f21s641nbjb { "Id": "6n5f21s641nbjb", "Name": "Sales Terms", "Description": "Glossary of sales-domain business terms" }
Richiesta
  • Identifier Obbligatorio: stringa. UTF-8

    L'identificatore univoco del glossario da recuperare.

Risposta
  • Id— stringa. UTF-8

    L'identificatore univoco del glossario.

  • Name— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    Il nome del glossario.

  • Description— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 2048 byte.

    La descrizione del glossario.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • ThrottlingException

UpdateGlossary azione (Python: update_glossary)

Aggiorna un glossario aziendale in Data Catalog. AWS Glue

Esempio

L'esempio seguente aggiorna la descrizione di un glossario.

aws glue update-glossary \ --identifier 6n5f21s641nbjb \ --name "Sales Terms" \ --description "Glossary of sales and revenue business terms" { "Id": "6n5f21s641nbjb", "Name": "Sales Terms", "Description": "Glossary of sales and revenue business terms" }
Richiesta
  • Identifier Obbligatorio: UTF-8 stringa.

    L'identificatore univoco del glossario da aggiornare.

  • Name— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    Il nome aggiornato del glossario.

  • Description— UTF-8 stringa lunga non meno di 1 o più di 2048 byte.

    La descrizione aggiornata del glossario.

  • ClientToken— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente al. Single-line string pattern

    Un identificatore univoco (con distinzione tra maiuscole e minuscole) che fornisci per assicurare l'idempotenza della richiesta.

Risposta
  • Id— UTF-8 stringa.

    L'identificatore univoco del glossario.

  • Name— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    Il nome del glossario.

  • Description— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 2048 byte.

    La descrizione del glossario.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

  • AlreadyExistsException

DeleteGlossary azione (Python: delete_glossary)

Elimina un glossario aziendale da Data Catalog. AWS Glue Un glossario non può essere eliminato se contiene ancora termini del glossario.

Esempio

L'esempio seguente elimina un glossario in base al relativo identificatore.

aws glue delete-glossary --identifier 6n5f21s641nbjb
Richiesta
  • Identifier Obbligatorio: stringa. UTF-8

    L'identificatore univoco del glossario da eliminare.

Risposta
  • Nessun parametro di risposta.

Errori
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConflictException

  • ConcurrentModificationException

  • ThrottlingException

ListGlossaries azione (Python: list_glossaries)

Elenca i glossari aziendali in Data Catalog. AWS Glue

Esempio

L'esempio seguente elenca i glossari dell'account.

aws glue list-glossaries --max-results 20 { "Items": [ { "Id": "6n5f21s641nbjb", "Name": "Sales Terms", "Description": "Glossary of sales and revenue business terms" } ] }
Richiesta
  • MaxResults: numero (intero), non inferiore a 1 o superiore a 1.000.

    Il numero massimo di risultati da restituire nella risposta.

  • NextToken— UTF-8 stringa.

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

Risposta
  • Items: una matrice di oggetti GlossaryItem.

    L'elenco degli elementi del glossario.

  • NextToken— UTF-8 stringa.

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

Errori
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

CreateGlossaryTerm azione (Python: create_glossary_term)

Crea un termine di glossario all'interno di un glossario aziendale in Data Catalog. AWS Glue

Esempio

L'esempio seguente crea un termine del glossario.

aws glue create-glossary-term \ --glossary-identifier 6n5f21s641nbjb \ --name "Net Revenue" \ --short-description "Revenue after returns, allowances, and discounts." \ --long-description "Net revenue is gross revenue minus returns, allowances, and discounts over a reporting period." { "Id": "avugvxvsul6izr", "GlossaryId": "6n5f21s641nbjb", "Name": "Net Revenue", "ShortDescription": "Revenue after returns, allowances, and discounts.", "LongDescription": "Net revenue is gross revenue minus returns, allowances, and discounts over a reporting period." }
Richiesta
  • GlossaryIdentifier Obbligatorio: UTF-8 stringa.

    L'identificatore univoco del glossario in cui creare il termine.

  • Name Obbligatorio: UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    Il nome del termine del glossario.

  • ShortDescription— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 1024 byte.

    Una breve descrizione del termine del glossario.

  • LongDescription— UTF-8 stringa lunga non meno di 1 o più di 4096 byte.

    Una lunga descrizione del termine del glossario.

  • ClientToken— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente al. Single-line string pattern

    Un identificatore univoco (con distinzione tra maiuscole e minuscole) che fornisci per assicurare l'idempotenza della richiesta.

Risposta
  • Id— UTF-8 stringa.

    L'identificatore univoco del termine del glossario.

  • GlossaryId— stringa UTF-8 .

    L'identificatore univoco del glossario contenente questo termine.

  • Name— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    Il nome del termine del glossario.

  • ShortDescription— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 1024 byte.

    Breve descrizione del termine del glossario.

  • LongDescription— UTF-8 stringa lunga non meno di 1 o più di 4096 byte.

    La descrizione estesa del termine del glossario.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

  • AlreadyExistsException

GetGlossaryTerm azione (Python: get_glossary_term)

Recupera un termine del glossario in Data Catalog in base al relativo identificatore. AWS Glue

Esempio

L'esempio seguente recupera un termine del glossario in base al relativo identificatore.

aws glue get-glossary-term --identifier avugvxvsul6izr { "Id": "avugvxvsul6izr", "GlossaryId": "6n5f21s641nbjb", "Name": "Net Revenue", "ShortDescription": "Revenue after returns, allowances, and discounts.", "LongDescription": "Net revenue is gross revenue minus returns, allowances, and discounts over a reporting period." }
Richiesta
  • Identifier Obbligatorio: stringa. UTF-8

    L'identificatore univoco del termine del glossario da recuperare.

Risposta
  • Id— stringa. UTF-8

    L'identificatore univoco del termine del glossario.

  • GlossaryId— stringa UTF-8 .

    L'identificatore univoco del glossario contenente questo termine.

  • Name— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    Il nome del termine del glossario.

  • ShortDescription— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 1024 byte.

    Breve descrizione del termine del glossario.

  • LongDescription— UTF-8 stringa lunga non meno di 1 o più di 4096 byte.

    La descrizione estesa del termine del glossario.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • ThrottlingException

UpdateGlossaryTerm azione (Python: update_glossary_term)

Aggiorna un termine del glossario in Data Catalog. AWS Glue

Esempio

L'esempio seguente aggiorna la breve descrizione di un termine del glossario.

aws glue update-glossary-term \ --identifier avugvxvsul6izr \ --name "Net Revenue" \ --short-description "Gross revenue minus returns, allowances, and discounts." \ --long-description "Net revenue is gross revenue minus returns, allowances, and discounts over a reporting period." { "Id": "avugvxvsul6izr", "GlossaryId": "6n5f21s641nbjb", "Name": "Net Revenue", "ShortDescription": "Gross revenue minus returns, allowances, and discounts.", "LongDescription": "Net revenue is gross revenue minus returns, allowances, and discounts over a reporting period." }
Richiesta
  • Identifier Obbligatorio: UTF-8 stringa.

    L'identificatore univoco del termine del glossario da aggiornare.

  • Name— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    Il nome aggiornato del termine del glossario.

  • ShortDescription— UTF-8 stringa lunga non meno di 1 o più di 1024 byte.

    Breve descrizione aggiornata del termine del glossario.

  • LongDescription— UTF-8 stringa lunga non meno di 1 o più di 4096 byte.

    La descrizione estesa aggiornata del termine del glossario.

  • ClientToken— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente al. Single-line string pattern

    Un identificatore univoco (con distinzione tra maiuscole e minuscole) che fornisci per assicurare l'idempotenza della richiesta.

Risposta
  • Id— UTF-8 stringa.

    L'identificatore univoco del termine del glossario.

  • GlossaryId— stringa UTF-8 .

    L'identificatore univoco del glossario contenente questo termine.

  • Name— UTF-8 stringa lunga non meno di 1 o più di 256 byte.

    Il nome del termine del glossario.

  • ShortDescription— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 1024 byte.

    Breve descrizione del termine del glossario.

  • LongDescription— UTF-8 stringa lunga non meno di 1 o più di 4096 byte.

    La descrizione estesa del termine del glossario.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

  • AlreadyExistsException

DeleteGlossaryTerm azione (Python: delete_glossary_term)

Elimina un termine del glossario da Data Catalog. AWS Glue

Esempio

L'esempio seguente elimina un termine del glossario in base al relativo identificatore.

aws glue delete-glossary-term --identifier avugvxvsul6izr
Richiesta
  • Identifier Obbligatorio: stringa. UTF-8

    L'identificatore univoco del termine del glossario da eliminare.

Risposta
  • Nessun parametro di risposta.

Errori
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

ListGlossaryTerms azione (Python: list_glossary_terms)

Elenca i termini del glossario all'interno di un glossario aziendale in Data Catalog. AWS Glue

Esempio

L'esempio seguente elenca i termini di un glossario.

aws glue list-glossary-terms \ --glossary-identifier 6n5f21s641nbjb \ --max-results 20 { "Items": [ { "Id": "avugvxvsul6izr", "Name": "Net Revenue", "ShortDescription": "Gross revenue minus returns, allowances, and discounts." } ] }
Richiesta
  • GlossaryIdentifier Obbligatorio: UTF-8 stringa.

    L'identificatore univoco del glossario di cui elencare i termini.

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

    Il numero massimo di risultati da restituire nella risposta.

  • NextToken— UTF-8 stringa.

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

Risposta
  • GlossaryId— UTF-8 corda.

    L'identificatore univoco del glossario.

  • Items: una matrice di oggetti GlossaryTermItem.

    L'elenco dei termini del glossario.

  • NextToken— UTF-8 stringa.

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

Errori
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

AssociateGlossaryTerms azione (Python: associate_glossary_terms)

Associa uno o più termini del glossario a una risorsa in Data Catalog. AWS Glue

Esempio

L'esempio seguente associa un termine del glossario a una risorsa.

aws glue associate-glossary-terms \ --asset-identifier quarterly-sales-2026q1 \ --glossary-term-identifiers avugvxvsul6izr { "AssetIdentifier": "quarterly-sales-2026q1", "GlossaryTerms": [ "avugvxvsul6izr" ] }
Richiesta
  • AssetIdentifier UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa a cui associare i termini del glossario.

  • IterableFormName— UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #73

    Il nome del modulo iterabile. Se specificati insieme aitemIdentifier, i termini del glossario sono associati a un elemento all'interno del modulo iterabile anziché alla risorsa stessa.

  • ItemIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte.

    L'identificatore dell'elemento all'interno del modulo iterabile. Opzione obbligatoria quando specifichi iterableFormName.

  • GlossaryTermIdentifiers Obbligatorio: un array di UTF-8 stringhe, non meno di 1 o più di 10 stringhe.

    L'elenco degli identificatori dei termini del glossario da associare alla risorsa.

  • ClientToken— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

    Un identificatore univoco (con distinzione tra maiuscole e minuscole) che fornisci per assicurare l'idempotenza della richiesta.

Risposta
  • AssetIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa.

  • IterableFormName— UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #73

    Il nome del modulo iterabile, se l'associazione è indirizzata a un elemento.

  • ItemIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte.

    L'identificatore dell'elemento all'interno del modulo iterabile, se applicabile.

  • GlossaryTerms— Una matrice di UTF-8 stringhe, non meno di 1 o più di 10 stringhe.

    I termini del glossario ora associati alla risorsa.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

DisassociateGlossaryTerms azione (Python: disassociate_glossary_terms)

Rimuove l'associazione di uno o più termini del glossario da una risorsa in Data Catalog. AWS Glue

Esempio

L'esempio seguente rimuove un termine del glossario da una risorsa.

aws glue disassociate-glossary-terms \ --asset-identifier quarterly-sales-2026q1 \ --glossary-term-identifiers avugvxvsul6izr { "AssetIdentifier": "quarterly-sales-2026q1", "GlossaryTerms": [] }
Richiesta
  • AssetIdentifier UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 1087 byte, corrispondente al. Custom string pattern #69

    L'identificatore univoco della risorsa da cui dissociare i termini del glossario.

  • IterableFormName— UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #73

    Il nome del modulo iterabile. Se specificati insieme aitemIdentifier, i termini del glossario vengono dissociati da un elemento all'interno del modulo iterabile anziché dalla risorsa stessa.

  • ItemIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte.

    L'identificatore dell'elemento all'interno del modulo iterabile. Opzione obbligatoria quando specifichi iterableFormName.

  • GlossaryTermIdentifiers Obbligatorio: un array di UTF-8 stringhe, non meno di 1 o più di 10 stringhe.

    L'elenco degli identificatori dei termini del glossario da dissociare dalla risorsa.

  • ClientToken— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

    Un identificatore univoco (con distinzione tra maiuscole e minuscole) che fornisci per assicurare l'idempotenza della richiesta.

Risposta
  • AssetIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte, corrispondente a. Custom string pattern #69

    L'identificatore univoco della risorsa.

  • IterableFormName— UTF-8 stringa, lunga non meno di 1 o più di 256 byte, corrispondente a. Custom string pattern #73

    Il nome del modulo iterabile, se la dissociazione ha come obiettivo un elemento.

  • ItemIdentifier— UTF-8 stringa, lunga non meno di 1 o più di 1087 byte.

    L'identificatore dell'elemento all'interno del modulo iterabile, se applicabile.

  • GlossaryTerms— Una matrice di UTF-8 stringhe, non meno di 1 o più di 10 stringhe.

    I restanti termini del glossario associati alla risorsa.

Errori
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

SearchAssets azione (Python: search_assets)

Cerca le risorse in AWS Glue Data Catalog utilizzando la ricerca completa, i filtri, l'ordinamento e le aggregazioni. Restituisce le risorse corrispondenti con risultati classificati in base alla pertinenza.

Esempio

L'esempio seguente esegue una ricerca completa per le risorse.

aws glue search-assets --search-text "sales" --max-results 10 { "Items": [ { "Id": "quarterly-sales-2026q1", "AssetName": "Quarterly Sales 2026 Q1", "AssetDescription": "Aggregated quarterly sales metrics", "UpdatedAt": "2026-06-16T06:42:00.442Z", "AssetTypeId": "DataSet" } ] }
Esempio

L'esempio seguente esegue la ricerca con una clausola di filtro e un criterio di ordinamento.

aws glue search-assets \ --search-text "sales" \ --max-results 10 \ --filter-clause '{"AttributeFilter":{"Attribute":"AssetTypeId","Operator":"equals","Value":{"StringValue":"DataSet"}}}' \ --sort '{"Attribute":"name","Order":"ASCENDING"}' { "Items": [ { "Id": "quarterly-sales-2026q1", "AssetName": "Quarterly Sales 2026 Q1", "AssetDescription": "Aggregated quarterly sales metrics", "UpdatedAt": "2026-06-16T06:42:00.442Z", "AssetTypeId": "DataSet" } ] }
Richiesta
  • SearchText— UTF-8 stringa lunga non meno di 1 o più di 1000 byte.

    Il testo da cercare. Almeno uno di searchText essi filterClause deve essere fornito.

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

    Il numero massimo di risultati da restituire nella risposta.

  • NextToken— UTF-8 stringa.

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

  • Sort: un oggetto SearchSort.

    I criteri di ordinamento per i risultati della ricerca.

  • FilterClause: un oggetto SearchFilterClause.

    La clausola di filtro da applicare alla ricerca. Supporta la AND/OR logica annidata con filtri a livello di attributi e a livello di mappa.

Risposta

I risultati della ricerca restituiti dall'operazione. SearchAssets

Errori
  • AccessDeniedException

  • InvalidInputException

  • InternalServiceException

  • ThrottlingException

GetDataCatalogExportConfiguration azione (Python: get_data_catalog_export_configuration)

Recupera la configurazione di esportazione corrente per il catalogo dati. AWS Glue La configurazione di esportazione controlla se i metadati del catalogo vengono esportati in tabelle S3.

Richiesta
  • Nessun parametro della richiesta.

Risposta

La configurazione di esportazione restituita dall'operazione. GetDataCatalogExportConfiguration

Errori
  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • ThrottlingException

PutDataCatalogExportConfiguration azione (Python: put_data_catalog_export_configuration)

Crea o aggiorna la configurazione di esportazione per il catalogo dati. AWS Glue Utilizzate questa operazione per abilitare o disabilitare l'esportazione dei metadati del catalogo in tabelle S3.

Richiesta
  • ExportSetting Obbligatorio: UTF-8 stringa (valori validi: ENABLED |). DISABLED

    L'impostazione di esportazione per il catalogo dati. Specifica ENABLED di avviare l'esportazione dei metadati del catalogo in tabelle S3 o DISABLED di interrompere l'esportazione. Questo campo è obbligatorio.

  • EncryptionConfiguration: un oggetto ExportEncryptionConfiguration.

    La configurazione di crittografia per i dati esportati. Se non viene specificata, vengono utilizzate le impostazioni di crittografia predefinite.

  • ClientToken— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

    Un identificatore univoco (con distinzione tra maiuscole e minuscole) che fornisci per assicurare l'idempotenza della richiesta.

Risposta

La configurazione di esportazione restituita dall'PutDataCatalogExportConfigurationoperazione.

Errori
  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

  • ThrottlingException

  • ConflictException