EC2 / Client / describe_ipam_policies

describe_ipam_policies¶

EC2.Client.describe_ipam_policies(**kwargs)¶

Describes one or more IPAM policies.

An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.

Request Syntax

response = client.describe_ipam_policies(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    IpamPolicyIds=[
        '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 IPAM policy description.
- (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 a single call.
NextToken (string) – The token for the next page of results.
IpamPolicyIds (list) –
The IDs of the IPAM policies to describe.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'IpamPolicies': [
        {
            'OwnerId': 'string',
            'IpamPolicyId': 'string',
            'IpamPolicyArn': 'string',
            'IpamPolicyRegion': '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',
            'StateMessage': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'IpamId': 'string'
        },
    ]
}

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.
- IpamPolicies (list) –
  
  Information about the IPAM policies.
  
  An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
  - (dict) –
    
    Information about an IPAM policy.
    
    An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
    - OwnerId (string) –
      
      The account ID that owns the IPAM policy.
    - IpamPolicyId (string) –
      
      The ID of the IPAM policy.
    - IpamPolicyArn (string) –
      
      The Amazon Resource Name (ARN) of the IPAM policy.
    - IpamPolicyRegion (string) –
      
      The Region of the IPAM policy.
    - State (string) –
      
      The state of the IPAM policy.
    - StateMessage (string) –
      
      A message about the state of the IPAM policy.
    - Tags (list) –
      
      The tags assigned to the IPAM policy.
      - (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.
    - IpamId (string) –
      
      The ID of the IPAM this policy belongs to.