get-environment¶
Description¶
Get detail data for an environment.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-environment
--name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--name (string)
The name of the environment that you want to get the detail data for.
--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.
See ‘aws help’ for descriptions of global parameters.
Output¶
environment -> (structure)
The environment detail data that’s returned by AWS Proton.
arn -> (string)
The Amazon Resource Name (ARN) of the environment.
createdAt -> (timestamp)
The time when the environment was created.
deploymentStatus -> (string)
The environment deployment status.
deploymentStatusMessage -> (string)
An environment deployment status message.
description -> (string)
The description of the environment.
environmentAccountConnectionId -> (string)
The ID of the environment account connection that’s used to provision infrastructure resources in an environment account.
environmentAccountId -> (string)
The ID of the environment account that the environment infrastructure resources are provisioned in.
lastDeploymentAttemptedAt -> (timestamp)
The time when a deployment of the environment was last attempted.
lastDeploymentSucceededAt -> (timestamp)
The time when the environment was last deployed successfully.
name -> (string)
The name of the environment.
protonServiceRoleArn -> (string)
The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.
provisioning -> (string)
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
spec -> (string)
The environment spec.
templateMajorVersion -> (string)
The ID of the major version of the environment template.
templateMinorVersion -> (string)
The ID of the minor version of the environment template.
templateName -> (string)
The Amazon Resource Name (ARN) of the environment template.