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

ListEnvironments

Lists Amazon DataZone environments.

Request Syntax


GET /v2/domains/domainIdentifier/environments?awsAccountId=awsAccountId&awsAccountRegion=awsAccountRegion&environmentBlueprintIdentifier=environmentBlueprintIdentifier&environmentProfileIdentifier=environmentProfileIdentifier&maxResults=maxResults&name=name&nextToken=nextToken&projectIdentifier=projectIdentifier&provider=provider&status=status 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 environments.

Pattern: ^\d{12}$

awsAccountRegion

The AWS region where you want to list environments.

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 Amazon DataZone blueprint.

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

environmentProfileIdentifier

The identifier of the environment profile.

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

maxResults

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.

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

name

The name of the environment.

nextToken

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.

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}$

Required: Yes

provider

The provider of the environment.

status

The status of the environments that you want to list.

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",
         "environmentProfileId": "string",
         "id": "string",
         "name": "string",
         "projectId": "string",
         "provider": "string",
         "status": "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 ListEnvironments action.

Type: Array of EnvironmentSummary 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