— tipos de dados —AssetFormEntry AssetTypeFormReference IterableFormEntry IterableFormItem IterableFormListItem SearchResultItem SearchSort SearchFilterClause SearchAttributeFilter SearchFilterValue ItemError GetAssetOutput SearchOutput — operações —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)CreateGlossary (create_glossary)GetGlossary (get_glossary)UpdateGlossary (update_glossary)DeleteGlossary (delete_glossary)ListGlossaries (list_glossaries)CreateGlossaryTerm (create_glossary_term)GetGlossaryTerm (get_glossary_term)UpdateGlossaryTerm (update_glossary_term)DeleteGlossaryTerm (delete_glossary_term)ListGlossaryTerms (list_glossary_terms)AssociateGlossaryTerms (associate_glossary_terms)DisassociateGlossaryTerms (disassociate_glossary_terms)Pesquisa (search)

APIs de contexto de negócios

A API de contexto de negócios descreve os tipos de dados e as operações para gerenciar ativos, tipos de ativos, tipos de formulários, glossários, termos do glossário, anexos e pesquisa no AWS Glue Data Catalog.

Estrutura AssetFormEntry

Um formulário em um ativo, consistindo no identificador do tipo de formulário e seu conteúdo JSON.

Campos

FormTypeId: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O identificador do tipo de formulário que define o esquema desse formulário.
Content – String UTF-8.

O conteúdo JSON do formulário, em conformidade com o esquema do tipo de formulário especificado.

Estrutura AssetTypeFormReference

Uma referência a um tipo de formulário incluído em um tipo de ativo.

Campos

FormTypeIdentifier: obrigatório: string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento.

O identificador do tipo de formulário referenciado.

Estrutura IterableFormEntry

Um formulário iterável disponível em um ativo, identificado por seu tipo de formulário.

Campos

FormTypeId: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O identificador do tipo de formulário iterável (por exemplo, columns), usado para recuperar os itens por meio de ListIterableForms ou BatchGetIterableForms.

Estrutura IterableFormItem

Um item de formulário iterável completo com seus formulários.

Campos

ItemId – String UTF-8.

O identificador exclusivo do item.
ItemName – String UTF-8.

O nome do item.
GlossaryTerms: uma matriz de strings UTF-8, não menos que 1 ou mais que 10 strings.

Os identificadores dos termos do glossário associados ao item.
Forms – Um array de mapa dos pares de valor-chave.

Cada chave é uma sequência de caracteres UTF-8.

Cada valor é um objeto AssetFormEntry.

Os formulários do item, codificados pelo nome do formulário.
Attachments – Um array de mapa dos pares de valor-chave.

Cada chave é uma sequência de caracteres UTF-8.

Cada valor é um objeto AssetFormEntry.

Anexos adicionais no item para mais contexto, codificados pelo nome do anexo.

Estrutura iterableFormListItem

Um resumo de um item em um formulário iterável.

Campos

ItemId – String UTF-8.

O identificador exclusivo do item.
ItemName – String UTF-8.

O nome do item.
Description – String UTF-8.

A descrição do item.
GlossaryTerms: uma matriz de strings UTF-8, não menos que 1 ou mais que 10 strings.

Os identificadores dos termos do glossário associados ao item.

Estrutura SearchResultItem

Um único item de resultado de pesquisa representando um ativo correspondente.

Campos

Id – string UTF-8, com pelo menos 1 e não mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo correspondente.
AssetName – String UTF-8.

O nome do ativocorrespondente.
AssetDescription – String UTF-8.

A descrição do ativo correspondente.
UpdatedAt – Timestamp.

A data e hora em que o ativo correspondente foi atualizado pela última vez.
AssetTypeId: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O identificador do tipo de ativo para o ativo correspondente.

Estrutura SearchSort

Critérios de pesquisa para os resultados da pesquisa.

Campos

Attribute: obrigatório: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

O atributo pelo qual executar a classificação.
Order – string UTF-8 (valores válidos: ASCENDING | DESCENDING).

A ordem de classificação. Os valores válidos são ASCENDING e DESCENDING.

Estrutura SearchFilterClause

Uma cláusula de filtro que oferece suporte à lógica booleana aninhada. Exatamente uma das opções andAllFilters, orAnyFilters, attributeFilter ou mapFilter deve ser especificada.

Campos

AndAllFilters: uma matriz de objetos SearchFilterClause com não menos que 1 nem mais que 10 estruturas.

Uma lista de todas as cláusulas de filtro que têm que ser correspondentes (AND lógico).
OrAnyFilters: uma matriz de objetos SearchFilterClause com não menos que 1 nem mais que 10 estruturas.

Uma lista de cláusulas de filtro em que pelo menos uma tem que ser correspondente (OR lógico).
AttributeFilter – Um objeto SearchAttributeFilter.

Um filtro em um único valor de atributo.
MapFilter – .

Um filtro no par de chave/valor de um atributo do mapa.

Estrutura SearchAttributeFilter

Um filtro que compara o valor de um atributo usando um operador.

Campos

Attribute: obrigatório: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

O nome do atributo a ser filtrado.
Operator – obrigatório: string UTF-8 (valores válidos: equals | greaterThan | greaterThanOrEquals | lessThan | lessThanOrEquals | notExists).

O operador de comparação. Os valores válidos são equals, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals e notExists.
Value – Um objeto SearchFilterValue.

O valor a ser comparado.

Estrutura SearchFilterValue

Um valor do filtro. Exatamente uma das opções stringValue ou longValue deve ser especificada.

Campos

StringValue – String UTF-8 com comprimento não superior a 256 bytes.

Um valor de filtro de string.
LongValue – Número (extenso).

Um valor de filtro inteiro extenso.

Estrutura ItemError

Um erro que ocorreu ao recuperar um item de formulário iterável.

Campos

ItemIdentifier: string UTF-8, não menos do que 1 ou mais de 1087 bytes de comprimento.

O identificador do item que causou o erro.
Code – String UTF-8.

O código do erro.
Message – String UTF-8.

A mensagem de erro.

Estrutura GetAssetOutput

A estrutura de resposta para a operação GetAsset.

Campos

Id – Obrigatório: string UTF-8, no mínimo 1 ou mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo.
Name – String UTF-8.

O nome do ativo.
Description – String UTF-8.

A descrição do ativo.
CreatedAt – Timestamp.

A data e hora em que o ativo foi criado.
UpdatedAt – Timestamp.

A data e hora em que o ativo foi atualizado pela última vez.
CreatedBy – .

A identidade da entidade principal que criou o ativo.
UpdatedBy – .

A identidade da entidade principal atualizou o ativo pela última vez.
AssetTypeId: obrigatório: string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento.

O identificador do tipo de ativo para esse ativo.
GlossaryTerms: uma matriz de strings UTF-8, não menos que 1 ou mais que 10 strings.

Os identificadores dos termos do glossário associados ao ativo.
Forms – Um array de mapa dos pares de valor-chave.

Cada chave é uma sequência de caracteres UTF-8.

Cada valor é um objeto AssetFormEntry.

Os formulários do ativo, codificados pelo nome do formulário.
Attachments – Um array de mapa dos pares de valor-chave.

Cada chave é uma sequência de caracteres UTF-8.

Cada valor é um objeto AssetFormEntry.

Anexos adicionais no ativo para mais contexto, codificados pelo nome do anexo.
IterableForms – Um array de mapa dos pares de valor-chave.

Cada chave é uma sequência de caracteres UTF-8.

Cada valor é um objeto IterableFormEntry.

Os formulários iteráveis disponíveis no ativo, codificados pelo nome do formulário (por exemplo, columns). Use o nome do formulário com ListIterableForms ou BatchGetIterableForms para recuperar os itens do formulário.

Estrutura SearchOutput

A estrutura de resposta para a operação Search.

Campos

Items: um array de objetos SearchResultItem.

A lista de ativos que correspondem aos critérios de pesquisa.
TotalCount – Número (íntegro).

O número total de ativos que correspondem aos critérios de pesquisa.
NextToken – String UTF-8.

Um token de continuação, presente se o segmento atual não for o último.
Aggregations: um array de objetos.

Os resultados da agregação para os atributos solicitados.

Operações

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

Ação GetAsset (Python: get_asset)

Recupera os metadados de um ativo no AWS Glue Data Catalog, incluindo os formulários, anexos adicionais e termos do glossário associados.

exemplo

O exemplo a seguir recupera um ativo por meio de seu 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": {}
    }

Solicitação

Identifier – Obrigatório: string UTF-8, no mínimo 1 ou mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo a ser recuperado.

Resposta

A estrutura de resposta para a operação GetAsset.

GetAssetOutput – Um objeto GetAssetOutput.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException
InvalidInputException

Ação PutAsset (Python: put_asset)

Cria ou atualiza um ativo no AWS Glue Data Catalog. Se o ativo já existir, essa operação o atualizará; caso contrário, um novo ativo será criado.

exemplo

O exemplo a seguir cria um ativo com um formulário.


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

Solicitação

AssetTypeId: obrigatório: string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento.

O identificador do tipo de ativo para o ativo.
Identifier – Obrigatório: string UTF-8, no mínimo 1 ou mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo. Se um ativo com esse identificador já existir, ele será atualizado.
Name – Obrigatório: string UTF-8.

O nome do ativo.
Description – String UTF-8.

A descrição do ativo.
Forms: obrigatório: uma matriz de mapa dos pares de chave-valor.

Cada chave é uma sequência de caracteres UTF-8.

Cada valor é um objeto AssetFormEntry.

Os formulários a serem definidos no ativo, codificados pelo nome do formulário. Cada entrada especifica o tipo de formulário e seu conteúdo JSON.
ClientToken – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

Um identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.

Resposta

Id – Obrigatório: string UTF-8, no mínimo 1 ou mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo.
Name – Obrigatório: string UTF-8.

O nome do ativo.
Description – String UTF-8.

A descrição do ativo.
CreatedAt – Timestamp.

A data e hora em que o ativo foi criado.
Forms – Um array de mapa dos pares de valor-chave.

Cada chave é uma sequência de caracteres UTF-8.

Cada valor é um objeto AssetFormEntry.

Os formulários vinculados ao ativo, codificados pelo nome do formulário.

Erros

AccessDeniedException
ConcurrentModificationException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

Ação DeleteAsset (Python: delete_asset)

Exclui um ativo do AWS Glue Data Catalog.

exemplo

O exemplo a seguir exclui um ativo por meio de seu identificador.


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

Solicitação

Identifier – Obrigatório: string UTF-8, no mínimo 1 ou mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo a ser excluído.

Resposta

Nenhum parâmetro de resposta.

Erros

AccessDeniedException
ConcurrentModificationException
InternalServiceException
InvalidInputException
ThrottlingException

Ação PutAssetType (Python: put_asset_type)

Cria ou atualiza um tipo de ativo no AWS Glue Data Catalog. Um tipo de ativo define a estrutura dos ativos especificando quais formulários estão incluídos. Se um tipo de ativo com o nome fornecido já existir, ele será atualizado.

exemplo

O exemplo a seguir cria um tipo de ativo que faz referência a um tipo de formulário.


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

Solicitação

Name: obrigatório: string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a String.

O nome do tipo de ativo.
Forms – Obrigatório: uma matriz de mapas de pares chave-valor, não inferior a 1 par nem superior a 100 pares.

Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes, correspondente a String.

Cada valor é um objeto AssetTypeFormReference.

Os formulários que formam o tipo de ativo, codificados pelo nome do formulário. Cada entrada faz referência ao tipo de formulário que define o esquema do formulário.
ClientToken – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

Um identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.

Resposta

Id: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O identificador do tipo de ativo.
Name – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a String.

O nome do tipo de ativo.
Forms: uma matriz de mapas de pares chave-valor, não menos que 1 o não mais que 100 pares.

Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes, correspondente a String.

Cada valor é um objeto AssetTypeFormReference.

Os formulários que formam o tipo de ativo, codificados pelo nome do formulário.

Erros

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

Ação GetAssetType (Python: get_asset_type)

Recupera um tipo de ativo no AWS Glue Data Catalog por meio de seu identificador.

exemplo

O exemplo a seguir recupera um tipo de ativo por meio de seu identificador.


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

Solicitação

Identifier: obrigatório: string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento.

O identificador do tipo de ativo a ser recuperado.

Resposta

Id: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O identificador do tipo de ativo.
Name – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a String.

O nome do tipo de ativo.
Forms: uma matriz de mapas de pares chave-valor, não menos que 1 o não mais que 100 pares.

Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes, correspondente a String.

Cada valor é um objeto AssetTypeFormReference.

Os formulários que formam o tipo de ativo, codificados pelo nome do formulário.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

Ação DeleteAssetType (Python: delete_asset_type)

Exclui um tipo de ativo do AWS Glue Data Catalog.

exemplo

O exemplo a seguir exclui um tipo de ativo por meio de seu identificador.


aws glue delete-asset-type --identifier DataSet

Solicitação

Identifier: obrigatório: string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento.

O identificador do tipo de ativo a ser excluído.

Resposta

Nenhum parâmetro de resposta.

Erros

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

Ação ListAssetTypes (Python: list_asset_types)

Lista os tipos de ativos definidos no AWS Glue Data Catalog.

exemplo

O exemplo a seguir lista os tipos de ativos na conta.


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

Solicitação

MaxResults – Número (inteiro), superior a 1 ou mais que 1000.

O número máximo de resultados a serem apresentados na resposta.
NextToken – String UTF-8.

Um token de continuação, se esta for uma chamada de continuação.

Resposta

Items: um array de objetos.

A lista de itens do tipo de ativo.
NextToken – String UTF-8.

Um token de continuação, presente se o segmento atual não for o último.

Erros

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

Ação PutFormType (Python: put_form_type)

Cria ou atualiza um tipo de formulário no AWS Glue Data Catalog. Um tipo de formulário define o esquema para metadados estruturados que podem ser anexados aos ativos.

exemplo

O exemplo a seguir cria um tipo de formulário com um esquema 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}"
    }

Solicitação

Name: obrigatório: string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a String.

O nome do tipo de formulário. É obrigatório começar com uma letra maiúscula.
Schema: obrigatório: string UTF-8 com no mínimo 1 e no máximo 100000 bytes de comprimento.

A definição do esquema Smithy IDL para o tipo de formulário.
ClientToken – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

Um identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.

Resposta

Id: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O identificador do tipo de formulário.
Name – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a String.

O nome do tipo de formulário.
Schema: string UTF-8 com no mínimo 1 e no máximo 100.000 bytes de comprimento.

O esquema Smithy IDL do tipo de formulário.

Erros

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

Ação GetFormType (Python: get_form_type)

Recupera um tipo de formulário no AWS Glue Data Catalog por meio de seu identificador.

exemplo

O exemplo a seguir recupera um tipo de formulário por meio de seu identificador.


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

Solicitação

Identifier: obrigatório: string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento.

O identificador do tipo de formulário a ser recuperado.

Resposta

Id: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O identificador do tipo de formulário.
Name – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a String.

O nome do tipo de formulário.
Schema: string UTF-8 com no mínimo 1 e no máximo 100.000 bytes de comprimento.

O esquema Smithy IDL do tipo de formulário.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

Ação DeleteFormType (Python: delete_form_type)

Exclui um tipo de formulário do AWS Glue Data Catalog. Um tipo de formulário não pode ser excluído se ainda for referenciado por um tipo de ativo.

exemplo

O exemplo a seguir exclui um tipo de formulário por meio de seu identificador.


aws glue delete-form-type --identifier DataClassification

Solicitação

Identifier: obrigatório: string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento.

O identificador do tipo de formulário a ser excluído.

Resposta

Nenhum parâmetro de resposta.

Erros

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ConflictException
ThrottlingException

Ação ListFormTypes (Python: list_form_types)

Lista os tipos de formulários definidos no AWS Glue Data Catalog.

exemplo

O exemplo a seguir lista os tipos de formulários na conta.


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

Solicitação

MaxResults – Número (inteiro), superior a 1 ou mais que 1000.

O número máximo de resultados a serem apresentados na resposta.
NextToken – String UTF-8.

Um token de continuação, se esta for uma chamada de continuação.

Resposta

Items: obrigatório: uma matriz de objetos.

A lista de itens do tipo de formulário.
NextToken – String UTF-8.

Um token de continuação, presente se o segmento atual não for o último.

Erros

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

Ação PutAttachment (Python: put_attachment)

Anexa um formulário a um ativo ou item de formulário iterável no AWS Glue Data Catalog. Se já existir um anexo com o mesmo nome, ele será substituído.

exemplo

O exemplo a seguir anexa um formulário a um ativo.


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

Solicitação

AssetIdentifier – Obrigatório: string UTF-8, no mínimo 1 ou mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo ao qual anexar o formulário.
IterableFormName – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a String.

O nome do formulário iterável. Quando especificado junto com itemIdentifier, o anexo tem como alvo um item dentro do formulário iterável em vez do ativo em si.
ItemIdentifier: string UTF-8, não menos do que 1 ou mais de 1087 bytes de comprimento.

O identificador do item no formulário iterável. Obrigatório quando iterableFormName for especificado.
AttachmentName: obrigatório: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a String.

O nome do anexo.
Content – Obrigatório: string UTF-8.

O conteúdo JSON do formulário, em conformidade com o esquema do tipo de formulário especificado.
FormTypeId: obrigatório: string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento.

O identificador do tipo de formulário desse anexo.
ClientToken – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

Um identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.

Resposta

AssetId – string UTF-8, com pelo menos 1 e não mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo.
IterableFormName – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a String.

O nome do formulário iterável, se o anexo for direcionado a um item.
ItemIdentifier: string UTF-8, não menos do que 1 ou mais de 1087 bytes de comprimento.

O identificador do item no formulário iterável, se aplicável.
AttachmentName – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a String.

O nome do anexo.
FormTypeId: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O identificador do tipo de formulário desse anexo.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

Ação DeleteAttachment (Python: delete_attachment)

Exclui um anexo de formulário de um ativo no AWS Glue Data Catalog.

exemplo

O exemplo a seguir exclui um anexo de um ativo.


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

Solicitação

AssetIdentifier – Obrigatório: string UTF-8, no mínimo 1 ou mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo do qual excluir o anexo.
AttachmentName: obrigatório: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a String.

O nome do anexo a ser excluído.

Resposta

Identifier – string UTF-8, com pelo menos 1 e não mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

Ação ListIterableForms (Python: list_iterable_forms)

Lista os itens em um formato iterável em um ativo no AWS Glue Data Catalog. Por exemplo, lista as colunas de um ativo de tabela.

exemplo

O exemplo a seguir lista as colunas de um ativo.


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

Solicitação

AssetIdentifier – Obrigatório: string UTF-8, no mínimo 1 ou mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo.
IterableFormName: obrigatório: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a String.

O nome do formulário iterável do qual os itens serão listados.
MaxResults – Número (inteiro), superior a 1 ou mais que 1000.

O número máximo de resultados a serem apresentados na resposta.
NextToken – String UTF-8.

Um token de continuação, se esta for uma chamada de continuação.

Resposta

AssetId – string UTF-8, com pelo menos 1 e não mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo.
IterableFormName – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a String.

O nome do formulário iterável.
Items: um array de objetos IterableFormListItem.

A lista de itens iteráveis do formulário.
NextToken – String UTF-8.

Um token de continuação, presente se o segmento atual não for o último.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException
InvalidInputException

Ação BatchGetIterableForms (Python: batch_get_iterable_forms)

Recupera vários itens de um formulário iterável em um ativo no AWS Glue Data Catalog em uma única solicitação.

exemplo

O exemplo a seguir recupera colunas específicas por 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": []
    }

Solicitação

AssetIdentifier – Obrigatório: string UTF-8, no mínimo 1 ou mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo.
IterableFormName: obrigatório: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a String.

O nome do formulário iterável do qual os itens serão recuperados.
ItemIdentifiers - obrigatório: uma matriz de strings UTF-8, não menos que 1 ou mais que 100 strings.

A lista de identificadores de itens a serem recuperados. Cada identificador pode ser a ID do item ou o nome do item.

Resposta

Items: um array de objetos IterableFormItem.

A lista de itens iteráveis do formulário recuperados.
Errors: um array de objetos ItemError.

A lista de erros de itens que não puderam ser recuperados.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

Ação CreateGlossary (Python: create_glossary)

Cria um glossário de negócios no AWS Glue Data Catalog. Um glossário é um contêiner para termos do glossário que definem conceitos de negócios.

exemplo

O exemplo a seguir cria um glossário de negócios.


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

Solicitação

Name: obrigatório: string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento.

O nome do glossário.
Description: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

A descrição do glossário.
ClientToken – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

Um identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.

Resposta

Id – String UTF-8.

O identificador exclusivo do glossário.
Name: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O nome do glossário.
Description: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

A descrição do glossário.

Erros

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

Ação GetGlossary (Python: get_glossary)

Recupera um glossário de negócios no AWS Glue Data Catalog por meio de seu identificador.

exemplo

O exemplo a seguir recupera um glossário por meio de seu identificador.


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

Solicitação

Identifier – Obrigatório: string UTF-8.

O identificador exclusivo do glossário a ser recuperado.

Resposta

Id – String UTF-8.

O identificador exclusivo do glossário.
Name: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O nome do glossário.
Description: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

A descrição do glossário.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException

Ação UpdateGlossary (Python: update_glossary)

Atualiza um glossário de negócios no AWS Glue Data Catalog.

exemplo

O exemplo a seguir atualiza a descrição de um glossário.


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

Solicitação

Identifier – Obrigatório: string UTF-8.

O identificador exclusivo do glossário a ser atualizado.
Name: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O nome atualizado do glossário.
Description: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

A descrição atualizada do glossário.
ClientToken – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

Um identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.

Resposta

Id – String UTF-8.

O identificador exclusivo do glossário.
Name: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O nome do glossário.
Description: string UTF-8 com no mínimo 1 e no máximo 2.048 bytes de comprimento.

A descrição do glossário.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

Ação DeleteGlossary (Python: delete_glossary)

Exclui um glossário de negócios do AWS Glue Data Catalog. Um glossário não pode ser excluído se ele ainda contiver termos do glossário.

exemplo

O exemplo a seguir exclui um glossário por meio de seu identificador.


aws glue delete-glossary --identifier 6n5f21s641nbjb

Solicitação

Identifier – Obrigatório: string UTF-8.

O identificador exclusivo do glossário a ser excluído.

Resposta

Nenhum parâmetro de resposta.

Erros

AccessDeniedException
InternalServiceException
InvalidInputException
ConflictException
ConcurrentModificationException
ThrottlingException

Ação ListGlossaries (Python: list_glossaries)

Lista glossários de negócios no AWS Glue Data Catalog.

exemplo

O exemplo a seguir lista os glossários na conta.


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

Solicitação

MaxResults – Número (inteiro), superior a 1 ou mais que 1000.

O número máximo de resultados a serem apresentados na resposta.
NextToken – String UTF-8.

Um token de continuação, se esta for uma chamada de continuação.

Resposta

Items: um array de objetos.

A lista de itens do glossário.
NextToken – String UTF-8.

Um token de continuação, presente se o segmento atual não for o último.

Erros

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

Ação CreateGlossaryTerm (Python: create_glossary_term)

Cria um termo do glossário dentro de um glossário de negócios no AWS Glue Data Catalog.

exemplo

O exemplo a seguir cria um termo do glossário.


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

Solicitação

GlossaryIdentifier – Obrigatório: string UTF-8.

O identificador exclusivo do glossário no qual o termo será criado.
Name: obrigatório: string UTF-8 com no mínimo 1 e no máximo 256 bytes de comprimento.

O nome do termo do glossário.
ShortDescription: string UTF-8, não menos do que 1 ou mais de 1024 bytes de comprimento.

Uma breve descrição do termo do glossário.
LongDescription: string UTF-8, não menos do que 1 ou mais de 4096 bytes de comprimento.

Uma descrição longa do termo do glossário.
ClientToken – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

Um identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.

Resposta

Id – String UTF-8.

O identificador exclusivo do termo do glossário.
GlossaryId – String UTF-8.

O identificador exclusivo do glossário que contém esse termo.
Name: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O nome do termo do glossário.
ShortDescription: string UTF-8, não menos do que 1 ou mais de 1024 bytes de comprimento.

Breve descrição do termo do glossário.
LongDescription: string UTF-8, não menos do que 1 ou mais de 4096 bytes de comprimento.

Descrição longa do termo do glossário.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

Ação GetGlossaryTerm (Python: get_glossary_term)

Recupera um termo do glossário no AWS Glue Data Catalog por meio de seu identificador.

exemplo

O exemplo a seguir recupera um termo do glossário por meio de seu 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."
    }

Solicitação

Identifier – Obrigatório: string UTF-8.

O identificador exclusivo do termo do glossário a ser recuperado.

Resposta

Id – String UTF-8.

O identificador exclusivo do termo do glossário.
GlossaryId – String UTF-8.

O identificador exclusivo do glossário que contém esse termo.
Name: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O nome do termo do glossário.
ShortDescription: string UTF-8, não menos do que 1 ou mais de 1024 bytes de comprimento.

Breve descrição do termo do glossário.
LongDescription: string UTF-8, não menos do que 1 ou mais de 4096 bytes de comprimento.

Descrição longa do termo do glossário.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException

Ação UpdateGlossaryTerm (Python: update_glossary_term)

Atualiza um termo do glossário no AWS Glue Data Catalog.

exemplo

O exemplo a seguir atualiza a descrição breve de um termo do glossário.


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

Solicitação

Identifier – Obrigatório: string UTF-8.

O identificador exclusivo do termo do glossário a ser atualizado.
Name: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O nome atualizado do termo do glossário.
ShortDescription: string UTF-8, não menos do que 1 ou mais de 1024 bytes de comprimento.

A descrição breve atualizada do termo do glossário.
LongDescription: string UTF-8, não menos do que 1 ou mais de 4096 bytes de comprimento.

A descrição longa atualizada do termo do glossário.
ClientToken – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

Um identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.

Resposta

Id – String UTF-8.

O identificador exclusivo do termo do glossário.
GlossaryId – String UTF-8.

O identificador exclusivo do glossário que contém esse termo.
Name: string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento.

O nome do termo do glossário.
ShortDescription: string UTF-8, não menos do que 1 ou mais de 1024 bytes de comprimento.

Breve descrição do termo do glossário.
LongDescription: string UTF-8, não menos do que 1 ou mais de 4096 bytes de comprimento.

Descrição longa do termo do glossário.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

Ação DeleteGlossaryTerm (Python: delete_glossary_term)

Exclui um termo do glossário do AWS Glue Data Catalog.

exemplo

O exemplo a seguir exclui um termo do glossário por meio de seu identificador.


aws glue delete-glossary-term --identifier avugvxvsul6izr

Solicitação

Identifier – Obrigatório: string UTF-8.

O identificador exclusivo do termo do glossário a ser excluído.

Resposta

Nenhum parâmetro de resposta.

Erros

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

Ação ListGlossaryTerms (Python: list_glossary_terms)

Lista os termos do glossário dentro de um glossário de negócios no AWS Glue Data Catalog.

exemplo

O exemplo a seguir lista os termos em um glossário.


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

Solicitação

GlossaryIdentifier – Obrigatório: string UTF-8.

O identificador exclusivo do glossário cujos termos serão listados.
MaxResults – Número (inteiro), superior a 1 ou mais que 1000.

O número máximo de resultados a serem apresentados na resposta.
NextToken – String UTF-8.

Um token de continuação, se esta for uma chamada de continuação.

Resposta

GlossaryId – String UTF-8.

O identificador exclusivo do glossário.
Items: um array de objetos.

A lista de itens do termo do glossário.
NextToken – String UTF-8.

Um token de continuação, presente se o segmento atual não for o último.

Erros

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

Ação AssociateGlossaryTerms (Python: associate_glossary_terms)

Associa um ou mais termos do glossário a um ativo no AWS Glue Data Catalog.

exemplo

O exemplo a seguir associa um termo do glossário a um ativo.


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

Solicitação

AssetIdentifier – Obrigatório: string UTF-8, no mínimo 1 ou mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo ao qual associar os termos do glossário.
GlossaryTermIdentifiers - obrigatório: uma matriz de strings UTF-8, não menos que 1 ou mais que 10 strings.

A lista de identificadores de termos do glossário a serem associados ao ativo.
ClientToken – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

Um identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.

Resposta

Identifier – string UTF-8, com pelo menos 1 e não mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo.
GlossaryTerms: uma matriz de strings UTF-8, não menos que 1 ou mais que 10 strings.

Os termos do glossário associados agora ao ativo.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

Ação DisassociateGlossaryTerms (Python: disassociate_glossary_terms)

Remove a associação de um ou mais termos do glossário de um ativo no AWS Glue Data Catalog.

exemplo

O exemplo a seguir remove um termo do glossário de um ativo.


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

Solicitação

AssetIdentifier – Obrigatório: string UTF-8, no mínimo 1 ou mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo do qual os termos do glossário serão desassociados.
GlossaryTermIdentifiers - obrigatório: uma matriz de strings UTF-8, não menos que 1 ou mais que 10 strings.

A lista de identificadores de termos do glossário que serão desassociados do ativo.
ClientToken – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

Um identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.

Resposta

Identifier – string UTF-8, com pelo menos 1 e não mais de 1087 bytes de comprimento, correspondente a String.

O identificador exclusivo do ativo.
GlossaryTerms: uma matriz de strings UTF-8, não menos que 1 ou mais que 10 strings.

Os termos do glossário remanescentes associados ao ativo.

Erros

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

Ação de pesquisa (Python: search)

Pesquisa ativos no AWS Glue Data Catalog usando pesquisa de texto completo, filtros, classificação e agregações. Exibe os ativos correspondentes com resultados classificados por relevância.

exemplo

O exemplo a seguir executa uma pesquisa por ativos com texto completo.


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

exemplo

O exemplo a seguir pesquisa com uma cláusula de filtro e uma ordem de classificação.


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

exemplo

O exemplo a seguir filtra em um campo definido por um formulário. Um campo de formulário é referenciado pelo identificador do tipo de ativo do formulário e pelo nome do campo, unidos por um ponto, neste caso, o campo databaseName do formulário amazon.glue::GlueTable. O prefixo :: é mostrado na AssetTypeId de cada resultado no caso dos identificadores de tipo de ativo para os tipos integrados.


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

exemplo

O exemplo a seguir combina um campo de ativo comum e um campo de formulário com um AND lógico. Campos de ativos comuns, como name, type, region e catalogId são referenciados diretamente; os campos definidos por um formulário usam a notação 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"
            }
        ]
    }

Solicitação

SearchText: string UTF-8, não menos do que 1 ou mais de 1000 bytes de comprimento.

O texto a ser pesquisado. Pelo menos searchText ou filterClause deve ser fornecido.
MaxResults: número (inteiro), não menos do que 1 ou superior a 100.

O número máximo de resultados a serem apresentados na resposta.
NextToken – String UTF-8.

Um token de continuação, se esta for uma chamada de continuação.
Sort – Um objeto SearchSort.

O critério de classificação para os resultados da pesquisa.
FilterClause – Um objeto SearchFilterClause.

A cláusula de filtro a ser aplicada à pesquisa. Suporta a lógica AND/OR aninhada com filtros em nível de atributo e em nível de mapa.

Resposta

A estrutura de resposta para a operação Search.

SearchOutput – Um objeto SearchOutput.

Erros

AccessDeniedException
InvalidInputException
InternalServiceException
ThrottlingException

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Catálogos

Bancos de dados