View a markdown version of this page

API de contexte métier - AWS Glue

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

API de contexte métier

L'API de contexte métier décrit les types de données et les opérations permettant de 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 une ressource, composé de l'identifiant du type de formulaire et de son contenu JSON.

Champs
  • FormTypeId— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Identifiant du type de formulaire qui définit le schéma de ce formulaire.

  • Content— UTF-8 chaîne.

    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
  • FormTypeIdentifierObligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou d'au plus 256 octets.

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

IterableFormEntry structure

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

Champs
  • FormTypeId— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    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 chaîne.

    L'identifiant unique de l'article.

  • ItemName— UTF-8 chaîne.

    Nom de l'élément.

  • GlossaryTerms— Un tableau de UTF-8 chaînes comprenant au moins 1 ou au plus 10 chaînes.

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

  • Forms – Tableau de mappage de paires valeur-clé.

    Chaque clé 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 clé 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 nom de pièce jointe.

IterableFormListItem structure

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

Champs
  • ItemId— UTF-8 chaîne.

    L'identifiant unique de l'article.

  • ItemName— UTF-8 chaîne.

    Nom de l'élément.

  • Description— UTF-8 chaîne.

    Description de l'article.

  • GlossaryTerms— Un tableau de UTF-8 chaînes comprenant au moins 1 ou au plus 10 chaînes.

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

SearchResultItem structure

Élément de résultat de recherche unique représentant un actif correspondant.

Champs
  • Id— UTF-8 chaîne d'au moins 1 octet ou supérieure à 1 087 octets, correspondant auString.

    Identifiant unique de l'actif correspondant.

  • AssetName— UTF-8 chaîne.

    Nom de l'actif correspondant.

  • AssetDescription— UTF-8 chaîne.

    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 de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

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

SearchSort structure

Les critères de tri pour les résultats de recherche.

Champs
  • AttributeObligatoire : UTF-8 chaîne d'au moins 1 octet ou d'au plus 128 octets.

    Attribut à utiliser pour effectuer le tri.

  • Order— UTF-8 chaîne (valeurs valides : ASCENDING |DESCENDING).

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

SearchFilterClause structure

Une clause de filtre qui prend en charge la logique booléenne imbriquée. Exactement l'un des andAllFilters orAnyFiltersattributeFilter,, ou mapFilter doit être spécifié.

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

    Liste de 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 (OR logique).

  • AttributeFilter – Un objet SearchAttributeFilter.

    Un filtre sur une seule valeur d'attribut.

  • MapFilter – .

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

SearchAttributeFilter structure

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

Champs
  • AttributeObligatoire : UTF-8 chaîne d'au moins 1 octet ou d'au plus 128 octets.

    Le nom de l'attribut sur lequel filtrer.

  • OperatorObligatoire : 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.

SearchFilterValue structure

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

Champs
  • StringValue— UTF-8 chaîne d'une longueur maximale de 256 octets.

    Une valeur de filtre de chaîne.

  • LongValue – Nombre (long).

    Valeur de filtre entière longue.

ItemError structure

Erreur survenue lors de la récupération d'un élément de formulaire itérable.

Champs
  • ItemIdentifier— UTF-8 chaîne d'au moins 1 octet ou supérieure à 1 087 octets.

    Identifiant de l'élément à l'origine de l'erreur.

  • Code— UTF-8 chaîne.

    Code de l’erreur.

  • Message— UTF-8 chaîne.

    Message d’erreur.

GetAssetOutput structure

Structure de réponse pour l'GetAssetopération.

Champs
  • IdObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 1 087 octets, correspondant auString.

    Identifiant unique de l'actif.

  • Name— UTF-8 chaîne.

    Le nom de l'actif.

  • Description— UTF-8 chaîne.

    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.

  • CreatedBy – .

    L'identité du principal qui a créé l'actif.

  • UpdatedBy – .

    L'identité du principal qui a mis à jour l'actif pour la dernière fois.

  • AssetTypeIdObligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Identifiant du type d'actif pour cet actif.

  • GlossaryTerms— Un tableau de UTF-8 chaînes comprenant au moins 1 ou au plus 10 chaînes.

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

  • Forms – Tableau de mappage de paires valeur-clé.

    Chaque clé est une UTF-8 chaîne.

    Chaque valeur est un objet AssetFormEntry.

    Les formulaires de la ressource, saisis par nom de formulaire.

  • Attachments – Tableau de mappage de paires valeur-clé.

    Chaque clé 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 clé 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.

SearchOutput structure

Structure de réponse pour l'Searchopération.

Champs
  • Items : un tableau d’objets SearchResultItem.

    La liste des actifs correspondant aux critères de recherche.

  • TotalCount : nombre (entier).

    Le nombre total de ressources correspondant aux critères de recherche.

  • NextToken— UTF-8 chaîne.

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

  • Aggregations— Un ensemble d'objets.

    Les résultats de l'agrégation pour les attributs demandés.

Opérations

GetAsset action (Python : get_asset)

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

Exemple

L'exemple suivant récupère un actif par 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
  • IdentifierObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 1 087 octets, correspondant auString.

    Identifiant unique de l'actif à récupérer.

Réponse

Structure de réponse pour l'GetAssetopération.

Erreurs
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • ThrottlingException

  • InvalidInputException

PutAsset action (Python : put_asset)

Crée ou met à jour un actif dans le catalogue de AWS Glue données. Si l'actif existe déjà, cette opération le met à jour ; dans le cas contraire, un nouvel actif est créé.

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
  • AssetTypeIdObligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Identifiant du type d'actif pour l'actif.

  • IdentifierObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 1 087 octets, correspondant auString.

    Identifiant unique de l'actif. Si un actif portant cet identifiant existe déjà, il est mis à jour.

  • NameObligatoire : UTF-8 chaîne.

    Le nom de l'actif.

  • Description— UTF-8 chaîne.

    Description de l'actif.

  • Formsobligatoire : tableau de mappage de paires clé-valeur.

    Chaque clé est une UTF-8 chaîne.

    Chaque valeur est un objet AssetFormEntry.

    Les formulaires à définir sur la ressource, saisis par nom de formulaire. Chaque entrée indique le type de formulaire et son contenu JSON.

  • ClientToken— UTF-8 chaîne d'au moins 1 octet ou supérieure à 255 octets, correspondant auSingle-line string pattern.

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

Réponse
  • IdObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 1 087 octets, correspondant auString.

    Identifiant unique de l'actif.

  • NameObligatoire : UTF-8 chaîne.

    Le nom de l'actif.

  • Description— UTF-8 chaîne.

    Description de l'actif.

  • CreatedAt – Horodatage.

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

  • Forms – Tableau de mappage de paires valeur-clé.

    Chaque clé est une UTF-8 chaîne.

    Chaque valeur est un objet AssetFormEntry.

    Les formulaires attachés à la ressource, 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 par son identifiant.

aws glue delete-asset --identifier quarterly-sales-2026q1
Demande
  • IdentifierObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 1 087 octets, correspondant auString.

    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 de ressource dans le catalogue de AWS Glue données. Un type d'actif définit la structure des actifs en spécifiant les formes qu'ils incluent. Si un type d'actif 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
  • NameObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 128 octets, correspondant auString.

    Nom du type de ressource.

  • FormsObligatoire : un tableau cartographique de paires clé-valeur, pas moins d'une paire ou plus de 100 paires.

    Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 128 octets, correspondant àString.

    Chaque valeur est un objet AssetTypeFormReference.

    Les formulaires qui constituent le type de ressource, saisis par le nom du 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'au moins 1 octet ou supérieure à 255 octets, correspondant auSingle-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 de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Identifiant du type d'actif.

  • Name— UTF-8 chaîne, d'au moins 1 ou plus de 128 octets, correspondant auString.

    Nom du type de ressource.

  • Forms— Un tableau cartographique de paires clé-valeur, d'au moins une paire ou d'au plus 100 paires.

    Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 128 octets, correspondant àString.

    Chaque valeur est un objet AssetTypeFormReference.

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

Erreurs
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

GetAssetType action (Python : get_asset_type)

Récupère un type d'actif dans le catalogue de AWS Glue données par son identifiant.

Exemple

L'exemple suivant extrait un type de ressource par son identifiant.

aws glue get-asset-type --identifier DataSet { "Id": "DataSet", "Name": "DataSet", "Forms": { "DataClassification": { "FormTypeIdentifier": "DataClassification" } } }
Demande
  • IdentifierObligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou d'au plus 256 octets.

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

Réponse
  • Id— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Identifiant du type d'actif.

  • Name— UTF-8 chaîne, d'au moins 1 ou plus de 128 octets, correspondant auString.

    Nom du type de ressource.

  • Forms— Un tableau cartographique de paires clé-valeur, d'au moins une paire ou d'au plus 100 paires.

    Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 128 octets, correspondant àString.

    Chaque valeur est un objet AssetTypeFormReference.

    Les formulaires qui constituent le type de ressource, saisis par le nom du 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 par son identifiant.

aws glue delete-asset-type --identifier DataSet
Demande
  • IdentifierObligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou 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 de ressources 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 chaîne.

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

Réponse
  • Items— Un ensemble d'objets.

    Liste des types d'actifs.

  • NextToken— UTF-8 chaîne.

    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 le catalogue de AWS Glue données. Un type de formulaire définit le schéma des métadonnées structurées qui peuvent être attachées aux ressources.

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
  • NameObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 128 octets, correspondant auString.

    Nom du type de formulaire. Doit commencer par une majuscule.

  • SchemaObligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 100 000 octets.

    Définition du schéma Smithy IDL pour le type de formulaire.

  • ClientToken— UTF-8 chaîne d'au moins 1 octet ou supérieure à 255 octets, correspondant auSingle-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 de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Identifiant du type de formulaire.

  • Name— UTF-8 chaîne, d'au moins 1 ou plus de 128 octets, correspondant auString.

    Nom du type de formulaire.

  • Schema— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou de plus de 100 000 octets.

    Le schéma Smithy IDL du type de formulaire.

Erreurs
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

GetFormType action (Python : get_form_type)

Récupère un type de formulaire dans le catalogue de AWS Glue données par son identifiant.

Exemple

L'exemple suivant extrait un type de formulaire par son identifiant.

aws glue get-form-type --identifier DataClassification { "Id": "DataClassification", "Name": "DataClassification", "Schema": "structure DataClassification {\n classification: String\n owner: String\n}" }
Demande
  • IdentifierObligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou d'au plus 256 octets.

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

Réponse
  • Id— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Identifiant du type de formulaire.

  • Name— UTF-8 chaîne, d'au moins 1 ou plus de 128 octets, correspondant auString.

    Nom du type de formulaire.

  • Schema— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou de plus de 100 000 octets.

    Le schéma Smithy IDL 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 par son identifiant.

aws glue delete-form-type --identifier DataClassification
Demande
  • IdentifierObligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou 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 le catalogue de AWS Glue données.

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 chaîne.

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

Réponse
  • ItemsObligatoire : un tableau d'objets.

    Liste des éléments de type de formulaire.

  • NextToken— UTF-8 chaîne.

    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 joint un formulaire à une ressource.

aws glue put-attachment \ --asset-identifier quarterly-sales-2026q1 \ --attachment-name reviewNote \ --form-type-id DataClassification \ --content '{"classification":"internal","owner":"analytics-team"}' { "AssetId": "quarterly-sales-2026q1", "AttachmentName": "reviewNote", "FormTypeId": "DataClassification" }
Demande
  • AssetIdentifierObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 1 087 octets, correspondant auString.

    Identifiant unique de la ressource à laquelle joindre le formulaire.

  • IterableFormName— UTF-8 chaîne, d'au moins 1 ou plus de 256 octets, correspondant auString.

    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'au moins 1 octet ou supérieure à 1 087 octets.

    Identifiant de l'élément dans le formulaire itérable. Obligatoire lorsque iterableFormName est spécifié.

  • AttachmentNameObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 256 octets, correspondant auString.

    Nom de la pièce jointe.

  • ContentObligatoire : UTF-8 chaîne.

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

  • FormTypeIdObligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou d'au plus 256 octets.

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

  • ClientToken— UTF-8 chaîne d'au moins 1 octet ou supérieure à 255 octets, correspondant auSingle-line string pattern.

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

Réponse
  • AssetId— UTF-8 chaîne d'au moins 1 octet ou supérieure à 1 087 octets, correspondant auString.

    Identifiant unique de l'actif.

  • IterableFormName— UTF-8 chaîne, d'au moins 1 ou plus de 256 octets, correspondant auString.

    Le nom du formulaire itérable, si la pièce jointe cible un élément.

  • ItemIdentifier— UTF-8 chaîne d'au moins 1 octet ou supérieure à 1 087 octets.

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

  • AttachmentName— UTF-8 chaîne, d'au moins 1 ou plus de 256 octets, correspondant auString.

    Nom de la pièce jointe.

  • FormTypeId— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou 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 du catalogue de AWS Glue données.

Exemple

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

aws glue delete-attachment \ --identifier quarterly-sales-2026q1 \ --attachment-name reviewNote { "Identifier": "quarterly-sales-2026q1" }
Demande
  • AssetIdentifierObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 1 087 octets, correspondant auString.

    Identifiant unique de la ressource dont vous souhaitez supprimer la pièce jointe.

  • AttachmentNameObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 256 octets, correspondant auString.

    Nom de la pièce jointe à supprimer.

Réponse
  • Identifier— UTF-8 chaîne d'au moins 1 octet ou supérieure à 1 087 octets, correspondant auString.

    Identifiant unique de l'actif.

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 le catalogue de AWS Glue données. Répertorie, par exemple, 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
  • AssetIdentifierObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 1 087 octets, correspondant auString.

    Identifiant unique de l'actif.

  • IterableFormNameObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 256 octets, correspondant auString.

    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 chaîne.

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

Réponse
  • AssetId— UTF-8 chaîne d'au moins 1 octet ou supérieure à 1 087 octets, correspondant auString.

    Identifiant unique de l'actif.

  • IterableFormName— UTF-8 chaîne, d'au moins 1 ou plus de 256 octets, correspondant auString.

    Nom du formulaire itérable.

  • Items : un tableau d’objets IterableFormListItem.

    Liste des éléments de formulaire itérables.

  • NextToken— UTF-8 chaîne.

    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 le catalogue de AWS Glue données 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
  • AssetIdentifierObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 1 087 octets, correspondant auString.

    Identifiant unique de l'actif.

  • IterableFormNameObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 256 octets, correspondant auString.

    Nom du formulaire itérable à partir duquel récupérer des éléments.

  • ItemIdentifiersObligatoire : un tableau de UTF-8 chaînes, pas moins d'une ou plus de 100 chaînes.

    La liste des identificateurs 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.

    Liste des erreurs relatives aux é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 commercial dans le catalogue AWS Glue de données. Un glossaire contient les termes du glossaire qui définissent les concepts commerciaux.

Exemple

L'exemple suivant crée un glossaire commercial.

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
  • NameObligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Le nom du glossaire.

  • Description— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou supérieure à 2 048 octets.

    Description du glossaire.

  • ClientToken— UTF-8 chaîne d'au moins 1 octet ou supérieure à 255 octets, correspondant auSingle-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.

    Identifiant unique du glossaire.

  • Name— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Le nom du glossaire.

  • Description— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou supérieure à 2 048 octets.

    Description du glossaire.

Erreurs
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

  • AlreadyExistsException

GetGlossary action (Python : get_glossary)

Récupère un glossaire commercial 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
  • IdentifierObligatoire : UTF-8 chaîne.

    Identifiant unique du glossaire à récupérer.

Réponse
  • Id— UTF-8 chaîne.

    Identifiant unique du glossaire.

  • Name— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Le nom du glossaire.

  • Description— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou supérieure à 2 048 octets.

    Description du glossaire.

Erreurs
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • ThrottlingException

UpdateGlossary action (Python : update_glossary)

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

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
  • IdentifierObligatoire : UTF-8 chaîne.

    Identifiant unique du glossaire à mettre à jour.

  • Name— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Nom mis à jour du glossaire.

  • Description— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou supérieure à 2 048 octets.

    Description mise à jour du glossaire.

  • ClientToken— UTF-8 chaîne d'au moins 1 octet ou supérieure à 255 octets, correspondant auSingle-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.

    Identifiant unique du glossaire.

  • Name— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Le nom du glossaire.

  • Description— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou supérieure à 2 048 octets.

    Description du glossaire.

Erreurs
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

  • AlreadyExistsException

DeleteGlossary action (Python : delete_glossary)

Supprime un glossaire professionnel 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
  • IdentifierObligatoire : UTF-8 chaîne.

    Identifiant unique du glossaire à supprimer.

Réponse
  • Paramètres d’absence de réponse.

Erreurs
  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConflictException

  • ConcurrentModificationException

  • ThrottlingException

ListGlossaries action (Python : liste_glossaires)

Répertorie les glossaires commerciaux 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 chaîne.

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

Réponse
  • Items— Un ensemble d'objets.

    Liste des éléments du glossaire.

  • NextToken— UTF-8 chaîne.

    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 commercial dans 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
  • GlossaryIdentifierObligatoire : UTF-8 chaîne.

    Identifiant unique du glossaire dans lequel le terme doit être créé.

  • NameObligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Nom du terme du glossaire.

  • ShortDescription— UTF-8 chaîne d'une longueur d'au moins 1 octet ou supérieure à 1 024 octets.

    Brève description du terme du glossaire.

  • LongDescription— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou de plus de 4 096 octets.

    Description détaillée du terme du glossaire.

  • ClientToken— UTF-8 chaîne d'au moins 1 octet ou supérieure à 255 octets, correspondant auSingle-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.

    Identifiant unique du terme du glossaire.

  • GlossaryId— UTF-8 chaîne.

    Identifiant unique du glossaire contenant ce terme.

  • Name— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Nom du terme du glossaire.

  • ShortDescription— UTF-8 chaîne d'une longueur d'au moins 1 octet ou supérieure à 1 024 octets.

    Brève description du terme du glossaire.

  • LongDescription— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou de plus de 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 le catalogue de AWS Glue données par son identifiant.

Exemple

L'exemple suivant extrait un terme du glossaire par 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
  • IdentifierObligatoire : UTF-8 chaîne.

    Identifiant unique du terme du glossaire à récupérer.

Réponse
  • Id— UTF-8 chaîne.

    Identifiant unique du terme du glossaire.

  • GlossaryId— UTF-8 chaîne.

    Identifiant unique du glossaire contenant ce terme.

  • Name— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Nom du terme du glossaire.

  • ShortDescription— UTF-8 chaîne d'une longueur d'au moins 1 octet ou supérieure à 1 024 octets.

    Brève description du terme du glossaire.

  • LongDescription— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou de plus de 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
  • IdentifierObligatoire : UTF-8 chaîne.

    Identifiant unique du terme du glossaire à mettre à jour.

  • Name— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Nom mis à jour du terme du glossaire.

  • ShortDescription— UTF-8 chaîne d'une longueur d'au moins 1 octet ou supérieure à 1 024 octets.

    Brève description mise à jour du terme du glossaire.

  • LongDescription— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou de plus de 4 096 octets.

    Description longue mise à jour du terme du glossaire.

  • ClientToken— UTF-8 chaîne d'au moins 1 octet ou supérieure à 255 octets, correspondant auSingle-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.

    Identifiant unique du terme du glossaire.

  • GlossaryId— UTF-8 chaîne.

    Identifiant unique du glossaire contenant ce terme.

  • Name— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou d'au plus 256 octets.

    Nom du terme du glossaire.

  • ShortDescription— UTF-8 chaîne d'une longueur d'au moins 1 octet ou supérieure à 1 024 octets.

    Brève description du terme du glossaire.

  • LongDescription— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou de plus de 4 096 octets.

    Description longue du terme du glossaire.

Erreurs
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

  • AlreadyExistsException

DeleteGlossaryTerm action (Python : supprimer_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
  • IdentifierObligatoire : 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 commercial dans le catalogue de AWS Glue données.

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
  • GlossaryIdentifierObligatoire : UTF-8 chaîne.

    Identifiant unique du glossaire dont les termes doivent être listés.

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

    Le nombre maximum de résultats à renvoyer dans la réponse.

  • NextToken— UTF-8 chaîne.

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

Réponse
  • GlossaryId— UTF-8 chaîne.

    Identifiant unique du glossaire.

  • Items— Un ensemble d'objets.

    Liste des termes du glossaire.

  • NextToken— UTF-8 chaîne.

    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 le catalogue de AWS Glue données.

Exemple

L'exemple suivant associe un terme du glossaire à une ressource.

aws glue associate-glossary-terms \ --identifier quarterly-sales-2026q1 \ --glossary-term-identifiers avugvxvsul6izr { "Identifier": "quarterly-sales-2026q1", "GlossaryTerms": [ "avugvxvsul6izr" ] }
Demande
  • AssetIdentifierObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 1 087 octets, correspondant auString.

    Identifiant unique de la ressource à laquelle associer les termes du glossaire.

  • GlossaryTermIdentifiersObligatoire : un tableau de UTF-8 chaînes, pas moins d'une ou plus de 10 chaînes.

    Liste des identificateurs de termes du glossaire à associer à l'actif.

  • ClientToken— UTF-8 chaîne d'au moins 1 octet ou supérieure à 255 octets, correspondant auSingle-line string pattern.

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

Réponse
  • Identifier— UTF-8 chaîne d'au moins 1 octet ou supérieure à 1 087 octets, correspondant auString.

    Identifiant unique de l'actif.

  • GlossaryTerms— Un tableau de UTF-8 chaînes comprenant au moins 1 ou au plus 10 chaînes.

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

Erreurs
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

DisassociateGlossaryTerms action (Python : dissocier_glossary_terms)

Supprime l'association d'un ou de plusieurs termes du glossaire à une ressource dans le catalogue de AWS Glue données.

Exemple

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

aws glue disassociate-glossary-terms \ --identifier quarterly-sales-2026q1 \ --glossary-term-identifiers avugvxvsul6izr { "Identifier": "quarterly-sales-2026q1", "GlossaryTerms": [] }
Demande
  • AssetIdentifierObligatoire : UTF-8 chaîne, d'au moins 1 ou plus de 1 087 octets, correspondant auString.

    Identifiant unique de la ressource dont il faut dissocier les termes du glossaire.

  • GlossaryTermIdentifiersObligatoire : un tableau de UTF-8 chaînes, pas moins d'une ou plus de 10 chaînes.

    Liste des identificateurs de termes du glossaire à dissocier de l'actif.

  • ClientToken— UTF-8 chaîne d'au moins 1 octet ou supérieure à 255 octets, correspondant auSingle-line string pattern.

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

Réponse
  • Identifier— UTF-8 chaîne d'au moins 1 octet ou supérieure à 1 087 octets, correspondant auString.

    Identifiant unique de l'actif.

  • GlossaryTerms— Un tableau de UTF-8 chaînes comprenant au moins 1 ou au plus 10 chaînes.

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

Erreurs
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

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

Exemple

L'exemple suivant exécute une recherche de ressources en texte intégral.

aws glue search --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 \ --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" } ] }
Exemple

L'exemple suivant filtre un champ défini par un formulaire. Un champ de formulaire est référencé par l'identifiant du type de ressource du formulaire et le nom du champ, joints par un point (ici, le databaseName champ du amazon.glue::GlueTable formulaire). Les identificateurs de type d'actif pour les types intégrés portent le :: préfixe indiqué dans chaque résultat. AssetTypeId

aws glue search \ --filter-clause '{"AttributeFilter":{"Attribute":"amazon.glue::GlueTable.databaseName","Operator":"equals","Value":{"StringValue":"sales"}}}' \ --max-results 10 { "Items": [ { "Id": "arn:aws:glue:us-east-1:123456789012:table/sales/transactions", "AssetName": "transactions", "AssetDescription": "Raw sales transactions", "UpdatedAt": "2026-06-16T06:42:00.442Z", "AssetTypeId": "amazon.glue::GlueTable" } ] }
Exemple

L'exemple suivant combine un champ de ressource commun et un champ de formulaire avec un ET logique. Les champs d'actifs courants tels que nametype,region, et catalogId sont directement référencés ; les champs définis par un formulaire utilisent la assetTypeId.fieldName notation.

aws glue search \ --filter-clause '{"AndAllFilters":[{"AttributeFilter":{"Attribute":"type","Operator":"equals","Value":{"StringValue":"Table"}}},{"AttributeFilter":{"Attribute":"amazon.glue::GlueTable.databaseName","Operator":"equals","Value":{"StringValue":"sales"}}}]}' \ --max-results 10 { "Items": [ { "Id": "arn:aws:glue:us-east-1:123456789012:table/sales/transactions", "AssetName": "transactions", "AssetDescription": "Raw sales transactions", "UpdatedAt": "2026-06-16T06:42:00.442Z", "AssetTypeId": "amazon.glue::GlueTable" } ] }
Demande
  • SearchText— UTF-8 chaîne de caractères d'une longueur d'au moins 1 ou de plus de 1 000 octets.

    Le texte à rechercher. Au moins l'un searchText des deux filterClause 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 chaîne.

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

  • Sort – Un objet SearchSort.

    Les critères de tri pour les 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

Structure de réponse pour l'Searchopération.

Erreurs
  • AccessDeniedException

  • InvalidInputException

  • InternalServiceException

  • ThrottlingException