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

Description

Returns a list of all direct connect gateway and virtual interface (VIF) attachments. Either a direct connect gateway ID or a VIF ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VIFs attached to the direct connect gateway. If a VIF ID is provided, the response returns all direct connect gateways attached to the VIF. If both are provided, the response only returns the attachment that matches both the direct connect gateway and the VIF.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-direct-connect-gateway-attachments
[--direct-connect-gateway-id <value>]
[--virtual-interface-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-interface-id (string)

The ID of the virtual interface.

Example: "dxvif-abc123ef"

Default: None

--max-results (integer)

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

The following example describes the virtual interfaces that are attached to Direct Connect gateway 5f294f92-bafb-4011-916d-9b0bexample.

Command:

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

Output:

{
  "directConnectGatewayAttachments": [
      {
          "virtualInterfaceOwnerAccount": "123456789012",
          "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample",
          "virtualInterfaceRegion": "us-east-2",
          "attachmentState": "attaching",
          "virtualInterfaceId": "dxvif-fg9zyabc"
      }
  ],
  "nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoibEhXdlNpUXF5RzhoL1JyUW52SlV2QT09IiwiYyI6Im5wQjFHQ0RyQUdRS3puNnNXcUlINCtkTTA4dTk3KzBiU0xtb05JQmlaczZ6NXRIYmk3c3VESUxFTTd6a2FzVHM0VTFwaGJkZGNxTytqWmQ3QzMzOGRQaTVrTThrOG1zelRsV3gyMWV3VTNFPSJ9"
}

Output

directConnectGatewayAttachments -> (list)

Information about the direct connect gateway attachments.

(structure)

The association between a direct connect gateway and virtual interface.

directConnectGatewayId -> (string)

The ID of the direct connect gateway.

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

virtualInterfaceId -> (string)

The ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

virtualInterfaceRegion -> (string)

The region in which the virtual interface is located.

Example: us-east-1

virtualInterfaceOwnerAccount -> (string)

The AWS account ID of the owner of the virtual interface.

attachmentState -> (string)

State of the direct connect gateway attachment.

  • Attaching : The initial state after a virtual interface is created using the direct connect gateway.
  • Attached : The direct connect gateway and virtual interface are successfully attached and ready to pass traffic.
  • Detaching : The initial state after calling delete-virtual-interface on a virtual interface that is attached to a direct connect gateway.
  • Detached : The virtual interface is successfully detached from the direct connect gateway. Traffic flow between the direct connect gateway and virtual interface 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.