ListAttachments¶

class NetworkManager.Paginator.ListAttachments¶

paginator = client.get_paginator('list_attachments')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from NetworkManager.Client.list_attachments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CoreNetworkId='string',
    AttachmentType='CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
    EdgeLocation='string',
    State='REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

CoreNetworkId (string) -- The ID of a core network.
AttachmentType (string) -- The type of attachment.
EdgeLocation (string) -- The Region where the edge is located.
State (string) -- The state of the attachment.
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

{
    'Attachments': [
        {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

(dict) --
- Attachments (list) --
  
  Describes the list of attachments.
  - (dict) --
    
    Describes a core network attachment.
    - CoreNetworkId (string) --
      
      The ID of a core network.
    - CoreNetworkArn (string) --
      
      The ARN of a core network.
    - AttachmentId (string) --
      
      The ID of the attachment.
    - OwnerAccountId (string) --
      
      The ID of the attachment account owner.
    - AttachmentType (string) --
      
      The type of attachment.
    - State (string) --
      
      The state of the attachment.
    - EdgeLocation (string) --
      
      The Region where the edge is located.
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - Tags (list) --
      
      The tags associated with the attachment.
      - (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
        
        Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
    - ProposedSegmentChange (dict) --
      
      The attachment to move from one segment to another.
      - Tags (list) --
        
        The list of key-value tags that changed for the segment.
        
        (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
        
        Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
      - AttachmentPolicyRuleNumber (integer) --
        
        The rule number in the policy document that applies to this change.
      - SegmentName (string) --
        
        The name of the segment to change.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.

Table Of Contents

ListAttachments¶