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

********************
describe_ipam_byoasn
********************



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

  

  Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see `Tutorial\: Bring your ASN to IPAM <https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html>`__ in the *Amazon VPC IPAM guide*.

  

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


  **Request Syntax**
  ::

    response = client.describe_ipam_byoasn(
        DryRun=True|False,
        MaxResults=123,
        NextToken='string'
    )
    
  :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``.

    

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

    

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

    
    ::

      {
          'Byoasns': [
              {
                  'Asn': 'string',
                  'IpamId': 'string',
                  'StatusMessage': 'string',
                  'State': 'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Byoasns** *(list) --* 

        ASN and BYOIP CIDR associations.

        
        

        - *(dict) --* 

          The Autonomous System Number (ASN) and BYOIP CIDR association.

          
          

          - **Asn** *(string) --* 

            A public 2-byte or 4-byte ASN.

            
          

          - **IpamId** *(string) --* 

            An IPAM ID.

            
          

          - **StatusMessage** *(string) --* 

            The status message.

            
          

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

            The provisioning state of the BYOASN.

            
      
    
      

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

        
  