DataZone / Paginator / ListEnvironments

ListEnvironments

class DataZone.Paginator.ListEnvironments

paginator = client.get_paginator('list_environments')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    awsAccountId='string',
    awsAccountRegion='string',
    domainIdentifier='string',
    environmentBlueprintIdentifier='string',
    environmentProfileIdentifier='string',
    name='string',
    projectIdentifier='string',
    provider='string',
    status='ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• awsAccountId (string) – The identifier of the Amazon Web Services account where you want to list environments.

• awsAccountRegion (string) – The Amazon Web Services region where you want to list environments.

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain.

• environmentBlueprintIdentifier (string) – The identifier of the Amazon DataZone blueprint.

• environmentProfileIdentifier (string) – The identifier of the environment profile.

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

• projectIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone project.

• provider (string) – The provider of the environment.

• status (string) – The status of the environments that you want to list.

• 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': [
        {
            'awsAccountId': 'string',
            'awsAccountRegion': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'domainId': 'string',
            'environmentProfileId': 'string',
            'id': 'string',
            'name': 'string',
            'projectId': 'string',
            'provider': 'string',
            'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListEnvironments action.

    • (dict) –

      The details of an environment.

      • awsAccountId (string) –

        The identifier of the Amazon Web Services account in which an environment exists.

      • awsAccountRegion (string) –

        The Amazon Web Services Region in which an environment exists.

      • createdAt (datetime) –

        The timestamp of when the environment was created.

      • createdBy (string) –

        The Amazon DataZone user who created the environment.

      • description (string) –

        The description of the environment.

      • domainId (string) –

        The identifier of the Amazon DataZone domain in which the environment exists.

      • environmentProfileId (string) –

        The identifier of the environment profile with which the environment was created.

      • id (string) –

        The identifier of the environment.

      • name (string) –

        The name of the environment.

      • projectId (string) –

        The identifier of the project in which the environment exists.

      • provider (string) –

        The provider of the environment.

      • status (string) –

        The status of the environment.

      • updatedAt (datetime) –

        The timestamp of when the environment was updated.

  • NextToken (string) –

    A token to resume pagination.