<a id="cli-aws-interconnect-list-environments"></a>

# list-environments

## Description

Lists all of the environments that can produce connections that will land in the called AWS region.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/interconnect-2022-07-26/ListEnvironments)

`list-environments` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument.
When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `environments`

## Synopsis

```
  list-environments
[--provider <value>]
[--location <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--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]
[--cli-error-format <value>]
[--help]
```

## Options

`--provider` (tagged union structure)

> Filter results to only include  Environment objects that connect to the  Provider .

> #### NOTE
> This is a Tagged Union structure. Only one of the following top level keys can be set: `cloudServiceProvider`, `lastMileProvider`.

> cloudServiceProvider -> (string)

> > The provider’s name. Specifically, connections to/from this Cloud Service Provider will be considered Multicloud connections.

> > Constraints:

> > * min: `0`
> > * max: `32`

> lastMileProvider -> (string)

> > The provider’s name. Specifically, connections to/from this Last Mile Provider will be considered LastMile connections.

> > Constraints:

> > * min: `0`
> > * max: `32`

Shorthand Syntax:

```
cloudServiceProvider=string,lastMileProvider=string
```

JSON Syntax:

```json
{
  "cloudServiceProvider": "string",
  "lastMileProvider": "string"
}
```

`--location` (string)

> Filter results to only include  Environment objects that connect to a given location distiguisher.

> Constraints:

> * min: `0`
> * max: `255`

`--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](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) 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](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

> Constraints:

> * min: `1`
> * max: `100`

`--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](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

`--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`.

`--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
* off

`--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.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Output

environments -> (list)

> The list of matching  Environment objects.

> (structure)

> > Defines the logical topology that an AWS Interconnect Connection is created upon.

> > Specifically, an Environment defines the partner The remote Cloud Service Provider of this resource. or The remote Last Mile Provider of this resource. and the region or location specification to which an AWS Interconnect Connection can be made.

> > provider -> (tagged union structure) [required]

> > > The provider on the remote side of this  Connection .

> > > #### NOTE
> > > This is a Tagged Union structure. Only one of the following top level keys can be set: `cloudServiceProvider`, `lastMileProvider`.

> > > cloudServiceProvider -> (string)

> > > > The provider’s name. Specifically, connections to/from this Cloud Service Provider will be considered Multicloud connections.

> > > > Constraints:

> > > > * min: `0`
> > > > * max: `32`

> > > lastMileProvider -> (string)

> > > > The provider’s name. Specifically, connections to/from this Last Mile Provider will be considered LastMile connections.

> > > > Constraints:

> > > > * min: `0`
> > > > * max: `32`

> > location -> (string) [required]

> > > The provider specific location on the remote side of this  Connection .

> > > Constraints:

> > > * min: `0`
> > > * max: `255`

> > environmentId -> (string) [required]

> > > The identifier of this  Environment

> > > Constraints:

> > > * min: `1`
> > > * max: `64`

> > state -> (string) [required]

> > > The state of the  Environment . Possible values:

> > > * `available` : The environment is available and new  Connection objects can be requested.
> > > * `limited` : The environment is available, but overall capacity is limited. The set of available bandwidths
> > > * `unavailable` : The environment is currently unavailable.

> > > Possible values:

> > > * `available`
> > > * `limited`
> > > * `unavailable`

> > bandwidths -> (structure) [required]

> > > The sets of bandwidths that are available and supported on this environment.

> > > available -> (list)

> > > > The list of currently available bandwidths.

> > > > (string)

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `8`
> > > > > * pattern: `\d+[MG]bps`

> > > supported -> (list)

> > > > The list of all bandwidths that this environment plans to support

> > > > (string)

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `8`
> > > > > * pattern: `\d+[MG]bps`

> > type -> (string) [required]

> > > The specific product type of  Connection objects provided by this  Environment .

> > > Constraints:

> > > * min: `5`
> > > * max: `32`

> > activationPageUrl -> (string)

> > > An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.

> > remoteIdentifierType -> (string)

> > > The type of identifying information that should be supplied to the `remoteAccount` parameter of a  CreateConnection call for this specific Environment.

> > > Possible values:

> > > * `account`
> > > * `email`

nextToken -> (string)

> A pagination token for use in subsequent calls to fetch the next page of results.