Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListEnvironmentProfiles

Lists Amazon DataZone environment profiles.

Request Syntax


GET /v2/domains/domainIdentifier/environment-profiles?awsAccountId=awsAccountId&awsAccountRegion=awsAccountRegion&environmentBlueprintIdentifier=environmentBlueprintIdentifier&maxResults=maxResults&name=name&nextToken=nextToken&projectIdentifier=projectIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

awsAccountId

The identifier of the AWS account where you want to list environment profiles.

Pattern: ^\d{12}$

awsAccountRegion

The AWS region where you want to list environment profiles.

Pattern: ^[a-z]{2}-[a-z]{4,10}-\d$

domainIdentifier

The identifier of the Amazon DataZone domain.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

environmentBlueprintIdentifier

The identifier of the blueprint that was used to create the environment profiles that you want to list.

Pattern: ^[a-zA-Z0-9_-]{1,36}$

maxResults

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.

Valid Range: Minimum value of 1. Maximum value of 50.

name

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[\w -]+$

nextToken

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.

Length Constraints: Minimum length of 1. Maximum length of 8192.

projectIdentifier

The identifier of the Amazon DataZone project.

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "awsAccountId": "string",
         "awsAccountRegion": "string",
         "createdAt": "string",
         "createdBy": "string",
         "description": "string",
         "domainId": "string",
         "environmentBlueprintId": "string",
         "id": "string",
         "name": "string",
         "projectId": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items

The results of the ListEnvironmentProfiles action.

Type: Array of EnvironmentProfileSummary objects

nextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400