:doc:`NetworkManager <../../networkmanager>` / Paginator / ListAttachments

***************
ListAttachments
***************



.. py:class:: NetworkManager.Paginator.ListAttachments

  ::

    
    paginator = client.get_paginator('list_attachments')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`NetworkManager.Client.list_attachments`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkmanager-2019-07-05/ListAttachments>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          CoreNetworkId='string',
          AttachmentType='CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'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'
          }
      )
      
    :type CoreNetworkId: string
    :param CoreNetworkId: 

      The ID of a core network.

      

    
    :type AttachmentType: string
    :param AttachmentType: 

      The type of attachment.

      

    
    :type EdgeLocation: string
    :param EdgeLocation: 

      The Region where the edge is located.

      

    
    :type State: string
    :param State: 

      The state of the attachment.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Attachments': [
                {
                    'CoreNetworkId': 'string',
                    'CoreNetworkArn': 'string',
                    'AttachmentId': 'string',
                    'OwnerAccountId': 'string',
                    'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
                    'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
                    'EdgeLocation': 'string',
                    'EdgeLocations': [
                        'string',
                    ],
                    'ResourceArn': 'string',
                    'AttachmentPolicyRuleNumber': 123,
                    'SegmentName': 'string',
                    'NetworkFunctionGroupName': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'ProposedSegmentChange': {
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ],
                        'AttachmentPolicyRuleNumber': 123,
                        'SegmentName': 'string'
                    },
                    'ProposedNetworkFunctionGroupChange': {
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ],
                        'AttachmentPolicyRuleNumber': 123,
                        'NetworkFunctionGroupName': 'string'
                    },
                    'CreatedAt': datetime(2015, 1, 1),
                    'UpdatedAt': datetime(2015, 1, 1),
                    'LastModificationErrors': [
                        {
                            'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                            'Message': 'string',
                            'ResourceArn': 'string',
                            'RequestId': 'string'
                        },
                    ]
                },
            ],
            
        }
        
      **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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns ``EdgeLocations``.

              
            

            - **EdgeLocations** *(list) --* 

              The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun ``EdgeLocation``.

              
              

              - *(string) --* 
          
            

            - **ResourceArn** *(string) --* 

              The attachment resource ARN.

              
            

            - **AttachmentPolicyRuleNumber** *(integer) --* 

              The policy rule number associated with the attachment.

              
            

            - **SegmentName** *(string) --* 

              The name of the segment attachment.

              
            

            - **NetworkFunctionGroupName** *(string) --* 

              The name of the network function group.

              
            

            - **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.

                
          
            

            - **ProposedNetworkFunctionGroupChange** *(dict) --* 

              Describes a proposed change to a network function group associated with the attachment.

              
              

              - **Tags** *(list) --* 

                The list of proposed changes to the key-value tags associated with the network function group.

                
                

                - *(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 proposed new attachment policy rule number for the network function group.

                
              

              - **NetworkFunctionGroupName** *(string) --* 

                The proposed name change for the network function group name.

                
          
            

            - **CreatedAt** *(datetime) --* 

              The timestamp when the attachment was created.

              
            

            - **UpdatedAt** *(datetime) --* 

              The timestamp when the attachment was last updated.

              
            

            - **LastModificationErrors** *(list) --* 

              Describes the error associated with the attachment request.

              
              

              - *(dict) --* 

                Describes the error associated with an attachment request.

                
                

                - **Code** *(string) --* 

                  The error code for the attachment request.

                  
                

                - **Message** *(string) --* 

                  The message associated with the error ``code``.

                  
                

                - **ResourceArn** *(string) --* 

                  The ARN of the requested attachment resource.

                  
                

                - **RequestId** *(string) --* 

                  The ID of the attachment request.

                  
            
          
        
      
    