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

***************************
describe_secondary_networks
***************************



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

  

  Describes one or more secondary networks.

  

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


  **Request Syntax**
  ::

    response = client.describe_secondary_networks(
        DryRun=True|False,
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxResults=123,
        NextToken='string',
        SecondaryNetworkIds=[
            '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 Filters: list
  :param Filters: 

    The filters. The following are the possible values:

     

    
    * ``ipv4-cidr-block-association.association-id`` - The association ID for an IPv4 CIDR block associated with the secondary network.
     
    * ``ipv4-cidr-block-association.cidr-block`` - An IPv4 CIDR block associated with the secondary network.
     
    * ``ipv4-cidr-block-association.state`` - The state of an IPv4 CIDR block associated with the secondary network.
     
    * ``owner-id`` - The ID of the Amazon Web Services account that owns the secondary network.
     
    * ``secondary-network-id`` - The ID of the secondary network.
     
    * ``secondary-network-arn`` - The ARN of the secondary network.
     
    * ``state`` - The state of the secondary network ( ``create-in-progress`` | ``create-complete`` | ``create-failed`` | ``delete-in-progress`` | ``delete-complete`` | ``delete-failed``).
     
    * ``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 assigned a tag with a specific key, regardless of the tag value.
     
    * ``type`` - The type of the secondary network ( ``rdma``).
    

    

  
    - *(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 SecondaryNetworkIds: list
  :param SecondaryNetworkIds: 

    The IDs of the secondary networks.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'SecondaryNetworks': [
              {
                  'SecondaryNetworkId': 'string',
                  'SecondaryNetworkArn': 'string',
                  'OwnerId': 'string',
                  'Type': 'rdma',
                  'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
                  'StateReason': 'string',
                  'Ipv4CidrBlockAssociations': [
                      {
                          'AssociationId': 'string',
                          'CidrBlock': 'string',
                          'State': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated'|'disassociation-failed',
                          'StateReason': 'string'
                      },
                  ],
                  'Tags': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **SecondaryNetworks** *(list) --* 

        Information about the secondary networks.

        
        

        - *(dict) --* 

          Describes a secondary network.

          
          

          - **SecondaryNetworkId** *(string) --* 

            The ID of the secondary network.

            
          

          - **SecondaryNetworkArn** *(string) --* 

            The Amazon Resource Name (ARN) of the secondary network.

            
          

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

            The ID of the Amazon Web Services account that owns the secondary network.

            
          

          - **Type** *(string) --* 

            The type of the secondary network.

            
          

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

            The state of the secondary network.

            
          

          - **StateReason** *(string) --* 

            The reason for the current state of the secondary network.

            
          

          - **Ipv4CidrBlockAssociations** *(list) --* 

            Information about the IPv4 CIDR blocks associated with the secondary network.

            
            

            - *(dict) --* 

              Describes an IPv4 CIDR block associated with a secondary network.

              
              

              - **AssociationId** *(string) --* 

                The association ID for the IPv4 CIDR block.

                
              

              - **CidrBlock** *(string) --* 

                The IPv4 CIDR block.

                
              

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

                The state of the CIDR block association.

                
              

              - **StateReason** *(string) --* 

                The reason for the current state of the CIDR block association.

                
          
        
          

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

            The tags assigned to the secondary network.

            
            

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

        
  