[ aws . m2 ]

get-environment

Description

Describes a specific runtime environment.

See also: AWS API Documentation

Synopsis

  get-environment
--environment-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

actualCapacity -> (integer)

The number of instances included in the runtime environment. A standalone runtime environment has a maximum 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. The minimum possible value is 1 and the maximum is 100.

instanceType -> (string)

The type of instance underlying the runtime environment.

kmsKeyId -> (string)

The identifier of a customer managed key.

loadBalancerArn -> (string)

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

name -> (string)

The name of the runtime environment. Must be unique within the account.

networkType -> (string)

The network type supported by 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 runtime engine version.

endTime -> (timestamp)

The time the scheduled maintenance is to end.

startTime -> (timestamp)

The time the scheduled maintenance is to start.

preferredMaintenanceWindow -> (string)

The maintenance window for the runtime environment. If you don’t provide a value for the maintenance window, the service assigns a random value.

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. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be Unhealthy .

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