Asociación de formularios

Los metadatos se pueden estandarizar al definir los tipos de formulario, que son plantillas de esquema estructuradas y reutilizables. Luego, dichos esquemas se pueden rellenar asociando instancias de estos formularios a los activos.

Definición de tipos de formulario

Un tipo de formulario define el esquema mediante la sintaxis de Smithy IDL. Los nombres deben empezar con una letra mayúscula.

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

Cómo crear un tipo de formulario

Utilice PutFormType para crear o actualizar un tipo de formulario.

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

Ejemplo de código de salida:

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

Cómo recuperar un tipo de formulario

aws glue get-form-type --identifier DataResidency

Asociación de formularios a los activos

Cómo asociar un formulario a un activo

Utilice PutAttachment con el identificador del activo, el nombre del anexo, el ID del tipo de formulario y el contenido JSON que se ajuste al 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}'

Cómo consultar los formularios y las asociaciones de un activo

Utilice GetAsset para recuperar un activo junto con sus formularios y asociaciones.

El siguiente comando recupera un activo:

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

Cómo asociar un formulario a una columna

Puede asociar un formulario a una sola columna de un activo.

Cada columna es un único elemento del formulario iterable columns con el nombre de la columna como identificador del elemento.

El siguiente comando asocia un formulario a una columna 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"}'

Después de asociar el formulario, utilice SearchAssets para buscar el activo mediante cualquiera de los campos de búsqueda del formulario.

Recuperación de metadatos de columna

Cómo consultar las columnas de un activo

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

Cómo recuperar columnas específicas con sus formularios

Utilice BatchGetIterableForms para recuperar columnas y formularios asociados en una sola solicitud.

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

Eliminación de asociaciones y tipos de formulario

Para eliminar una asociación

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

Cómo eliminar una asociación de una columna específica

Para eliminar un formulario asociado a una sola columna, ejecute el siguiente comando. Proporcione el nombre del formulario iterable, el identificador del elemento y el nombre de la asociación:

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

Cómo eliminar un tipo de formulario

No puede eliminar un tipo de formulario al que sigue haciendo referencia un tipo de activo.

aws glue delete-form-type --identifier DataResidency

Consulta de tipos de formulario

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

Ejemplo de salida:

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