[ aws . directconnect ]

describe-direct-connect-gateways

Description

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-direct-connect-gateways is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: directConnectGateways

Synopsis

  describe-direct-connect-gateways
[--direct-connect-gateway-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

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

The ID of the Direct Connect gateway.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

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)

The Direct Connect gateways.

(structure)

Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.

directConnectGatewayId -> (string)

The ID of the Direct Connect gateway.

directConnectGatewayName -> (string)

The name of the Direct Connect gateway.

amazonSideAsn -> (long)

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

ownerAccount -> (string)

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

directConnectGatewayState -> (string)

The state of the Direct Connect gateway. The following are the possible values:

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

The error message if the state of an object failed to advance.

nextToken -> (string)

The token to retrieve the next page.