Skip to content

Lists Amazon DataZone environments

Description

Lists Amazon DataZone environments.

Usage

datazone_list_environments(domainIdentifier, awsAccountId, status,
  awsAccountRegion, projectIdentifier, environmentProfileIdentifier,
  environmentBlueprintIdentifier, provider, name, maxResults, nextToken)

Arguments

  • domainIdentifier

[required] The identifier of the Amazon DataZone domain.

  • awsAccountId

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

  • status

The status of the environments that you want to list.

  • awsAccountRegion

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

  • projectIdentifier

[required] The identifier of the Amazon DataZone project.

  • environmentProfileIdentifier

The identifier of the environment profile.

  • environmentBlueprintIdentifier

The identifier of the Amazon DataZone blueprint.

  • provider

The provider of the environment.

  • name

The name of the environment.

  • maxResults

The maximum number of environments to return in a single call to list_environments. 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 list_environments to list the next set of environments.

  • 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 list_environments to list the next set of environments.

Value

A list with the following syntax:

list(
  items = list(
    list(
      projectId = "string",
      id = "string",
      domainId = "string",
      createdBy = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      name = "string",
      description = "string",
      environmentProfileId = "string",
      awsAccountId = "string",
      awsAccountRegion = "string",
      provider = "string",
      status = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED"|"VALIDATION_FAILED"|"SUSPENDED"|"DISABLED"|"EXPIRED"|"DELETED"|"INACCESSIBLE",
      environmentConfigurationId = "string",
      environmentConfigurationName = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_environments(
  domainIdentifier = "string",
  awsAccountId = "string",
  status = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED"|"VALIDATION_FAILED"|"SUSPENDED"|"DISABLED"|"EXPIRED"|"DELETED"|"INACCESSIBLE",
  awsAccountRegion = "string",
  projectIdentifier = "string",
  environmentProfileIdentifier = "string",
  environmentBlueprintIdentifier = "string",
  provider = "string",
  name = "string",
  maxResults = 123,
  nextToken = "string"
)