Anexar formulários

Você pode padronizar os metadados definindo os tipos de formulários, que são modelos de esquema estruturados e reutilizáveis. O esquema pode ser preenchido em seguida mediante a anexação das instâncias desses formulários aos ativos.

Definir tipos de formulários

Um tipo de formulário define o esquema usando a sintaxe Smithy IDL. Os nomes têm de começar com uma letra maiúscula.

structure DataResidency {
    region: String
    complianceFramework: String
    retentionDays: Integer
}

Para criar um tipo de formulário

Use PutFormType para criar ou atualizar um tipo de formulário.

aws glue put-form-type \
    --name DataResidency \
    --schema 'structure DataResidency {
    region: String
    complianceFramework: String
    retentionDays: Integer
}'

Resultado do exemplo:

{
    "Id": "DataResidency",
    "Name": "DataResidency"
}

Para recuperar um tipo de formulário

aws glue get-form-type --identifier DataResidency

Anexar formulários aos ativos

Para anexar um formulário a um ativo

Use PutAttachment com o identificador do ativo, o nome do anexo, a ID do tipo de formulário e o conteúdo JSON de acordo com o esquema.

aws glue put-attachment \
    --asset-identifier asset-id \
    --attachment-name residencyInfo \
    --form-type-id DataResidency \
    --content '{"region":"us-east-1","complianceFramework":"SOC2","retentionDays":730}'

Para visualizar os formulários e anexos de um ativo

Use GetAsset para recuperar um ativo junto com seus formulários e seus anexos.

O comando a seguir recupera um ativo:

aws glue get-asset --asset-identifier asset-id

Para associar um formulário a uma coluna

É possível anexar um formulário a uma única coluna de um ativo.

Cada coluna é um único item do formulário iterável columns, tendo o nome da coluna como identificador do item.

O comando a seguir vincula um formulário a uma coluna específica:

aws glue put-attachment \
    --asset-identifier asset-id \
    --iterable-form-name columns \
    --item-identifier region \
    --attachment-name sensitivity \
    --form-type-id DataClassification \
    --content '{"classification":"PII","sensitivity":"HIGH"}'

Depois de anexar o formulário, use SearchAssets para localizar o ativo por meio de qualquer campo pesquisável no formulário.

Recuperar metadados da coluna

Para listar as colunas de um ativo

aws glue list-iterable-forms \
    --asset-identifier asset-id \
    --iterable-form-name columns \
    --max-results 20

Para recuperar colunas específicas com seus formulários

Use BatchGetIterableForms para recuperar as colunas e os formulários anexados em uma única solicitação.

aws glue batch-get-iterable-forms \
    --asset-identifier asset-id \
    --iterable-form-name columns \
    --item-identifiers region email

Excluir anexos e tipos de formulário

Para excluir um anexo

aws glue delete-attachment \
    --asset-identifier asset-id \
    --attachment-name residencyInfo

Para excluir um anexo de uma coluna específica

Para remover um formulário vinculado a uma única coluna, execute o comando a seguir. O nome do formulário iterável, o identificador do item e o nome do anexo são passados:

aws glue delete-attachment \
    --asset-identifier asset-id \
    --iterable-form-name columns \
    --item-identifier region \
    --attachment-name sensitivity

Para excluir um tipo de formulário

Não é possível excluir um tipo de formulário que ainda seja referenciado por um tipo de ativo.

aws glue delete-form-type --identifier DataResidency

Lista de tipos de formulário

aws glue list-form-types --max-results 20

Resultado do exemplo:

{
    "Items": [
        {"Id": "DataResidency", "Name": "DataResidency"},
        {"Id": "DataClassification", "Name": "DataClassification"}
    ]
}