Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . m2 ]

get-environment

Description

Describes a specific runtime environment.

See also: AWS API Documentation

Synopsis

  get-environment
--environment-id <value>
[--cli-input-json <value>]
[--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>]

Options

--environment-id (string)

The unique identifier of the runtime environment.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

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.

(tagged union structure)

Defines the storage configuration for an environment.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: efs, fsx.

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.