DirectConnect / Paginator / DescribeDirectConnectGatewayAttachments
DescribeDirectConnectGatewayAttachments#
- class DirectConnect.Paginator.DescribeDirectConnectGatewayAttachments#
paginator = client.get_paginator('describe_direct_connect_gateway_attachments')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
DirectConnect.Client.describe_direct_connect_gateway_attachments()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( directConnectGatewayId='string', virtualInterfaceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
directConnectGatewayId (string) – The ID of the Direct Connect gateway.
virtualInterfaceId (string) – The ID of the virtual interface.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'directConnectGatewayAttachments': [ { 'directConnectGatewayId': 'string', 'virtualInterfaceId': 'string', 'virtualInterfaceRegion': 'string', 'virtualInterfaceOwnerAccount': 'string', 'attachmentState': 'attaching'|'attached'|'detaching'|'detached', 'attachmentType': 'TransitVirtualInterface'|'PrivateVirtualInterface', 'stateChangeError': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
directConnectGatewayAttachments (list) –
The attachments.
(dict) –
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) –
A token to resume pagination.