[ aws . directconnect ]

describe-direct-connect-gateway-attachments

Description

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-direct-connect-gateway-attachments 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: directConnectGatewayAttachments

Synopsis

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

--virtual-interface-id (string)

The ID of the virtual interface.

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

The attachments.

(structure)

Information about an attachment between a Direct Connect gateway and a virtual interface.

directConnectGatewayId -> (string)

The ID of the Direct Connect gateway.

virtualInterfaceId -> (string)

The ID of the virtual interface.

virtualInterfaceRegion -> (string)

The Amazon Web Services Region where the virtual interface is located.

virtualInterfaceOwnerAccount -> (string)

The ID of the Amazon Web Services account that owns the virtual interface.

attachmentState -> (string)

The state of the attachment. The following are the possible values:

• attaching : The initial state after a virtual interface is created using the Direct Connect gateway.

• attached : The Direct Connect gateway and virtual interface are attached and ready to pass traffic.

• detaching : The initial state after calling DeleteVirtualInterface .

• detached : The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.

attachmentType -> (string)

The type of attachment.

stateChangeError -> (string)

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

nextToken -> (string)

The token to retrieve the next page.