EC2 / Client / describe_ipams

describe_ipams#

EC2.Client.describe_ipams(**kwargs)#

Get information about your IPAM pools.

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

Request Syntax

response = client.describe_ipams(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    IpamIds=[
        'string',
    ]
)

Parameters:

DryRun (boolean) – A check for 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.
Filters (list) –
One or more filters for the request. For more information about filtering, see Filtering CLI output.
- (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 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) –
MaxResults (integer) – The maximum number of results to return in the request.
NextToken (string) – The token for the next page of results.
IpamIds (list) –
The IDs of the IPAMs you want information on.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Ipams': [
        {
            'OwnerId': 'string',
            'IpamId': 'string',
            'IpamArn': 'string',
            'IpamRegion': 'string',
            'PublicDefaultScopeId': 'string',
            'PrivateDefaultScopeId': 'string',
            'ScopeCount': 123,
            'Description': 'string',
            'OperatingRegions': [
                {
                    'RegionName': 'string'
                },
            ],
            'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'DefaultResourceDiscoveryId': 'string',
            'DefaultResourceDiscoveryAssociationId': 'string',
            'ResourceDiscoveryAssociationCount': 123,
            'StateMessage': 'string',
            'Tier': 'free'|'advanced',
            'EnablePrivateGua': True|False
        },
    ]
}

Response Structure

(dict) –
- 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.
- Ipams (list) –
  
  Information about the IPAMs.
  - (dict) –
    
    IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
    - OwnerId (string) –
      
      The Amazon Web Services account ID of the owner of the IPAM.
    - IpamId (string) –
      
      The ID of the IPAM.
    - IpamArn (string) –
      
      The Amazon Resource Name (ARN) of the IPAM.
    - IpamRegion (string) –
      
      The Amazon Web Services Region of the IPAM.
    - PublicDefaultScopeId (string) –
      
      The ID of the IPAM’s default public scope.
    - PrivateDefaultScopeId (string) –
      
      The ID of the IPAM’s default private scope.
    - ScopeCount (integer) –
      
      The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
    - Description (string) –
      
      The description for the IPAM.
    - OperatingRegions (list) –
      
      The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
      
      For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
      - (dict) –
        
        The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
        
        For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
        
        RegionName (string) –
        
        The name of the operating Region.
    - State (string) –
      
      The state of the IPAM.
    - Tags (list) –
      
      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.
      - (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.
    - DefaultResourceDiscoveryId (string) –
      
      The IPAM’s default resource discovery ID.
    - DefaultResourceDiscoveryAssociationId (string) –
      
      The IPAM’s default resource discovery association ID.
    - ResourceDiscoveryAssociationCount (integer) –
      
      The IPAM’s resource discovery association count.
    - StateMessage (string) –
      
      The state message.
    - Tier (string) –
      
      IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
    - EnablePrivateGua (boolean) –
      
      Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.