Glue / Client / batch_get_iterable_forms

batch_get_iterable_forms

Glue.Client.batch_get_iterable_forms(**kwargs)

Retrieves multiple items from an iterable form on an asset in Glue Data Catalog in a single request.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_iterable_forms(
    AssetIdentifier='string',
    IterableFormName='string',
    ItemIdentifiers=[
        'string',
    ]
)
Parameters:

  • AssetIdentifier (string) –

    [REQUIRED]

    The unique identifier of the asset.

  • IterableFormName (string) –

    [REQUIRED]

    The name of the iterable form to retrieve items from.

  • ItemIdentifiers (list) –

    [REQUIRED]

    The list of item identifiers to retrieve. Each identifier can be an item ID or item name.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'ItemId': 'string',
            'ItemName': 'string',
            'GlossaryTerms': [
                'string',
            ],
            'Forms': {
                'string': {
                    'FormTypeId': 'string',
                    'Content': 'string'
                }
            },
            'Attachments': {
                'string': {
                    'FormTypeId': 'string',
                    'Content': 'string'
                }
            }
        },
    ],
    'Errors': [
        {
            'ItemIdentifier': 'string',
            'Code': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Items (list) –

      The list of retrieved iterable form items.

      • (dict) –

        A full iterable form item with its forms.

        • ItemId (string) –

          The unique identifier of the item.

        • ItemName (string) –

          The name of the item.

        • GlossaryTerms (list) –

          The identifiers of the glossary terms associated with the item.

          • (string) –

        • Forms (dict) –

          The forms on the item, keyed by form name.

          • (string) –

            • (dict) –

              A form on an asset, consisting of the form type identifier and its JSON content.

              • FormTypeId (string) –

                The identifier of the form type that defines this form’s schema.

              • Content (string) –

                The JSON content of the form, conforming to the schema of the specified form type.

        • Attachments (dict) –

          Additional attachments on the item for more context, keyed by attachment name.

          • (string) –

            • (dict) –

              A form on an asset, consisting of the form type identifier and its JSON content.

              • FormTypeId (string) –

                The identifier of the form type that defines this form’s schema.

              • Content (string) –

                The JSON content of the form, conforming to the schema of the specified form type.

    • Errors (list) –

      The list of errors for items that could not be retrieved.

      • (dict) –

        An error that occurred when retrieving an iterable form item.

        • ItemIdentifier (string) –

          The identifier of the item that caused the error.

        • Code (string) –

          The error code.

        • Message (string) –

          The error message.

Exceptions