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-gateway-associations

Description

Returns a list of all direct connect gateway and virtual private gateway (VGW) associations. Either a direct connect gateway ID or a VGW ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VGWs associated with the direct connect gateway. If a VGW ID is provided, the response returns all direct connect gateways associated with the VGW. If both are provided, the response only returns the association that matches both the direct connect gateway and the VGW.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-direct-connect-gateway-associations
[--direct-connect-gateway-id <value>]
[--virtual-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

--virtual-gateway-id (string)

The ID of the virtual private gateway.

Example: "vgw-abc123ef"

Default: None

--max-results (integer)

The maximum number of direct connect gateway associations 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.

--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 Direct Connect gateway associations

The following example describes all the associations with Direct Connect gateway 5f294f92-bafb-4011-916d-9b0bexample.

Command:

aws directconnect describe-direct-connect-gateway-associations --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample

Output:

{
  "nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoiOU83OTFodzdycnZCbkN4MExHeHVwQT09IiwiYyI6InIxTEN0UEVHV0I1UFlkaWFnNlUxanJkRWF6eW1iOElHM0FRVW1MdHRJK0dxcnN1RWtvcFBKWFE2ZjRNRGdGTkhCa0tDZmVINEtZOEYwZ0dEYWZpbmU0ZnZMYVhKRjdXRVdENmdQZ1Y4d2w0PSJ9",
  "directConnectGatewayAssociations": [
      {
          "associationState": "associating",
          "virtualGatewayOwnerAccount": "123456789012",
          "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample",
          "virtualGatewayId": "vgw-6efe725e",
          "virtualGatewayRegion": "us-east-2"
      },
      {
          "associationState": "disassociating",
          "virtualGatewayOwnerAccount": "123456789012",
          "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample",
          "virtualGatewayId": "vgw-ebaa27db",
          "virtualGatewayRegion": "us-east-2"
      }
  ]
}

Output

directConnectGatewayAssociations -> (list)

Information about the direct connect gateway associations.

(structure)

The association between a direct connect gateway and virtual private gateway.

directConnectGatewayId -> (string)

The ID of the direct connect gateway.

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

virtualGatewayId -> (string)

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

Example: vgw-123er56

virtualGatewayRegion -> (string)

The region in which the virtual private gateway is located.

Example: us-east-1

virtualGatewayOwnerAccount -> (string)

The AWS account ID of the owner of the virtual private gateway.

associationState -> (string)

State of the direct connect gateway association.

  • Associating : The initial state after calling create-direct-connect-gateway-association .
  • Associated : The direct connect gateway and virtual private gateway are successfully associated and ready to pass traffic.
  • Disassociating : The initial state after calling delete-direct-connect-gateway-association .
  • Disassociated : The virtual private gateway is successfully disassociated from the direct connect gateway. Traffic flow between the direct connect gateway and virtual private gateway stops.

stateChangeError -> (string)

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

nextToken -> (string)

Token to retrieve the next page of the result.