DataZone / Client / list_environments

list_environments#

DataZone.Client.list_environments(**kwargs)#

Lists Amazon DataZone environments.

See also: AWS API Documentation

Request Syntax

response = client.list_environments(
    awsAccountId='string',
    awsAccountRegion='string',
    domainIdentifier='string',
    environmentBlueprintIdentifier='string',
    environmentProfileIdentifier='string',
    maxResults=123,
    name='string',
    nextToken='string',
    projectIdentifier='string',
    provider='string',
    status='ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE'
)
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.

  • maxResults (integer) – The maximum number of environments to return in a single call to ListEnvironments. When the number of environments to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironments to list the next set of environments.

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

  • nextToken (string) – When the number of environments is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.

  • 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.

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) –

      When the number of environments is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.

Exceptions

  • DataZone.Client.exceptions.InternalServerException

  • DataZone.Client.exceptions.AccessDeniedException

  • DataZone.Client.exceptions.ThrottlingException

  • DataZone.Client.exceptions.ValidationException

  • DataZone.Client.exceptions.UnauthorizedException