:doc:`DirectConnect <../../directconnect>` / Client / describe_direct_connect_gateway_association_proposals

*****************************************************
describe_direct_connect_gateway_association_proposals
*****************************************************



.. py:method:: DirectConnect.Client.describe_direct_connect_gateway_association_proposals(**kwargs)

  

  Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociationProposals>`_  


  **Request Syntax**
  ::

    response = client.describe_direct_connect_gateway_association_proposals(
        directConnectGatewayId='string',
        proposalId='string',
        associatedGatewayId='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type directConnectGatewayId: string
  :param directConnectGatewayId: 

    The ID of the Direct Connect gateway.

    

  
  :type proposalId: string
  :param proposalId: 

    The ID of the proposal.

    

  
  :type associatedGatewayId: string
  :param associatedGatewayId: 

    The ID of the associated gateway.

    

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

     

    If ``MaxResults`` is given a value larger than 100, only 100 results are returned.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next page of results.

    

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

    
    ::

      {
          'directConnectGatewayAssociationProposals': [
              {
                  'proposalId': 'string',
                  'directConnectGatewayId': 'string',
                  'directConnectGatewayOwnerAccount': 'string',
                  'proposalState': 'requested'|'accepted'|'deleted',
                  'associatedGateway': {
                      'id': 'string',
                      'type': 'virtualPrivateGateway'|'transitGateway',
                      'ownerAccount': 'string',
                      'region': 'string'
                  },
                  'existingAllowedPrefixesToDirectConnectGateway': [
                      {
                          'cidr': 'string'
                      },
                  ],
                  'requestedAllowedPrefixesToDirectConnectGateway': [
                      {
                          'cidr': 'string'
                      },
                  ]
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **directConnectGatewayAssociationProposals** *(list) --* 

        Describes the Direct Connect gateway association proposals.

        
        

        - *(dict) --* 

          Information about the proposal request to attach a virtual private gateway to a Direct Connect gateway.

          
          

          - **proposalId** *(string) --* 

            The ID of the association proposal.

            
          

          - **directConnectGatewayId** *(string) --* 

            The ID of the Direct Connect gateway.

            
          

          - **directConnectGatewayOwnerAccount** *(string) --* 

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

            
          

          - **proposalState** *(string) --* 

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

             

            
            * ``accepted``: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.
             
            * ``deleted``: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.
             
            * ``requested``: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.
            

            
          

          - **associatedGateway** *(dict) --* 

            Information about the associated gateway.

            
            

            - **id** *(string) --* 

              The ID of the associated gateway.

              
            

            - **type** *(string) --* 

              The type of associated gateway.

              
            

            - **ownerAccount** *(string) --* 

              The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.

              
            

            - **region** *(string) --* 

              The Region where the associated gateway is located.

              
        
          

          - **existingAllowedPrefixesToDirectConnectGateway** *(list) --* 

            The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

            
            

            - *(dict) --* 

              Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

              
              

              - **cidr** *(string) --* 

                The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

                
          
        
          

          - **requestedAllowedPrefixesToDirectConnectGateway** *(list) --* 

            The Amazon VPC prefixes to advertise to the Direct Connect gateway.

            
            

            - *(dict) --* 

              Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

              
              

              - **cidr** *(string) --* 

                The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

                
          
        
      
    
      

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

        
  
  **Exceptions**
  
  *   :py:class:`DirectConnect.Client.exceptions.DirectConnectServerException`

  
  *   :py:class:`DirectConnect.Client.exceptions.DirectConnectClientException`

  