[ aws . m2 ]

get-environment

Description

Describes a specific runtime environment.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--environment-id (string)

The unique identifier of the runtime 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

actualCapacity -> (integer)

The number of instances included in the runtime environment. A standalone runtime environment has a maxiumum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

creationTime -> (timestamp)

The timestamp when the runtime environment was created.

description -> (string)

The description of the runtime environment.

engineType -> (string)

The target platform for the runtime environment.

engineVersion -> (string)

The version of the runtime engine.

environmentArn -> (string)

The Amazon Resource Name (ARN) of the runtime environment.

environmentId -> (string)

The unique identifier of the runtime environment.

highAvailabilityConfig -> (structure)

The desired capacity of the high availability configuration for the runtime environment.

desiredCapacity -> (integer)

The number of instances in a high availability configuration.

instanceType -> (string)

The type of instance underlying the runtime environment.

loadBalancerArn -> (string)

The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

name -> (string)

The name of the runtime environment.

pendingMaintenance -> (structure)

Indicates the pending maintenance scheduled on this environment.

engineVersion -> (string)

The specific runtime engine that the maintenance schedule applies to.

schedule -> (structure)

The maintenance schedule for the engine version.

endTime -> (timestamp)

The time the scheduled maintenance is to end.

startTime -> (timestamp)

The time the scheduled maintenance is to start.

preferredMaintenanceWindow -> (string)

Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.

publiclyAccessible -> (boolean)

Whether applications running in this runtime environment are publicly accessible.

securityGroupIds -> (list)

The unique identifiers of the security groups assigned to this runtime environment.

(string)

status -> (string)

The status of the runtime environment.

statusReason -> (string)

The reason for the reported status.

storageConfigurations -> (list)

The storage configurations defined for the runtime environment.

(structure)

Defines the storage configuration for an environment.

efs -> (structure)

Defines the storage configuration for an Amazon EFS file system.

fileSystemId -> (string)

The file system identifier.

mountPoint -> (string)

The mount point for the file system.

fsx -> (structure)

Defines the storage configuration for an Amazon FSx file system.

fileSystemId -> (string)

The file system identifier.

mountPoint -> (string)

The mount point for the file system.

subnetIds -> (list)

The unique identifiers of the subnets assigned to this runtime environment.

(string)

tags -> (map)

The tags defined for this runtime environment.

key -> (string)

value -> (string)

vpcId -> (string)

The unique identifier for the VPC used with this runtime environment.