:doc:`EC2 <../../ec2>` / Client / describe_transit_gateway_peering_attachments

********************************************
describe_transit_gateway_peering_attachments
********************************************



.. py:method:: EC2.Client.describe_transit_gateway_peering_attachments(**kwargs)

  

  Describes your transit gateway peering attachments.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeTransitGatewayPeeringAttachments>`_  


  **Request Syntax**
  ::

    response = client.describe_transit_gateway_peering_attachments(
        TransitGatewayAttachmentIds=[
            'string',
        ],
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxResults=123,
        NextToken='string',
        DryRun=True|False
    )
    
  :type TransitGatewayAttachmentIds: list
  :param TransitGatewayAttachmentIds: 

    One or more IDs of the transit gateway peering attachments.

    

  
    - *(string) --* 

    

  :type Filters: list
  :param Filters: 

    One or more filters. The possible values are:

     

    
    * ``transit-gateway-attachment-id`` - The ID of the transit gateway attachment.
     
    * ``local-owner-id`` - The ID of your Amazon Web Services account.
     
    * ``remote-owner-id`` - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
     
    * ``state`` - The state of the peering attachment. Valid values are ``available`` | ``deleted`` | ``deleting`` | ``failed`` | ``failing`` | ``initiatingRequest`` | ``modifying`` | ``pendingAcceptance`` | ``pending`` | ``rollingBack`` | ``rejected`` | ``rejecting``).
     
    * ``tag``:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key ``Owner`` and the value ``TeamA``, specify ``tag:Owner`` for the filter name and ``TeamA`` for the filter value.
     
    * ``tag-key`` - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
     
    * ``transit-gateway-id`` - The ID of the transit gateway.
    

    

  
    - *(dict) --* 

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

       

      If you specify multiple filters, the filters are joined with an ``AND``, and the request returns only results that match all of the specified filters.

       

      For more information, see `List and filter using the CLI and API <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ in the *Amazon EC2 User Guide*.

      

    
      - **Name** *(string) --* 

        The name of the filter. Filter names are case-sensitive.

        

      
      - **Values** *(list) --* 

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an ``OR``, and the request returns all results that match any of the specified values.

        

      
        - *(string) --* 

        
    
    

  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned ``nextToken`` value.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next page of results.

    

  
  :type DryRun: boolean
  :param DryRun: 

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ``DryRunOperation``. Otherwise, it is ``UnauthorizedOperation``.

    

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

    
    ::

      {
          'TransitGatewayPeeringAttachments': [
              {
                  'TransitGatewayAttachmentId': 'string',
                  'AccepterTransitGatewayAttachmentId': 'string',
                  'RequesterTgwInfo': {
                      'TransitGatewayId': 'string',
                      'CoreNetworkId': 'string',
                      'OwnerId': 'string',
                      'Region': 'string'
                  },
                  'AccepterTgwInfo': {
                      'TransitGatewayId': 'string',
                      'CoreNetworkId': 'string',
                      'OwnerId': 'string',
                      'Region': 'string'
                  },
                  'Options': {
                      'DynamicRouting': 'enable'|'disable'
                  },
                  'Status': {
                      'Code': 'string',
                      'Message': 'string'
                  },
                  'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
                  'CreationTime': datetime(2015, 1, 1),
                  'Tags': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **TransitGatewayPeeringAttachments** *(list) --* 

        The transit gateway peering attachments.

        
        

        - *(dict) --* 

          Describes the transit gateway peering attachment.

          
          

          - **TransitGatewayAttachmentId** *(string) --* 

            The ID of the transit gateway peering attachment.

            
          

          - **AccepterTransitGatewayAttachmentId** *(string) --* 

            The ID of the accepter transit gateway attachment.

            
          

          - **RequesterTgwInfo** *(dict) --* 

            Information about the requester transit gateway.

            
            

            - **TransitGatewayId** *(string) --* 

              The ID of the transit gateway.

              
            

            - **CoreNetworkId** *(string) --* 

              The ID of the core network where the transit gateway peer is located.

              
            

            - **OwnerId** *(string) --* 

              The ID of the Amazon Web Services account that owns the transit gateway.

              
            

            - **Region** *(string) --* 

              The Region of the transit gateway.

              
        
          

          - **AccepterTgwInfo** *(dict) --* 

            Information about the accepter transit gateway.

            
            

            - **TransitGatewayId** *(string) --* 

              The ID of the transit gateway.

              
            

            - **CoreNetworkId** *(string) --* 

              The ID of the core network where the transit gateway peer is located.

              
            

            - **OwnerId** *(string) --* 

              The ID of the Amazon Web Services account that owns the transit gateway.

              
            

            - **Region** *(string) --* 

              The Region of the transit gateway.

              
        
          

          - **Options** *(dict) --* 

            Details about the transit gateway peering attachment.

            
            

            - **DynamicRouting** *(string) --* 

              Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.

              
        
          

          - **Status** *(dict) --* 

            The status of the transit gateway peering attachment.

            
            

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

              The status code.

              
            

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

              The status message, if applicable.

              
        
          

          - **State** *(string) --* 

            The state of the transit gateway peering attachment. Note that the ``initiating`` state has been deprecated.

            
          

          - **CreationTime** *(datetime) --* 

            The time the transit gateway peering attachment was created.

            
          

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

            The tags for the transit gateway peering attachment.

            
            

            - *(dict) --* 

              Describes a tag.

              
              

              - **Key** *(string) --* 

                The key of the tag.

                 

                Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``.

                
              

              - **Value** *(string) --* 

                The value of the tag.

                 

                Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

                
          
        
      
    
      

      - **NextToken** *(string) --* 

        The token to use to retrieve the next page of results. This value is ``null`` when there are no more results to return.

        
  