Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

Lists Amazon DataZone environments.

get/v2/domains/{domainIdentifier}/environments#projectIdentifier

Path parameters

domainIdentifierstring required

The identifier of the Amazon DataZone domain.

Query parameters

awsAccountIdstring

The identifier of the Amazon Web Services account where you want to list environments.

status'ACTIVE' | 'CREATING' | 'UPDATING' | 'DELETING' | 'CREATE_FAILED' | 'UPDATE_FAILED' | 'DELETE_FAILED' | 'VALIDATION_FAILED' | 'SUSPENDED' | 'DISABLED' | 'EXPIRED' | 'DELETED' | 'INACCESSIBLE'

The status of the environments that you want to list.

awsAccountRegionstring

The Amazon Web Services region where you want to list environments.

projectIdentifierstring required

The identifier of the Amazon DataZone project.

environmentProfileIdentifierstring

The identifier of the environment profile.

environmentBlueprintIdentifierstring

The identifier of the Amazon DataZone blueprint.

providerstring

The provider of the environment.

namestring

The name of the environment.

maxResultsinteger

The maximum number of environments to return in a single call to <code>ListEnvironments</code>. When the number of environments to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListEnvironments</code> to list the next set of environments.

nextTokenstring

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

Response

Success

nextTokenstring

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