DataZone / Paginator / ListEnvironmentBlueprints

ListEnvironmentBlueprints

class DataZone.Paginator.ListEnvironmentBlueprints

paginator = client.get_paginator('list_environment_blueprints')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    managed=True|False,
    name='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain.

• managed (boolean) – Specifies whether the environment blueprint is managed by Amazon DataZone.

• name (string) – The name of the Amazon DataZone environment.

• 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': [
        {
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'id': 'string',
            'name': 'string',
            'provider': 'string',
            'provisioningProperties': {
                'cloudFormation': {
                    'templateUrl': 'string'
                }
            },
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListEnvironmentBlueprints action.

    • (dict) –

      The details of an environment blueprint summary.

      • createdAt (datetime) –

        The timestamp of when an environment blueprint was created.

      • description (string) –

        The description of a blueprint.

      • id (string) –

        The identifier of the blueprint.

      • name (string) –

        The name of the blueprint.

      • provider (string) –

        The provider of the blueprint.

      • provisioningProperties (dict) –

        The provisioning properties of the blueprint.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: cloudFormation. 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'}
        

        • cloudFormation (dict) –

          The cloud formation properties included as part of the provisioning properties of an environment blueprint.

          • templateUrl (string) –

            The template URL of the cloud formation provisioning properties of the environment blueprint.

      • updatedAt (datetime) –

        The timestamp of when the blueprint was enabled.

  • NextToken (string) –

    A token to resume pagination.