[ aws . migration-hub-refactor-spaces ]

get-environment

Description

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-environment
--environment-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--environment-identifier (string)

The ID of the environment.

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

See ‘aws help’ for descriptions of global parameters.

Output

Arn -> (string)

The Amazon Resource Name (ARN) of the environment.

CreatedTime -> (timestamp)

A timestamp that indicates when the environment is created.

Description -> (string)

The 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 to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

key -> (string)

value -> (string)

TransitGatewayId -> (string)

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