AWS CLI Command Reference

[ aws . ecs ]

describe-gateway

Description

Describes a gateway, including its configuration, status, and the type-specific infrastructure settings that it uses.

See also: AWS API Documentation

Synopsis

  describe-gateway
--gateway <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]
[--cli-error-format <value>]

Options

--gateway (string) [required]

The name or Amazon Resource Name (ARN) of the gateway to describe.

--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
  • off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

gateway -> (structure)

The details of the gateway.

gatewayArn -> (string)

The Amazon Resource Name (ARN) of the gateway.

name -> (string)

The name of the gateway.

status -> (string)

The status of the gateway.

Possible values:

  • ACTIVE
  • UPDATE_IN_PROGRESS
  • UPDATE_COMPLETE
  • UPDATE_FAILED
  • DELETED

statusReason -> (string)

A human-readable explanation of the current status. This value is populated when the gateway is in a failure state, such as UPDATE_FAILED .

failures -> (list)

The per-resource failure details for asynchronous gateway processes, such as an UpdateGateway operation that couldn’t update every load balancer.

Constraints:

  • min: 0
  • max: 200

(structure)

The failures for a single resource that was touched by an asynchronous gateway process.

arn -> (string)

The Amazon Resource Name (ARN) of the resource that failed to update, such as a load balancer ARN.

errors -> (list)

The errors that were encountered while operating on the resource.

Constraints:

  • min: 0
  • max: 5

(structure)

A single failed operation against a resource that a gateway manages.

operation -> (string)

The IAM-style action identifier of the operation that failed, such as elasticloadbalancing:ModifyLoadBalancerAttributes .

code -> (string)

The error code returned by the failed operation, passed through from the downstream service, such as AccessDenied .

message -> (string)

The detailed error message.

infrastructureRoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role that the gateway uses to manage infrastructure on your behalf.

deletionProtection -> (boolean)

Specifies whether deletion protection is enabled for the gateway.

configuration -> (tagged union structure)

The type-specific configuration for the gateway.

Note

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

hostSharedAlb -> (structure)

The configuration for a host-based, shared Application Load Balancer gateway.

networkConfiguration -> (structure)

The network configuration for the load balancers that the gateway manages.

inboundSecurityGroup -> (string)

The ID of a security group that you provide to control inbound traffic to the load balancers that the gateway manages. When you specify a security group, the gateway doesn’t create inbound rules on the security group it manages.

subnets -> (list)

The subnets for the load balancers that the gateway manages. The default is the subnets in the default VPC.

(string)

ipAddressType -> (string)

The IP address type for the load balancers that the gateway manages. The default is dualstack .

Possible values:

  • ipv4
  • dualstack
  • dualstack-without-public-ipv4

scheme -> (string)

Specifies whether the load balancers the gateway manages are internet-facing or internal .

Possible values:

  • internet-facing
  • internal

accessLogs -> (structure)

The access log configuration for the load balancers that the gateway manages.

destination -> (tagged union structure)

The destination where access logs are delivered.

Note

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

s3 -> (structure)

The Amazon S3 destination for access logs.

bucket -> (string) [required]

The name of the Amazon S3 bucket where access logs are delivered.

prefix -> (string)

The object key prefix for the access logs in the Amazon S3 bucket.

webACLArn -> (string)

The Amazon Resource Name (ARN) of the WAF web ACL associated with the load balancers that the gateway manages.

port -> (integer)

The port that the load balancer listener uses is 443. The gateway supports only HTTPS at port 443.

protocol -> (string)

The protocol for the load balancer listener is HTTPS . No other protocol is supported.

Possible values:

  • HTTP
  • HTTPS

maxAlbCount -> (integer)

The maximum number of Application Load Balancers that the gateway manages.

currentAlbCount -> (integer)

The current number of Application Load Balancers that the gateway has allocated.

httpDesync -> (string)

The desync mitigation mode for the load balancers that the gateway manages.

Possible values:

  • monitor
  • defensive
  • strictest

testTrafficRules -> (structure)

The rules that route test traffic for progressive deployments.

header -> (structure)

The header-based rule that identifies test traffic.

name -> (string) [required]

The name of the header to match for test traffic routing.

values -> (list) [required]

The header values to match for test traffic routing.

(string)

accessType -> (string)

Specifies whether the gateway is publicly accessible (PUBLIC ) or private (PRIVATE ). The gateway derives this value from its scheme when you create the gateway, and the value is immutable.

Possible values:

  • PUBLIC
  • PRIVATE

propagateTags -> (string)

Specifies whether the gateway propagates its tags to the infrastructure it manages.

Possible values:

  • NONE
  • GATEWAY

tags -> (list)

The metadata applied to the gateway. Each tag consists of a key and an optional value.

Constraints:

  • min: 0
  • max: 50

(structure)

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

key -> (string)

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

Constraints:

  • min: 1
  • max: 128
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

value -> (string)

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Constraints:

  • min: 0
  • max: 256
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

createdAt -> (timestamp)

The Unix timestamp for the time when the gateway was created.

updatedAt -> (timestamp)

The Unix timestamp for the time when the gateway was last updated.
© Copyright 2026, Amazon Web Services. Created using Sphinx.