Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . directconnect ]

describe-direct-connect-gateways

Description

Returns a list of direct connect gateways in your account. Deleted direct connect gateways are not returned. You can provide a direct connect gateway ID in the request to return information about the specific direct connect gateway only. Otherwise, if a direct connect gateway ID is not provided, information about all of your direct connect gateways is returned.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-direct-connect-gateways
[--direct-connect-gateway-id <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--direct-connect-gateway-id (string)

The ID of the direct connect gateway.

Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

Default: None

--max-results (integer)

The maximum number of direct connect gateways to return per page.

Example: 15

Default: None

--next-token (string)

The token provided in the previous describe result to retrieve the next page of the result.

Default: None

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

See 'aws help' for descriptions of global parameters.

Examples

To describe your Direct Connect gateways

The following example describe all of your Direct Connect gateways.

Command:

aws directconnect describe-direct-connect-gateways

Output:

{
  "directConnectGateways": [
      {
          "amazonSideAsn": 64512,
          "directConnectGatewayId": "cf68415c-f4ae-48f2-87a7-3b52cexample",
          "ownerAccount": "123456789012",
          "directConnectGatewayName": "DxGateway2",
          "directConnectGatewayState": "available"
      },
      {
          "amazonSideAsn": 64512,
          "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bdexample",
          "ownerAccount": "123456789012",
          "directConnectGatewayName": "DxGateway1",
          "directConnectGatewayState": "available"
      }
  ]
}

Output

directConnectGateways -> (list)

Information about the direct connect gateways.

(structure)

A direct connect gateway is an intermediate object that enables you to connect virtual interfaces and virtual private gateways.

directConnectGatewayId -> (string)

The ID of the direct connect gateway.

Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

directConnectGatewayName -> (string)

The name of the direct connect gateway.

Example: "My direct connect gateway"

Default: None

amazonSideAsn -> (long)

The autonomous system number (ASN) for the Amazon side of the connection.

ownerAccount -> (string)

The AWS account ID of the owner of the direct connect gateway.

directConnectGatewayState -> (string)

State of the direct connect gateway.

  • Pending : The initial state after calling CreateDirectConnectGateway .
  • Available : The direct connect gateway is ready for use.
  • Deleting : The initial state after calling DeleteDirectConnectGateway .
  • Deleted : The direct connect gateway is deleted and cannot pass traffic.

stateChangeError -> (string)

Error message when the state of an object fails to advance.

nextToken -> (string)

Token to retrieve the next page of the result.