DataZone / Client / list_environment_profiles

list_environment_profiles#

DataZone.Client.list_environment_profiles(**kwargs)#

Lists Amazon DataZone environment profiles.

See also: AWS API Documentation

Request Syntax

response = client.list_environment_profiles(
    awsAccountId='string',
    awsAccountRegion='string',
    domainIdentifier='string',
    environmentBlueprintIdentifier='string',
    maxResults=123,
    name='string',
    nextToken='string',
    projectIdentifier='string'
)
Parameters:

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

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

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain.

  • environmentBlueprintIdentifier (string) – The identifier of the blueprint that was used to create the environment profiles that you want to list.

  • maxResults (integer) – The maximum number of environment profiles to return in a single call to ListEnvironmentProfiles. When the number of environment profiles 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 ListEnvironmentProfiles to list the next set of environment profiles.

  • name (string) –

  • nextToken (string) – When the number of environment profiles 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 environment profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentProfiles to list the next set of environment profiles.

  • projectIdentifier (string) – The identifier of the Amazon DataZone project.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'awsAccountId': 'string',
            'awsAccountRegion': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'domainId': 'string',
            'environmentBlueprintId': 'string',
            'id': 'string',
            'name': 'string',
            'projectId': 'string',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The results of the ListEnvironmentProfiles action.

      • (dict) –

        The details of an environment profile.

        • awsAccountId (string) –

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

        • awsAccountRegion (string) –

          The Amazon Web Services Region in which an environment profile exists.

        • createdAt (datetime) –

          The timestamp of when an environment profile was created.

        • createdBy (string) –

          The Amazon DataZone user who created the environment profile.

        • description (string) –

          The description of the environment profile.

        • domainId (string) –

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

        • environmentBlueprintId (string) –

          The identifier of a blueprint with which an environment profile is created.

        • id (string) –

          The identifier of the environment profile.

        • name (string) –

          The name of the environment profile.

        • projectId (string) –

          The identifier of a project in which an environment profile exists.

        • updatedAt (datetime) –

          The timestamp of when the environment profile was updated.

    • nextToken (string) –

      When the number of environment profiles 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 environment profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentProfiles to list the next set of environment profiles.

Exceptions

  • DataZone.Client.exceptions.InternalServerException

  • DataZone.Client.exceptions.AccessDeniedException

  • DataZone.Client.exceptions.ThrottlingException

  • DataZone.Client.exceptions.ValidationException

  • DataZone.Client.exceptions.UnauthorizedException