DataZone / Client / batch_get_attributes_metadata

batch_get_attributes_metadata

DataZone.Client.batch_get_attributes_metadata(**kwargs)

Gets the attribute metadata.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_attributes_metadata(
    attributeIdentifiers=[
        'string',
    ],
    domainIdentifier='string',
    entityIdentifier='string',
    entityRevision='string',
    entityType='ASSET'|'LISTING'
)
Parameters:

  • attributeIdentifiers (list) –

    [REQUIRED]

    The attribute identifier.

    • (string) –

  • domainIdentifier (string) –

    [REQUIRED]

    The domain ID where you want to get the attribute metadata.

  • entityIdentifier (string) –

    [REQUIRED]

    The entity ID for which you want to get attribute metadata.

  • entityRevision (string) – The entity revision for which you want to get attribute metadata.

  • entityType (string) –

    [REQUIRED]

    The entity type for which you want to get attribute metadata.

Return type:

dict

Returns:

Response Syntax

{
    'attributes': [
        {
            'attributeIdentifier': 'string',
            'forms': [
                {
                    'content': 'string',
                    'formName': 'string',
                    'typeName': 'string',
                    'typeRevision': 'string'
                },
            ]
        },
    ],
    'errors': [
        {
            'attributeIdentifier': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • attributes (list) –

      The results of the BatchGetAttributesMetadata action.

      • (dict) –

        The results of the BatchGetAttribute action.

        • attributeIdentifier (string) –

          The attribute ID.

        • forms (list) –

          The metadata forms that are part of the results of the BatchGetAttribute action.

          • (dict) –

            The details of a metadata form.

            • content (string) –

              The content of the metadata form.

            • formName (string) –

              The name of the metadata form.

            • typeName (string) –

              The name of the metadata form type.

            • typeRevision (string) –

              The revision of the metadata form type.

    • errors (list) –

      The errors generated when the BatchGetAttributesMetadata action is invoked.

      • (dict) –

        The attribute error.

        • attributeIdentifier (string) –

          The attribute ID as part of the attribute error.

        • code (string) –

          The code generated as part of the attribute error.

        • message (string) –

          The message generated as part of the attribute error.

Exceptions