List Environments

datazone_list_environments

R Documentation

Lists Amazon DataZone environments

Description

Lists Amazon DataZone environments.

Usage

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

Arguments

awsAccountId

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

awsAccountRegion

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

domainIdentifier

[required] The identifier of the Amazon DataZone domain.

environmentBlueprintIdentifier

The identifier of the Amazon DataZone blueprint.

environmentProfileIdentifier

The identifier of the environment profile.

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.

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

projectIdentifier

[required] The identifier of the Amazon DataZone project.

provider

The provider of the environment.

status

The status of the environments that you want to list.

Value

A list with the following syntax:

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

Request syntax

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