[ aws . migration-hub-refactor-spaces ]

list-environments

Description

Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

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: EnvironmentSummaryList

Synopsis

  list-environments
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

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

See ‘aws help’ for descriptions of global parameters.

Output

EnvironmentSummaryList -> (list)

The list of EnvironmentSummary objects.

(structure)

The summary information for environments as a response to ListEnvironments .

Arn -> (string)

The Amazon Resource Name (ARN) of the environment.

CreatedTime -> (timestamp)

A timestamp that indicates when the environment is created.

Description -> (string)

A description of the environment.

EnvironmentId -> (string)

The unique identifier of the environment.

Error -> (structure)

Any error associated with the environment resource.

AccountId -> (string)

The Amazon Web Services account ID of the resource owner.

AdditionalDetails -> (map)

Additional details about the error.

key -> (string)

value -> (string)

Code -> (string)

The error code associated with the error.

Message -> (string)

The message associated with the error.

ResourceIdentifier -> (string)

The ID of the resource.

ResourceType -> (string)

The type of resource.

LastUpdatedTime -> (timestamp)

A timestamp that indicates when the environment was last updated.

Name -> (string)

The name of the environment.

NetworkFabricType -> (string)

The network fabric type of the environment.

OwnerAccountId -> (string)

The Amazon Web Services account ID of the environment owner.

State -> (string)

The current state of the environment.

Tags -> (map)

The tags assigned to the environment.

key -> (string)

value -> (string)

TransitGatewayId -> (string)

The ID of the transit gateway set up by the environment.

NextToken -> (string)

The token for the next page of results.