— les types de données —AssetFormEntry AssetTypeFormReference IterableFormEntry IterableFormItem IterableFormListItem SearchResultItem SearchSort SearchFilterClause SearchAttributeFilter SearchMapFilter SearchMapFilterValue SearchFilterValue ItemError AssetTypeItem FormTypeItem GlossaryItem GlossaryTermItem GetAssetOutput SearchAssetsOutput ExportEncryptionConfiguration GetDataCatalogExportConfigurationOutput PutDataCatalogExportConfigurationOutput — operations —GetAsset (obtenir_actif)PutAsset (put_asset)DeleteAsset (supprimer_actif)PutAssetType (put_asset_type)GetAssetType (obtenir_type_d'actif)DeleteAssetType (supprimer_type_d'actif)ListAssetTypes (liste_types_d'actifs)PutFormType (put_form_type)GetFormType (obtenir_form_type)DeleteFormType (supprimer_form_type)ListFormTypes (liste_forms_types)PutAttachment (mettre_pièce jointe)DeleteAttachment (supprimer_pièce jointe)ListIterableForms (list_iterable_forms)BatchGetIterableForms (batch_get_iterable_forms)CreateGlossary (créer_glossaire)GetGlossary (get_glossaire)UpdateGlossary (update_glossary)DeleteGlossary (supprimer_glossaire)ListGlossaries (liste_glossaires)CreateGlossaryTerm (créer_terme_glossaire)GetGlossaryTerm (get_glossary_term)UpdateGlossaryTerm (update_glossary_term)DeleteGlossaryTerm (supprimer_terme_du glossaire)ListGlossaryTerms (liste_glossaire_termes)AssociateGlossaryTerms (termes_glossaires_associés)DisassociateGlossaryTerms (termes_glossaire_dissociés)SearchAssets (recherche_actifs)GetDataCatalogExportConfiguration (get_data_catalog_export_configuration)PutDataCatalogExportConfiguration (put_data_catalog_export_configuration)

API de contexte commercial

L'API Business Context décrit les types de données et les opérations pour gérer les actifs, les types d'actifs, les types de formulaires, les glossaires, les termes du glossaire, les pièces jointes et la recherche dans le catalogue de AWS Glue données.

Types de données

AssetFormEntry structure

Un formulaire sur un actif, composé de l'identifiant du type de formulaire et de son contenu JSON.

Champs

FormTypeId— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de formulaire qui définit le schéma de ce formulaire.
Content— UTF-8 ficelle.

Le contenu JSON du formulaire, conformément au schéma du type de formulaire spécifié.

AssetTypeFormReference structure

Référence à un type de formulaire inclus dans un type de ressource.

Champs

FormTypeIdentifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de formulaire référencé.

IterableFormEntry structure

Un formulaire itérable disponible sur une ressource, identifié par son type de formulaire.

Champs

FormTypeId— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

L'identifiant du type de formulaire du formulaire itérable (par exemple,columns), utilisé pour récupérer ses éléments via ListIterableForms ouBatchGetIterableForms.

IterableFormItem structure

Un élément de formulaire itérable complet avec ses formulaires.

Champs

ItemId— UTF-8 ficelle.

L'identifiant unique de l'article.
ItemName— UTF-8 ficelle.

Nom de l'élément.
GlossaryTerms— Tableau de UTF-8 chaînes composé d'au moins 1 ou de plus de 10 chaînes.

Identifiants des termes du glossaire associés à l'article.
Forms – Tableau de mappage de paires valeur-clé.

Chaque touche est une UTF-8 chaîne.

Chaque valeur est un objet AssetFormEntry.

Les formulaires de l'élément, saisis par nom de formulaire.
Attachments – Tableau de mappage de paires valeur-clé.

Chaque touche est une UTF-8 chaîne.

Chaque valeur est un objet AssetFormEntry.

Pièces jointes supplémentaires sur l'élément pour plus de contexte, saisies par le nom de la pièce jointe.

IterableFormListItem structure

Résumé d'un élément sous une forme itérable.

Champs

ItemId— UTF-8 ficelle.

L'identifiant unique de l'article.
ItemName— UTF-8 ficelle.

Nom de l'élément.
Description— UTF-8 ficelle.

Description de l'article.
GlossaryTerms— Tableau de UTF-8 chaînes composé d'au moins 1 ou de plus de 10 chaînes.

Identifiants des termes du glossaire associés à l'article.

SearchResultItem structure

Un seul élément de résultat de recherche représentant un actif correspondant.

Champs

Id— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de l'actif correspondant.
AssetName— UTF-8 ficelle.

Le nom de l'actif correspondant.
AssetDescription— UTF-8 ficelle.

Description de l'actif correspondant.
UpdatedAt – Horodatage.

Horodatage auquel la ressource correspondante a été mise à jour pour la dernière fois.
AssetTypeId— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type d'actif pour l'actif correspondant.

SearchSort structure

Les critères de tri des résultats de recherche.

Champs

Attribute— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

L'attribut selon lequel le tri doit être effectué.
Order— UTF-8 chaîne (valeurs valides : ASCENDING |DESCENDING).

L'ordre de tri. Les valeurs valides sont ASCENDING et DESCENDING.

SearchFilterClause structure

Clause de filtre qui prend en charge la logique booléenne imbriquée. Exactement l'un andAllFilters des orAnyFilters éléments attributeFilter suivants :,, ou mapFilter doit être spécifié.

Champs

AndAllFilters – Tableau d’objets SearchFilterClause, avec 1 structure minimum et 10 structures maximum.

Liste des clauses de filtre qui doivent toutes correspondre (ET logique).
OrAnyFilters – Tableau d’objets SearchFilterClause, avec 1 structure minimum et 10 structures maximum.

Liste de clauses de filtre dont au moins une doit correspondre (OU logique).
AttributeFilter – Un objet SearchAttributeFilter.

Filtre basé sur une valeur d'attribut unique.
MapFilter – Un objet SearchMapFilter.

Filtre sur la paire clé-valeur d'un attribut de carte.

SearchAttributeFilter structure

Filtre qui compare une valeur d'attribut à l'aide d'un opérateur.

Champs

Attribute— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

Le nom de l'attribut sur lequel filtrer.
Operator— Obligatoire : UTF-8 chaîne (valeurs valides : equals greaterThan greaterThanOrEquals | | lessThan | lessThanOrEquals |notExists).

Opérateur de comparaison. Les valeurs valides sont equals greaterThangreaterThanOrEquals,lessThan,lessThanOrEquals, etnotExists.
Value – Un objet SearchFilterValue.

La valeur à comparer.

SearchMapFilter structure

Filtre sur la paire clé-valeur d'un attribut de carte.

Champs

Attribute— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

Le nom de l'attribut de carte sur lequel filtrer.
Key— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

La clé de l'attribut de carte sur laquelle filtrer.
Value – Obligatoire : un objet SearchMapFilterValue.

La valeur à comparer.

SearchMapFilterValue structure

Une valeur de filtre cartographique. Ne prend actuellement en charge que la comparaison de chaînes.

Champs

StringValue— UTF-8 chaîne ne dépassant pas 256 octets.

Une valeur de filtre de chaîne.

SearchFilterValue structure

Une valeur de filtre. Exactement l'un des stringValue ou longValue doit être spécifié.

Champs

StringValue— UTF-8 chaîne ne dépassant pas 256 octets.

Une valeur de filtre de chaîne.
LongValue – Nombre (long).

Une valeur de filtre de type entier long.

ItemError structure

Une erreur s'est produite lors de la récupération d'un élément de formulaire itérable.

Champs

ItemIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 087 octets.

Identifiant de l'élément à l'origine de l'erreur.
Code— UTF-8 ficelle.

Code de l’erreur.
Message— UTF-8 ficelle.

Message d’erreur.

AssetTypeItem structure

Résumé d'un type d'actif.

Champs

Id— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type d'actif.
Name— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #75.

Le nom du type d'actif.

FormTypeItem structure

Résumé d'un type de formulaire.

Champs

Id— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de formulaire.
Name— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #77.

Le nom du type de formulaire.

GlossaryItem structure

Résumé d'un glossaire commercial.

Champs

Id— UTF-8 ficelle.

L'identifiant unique du glossaire.
Name— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Le nom du glossaire.
Description— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 2 048 octets.

Description du glossaire.

GlossaryTermItem structure

Résumé d'un terme du glossaire.

Champs

Id— UTF-8 ficelle.

L'identifiant unique du terme du glossaire.
Name— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Nom du terme du glossaire.
ShortDescription— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 024 octets.

Brève description du terme du glossaire.

GetAssetOutput structure

Les métadonnées de l'actif renvoyées par l'GetAssetopération.

Champs

Id— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de l'actif.
Name— UTF-8 ficelle.

Le nom de l'actif.
Description— UTF-8 ficelle.

Description de l'actif.
CreatedAt – Horodatage.

Horodatage auquel la ressource a été créée.
UpdatedAt – Horodatage.

Horodatage auquel la ressource a été mise à jour pour la dernière fois.
AssetTypeId— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de ressource pour cette ressource.
GlossaryTerms— Tableau de UTF-8 chaînes composé d'au moins 1 ou de plus de 10 chaînes.

Identifiants des termes du glossaire associés à l'actif.
Forms – Tableau de mappage de paires valeur-clé.

Chaque touche est une UTF-8 chaîne.

Chaque valeur est un objet AssetFormEntry.

Les formulaires de l'actif, saisis par nom de formulaire.
Attachments – Tableau de mappage de paires valeur-clé.

Chaque touche est une UTF-8 chaîne.

Chaque valeur est un objet AssetFormEntry.

Pièces jointes supplémentaires sur la ressource pour plus de contexte, saisies par nom de pièce jointe.
IterableForms – Tableau de mappage de paires valeur-clé.

Chaque touche est une UTF-8 chaîne.

Chaque valeur est un objet IterableFormEntry.

Les formulaires itérables disponibles sur la ressource, saisis par nom de formulaire (par exemple,columns). Utilisez le nom du formulaire avec ListIterableForms ou BatchGetIterableForms pour récupérer les éléments du formulaire.

SearchAssetsOutput structure

Les résultats de recherche renvoyés par l'SearchAssetsopération.

Champs

Items : un tableau d’objets SearchResultItem.

La liste des actifs correspondant aux critères de recherche.
NextToken— UTF-8 ficelle.

Un jeton de continuation, présent si le segment actuel n’est pas le dernier.

ExportEncryptionConfiguration structure

Configuration de chiffrement pour les métadonnées du catalogue de données exportées.

Champs

SseAlgorithm— UTF-8 ficelle.

Algorithme de chiffrement côté serveur utilisé pour les données exportées. Les valeurs valides sont AES256 et aws:kms.
KmsKeyArn— UTF-8 chaîne, correspondant àCustom string pattern #72.

L'ARN de la clé KMS utilisée pour chiffrer les données exportées.

GetDataCatalogExportConfigurationOutput structure

La configuration d'exportation renvoyée par l'GetDataCatalogExportConfigurationopération.

Champs

ExportSetting— UTF-8 chaîne (valeurs valides : ENABLED |DISABLED).

Paramètre d'exportation pour le catalogue de données. Les valeurs valides sont ENABLED et DISABLED.
Status— UTF-8 chaîne (valeurs valides : ENABLING | ENABLED | DISABLING | DISABLED |FAILED).

État actuel de l'exportation. Les valeurs valides sont ENABLING, ENABLED, DISABLING, DISABLED et FAILED.
EncryptionConfiguration : un objet ExportEncryptionConfiguration.

Configuration de chiffrement pour les données exportées.
S3TableBucketArn— UTF-8 ficelle.

L'ARN du compartiment S3 Tables dans lequel les métadonnées du catalogue sont exportées.
CreatedAt – Horodatage.

Horodatage auquel la configuration d'exportation a été créée.
UpdatedAt – Horodatage.

Horodatage auquel la configuration d'exportation a été mise à jour pour la dernière fois.

PutDataCatalogExportConfigurationOutput structure

La configuration d'exportation renvoyée par l'PutDataCatalogExportConfigurationopération.

Champs

ExportSetting— UTF-8 chaîne (valeurs valides : ENABLED |DISABLED).

Paramètre d'exportation pour le catalogue de données.
EncryptionConfiguration : un objet ExportEncryptionConfiguration.

Configuration de chiffrement pour les données exportées.

Opérations

GetAsset action (Python : get_asset)
PutAsset action (Python : put_asset)
DeleteAsset action (Python : delete_asset)
PutAssetType action (Python : put_asset_type)
GetAssetType action (Python : get_asset_type)
DeleteAssetType action (Python : delete_asset_type)
ListAssetTypes action (Python : list_asset_types)
PutFormType action (Python : put_form_type)
GetFormType action (Python : get_form_type)
DeleteFormType action (Python : delete_form_type)
ListFormTypes action (Python : list_form_types)
PutAttachment action (Python : put_attachment)
DeleteAttachment action (Python : delete_attachment)
ListIterableForms action (Python : list_iterable_forms)
BatchGetIterableForms action (Python : batch_get_iterable_forms)
CreateGlossary action (Python : create_glossary)
GetGlossary action (Python : get_glossary)
UpdateGlossary action (Python : update_glossary)
DeleteGlossary action (Python : delete_glossary)
ListGlossaries action (Python : list_glossaries)
CreateGlossaryTerm action (Python : create_glossary_term)
GetGlossaryTerm action (Python : get_glossary_term)
UpdateGlossaryTerm action (Python : update_glossary_term)
DeleteGlossaryTerm action (Python : delete_glossary_term)
ListGlossaryTerms action (Python : list_glossary_terms)
AssociateGlossaryTerms action (Python : associate_glossary_terms)
DisassociateGlossaryTerms action (Python : disassociate_glossary_terms)
SearchAssets action (Python : search_assets)
GetDataCatalogExportConfiguration action (Python : get_data_catalog_export_configuration)
PutDataCatalogExportConfiguration action (Python : put_data_catalog_export_configuration)

GetAsset action (Python : get_asset)

Récupère les métadonnées d'une ressource dans AWS Glue Data Catalog, y compris ses formulaires, ses pièces jointes supplémentaires et les termes du glossaire associés.

Exemple

L'exemple suivant extrait un actif à l'aide de son identifiant.


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": {}
    }

Demande

Identifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de la ressource à récupérer.

Réponse

Les métadonnées de l'actif renvoyées par l'GetAssetopération.

GetAssetOutput – Un objet GetAssetOutput.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException
InvalidInputException

PutAsset action (Python : put_asset)

Crée ou met à jour un actif dans AWS Glue Data Catalog. Si la ressource existe déjà, cette opération la met à jour ; sinon, une nouvelle ressource est créée.

Exemple

L'exemple suivant crée une ressource à l'aide d'un formulaire.


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\"}"
            }
        }
    }

Demande

AssetTypeId— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de ressource pour la ressource.
Identifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de l'actif. Si un actif avec cet identifiant existe déjà, il est mis à jour.
Name— Obligatoire : UTF-8 chaîne.

Le nom de l'actif.
Description— UTF-8 ficelle.

Description de l'actif.
Forms – obligatoire : tableau de mappage de paires clé-valeur.

Chaque touche est une UTF-8 chaîne.

Chaque valeur est un objet AssetFormEntry.

Les formulaires à définir sur l'actif, saisis par nom de formulaire. Chaque entrée spécifie le type de formulaire et son contenu JSON.
ClientToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

Un identifiant unique, sensible à la casse, que vous devez fournir afin de garantir l'idempotence de la demande.

Réponse

Id— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de l'actif.
Name— Obligatoire : UTF-8 chaîne.

Le nom de l'actif.
Description— UTF-8 ficelle.

Description de l'actif.
CreatedAt – Horodatage.

Horodatage auquel la ressource a été créée.
Forms – Tableau de mappage de paires valeur-clé.

Chaque touche est une UTF-8 chaîne.

Chaque valeur est un objet AssetFormEntry.

Les formulaires attachés à l'actif, saisis par le nom du formulaire.

Erreurs

AccessDeniedException
ConcurrentModificationException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

DeleteAsset action (Python : delete_asset)

Supprime un actif du catalogue de AWS Glue données.

Exemple

L'exemple suivant supprime un actif en fonction de son identifiant.


aws glue delete-asset --identifier quarterly-sales-2026q1

Demande

Identifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de la ressource à supprimer.

Réponse

Paramètres d’absence de réponse.

Erreurs

AccessDeniedException
ConcurrentModificationException
InternalServiceException
InvalidInputException
ThrottlingException

PutAssetType action (Python : put_asset_type)

Crée ou met à jour un type d'actif dans AWS Glue Data Catalog. Un type d'actif définit la structure des actifs en spécifiant les formulaires qu'ils incluent. Si un type de ressource portant le nom donné existe déjà, il est mis à jour.

Exemple

L'exemple suivant crée un type de ressource qui fait référence à un type de formulaire.


aws glue put-asset-type \
        --name DataSet \
        --forms '{"DataClassification":{"FormTypeIdentifier":"DataClassification"}}'
    
    {
        "Id": "DataSet",
        "Name": "DataSet",
        "Forms": {
            "DataClassification": {
                "FormTypeIdentifier": "DataClassification"
            }
        }
    }

Demande

Name— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 128 octets, correspondant àCustom string pattern #75.

Le nom du type d'actif.
Forms— Obligatoire : un tableau cartographique de paires clé-valeur, pas moins de 1 ou plus de 100 paires.

Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #75.

Chaque valeur est un objet AssetTypeFormReference.

Les formulaires qui constituent le type de ressource, saisis par nom de formulaire. Chaque entrée fait référence au type de formulaire qui définit le schéma du formulaire.
ClientToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

Un identifiant unique, sensible à la casse, que vous devez fournir afin de garantir l'idempotence de la demande.

Réponse

Id— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type d'actif.
Name— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #75.

Le nom du type d'actif.
Forms— Tableau cartographique de paires clé-valeur, pas moins de 1 ou plus de 100 paires.

Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #75.

Chaque valeur est un objet AssetTypeFormReference.

Les formulaires qui constituent le type de ressource, saisis par nom de formulaire.

Erreurs

AccessDeniedException
InternalServiceException
InvalidInputException
EntityNotFoundException
ConcurrentModificationException
ThrottlingException

GetAssetType action (Python : get_asset_type)

Récupère un type de ressource dans AWS Glue Data Catalog par son identifiant.

Exemple

L'exemple suivant extrait un type de ressource à l'aide de son identifiant.


aws glue get-asset-type --identifier DataSet
    
    {
        "Id": "DataSet",
        "Name": "DataSet",
        "Forms": {
            "DataClassification": {
                "FormTypeIdentifier": "DataClassification"
            }
        }
    }

Demande

Identifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de ressource à récupérer.

Réponse

Id— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type d'actif.
Name— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #75.

Le nom du type d'actif.
Forms— Tableau cartographique de paires clé-valeur, pas moins de 1 ou plus de 100 paires.

Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #75.

Chaque valeur est un objet AssetTypeFormReference.

Les formulaires qui constituent le type de ressource, saisis par nom de formulaire.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

DeleteAssetType action (Python : delete_asset_type)

Supprime un type de ressource du catalogue de AWS Glue données.

Exemple

L'exemple suivant supprime un type de ressource en fonction de son identifiant.


aws glue delete-asset-type --identifier DataSet

Demande

Identifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de ressource à supprimer.

Réponse

Paramètres d’absence de réponse.

Erreurs

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

ListAssetTypes action (Python : list_asset_types)

Répertorie les types d'actifs définis dans le catalogue de AWS Glue données.

Exemple

L'exemple suivant répertorie les types d'actifs du compte.


aws glue list-asset-types --max-results 20
    
    {
        "Items": [
            {
                "Id": "DataSet",
                "Name": "DataSet"
            }
        ]
    }

Demande

MaxResults – Nombre (entier), compris entre 1 et 1 000.

Le nombre maximum de résultats à renvoyer dans la réponse.
NextToken— UTF-8 ficelle.

Jeton de continuation, s’il s’agit d’un appel de continuation.

Réponse

Items : un tableau d’objets AssetTypeItem.

La liste des éléments de type d'actif.
NextToken— UTF-8 ficelle.

Un jeton de continuation, présent si le segment actuel n’est pas le dernier.

Erreurs

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

PutFormType action (Python : put_form_type)

Crée ou met à jour un type de formulaire dans AWS Glue Data Catalog. Un type de formulaire définit le schéma des métadonnées structurées qui peuvent être jointes aux actifs.

Exemple

L'exemple suivant crée un type de formulaire avec un schéma 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}"
    }

Demande

Name— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 128 octets, correspondant àCustom string pattern #77.

Le nom du type de formulaire. Doit commencer par une majuscule.
Schema— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 100 000 octets.

Définition du schéma IDL de Smithy pour le type de formulaire.
ClientToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

Un identifiant unique, sensible à la casse, que vous devez fournir afin de garantir l'idempotence de la demande.

Réponse

Id— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de formulaire.
Name— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #77.

Le nom du type de formulaire.
Schema— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 100 000 octets.

Schéma IDL de Smithy du type de formulaire.

Erreurs

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

GetFormType action (Python : get_form_type)

Récupère un type de formulaire dans AWS Glue Data Catalog à l'aide de son identifiant.

Exemple

L'exemple suivant extrait un type de formulaire à l'aide de son identifiant.


aws glue get-form-type --identifier DataClassification
    
    {
        "Id": "DataClassification",
        "Name": "DataClassification",
        "Schema": "structure DataClassification {\n    classification: String\n    owner: String\n}"
    }

Demande

Identifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de formulaire à récupérer.

Réponse

Id— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de formulaire.
Name— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #77.

Le nom du type de formulaire.
Schema— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 100 000 octets.

Schéma IDL de Smithy du type de formulaire.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

DeleteFormType action (Python : delete_form_type)

Supprime un type de formulaire du catalogue de AWS Glue données. Un type de formulaire ne peut pas être supprimé s'il est toujours référencé par un type de ressource.

Exemple

L'exemple suivant supprime un type de formulaire en fonction de son identifiant.


aws glue delete-form-type --identifier DataClassification

Demande

Identifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de formulaire à supprimer.

Réponse

Paramètres d’absence de réponse.

Erreurs

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ConflictException
ThrottlingException

ListFormTypes action (Python : list_form_types)

Répertorie les types de formulaires définis dans AWS Glue Data Catalog.

Exemple

L'exemple suivant répertorie les types de formulaires du compte.


aws glue list-form-types --max-results 20
    
    {
        "Items": [
            {
                "Id": "DataClassification",
                "Name": "DataClassification"
            }
        ]
    }

Demande

MaxResults – Nombre (entier), compris entre 1 et 1 000.

Le nombre maximum de résultats à renvoyer dans la réponse.
NextToken— UTF-8 ficelle.

Jeton de continuation, s’il s’agit d’un appel de continuation.

Réponse

Items – Obligatoire : un tableau d’objets FormTypeItem.

La liste des éléments du type de formulaire.
NextToken— UTF-8 ficelle.

Un jeton de continuation, présent si le segment actuel n’est pas le dernier.

Erreurs

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

PutAttachment action (Python : put_attachment)

Attache un formulaire à une ressource ou à un élément de formulaire itérable dans le catalogue de AWS Glue données. Si une pièce jointe portant le même nom existe déjà, elle est remplacée.

Exemple

L'exemple suivant associe un formulaire à un actif.


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"
    }

Demande

AssetIdentifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de la ressource à laquelle joindre le formulaire.
IterableFormName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 256 octets, correspondant àCustom string pattern #73.

Le nom du formulaire itérable. Lorsqu'elle est spécifiée en même tempsitemIdentifier, la pièce jointe cible un élément du formulaire itérable plutôt que l'actif lui-même.
ItemIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 087 octets.

L'identifiant de l'élément dans le formulaire itérable. Obligatoire lorsque iterableFormName est spécifié.
AttachmentName— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 256 octets, correspondant àCustom string pattern #76.

Le nom de la pièce jointe.
Content— Obligatoire : UTF-8 chaîne.

Le contenu JSON du formulaire, conformément au schéma du type de formulaire spécifié.
FormTypeId— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de formulaire pour cette pièce jointe.
ClientToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

Un identifiant unique, sensible à la casse, que vous devez fournir afin de garantir l'idempotence de la demande.

Réponse

AssetIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de l'actif.
IterableFormName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 256 octets, correspondant àCustom string pattern #73.

Le nom du formulaire itérable, si la pièce jointe cible un élément.
ItemIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 087 octets.

L'identifiant de l'élément dans le formulaire itérable, le cas échéant.
AttachmentName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 256 octets, correspondant àCustom string pattern #76.

Le nom de la pièce jointe.
FormTypeId— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Identifiant du type de formulaire pour cette pièce jointe.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

DeleteAttachment action (Python : delete_attachment)

Supprime une pièce jointe à un formulaire d'une ressource dans AWS Glue Data Catalog.

Exemple

L'exemple suivant supprime une pièce jointe d'un actif.


aws glue delete-attachment \
        --asset-identifier quarterly-sales-2026q1 \
        --attachment-name reviewNote
    
    {
        "AssetIdentifier": "quarterly-sales-2026q1"
    }

Demande

AssetIdentifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

Identifiant unique de la ressource à partir de laquelle supprimer la pièce jointe.
IterableFormName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 256 octets, correspondant àCustom string pattern #73.

Le nom du formulaire itérable. Lorsqu'elle est spécifiée en même tempsitemIdentifier, la pièce jointe est supprimée d'un élément du formulaire itérable plutôt que de la ressource elle-même.
ItemIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 087 octets.

L'identifiant de l'élément dans le formulaire itérable. Obligatoire lorsque iterableFormName est spécifié.
AttachmentName— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 256 octets, correspondant àCustom string pattern #76.

Le nom de la pièce jointe à supprimer.

Réponse

AssetIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de l'actif.
IterableFormName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 256 octets, correspondant àCustom string pattern #73.

Le nom du formulaire itérable, si la suppression cible un élément.
ItemIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 087 octets.

L'identifiant de l'élément dans le formulaire itérable, le cas échéant.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

ListIterableForms action (Python : list_iterable_forms)

Répertorie les éléments sous une forme itérable sur une ressource dans AWS Glue Data Catalog. Par exemple, répertorie les colonnes d'un actif de table.

Exemple

L'exemple suivant répertorie les colonnes d'un actif.


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": []
            }
        ]
    }

Demande

AssetIdentifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de l'actif.
IterableFormName— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 256 octets, correspondant àCustom string pattern #73.

Le nom du formulaire itérable à partir duquel répertorier les éléments.
MaxResults – Nombre (entier), compris entre 1 et 1 000.

Le nombre maximum de résultats à renvoyer dans la réponse.
NextToken— UTF-8 ficelle.

Jeton de continuation, s’il s’agit d’un appel de continuation.

Réponse

AssetId— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de l'actif.
IterableFormName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 256 octets, correspondant àCustom string pattern #73.

Le nom du formulaire itérable.
Items : un tableau d’objets IterableFormListItem.

La liste des éléments de formulaire itérables.
NextToken— UTF-8 ficelle.

Un jeton de continuation, présent si le segment actuel n’est pas le dernier.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException
InvalidInputException

BatchGetIterableForms action (Python : batch_get_iterable_forms)

Récupère plusieurs éléments d'un formulaire itérable sur une ressource dans AWS Glue Data Catalog en une seule demande.

Exemple

L'exemple suivant extrait des colonnes spécifiques par identifiant.


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": []
    }

Demande

AssetIdentifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de l'actif.
IterableFormName— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 256 octets, correspondant àCustom string pattern #73.

Le nom du formulaire itérable à partir duquel récupérer les éléments.
ItemIdentifiers— Obligatoire : un tableau de UTF-8 chaînes, pas moins de 1 ou plus de 100 chaînes.

La liste des identifiants d'articles à récupérer. Chaque identifiant peut être un identifiant ou un nom d'article.

Réponse

Items : un tableau d’objets IterableFormItem.

La liste des éléments de formulaire itérables récupérés.
Errors : un tableau d’objets ItemError.

La liste des erreurs pour les éléments qui n'ont pas pu être récupérés.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

CreateGlossary action (Python : create_glossary)

Crée un glossaire métier dans AWS Glue Data Catalog. Un glossaire est un conteneur contenant les termes du glossaire qui définissent les concepts commerciaux.

Exemple

L'exemple suivant crée un glossaire professionnel.


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"
    }

Demande

Name— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Le nom du glossaire.
Description— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 2 048 octets.

Description du glossaire.
ClientToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

Un identifiant unique, sensible à la casse, que vous devez fournir afin de garantir l'idempotence de la demande.

Réponse

Id— UTF-8 ficelle.

L'identifiant unique du glossaire.
Name— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Le nom du glossaire.
Description— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 2 048 octets.

Description du glossaire.

Erreurs

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

GetGlossary action (Python : get_glossary)

Récupère un glossaire métier dans AWS Glue Data Catalog par son identifiant.

Exemple

L'exemple suivant extrait un glossaire par son identifiant.


aws glue get-glossary --identifier 6n5f21s641nbjb
    
    {
        "Id": "6n5f21s641nbjb",
        "Name": "Sales Terms",
        "Description": "Glossary of sales-domain business terms"
    }

Demande

Identifier— Obligatoire : UTF-8 chaîne.

L'identifiant unique du glossaire à récupérer.

Réponse

Id— UTF-8 ficelle.

L'identifiant unique du glossaire.
Name— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Le nom du glossaire.
Description— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 2 048 octets.

Description du glossaire.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException

UpdateGlossary action (Python : update_glossary)

Met à jour un glossaire professionnel dans AWS Glue Data Catalog.

Exemple

L'exemple suivant met à jour la description d'un glossaire.


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"
    }

Demande

Identifier— Obligatoire : UTF-8 chaîne.

Identifiant unique du glossaire à mettre à jour.
Name— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Le nom mis à jour du glossaire.
Description— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 2 048 octets.

Description mise à jour du glossaire.
ClientToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

Un identifiant unique, sensible à la casse, que vous devez fournir afin de garantir l'idempotence de la demande.

Réponse

Id— UTF-8 ficelle.

L'identifiant unique du glossaire.
Name— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Le nom du glossaire.
Description— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 2 048 octets.

Description du glossaire.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

DeleteGlossary action (Python : delete_glossary)

Supprime un glossaire métier du catalogue de AWS Glue données. Un glossaire ne peut pas être supprimé s'il contient encore des termes du glossaire.

Exemple

L'exemple suivant supprime un glossaire en fonction de son identifiant.


aws glue delete-glossary --identifier 6n5f21s641nbjb

Demande

Identifier— Obligatoire : UTF-8 chaîne.

L'identifiant unique du glossaire à supprimer.

Réponse

Paramètres d’absence de réponse.

Erreurs

AccessDeniedException
InternalServiceException
InvalidInputException
ConflictException
ConcurrentModificationException
ThrottlingException

ListGlossaries action (Python : list_glossaries)

Répertorie les glossaires professionnels dans le catalogue AWS Glue de données.

Exemple

L'exemple suivant répertorie les glossaires du compte.


aws glue list-glossaries --max-results 20
    
    {
        "Items": [
            {
                "Id": "6n5f21s641nbjb",
                "Name": "Sales Terms",
                "Description": "Glossary of sales and revenue business terms"
            }
        ]
    }

Demande

MaxResults – Nombre (entier), compris entre 1 et 1 000.

Le nombre maximum de résultats à renvoyer dans la réponse.
NextToken— UTF-8 ficelle.

Jeton de continuation, s’il s’agit d’un appel de continuation.

Réponse

Items : un tableau d’objets GlossaryItem.

La liste des éléments du glossaire.
NextToken— UTF-8 ficelle.

Un jeton de continuation, présent si le segment actuel n’est pas le dernier.

Erreurs

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

CreateGlossaryTerm action (Python : create_glossary_term)

Crée un terme de glossaire dans un glossaire métier de AWS Glue Data Catalog.

Exemple

L'exemple suivant crée un terme de glossaire.


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."
    }

Demande

GlossaryIdentifier— Obligatoire : UTF-8 chaîne.

Identifiant unique du glossaire dans lequel le terme doit être créé.
Name— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Le nom du terme du glossaire.
ShortDescription— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 024 octets.

Brève description du terme du glossaire.
LongDescription— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 4 096 octets.

Longue description du terme du glossaire.
ClientToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

Un identifiant unique, sensible à la casse, que vous devez fournir afin de garantir l'idempotence de la demande.

Réponse

Id— UTF-8 ficelle.

L'identifiant unique du terme du glossaire.
GlossaryId— UTF-8 ficelle.

L'identifiant unique du glossaire contenant ce terme.
Name— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Nom du terme du glossaire.
ShortDescription— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 024 octets.

Brève description du terme du glossaire.
LongDescription— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 4 096 octets.

Description longue du terme du glossaire.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

GetGlossaryTerm action (Python : get_glossary_term)

Récupère un terme du glossaire dans AWS Glue Data Catalog à l'aide de son identifiant.

Exemple

L'exemple suivant extrait un terme du glossaire à l'aide de son identifiant.


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."
    }

Demande

Identifier— Obligatoire : UTF-8 chaîne.

L'identifiant unique du terme du glossaire à récupérer.

Réponse

Id— UTF-8 ficelle.

L'identifiant unique du terme du glossaire.
GlossaryId— UTF-8 ficelle.

L'identifiant unique du glossaire contenant ce terme.
Name— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Nom du terme du glossaire.
ShortDescription— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 024 octets.

Brève description du terme du glossaire.
LongDescription— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 4 096 octets.

Description longue du terme du glossaire.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException

UpdateGlossaryTerm action (Python : update_glossary_term)

Met à jour un terme du glossaire dans le catalogue AWS Glue de données.

Exemple

L'exemple suivant met à jour la brève description d'un terme du glossaire.


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."
    }

Demande

Identifier— Obligatoire : UTF-8 chaîne.

Identifiant unique du terme du glossaire à mettre à jour.
Name— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Le nom mis à jour du terme du glossaire.
ShortDescription— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 024 octets.

Brève description mise à jour du terme du glossaire.
LongDescription— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 4 096 octets.

Description longue mise à jour du terme du glossaire.
ClientToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

Un identifiant unique, sensible à la casse, que vous devez fournir afin de garantir l'idempotence de la demande.

Réponse

Id— UTF-8 ficelle.

L'identifiant unique du terme du glossaire.
GlossaryId— UTF-8 ficelle.

L'identifiant unique du glossaire contenant ce terme.
Name— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 256 octets.

Nom du terme du glossaire.
ShortDescription— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 024 octets.

Brève description du terme du glossaire.
LongDescription— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 4 096 octets.

Description longue du terme du glossaire.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

DeleteGlossaryTerm action (Python : delete_glossary_term)

Supprime un terme du glossaire du catalogue de AWS Glue données.

Exemple

L'exemple suivant supprime un terme du glossaire par son identifiant.


aws glue delete-glossary-term --identifier avugvxvsul6izr

Demande

Identifier— Obligatoire : UTF-8 chaîne.

Identifiant unique du terme du glossaire à supprimer.

Réponse

Paramètres d’absence de réponse.

Erreurs

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

ListGlossaryTerms action (Python : list_glossary_terms)

Répertorie les termes du glossaire dans un glossaire métier dans AWS Glue Data Catalog.

Exemple

L'exemple suivant répertorie les termes d'un glossaire.


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."
            }
        ]
    }

Demande

GlossaryIdentifier— Obligatoire : UTF-8 chaîne.

L'identifiant unique du glossaire dont les termes doivent être répertoriés.
MaxResults – Nombre (entier), compris entre 1 et 1 000.

Le nombre maximum de résultats à renvoyer dans la réponse.
NextToken— UTF-8 ficelle.

Jeton de continuation, s’il s’agit d’un appel de continuation.

Réponse

GlossaryId— UTF-8 ficelle.

L'identifiant unique du glossaire.
Items : un tableau d’objets GlossaryTermItem.

La liste des éléments terminologiques du glossaire.
NextToken— UTF-8 ficelle.

Un jeton de continuation, présent si le segment actuel n’est pas le dernier.

Erreurs

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

AssociateGlossaryTerms action (Python : associate_glossary_terms)

Associe un ou plusieurs termes du glossaire à une ressource dans AWS Glue Data Catalog.

Exemple

L'exemple suivant associe un terme du glossaire à un actif.


aws glue associate-glossary-terms \
        --asset-identifier quarterly-sales-2026q1 \
        --glossary-term-identifiers avugvxvsul6izr
    
    {
        "AssetIdentifier": "quarterly-sales-2026q1",
        "GlossaryTerms": [
            "avugvxvsul6izr"
        ]
    }

Demande

AssetIdentifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

Identifiant unique de la ressource à laquelle associer les termes du glossaire.
IterableFormName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 256 octets, correspondant àCustom string pattern #73.

Le nom du formulaire itérable. Lorsqu'ils sont spécifiés conjointementitemIdentifier, les termes du glossaire sont associés à un élément du formulaire itérable plutôt qu'à l'actif lui-même.
ItemIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 087 octets.

L'identifiant de l'élément dans le formulaire itérable. Obligatoire lorsque iterableFormName est spécifié.
GlossaryTermIdentifiers— Obligatoire : un tableau de UTF-8 chaînes, pas moins de 1 ou plus de 10 chaînes.

La liste des identifiants de termes du glossaire à associer à la ressource.
ClientToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

Un identifiant unique, sensible à la casse, que vous devez fournir afin de garantir l'idempotence de la demande.

Réponse

AssetIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de l'actif.
IterableFormName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 256 octets, correspondant àCustom string pattern #73.

Le nom du formulaire itérable, si l'association cible un élément.
ItemIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 087 octets.

L'identifiant de l'élément dans le formulaire itérable, le cas échéant.
GlossaryTerms— Tableau de UTF-8 chaînes composé d'au moins 1 ou de plus de 10 chaînes.

Les termes du glossaire désormais associés à l'actif.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

DisassociateGlossaryTerms action (Python : disassociate_glossary_terms)

Supprime l'association d'un ou de plusieurs termes du glossaire à une ressource dans AWS Glue Data Catalog.

Exemple

L'exemple suivant supprime un terme du glossaire d'une ressource.


aws glue disassociate-glossary-terms \
        --asset-identifier quarterly-sales-2026q1 \
        --glossary-term-identifiers avugvxvsul6izr
    
    {
        "AssetIdentifier": "quarterly-sales-2026q1",
        "GlossaryTerms": []
    }

Demande

AssetIdentifier— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de la ressource dont il faut dissocier les termes du glossaire.
IterableFormName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 256 octets, correspondant àCustom string pattern #73.

Le nom du formulaire itérable. Lorsqu'ils sont spécifiés en même tempsitemIdentifier, les termes du glossaire sont dissociés d'un élément du formulaire itérable plutôt que de l'actif lui-même.
ItemIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 087 octets.

L'identifiant de l'élément dans le formulaire itérable. Obligatoire lorsque iterableFormName est spécifié.
GlossaryTermIdentifiers— Obligatoire : un tableau de UTF-8 chaînes, pas moins de 1 ou plus de 10 chaînes.

La liste des identifiants de termes du glossaire à dissocier de l'actif.
ClientToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

Un identifiant unique, sensible à la casse, que vous devez fournir afin de garantir l'idempotence de la demande.

Réponse

AssetIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1087 octets, correspondant à. Custom string pattern #69

L'identifiant unique de l'actif.
IterableFormName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 256 octets, correspondant àCustom string pattern #73.

Le nom du formulaire itérable, si la dissociation cible un élément.
ItemIdentifier— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 087 octets.

L'identifiant de l'élément dans le formulaire itérable, le cas échéant.
GlossaryTerms— Tableau de UTF-8 chaînes composé d'au moins 1 ou de plus de 10 chaînes.

Les autres termes du glossaire associés à l'actif.

Erreurs

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

SearchAssets action (Python : search_assets)

Recherche des actifs dans le catalogue de AWS Glue données à l'aide de la recherche en texte intégral, des filtres, du tri et des agrégations. Des rendements correspondant aux actifs aux résultats classés par pertinence.

Exemple

L'exemple suivant exécute une recherche en texte intégral pour les actifs.


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"
            }
        ]
    }

Exemple

L'exemple suivant effectue une recherche à l'aide d'une clause de filtre et d'un ordre de tri.


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"
            }
        ]
    }

Demande

SearchText— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1 000 octets.

Le texte à rechercher. Au moins l'un de searchText ces filterClause éléments doit être fourni.
MaxResults – Nombre (entier), compris entre 1 et 100.

Le nombre maximum de résultats à renvoyer dans la réponse.
NextToken— UTF-8 ficelle.

Jeton de continuation, s’il s’agit d’un appel de continuation.
Sort – Un objet SearchSort.

Les critères de tri des résultats de recherche.
FilterClause – Un objet SearchFilterClause.

La clause de filtre à appliquer à la recherche. Supporte la AND/OR logique imbriquée avec des filtres au niveau des attributs et au niveau de la carte.

Réponse

Les résultats de recherche renvoyés par l'SearchAssetsopération.

SearchAssetsOutput – Un objet SearchAssetsOutput.

Erreurs

AccessDeniedException
InvalidInputException
InternalServiceException
ThrottlingException

GetDataCatalogExportConfiguration action (Python : get_data_catalog_export_configuration)

Récupère la configuration d'exportation actuelle pour le catalogue de AWS Glue données. La configuration d'exportation contrôle si les métadonnées du catalogue sont exportées vers S3 Tables.

Demande

Aucun paramètre de demande.

Réponse

La configuration d'exportation renvoyée par l'GetDataCatalogExportConfigurationopération.

GetDataCatalogExportConfigurationOutput – Un objet GetDataCatalogExportConfigurationOutput.

Erreurs

InvalidInputException
EntityNotFoundException
InternalServiceException
ThrottlingException

PutDataCatalogExportConfiguration action (Python : put_data_catalog_export_configuration)

Crée ou met à jour la configuration d'exportation pour le catalogue de AWS Glue données. Utilisez cette opération pour activer ou désactiver l'exportation des métadonnées du catalogue vers S3 Tables.

Demande

ExportSetting— Obligatoire : UTF-8 chaîne (valeurs valides : ENABLED |DISABLED).

Paramètre d'exportation du catalogue de données. Spécifiez ENABLED si vous souhaitez commencer à exporter les métadonnées du catalogue vers S3 Tables ou DISABLED arrêter l'exportation. Ce champ est obligatoire.
EncryptionConfiguration : un objet ExportEncryptionConfiguration.

Configuration de chiffrement pour les données exportées. S'ils ne sont pas spécifiés, les paramètres de chiffrement par défaut sont utilisés.
ClientToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

Un identifiant unique, sensible à la casse, que vous devez fournir afin de garantir l'idempotence de la demande.

Réponse

La configuration d'exportation renvoyée par l'PutDataCatalogExportConfigurationopération.

PutDataCatalogExportConfigurationOutput – Un objet PutDataCatalogExportConfigurationOutput.

Erreurs

InvalidInputException
AccessDeniedException
InternalServiceException
ThrottlingException
ConflictException

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Catalogues

Bases de données