DataZone / Paginator / SearchTypes

SearchTypes

class DataZone.Paginator.SearchTypes

paginator = client.get_paginator('search_types')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataZone.Client.search_types().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    filters={
        'and': [
            {'... recursive ...'},
        ],
        'filter': {
            'attribute': 'string',
            'value': 'string'
        },
        'or': [
            {'... recursive ...'},
        ]
    },
    managed=True|False,
    searchIn=[
        {
            'attribute': 'string'
        },
    ],
    searchScope='ASSET_TYPE'|'FORM_TYPE'|'LINEAGE_NODE_TYPE',
    searchText='string',
    sort={
        'attribute': 'string',
        'order': 'ASCENDING'|'DESCENDING'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.

• filters (dict) –

  The filters for the SearchTypes action.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: and, filter, or.

  • and (list) –

    The ‘and’ search filter clause in Amazon DataZone.

    • (dict) –

      A search filter clause in Amazon DataZone.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: and, filter, or.

  • filter (dict) –

    A search filter in Amazon DataZone.

    • attribute (string) – [REQUIRED]

      A search filter attribute in Amazon DataZone.

    • value (string) – [REQUIRED]

      A search filter value in Amazon DataZone.

  • or (list) –

    The ‘or’ search filter clause in Amazon DataZone.

    • (dict) –

      A search filter clause in Amazon DataZone.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: and, filter, or.

• managed (boolean) –

  [REQUIRED]

  Specifies whether the search is managed.

• searchIn (list) –

  The details of the search.

  • (dict) –

    The details of the search.

    • attribute (string) – [REQUIRED]

      The search attribute.

• searchScope (string) –

  [REQUIRED]

  Specifies the scope of the search for types.

• searchText (string) – Specifies the text for which to search.

• sort (dict) –

  The specifies the way to sort the SearchTypes results.

  • attribute (string) – [REQUIRED]

    The attribute detail of the way to sort search results.

  • order (string) –

    The order detail of the wya to sort search results.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'assetTypeItem': {
                'createdAt': datetime(2015, 1, 1),
                'createdBy': 'string',
                'description': 'string',
                'domainId': 'string',
                'formsOutput': {
                    'string': {
                        'required': True|False,
                        'typeName': 'string',
                        'typeRevision': 'string'
                    }
                },
                'name': 'string',
                'originDomainId': 'string',
                'originProjectId': 'string',
                'owningProjectId': 'string',
                'revision': 'string',
                'updatedAt': datetime(2015, 1, 1),
                'updatedBy': 'string'
            },
            'formTypeItem': {
                'createdAt': datetime(2015, 1, 1),
                'createdBy': 'string',
                'description': 'string',
                'domainId': 'string',
                'imports': [
                    {
                        'name': 'string',
                        'revision': 'string'
                    },
                ],
                'model': {
                    'smithy': 'string'
                },
                'name': 'string',
                'originDomainId': 'string',
                'originProjectId': 'string',
                'owningProjectId': 'string',
                'revision': 'string',
                'status': 'ENABLED'|'DISABLED'
            },
            'lineageNodeTypeItem': {
                'createdAt': datetime(2015, 1, 1),
                'createdBy': 'string',
                'description': 'string',
                'domainId': 'string',
                'formsOutput': {
                    'string': {
                        'required': True|False,
                        'typeName': 'string',
                        'typeRevision': 'string'
                    }
                },
                'name': 'string',
                'revision': 'string',
                'updatedAt': datetime(2015, 1, 1),
                'updatedBy': 'string'
            }
        },
    ],
    'totalMatchCount': 123,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the SearchTypes action.

    • (dict) –

      The details of the results of the SearchTypes action.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: assetTypeItem, formTypeItem, lineageNodeTypeItem. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • assetTypeItem (dict) –

        The asset type included in the results of the SearchTypes action.

        • createdAt (datetime) –

          The timestamp of when the asset type was created.

        • createdBy (string) –

          The Amazon DataZone user who created the asset type.

        • description (string) –

          The description of the asset type.

        • domainId (string) –

          The identifier of the Amazon DataZone domain where the asset type exists.

        • formsOutput (dict) –

          The forms included in the details of the asset type.

          • (string) –

            • (dict) –

              The details of the form entry.

              • required (boolean) –

                Specifies whether a form entry is required.

              • typeName (string) –

                The name of the type of the form entry.

              • typeRevision (string) –

                The type revision of the form entry.

        • name (string) –

          The name of the asset type.

        • originDomainId (string) –

          The identifier of the Amazon DataZone domain where the asset type was originally created.

        • originProjectId (string) –

          The identifier of the Amazon DataZone project where the asset type exists.

        • owningProjectId (string) –

          The identifier of the Amazon DataZone project that owns the asset type.

        • revision (string) –

          The revision of the asset type.

        • updatedAt (datetime) –

          The timestamp of when the asset type was updated.

        • updatedBy (string) –

          The Amazon DataZone user who updated the asset type.

      • formTypeItem (dict) –

        The form type included in the results of the SearchTypes action.

        • createdAt (datetime) –

          The timestamp of when the metadata form type was created.

        • createdBy (string) –

          The Amazon DataZone user who created teh metadata form type.

        • description (string) –

          The description of the metadata form type.

        • domainId (string) –

          The identifier of the Amazon DataZone domain in which the form type exists.

        • imports (list) –

          The imports specified in the form type.

          • (dict) –

            The details of the import of the metadata form type.

            • name (string) –

              The name of the import.

            • revision (string) –

              The revision of the import.

        • model (dict) –

          The model of the form type.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: smithy. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          

          • smithy (string) –

            Indicates the smithy model of the API.

        • name (string) –

          The name of the form type.

        • originDomainId (string) –

          The identifier of the Amazon DataZone domain in which the form type was originally created.

        • originProjectId (string) –

          The identifier of the project in which the form type was originally created.

        • owningProjectId (string) –

          The identifier of the project that owns the form type.

        • revision (string) –

          The revision of the form type.

        • status (string) –

          The status of the form type.

      • lineageNodeTypeItem (dict) –

        The details of a data lineage node type.

        • createdAt (datetime) –

          The timestamp at which the data lineage node type was created.

        • createdBy (string) –

          The user who created the data lineage node type.

        • description (string) –

          The description of the data lineage node type.

        • domainId (string) –

          The ID of the domain where the data lineage node type lives.

        • formsOutput (dict) –

          The forms output of the data lineage node type.

          • (string) –

            • (dict) –

              The details of the form entry.

              • required (boolean) –

                Specifies whether a form entry is required.

              • typeName (string) –

                The name of the type of the form entry.

              • typeRevision (string) –

                The type revision of the form entry.

        • name (string) –

          The name of the data lineage node type.

        • revision (string) –

          The revision of the data lineage node type.

        • updatedAt (datetime) –

          The timestamp at which the data lineage node type was updated.

        • updatedBy (string) –

          The user who updated the data lineage node type.

  • totalMatchCount (integer) –

    Total number of search results.

  • NextToken (string) –

    A token to resume pagination.