list-environments¶

Description¶

Lists Amazon DataZone environments.

Synopsis¶

  list-environments
[--aws-account-id <value>]
[--aws-account-region <value>]
--domain-identifier <value>
[--environment-blueprint-identifier <value>]
[--environment-profile-identifier <value>]
[--name <value>]
--project-identifier <value>
[--provider <value>]
[--status <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--aws-account-id (string)

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

--aws-account-region (string)

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

--domain-identifier (string)

The identifier of the Amazon DataZone domain.

--environment-blueprint-identifier (string)

The identifier of the Amazon DataZone blueprint.

--environment-profile-identifier (string)

The identifier of the environment profile.

--name (string)

The name of the environment.

--project-identifier (string)

The identifier of the Amazon DataZone project.

--provider (string)

The provider of the environment.

--status (string)

The status of the environments that you want to list.

Possible values:

ACTIVE

CREATING

UPDATING

DELETING

CREATE_FAILED

UPDATE_FAILED

DELETE_FAILED

VALIDATION_FAILED

SUSPENDED

DISABLED

EXPIRED

DELETED

INACCESSIBLE

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

items -> (list)

The results of the ListEnvironments action.

(structure)

The details of an environment.

awsAccountId -> (string)

The identifier of the Amazon Web Services account in which an environment exists.

awsAccountRegion -> (string)

The Amazon Web Services Region in which an environment exists.

createdAt -> (timestamp)

The timestamp of when the environment was created.

createdBy -> (string)

The Amazon DataZone user who created the environment.

description -> (string)

The description of the environment.

domainId -> (string)

The identifier of the Amazon DataZone domain in which the environment exists.

environmentProfileId -> (string)

The identifier of the environment profile with which the environment was created.

id -> (string)

The identifier of the environment.

name -> (string)

The name of the environment.

projectId -> (string)

The identifier of the project in which the environment exists.

provider -> (string)

The provider of the environment.

status -> (string)

The status of the environment.

updatedAt -> (timestamp)

The timestamp of when the environment was updated.

nextToken -> (string)

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.

Table of Contents

Feedback

User Guide