View a markdown version of this page

Las API del contexto empresarial - AWS Glue
 —  data types  —AssetFormEntryAssetTypeFormReferenceIterableFormEntryIterableFormItemIterableFormListItemSearchResultItemSearchSortSearchFilterClauseSearchAttributeFilterSearchFilterValueItemErrorGetAssetOutputSearchOutput —  operaciones  —GetAsset (get_asset)PutAsset (put_asset)DeleteAsset (delete_asset)PutAssetType (put_asset_type)GetAssetType (get_asset_type)DeleteAssetType (delete_asset_type)ListAssetTypes (list_asset_types)PutFormType (put_form_type)GetFormType (get_form_type)DeleteFormType (delete_form_type)ListFormTypes (list_form_types)PutAttachment (put_attachment)DeleteAttachment (delete_attachment)ListIterableForms (list_iterable_forms)BatchGetIterableForms (batch_get_iterable_forms)CreateGlosary (create_glossary)GetGlossary (get_glossary)UpdateGlosary (update_glossary)DeleteGlossary (delete_glossary)ListGlossaries (list_glossaries)CreateGlossaryTerm (create_glossary_term)GetGlossaryTerm (get_glossary_term)UpdateGlossaryTerm (update_glossary_term)DeleteGlossaryTerm (delete_glossary_term)ListGlossaryTerms (list_glossary_terms)AssociateGlossaryTerms (associate_glossary_terms)DisassociateGlossaryTerms (disassociate_glossary_terms)Search (search)

Las API del contexto empresarial

La API del contexto empresarial describe los tipos de datos y las operaciones para administrar los activos, los tipos de activos, los tipos de formularios, los glosarios, los términos del glosario, los archivos adjuntos y la búsqueda en el Catálogo de datos de AWS Glue.

Tipos de datos

Estructura AssetFormEntry

Formulario de un activo que consta del identificador del tipo de formulario y de su contenido en JSON.

Campos

  • FormTypeId: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Identificador del tipo de formulario que define el esquema de este formulario.

  • Content: cadena UTF-8.

    Contenido del formulario en JSON que se ajusta al esquema del tipo de formulario especificado.

Estructura AssetTypeFormReference

Referencia a un tipo de formulario incluido en un tipo de activo.

Campos

  • FormTypeIdentifier: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo.

    Identificador del tipo de formulario al que se hace referencia.

Estructura IterableFormEntry

Formulario iterable disponible en un activo, identificado por su tipo de formulario.

Campos

  • FormTypeId: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Identificador del tipo de formulario del formulario iterable (por ejemplo, columns), que se utiliza para recuperar sus elementos mediante ListIterableForms o BatchGetIterableForms.

Estructura IterableFormItem

Elemento de formulario iterable completo con sus formularios.

Campos

  • ItemId: cadena UTF-8.

    Identificador único del elemento.

  • ItemName: cadena UTF-8.

    El nombre del elemento.

  • GlossaryTerms: matriz de cadenas UTF-8, con una cadena como mínimo y 10 cadenas como máximo.

    Identificadores de los términos del glosario asociados al elemento.

  • Forms: matriz de mapas de pares clave-valor.

    Cada clave es una cadena UTF-8.

    Cada valor es un objeto AssetFormEntry.

    Los formularios del elemento, organizados por nombre del formulario.

  • Attachments: matriz de mapas de pares clave-valor.

    Cada clave es una cadena UTF-8.

    Cada valor es un objeto AssetFormEntry.

    Archivos adjuntos adicionales en el elemento para aportar más contexto, organizados por el nombre del archivo adjunto.

Estructura IterableFormListItem

Resumen de un elemento en un formulario iterable.

Campos

  • ItemId: cadena UTF-8.

    Identificador único del elemento.

  • ItemName: cadena UTF-8.

    El nombre del elemento.

  • Description: cadena UTF-8.

    Descripción del elemento.

  • GlossaryTerms: matriz de cadenas UTF-8, con una cadena como mínimo y 10 cadenas como máximo.

    Identificadores de los términos del glosario asociados al elemento.

Estructura SearchResultItem

Único elemento de resultado de búsqueda que representa un activo coincidente.

Campos

  • Id – cadena UTF-8, con 1 byte como mínimo o más de 1087 bytes de largo, que coincide con el String.

    Identificador único del activo coincidente.

  • AssetName: cadena UTF-8.

    Nombre del activo coincidente.

  • AssetDescription: cadena UTF-8.

    Descripción del activo coincidente.

  • UpdatedAt: marca temporal.

    Marca de tiempo de la última actualización del activo coincidente.

  • AssetTypeId: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Identificador del tipo de activo del activo coincidente.

Estructura SearchSort

Criterios de clasificación de los resultados de la solicitud.

Campos

  • Attribute: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 128 bytes como máximo.

    Atributo por el que se clasificará.

  • Order – cadena UTF-8 (valores válidos: ASCENDING | DESCENDING).

    Orden de clasificación. Los valores válidos son ASCENDING y DESCENDING.

Estructura SearchFilterClause

Cláusula de filtro que admite la lógica booleana anidada. Se debe especificar exactamente uno de los siguientes: andAllFilters, orAnyFilters, attributeFilter o mapFilter.

Campos

  • AndAllFilters: Una matriz de objetos SearchFilterClause, con 1 estructura como mínimo y 10 como máximo.

    Lista de cláusulas de filtro que deben coincidir todas (lógica AND).

  • OrAnyFilters: Una matriz de objetos SearchFilterClause, con 1 estructura como mínimo y 10 como máximo.

    Lista de cláusulas de filtro con las que debe coincidir al menos una (lógica OR).

  • AttributeFilter: un objeto SearchAttributeFilter.

    Filtro basado en un único valor de atributo.

  • MapFilter – .

    Filtro basado en un par clave-valor de un atributo de la asignación.

Estructura SearchAttributeFilter

Filtro que compara el valor de un atributo mediante un operador.

Campos

  • Attribute: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 128 bytes como máximo.

    El nombre del atributo con el que se va a filtrar.

  • Operator Obligatorio: cadena UTF-8 (valores válidos: equals | greaterThan | greaterThanOrEquals | lessThan | lessThanOrEquals | notExists).

    El operador de comparación. Los valores válidos son equals, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals y notExists.

  • Value: un objeto SearchFilterValue.

    Valor con el que se comparará.

Estructura SearchFilterValue

Valor del filtro. Se debe especificar exactamente uno de los siguientes: stringValue o longValue.

Campos

  • StringValue: cadena UTF-8 de 256 bytes de largo como máximo.

    Valor del filtro de cadenas.

  • LongValue: número (largo).

    Valor del filtro de tipo de número entero largo.

Estructura ItemError

Error que se produjo al recuperar un elemento de un formulario iterable.

Campos

  • ItemIdentifier: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo.

    Identificador del elemento que causó el error.

  • Code: cadena UTF-8.

    Código de error.

  • Message: cadena UTF-8.

    Mensaje de error.

Estructura GetAssetOutput

Estructura de respuesta de la operación GetAsset.

Campos

  • Id – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo, que coincide con el String.

    Identificador único del activo.

  • Name: cadena UTF-8.

    Nombre del activo.

  • Description: cadena UTF-8.

    Descripción del activo.

  • CreatedAt: marca temporal.

    Marca temporal de creación del activo.

  • UpdatedAt: marca temporal.

    Marca temporal de la última actualización del activo.

  • CreatedBy – .

    Identidad de la entidad principal que creó el activo.

  • UpdatedBy – .

    Identidad de la entidad principal que actualizó el activo por última vez.

  • AssetTypeId: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo.

    Identificador del tipo de activo para este activo.

  • GlossaryTerms: matriz de cadenas UTF-8, con una cadena como mínimo y 10 cadenas como máximo.

    Identificadores de los términos del glosario asociados al activo.

  • Forms: matriz de mapas de pares clave-valor.

    Cada clave es una cadena UTF-8.

    Cada valor es un objeto AssetFormEntry.

    Los formularios del activo, organizados por nombre del formulario.

  • Attachments: matriz de mapas de pares clave-valor.

    Cada clave es una cadena UTF-8.

    Cada valor es un objeto AssetFormEntry.

    Archivos adjuntos adicionales en el activo para aportar más contexto, organizados por el nombre del archivo adjunto.

  • IterableForms: matriz de mapas de pares clave-valor.

    Cada clave es una cadena UTF-8.

    Cada valor es un objeto IterableFormEntry.

    Los formularios iterables disponibles en el activo, organizados por el nombre del formulario (por ejemplo, columns). Para recuperar los elementos del formulario, utilice el nombre del formulario con ListIterableForms o BatchGetIterableForms.

Estructura SearchOutput

Estructura de respuesta de la operación Search.

Campos

  • Items: matriz de objetos SearchResultItem.

    Lista de activos que coinciden con los criterios de búsqueda.

  • TotalCount: número (entero).

    Número total de activos que coinciden con los criterios de búsqueda.

  • NextToken: cadena UTF-8.

    Un token de continuación, presente si el segmento de lista actual no es el último.

  • Aggregations: matriz de objetos.

    Resultados de la agregación de los atributos solicitados.

Operaciones

Acción GetAsset (Python: get_asset)

Recupera los metadatos de un activo del Catálogo de datos de AWS Glue, entre ellos sus formularios, archivos adjuntos adicionales y términos del glosario asociados.

ejemplo

El siguiente ejemplo muestra cómo recuperar un activo mediante su identificador.

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

  • Identifier – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo, que coincide con el String.

    Identificador único del activo que se va a recuperar.

Respuesta

Estructura de respuesta de la operación GetAsset.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • ThrottlingException

  • InvalidInputException

Acción PutAsset (Python: put_asset)

Crea o actualiza un activo en el Catálogo de datos de AWS Glue. Si el activo ya existe, esta operación lo actualiza. De lo contrario, se crea un activo nuevo.

ejemplo

El siguiente ejemplo muestra cómo crear una tarea con un rol asociado.

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

  • AssetTypeId: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo.

    El identificador del tipo de activo para el activo.

  • Identifier – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo, que coincide con el String.

    Identificador único del activo. Se actualiza si ya existe un activo con este identificador.

  • Name: obligatorio: cadena UTF-8.

    Nombre del activo.

  • Description: cadena UTF-8.

    Descripción del activo.

  • Forms – Obligatorio: matriz de mapas de pares clave-valor.

    Cada clave es una cadena UTF-8.

    Cada valor es un objeto AssetFormEntry.

    Formularios que se configurarán en el activo, organizados por nombre del formulario. Cada entrada especifica el tipo de formulario y su contenido en JSON.

  • ClientToken – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Un identificador único con distinción entre mayúsculas y minúsculas, que se proporciona para garantizar la idempotencia de la solicitud.

Respuesta

  • Id – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo, que coincide con el String.

    Identificador único del activo.

  • Name: obligatorio: cadena UTF-8.

    Nombre del activo.

  • Description: cadena UTF-8.

    Descripción del activo.

  • CreatedAt: marca temporal.

    Marca temporal de creación del activo.

  • Forms: matriz de mapas de pares clave-valor.

    Cada clave es una cadena UTF-8.

    Cada valor es un objeto AssetFormEntry.

    Formularios adjuntos al activo, organizados por nombre del formulario.

Errores

  • AccessDeniedException

  • ConcurrentModificationException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

Acción DeleteAsset (Python: delete_asset)

Elimina un activo del Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo eliminar un activo mediante su identificador.

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

  • Identifier – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo, que coincide con el String.

    Identificador único del activo que se eliminará.

Respuesta

  • Sin parámetros de respuesta.

Errores

  • AccessDeniedException

  • ConcurrentModificationException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

PutAssetType (Python: put_asset_type)

Crea o actualiza un tipo de activo en el Catálogo de datos de AWS Glue. Tipo de activo que define la estructura de los activos especificando los formularios que incluyen. Se actualiza si ya existe un tipo de activo con ese nombre.

ejemplo

El siguiente ejemplo muestra cómo crear un tipo de activo que hace referencia a un tipo de formulario.

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

  • Name – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el String.

    Nombre del tipo de activo.

  • Forms – obligatorio: una matriz de asignación de pares de clave-valor, con 1 par como mínimo y 100 como máximo.

    Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con String.

    Cada valor es un objeto AssetTypeFormReference.

    Formularios que componen el tipo de activo, organizados por el nombre del formulario. Cada entrada hace referencia al tipo de formulario que define el esquema del formulario.

  • ClientToken – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Un identificador único con distinción entre mayúsculas y minúsculas, que se proporciona para garantizar la idempotencia de la solicitud.

Respuesta

  • Id: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Identificador del tipo de activo.

  • Name – cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el String.

    Nombre del tipo de activo.

  • Forms: una matriz de asignación de pares de clave-valor, con 1 par como mínimo y 100 como máximo.

    Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con String.

    Cada valor es un objeto AssetTypeFormReference.

    Formularios que componen el tipo de activo, organizados por el nombre del formulario.

Errores

  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

Acción GetAssetType (Python: get_asset_type)

Recupera un tipo de activo en el Catálogo de datos de AWS Glue mediante su identificador.

ejemplo

El siguiente ejemplo muestra cómo recuperar un tipo de activo mediante su identificador.

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

  • Identifier: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo.

    Identificador del tipo de activo que se recuperará.

Respuesta

  • Id: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Identificador del tipo de activo.

  • Name – cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el String.

    Nombre del tipo de activo.

  • Forms: una matriz de asignación de pares de clave-valor, con 1 par como mínimo y 100 como máximo.

    Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con String.

    Cada valor es un objeto AssetTypeFormReference.

    Formularios que componen el tipo de activo, organizados por el nombre del formulario.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

Acción DeleteAssetType (Python: delete_asset_type)

Elimina un tipo de activo del Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo eliminar un tipo de activo mediante su identificador.

aws glue delete-asset-type --identifier DataSet
Solicitud

  • Identifier: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo.

    Identificador del tipo de activo que se eliminará.

Respuesta

  • Sin parámetros de respuesta.

Errores

  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

Acción ListAssetTypes (Python: list_asset_types)

Enumera los tipos de activos definidos en el Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo enumerar los tipos de activos en la cuenta.

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

  • MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.

    El número máximo de resultados que se devolverá en la respuesta.

  • NextToken: cadena UTF-8.

    Token de continuación si se trata de una llamada de continuidad.

Respuesta

  • Items: matriz de objetos.

    Lista de elementos del tipo de activo.

  • NextToken: cadena UTF-8.

    Un token de continuación, presente si el segmento de lista actual no es el último.

Errores

  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

PutFormType (Python: put_form_type)

Crea o actualiza un tipo de formulario en el Catálogo de datos de AWS Glue. Tipo de formulario que define el esquema de los metadatos estructurados que pueden adjuntarse a los activos.

ejemplo

El siguiente ejemplo muestra cómo crear un tipo de formulario con un esquema de 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}"
    }
Solicitud

  • Name – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el String.

    El nombre del tipo de formulario. Debe empezar con una letra mayúscula.

  • Schema: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 100000 como máximo.

    Definición del esquema IDL de Smithy para el tipo de formulario.

  • ClientToken – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Un identificador único con distinción entre mayúsculas y minúsculas, que se proporciona para garantizar la idempotencia de la solicitud.

Respuesta

  • Id: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Identificador del tipo de formulario.

  • Name – cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el String.

    El nombre del tipo de formulario.

  • Schema: Cadena UTF-8 con una extensión de 1 byte como mínimo o 100 000 como máximo.

    Esquema IDL de Smithy para el tipo de formulario.

Errores

  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

Acción GetFormType (Python: get_form_type)

Recupera un tipo de formulario en el Catálogo de datos de AWS Glue mediante su identificador.

ejemplo

El siguiente ejemplo muestra cómo recuperar un tipo de formulario mediante su identificador.

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

  • Identifier: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo.

    Identificador del tipo de formulario que se recuperará.

Respuesta

  • Id: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Identificador del tipo de formulario.

  • Name – cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el String.

    Nombre del tipo de formulario.

  • Schema: Cadena UTF-8 con una extensión de 1 byte como mínimo o 100 000 como máximo.

    Esquema IDL de Smithy para el tipo de formulario.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

Acción DeleteFormType (Python: delete_form_type)

Elimina un tipo de formulario del Catálogo de datos de AWS Glue. No se puede eliminar un tipo de formulario si un tipo de activo sigue haciendo referencia a él.

ejemplo

El siguiente ejemplo muestra cómo eliminar un tipo de formulario mediante su identificador.

aws glue delete-form-type --identifier DataClassification
Solicitud

  • Identifier: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo.

    Identificador del tipo de formulario que se eliminará.

Respuesta

  • Sin parámetros de respuesta.

Errores

  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ConflictException

  • ThrottlingException

Acción ListFormTypes (Python: list_form_types)

Enumera los tipos de formularios definidos en el Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo enumerar los tipos de formularios en la cuenta.

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

  • MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.

    El número máximo de resultados que se devolverá en la respuesta.

  • NextToken: cadena UTF-8.

    Token de continuación si se trata de una llamada de continuidad.

Respuesta

  • Items – obligatorio: una matriz de objetos.

    Lista de elementos del tipo de formulario.

  • NextToken: cadena UTF-8.

    Un token de continuación, presente si el segmento de lista actual no es el último.

Errores

  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

PutAttachment (Python: put_attachment)

Adjunta un formulario a un activo o a un elemento de formulario iterable en el Catálogo de datos de AWS Glue. Se sobrescribirá si ya existe un archivo adjunto con el mismo nombre.

ejemplo

El siguiente ejemplo muestra cómo adjuntar un formulario a un activo.

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

  • AssetIdentifier – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo, que coincide con el String.

    Identificador único del activo que se adjuntará al formulario.

  • IterableFormName – cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el String.

    El nombre del formulario iterable. Si se especifica junto con itemIdentifier, el archivo adjunto se dirige a un elemento del formulario iterable y no al activo en sí.

  • ItemIdentifier: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo.

    Identificador del elemento en el formlario iterable. Es obligatorio cuando se especifica iterableFormName.

  • AttachmentName – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el String.

    Nombre del archivo adjunto.

  • Content: obligatorio: cadena UTF-8.

    Contenido del formulario en JSON que se ajusta al esquema del tipo de formulario especificado.

  • FormTypeId: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo.

    Identificador del tipo de formulario de este archivo adjunto.

  • ClientToken – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Un identificador único con distinción entre mayúsculas y minúsculas, que se proporciona para garantizar la idempotencia de la solicitud.

Respuesta

  • AssetId – cadena UTF-8, con 1 byte como mínimo o más de 1087 bytes de largo, que coincide con el String.

    Identificador único del activo.

  • IterableFormName – cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el String.

    Nombre del formulario iterable si el adjunto está dirigido a un elemento.

  • ItemIdentifier: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo.

    Identificador del elemento en el formulario iterable, si corresponde.

  • AttachmentName – cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el String.

    Nombre del archivo adjunto.

  • FormTypeId: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Identificador del tipo de formulario de este archivo adjunto.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

Acción DeleteAttachment (Python: delete_attachment)

Elimina el archivo adjunto de un formulario de un activo del Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo eliminar un archivo adjunto de un activo.

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

  • AssetIdentifier – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo, que coincide con el String.

    Identificador único del activo del que se eliminará el archivo adjunto.

  • AttachmentName – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el String.

    Nombre del archivo adjunto que se eliminará.

Respuesta

  • Identifier – cadena UTF-8, con 1 byte como mínimo o más de 1087 bytes de largo, que coincide con el String.

    Identificador único del activo.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

Acción ListIterableForms (Python: list_iterable_forms)

Enumera los elementos de un formulario iterable en un activo del Catálogo de datos de AWS Glue. Por ejemplo, enumera las columnas de una tabla de activos.

ejemplo

El siguiente ejemplo muestra cómo enumerar las columnas de un activo.

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

  • AssetIdentifier – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo, que coincide con el String.

    Identificador único del activo.

  • IterableFormName – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el String.

    El nombre del formulario iterable del que se muestran los elementos.

  • MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.

    El número máximo de resultados que se devolverá en la respuesta.

  • NextToken: cadena UTF-8.

    Token de continuación si se trata de una llamada de continuidad.

Respuesta

  • AssetId – cadena UTF-8, con 1 byte como mínimo o más de 1087 bytes de largo, que coincide con el String.

    Identificador único del activo.

  • IterableFormName – cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el String.

    El nombre del formulario iterable.

  • Items: matriz de objetos IterableFormListItem.

    Lista de elementos del formulario iterable.

  • NextToken: cadena UTF-8.

    Un token de continuación, presente si el segmento de lista actual no es el último.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • ThrottlingException

  • InvalidInputException

Acción BatchGetIterableForms (Python: batch_get_iterable_forms)

Recupera varios elementos de un formulario iterable de un activo del Catálogo de datos de AWS Glue en una sola solicitud.

ejemplo

El siguiente ejemplo muestra cómo recuperar columnas específicas mediante su identificador.

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

  • AssetIdentifier – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo, que coincide con el String.

    Identificador único del activo.

  • IterableFormName – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el String.

    El nombre del formulario iterable del que se recuperan los elementos.

  • ItemIdentifiers: obligatorio: matriz de cadenas UTF-8, con una cadena como mínimo y 100 cadenas como máximo.

    Lista de identificadores de los elementos que se recuperarán. Cada identificador puede ser un ID de elemento o un nombre de elemento.

Respuesta

  • Items: matriz de objetos IterableFormItem.

    Lista de elementos del formulario iterable recuperados.

  • Errors: matriz de objetos ItemError.

    Lista de errores de los elementos que no se pudieron recuperar.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

Acción CreateGlossary (Python: create_glossary)

Crea un glosario empresarial en el Catálogo de datos de AWS Glue. Un glosario es un conjunto de términos del glosario que definen conceptos empresariales.

ejemplo

El siguiente ejemplo muestra cómo crear un glosario empresarial.

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

  • Name: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo.

    Nombre del glosario.

  • Description: cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo.

    Descripción del glosario.

  • ClientToken – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Un identificador único con distinción entre mayúsculas y minúsculas, que se proporciona para garantizar la idempotencia de la solicitud.

Respuesta

  • Id: cadena UTF-8.

    Identificador único del glosario.

  • Name: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Nombre del glosario.

  • Description: cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo.

    Descripción del glosario.

Errores

  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

  • AlreadyExistsException

Acción GetGlossary (Python: get_glossary)

Recupera un glosario empresarial del Catálogo de datos de AWS Glue mediante su identificador.

ejemplo

El siguiente ejemplo muestra cómo recuperar un glosario mediante su identificador.

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

  • Identifier: obligatorio: cadena UTF-8.

    Identificador único del glosario que se recuperará.

Respuesta

  • Id: cadena UTF-8.

    Identificador único del glosario.

  • Name: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Nombre del glosario.

  • Description: cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo.

    Descripción del glosario.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • ThrottlingException

Acción UpdateGlossary (Python: update_glossary)

Actualiza un glosario empresarial en el Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo actualizar la descripción de un glosario.

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

  • Identifier: obligatorio: cadena UTF-8.

    Identificador único del glosario que se actualizará.

  • Name: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    El nombre actualizado del glosario.

  • Description: cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo.

    Descripción actualizada del glosario.

  • ClientToken – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Un identificador único con distinción entre mayúsculas y minúsculas, que se proporciona para garantizar la idempotencia de la solicitud.

Respuesta

  • Id: cadena UTF-8.

    Identificador único del glosario.

  • Name: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Nombre del glosario.

  • Description: cadena UTF-8 con una extensión de 1 byte como mínimo o 2048 bytes como máximo.

    Descripción del glosario.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

  • AlreadyExistsException

Acción DeleteGlossary (Python: delete_glossary)

Elimina un glosario empresarial del Catálogo de datos de AWS Glue. No se puede eliminar un glosario si aún contiene términos del glosario.

ejemplo

El siguiente ejemplo muestra cómo eliminar un glosario mediante su identificador.

aws glue delete-glossary --identifier 6n5f21s641nbjb
Solicitud

  • Identifier: obligatorio: cadena UTF-8.

    Identificador único del glosario que se eliminará.

Respuesta

  • Sin parámetros de respuesta.

Errores

  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConflictException

  • ConcurrentModificationException

  • ThrottlingException

Acción ListGlossaries (Python: list_glossaries)

Enumera los glosarios empresariales en el Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo enumerar los glosarios en la cuenta.

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

  • MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.

    El número máximo de resultados que se devolverá en la respuesta.

  • NextToken: cadena UTF-8.

    Token de continuación si se trata de una llamada de continuidad.

Respuesta

  • Items: matriz de objetos.

    Lista de elementos del glosario.

  • NextToken: cadena UTF-8.

    Un token de continuación, presente si el segmento de lista actual no es el último.

Errores

  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

Acción CreateGlossaryTerm (Python: create_glossary_term)

Crea un término de glosario para un glosario empresarial del Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo crear un término del glosario.

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

  • GlossaryIdentifier: obligatorio: cadena UTF-8.

    Identificador único del glosario en el que se creará el término.

  • Name: requerido: cadena UTF-8 con una extensión de 1 byte como mínimo y 256 bytes como máximo.

    Nombre del término del glosario.

  • ShortDescription: cadena UTF-8, con 1 byte de largo como mínimo y 1024 bytes de largo como máximo.

    Breve descripción del término del glosario.

  • LongDescription: cadena UTF-8, con 1 byte de largo como mínimo y 4096 bytes de largo como máximo.

    Descripción extensa del término del glosario.

  • ClientToken – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Un identificador único con distinción entre mayúsculas y minúsculas, que se proporciona para garantizar la idempotencia de la solicitud.

Respuesta

  • Id: cadena UTF-8.

    Identificador único del término del glosario.

  • GlossaryId: cadena UTF-8.

    Identificador único del glosario que contiene este término.

  • Name: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Nombre del término del glosario.

  • ShortDescription: cadena UTF-8, con 1 byte de largo como mínimo y 1024 bytes de largo como máximo.

    Breve descripción del término del glosario.

  • LongDescription: cadena UTF-8, con 1 byte de largo como mínimo y 4096 bytes de largo como máximo.

    Descripción extensa del término del glosario.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

  • AlreadyExistsException

Acción GetGlossaryTerm (Python: get_glossary_term)

Recupera un término del glosario del Catálogo de datos de AWS Glue mediante su identificador.

ejemplo

El siguiente ejemplo muestra cómo recuperar un término del glosario mediante su identificador.

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

  • Identifier: obligatorio: cadena UTF-8.

    Identificador único del término del glosario que se recuperará.

Respuesta

  • Id: cadena UTF-8.

    Identificador único del término del glosario.

  • GlossaryId: cadena UTF-8.

    Identificador único del glosario que contiene este término.

  • Name: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Nombre del término del glosario.

  • ShortDescription: cadena UTF-8, con 1 byte de largo como mínimo y 1024 bytes de largo como máximo.

    Breve descripción del término del glosario.

  • LongDescription: cadena UTF-8, con 1 byte de largo como mínimo y 4096 bytes de largo como máximo.

    Descripción extensa del término del glosario.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • ThrottlingException

Acción UpdateGlossaryTerm (Python: update_glossary_term)

Actualiza un término del glosario en el Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo actualizar la breve descripción de un término del glosario.

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

  • Identifier: obligatorio: cadena UTF-8.

    Identificador único del término del glosario que se actualizará.

  • Name: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Nombre actualizado del término del glosario.

  • ShortDescription: cadena UTF-8, con 1 byte de largo como mínimo y 1024 bytes de largo como máximo.

    Breve descripción actualizada del término del glosario.

  • LongDescription: cadena UTF-8, con 1 byte de largo como mínimo y 4096 bytes de largo como máximo.

    Descripción extensa actualizada del término del glosario.

  • ClientToken – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Un identificador único con distinción entre mayúsculas y minúsculas, que se proporciona para garantizar la idempotencia de la solicitud.

Respuesta

  • Id: cadena UTF-8.

    Identificador único del término del glosario.

  • GlossaryId: cadena UTF-8.

    Identificador único del glosario que contiene este término.

  • Name: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo.

    Nombre del término del glosario.

  • ShortDescription: cadena UTF-8, con 1 byte de largo como mínimo y 1024 bytes de largo como máximo.

    Breve descripción del término del glosario.

  • LongDescription: cadena UTF-8, con 1 byte de largo como mínimo y 4096 bytes de largo como máximo.

    Descripción extensa del término del glosario.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

  • AlreadyExistsException

Acción DeleteGlossaryTerm (Python: delete_glossary_term)

Elimina un término del glosario del Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo eliminar un término del glosario mediante su identificador.

aws glue delete-glossary-term --identifier avugvxvsul6izr
Solicitud

  • Identifier: obligatorio: cadena UTF-8.

    Identificador único del término del glosario que se eliminará.

Respuesta

  • Sin parámetros de respuesta.

Errores

  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

Acción ListGlossaryTerms (Python: list_glossary_terms)

Muestra los términos del glosario en un glosario empresarial del Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo presentar los términos de un glosario.

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

  • GlossaryIdentifier: obligatorio: cadena UTF-8.

    Identificador único del glosario cuyos términos se mostrarán.

  • MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.

    El número máximo de resultados que se devolverá en la respuesta.

  • NextToken: cadena UTF-8.

    Token de continuación si se trata de una llamada de continuidad.

Respuesta

  • GlossaryId: cadena UTF-8.

    Identificador único del glosario.

  • Items: matriz de objetos.

    Lista de elementos del término del glosario.

  • NextToken: cadena UTF-8.

    Un token de continuación, presente si el segmento de lista actual no es el último.

Errores

  • AccessDeniedException

  • InternalServiceException

  • InvalidInputException

  • ThrottlingException

Acción AssociateGlosaryTerms (Python: associate_glossary_terms)

Vincula uno o más términos del glosario a un activo del Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo vincular un término del glosario a un activo.

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

  • AssetIdentifier – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo, que coincide con el String.

    Identificador único del activo al que vincular los términos del glosario.

  • GlossaryTermIdentifiers: obligatorio: matriz de cadenas UTF-8, con una cadena como mínimo y 10 cadenas como máximo.

    Lista de identificadores de términos del glosario que se vincularán al activo.

  • ClientToken – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Un identificador único con distinción entre mayúsculas y minúsculas, que se proporciona para garantizar la idempotencia de la solicitud.

Respuesta

  • Identifier – cadena UTF-8, con 1 byte como mínimo o más de 1087 bytes de largo, que coincide con el String.

    Identificador único del activo.

  • GlossaryTerms: matriz de cadenas UTF-8, con una cadena como mínimo y 10 cadenas como máximo.

    Términos del glosario que ahora están asociados al activo.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

Acción DisassociateGlosaryTerms (Python: disassociate_glossary_terms)

Elimina la asociación de uno o más términos del glosario de un activo del Catálogo de datos de AWS Glue.

ejemplo

El siguiente ejemplo muestra cómo eliminar un término de glosario de un activo.

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

  • AssetIdentifier – Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1087 bytes de largo como máximo, que coincide con el String.

    Identificador único del activo del que se desvincularán los términos del glosario.

  • GlossaryTermIdentifiers: obligatorio: matriz de cadenas UTF-8, con una cadena como mínimo y 10 cadenas como máximo.

    Lista de identificadores de términos del glosario que se desvincularán del activo.

  • ClientToken – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Un identificador único con distinción entre mayúsculas y minúsculas, que se proporciona para garantizar la idempotencia de la solicitud.

Respuesta

  • Identifier – cadena UTF-8, con 1 byte como mínimo o más de 1087 bytes de largo, que coincide con el String.

    Identificador único del activo.

  • GlossaryTerms: matriz de cadenas UTF-8, con una cadena como mínimo y 10 cadenas como máximo.

    Términos del glosario pendientes vinculados al activo.

Errores

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • ConcurrentModificationException

  • ThrottlingException

Busca activos en el Catálogo de datos de AWS Glue mediante la búsqueda de texto completo, los filtros, la clasificación y las agregaciones. Devuelve los activos que coinciden con los resultados clasificados por relevancia.

ejemplo

El siguiente ejemplo muestra cómo ejecutar una búsqueda de texto completo de activos.

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

El siguiente ejemplo muestra cómo buscar una cláusula de filtro y un criterio de ordenación.

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

El siguiente ejemplo muestra cómo filtrar un campo definido por un formulario. Se hace referencia a un campo de formulario mediante el identificador del tipo de activo del formulario y el nombre del campo, unidos por un punto (en este caso, el campo databaseName del formulario amazon.glue::GlueTable). Los identificadores de tipo de activo de los tipos integrados llevan el prefijo :: que se muestra en cada resultado de 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"
            }
        ]
    }
ejemplo

El siguiente ejemplo muestra cómo combinar un campo de activo común y un campo de formulario con una lógica AND. Se hace referencia directamente a los campos de activos comunes name, type, region y catalogId. Los campos definidos en un formulario utilizan la notación assetTypeId.fieldName.

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

  • SearchText: cadena UTF-8, con 1 byte de largo como mínimo y 1000 bytes de largo como máximo.

    El texto que se va a buscar. Se debe especificar al menos uno de los siguientes: searchText o filterClause.

  • MaxResults: número (entero) que no es inferior a 1 ni es superior a 100.

    El número máximo de resultados que se devolverá en la respuesta.

  • NextToken: cadena UTF-8.

    Token de continuación si se trata de una llamada de continuidad.

  • Sort: un objeto SearchSort.

    Criterios de clasificación de los resultados de la solicitud.

  • FilterClause: un objeto SearchFilterClause.

    La cláusula de filtro que se aplicará a la búsqueda. Es compatible con la lógica AND/OR anidada con filtros a nivel de atributo y de asignación.

Respuesta

Estructura de respuesta de la operación Search.

Errores

  • AccessDeniedException

  • InvalidInputException

  • InternalServiceException

  • ThrottlingException