EC2 / Client / describe_ipam_prefix_list_resolvers

describe_ipam_prefix_list_resolvers¶

EC2.Client.describe_ipam_prefix_list_resolvers(**kwargs)¶

Describes one or more IPAM prefix list resolvers. Use this operation to view the configuration, status, and properties of your resolvers.

Request Syntax

response = client.describe_ipam_prefix_list_resolvers(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    IpamPrefixListResolverIds=[
        '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 to limit the results.
- (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 items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
NextToken (string) – The token for the next page of results.
IpamPrefixListResolverIds (list) –
The IDs of the IPAM prefix list resolvers to describe. If not specified, all resolvers in your account are described.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'IpamPrefixListResolvers': [
        {
            'OwnerId': 'string',
            'IpamPrefixListResolverId': 'string',
            'IpamPrefixListResolverArn': 'string',
            'IpamArn': 'string',
            'IpamRegion': 'string',
            'Description': 'string',
            'AddressFamily': 'ipv4'|'ipv6',
            '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'
                },
            ],
            'LastVersionCreationStatus': 'pending'|'success'|'failure',
            'LastVersionCreationStatusMessage': '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.
- IpamPrefixListResolvers (list) –
  
  Information about the IPAM prefix list resolvers.
  - (dict) –
    
    Describes an IPAM prefix list resolver.
    
    An IPAM prefix list resolver is a component that manages the synchronization between IPAM’s CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM’s database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups.
    - OwnerId (string) –
      
      The ID of the Amazon Web Services account that owns the IPAM prefix list resolver.
    - IpamPrefixListResolverId (string) –
      
      The ID of the IPAM prefix list resolver.
    - IpamPrefixListResolverArn (string) –
      
      The Amazon Resource Name (ARN) of the IPAM prefix list resolver.
    - IpamArn (string) –
      
      The Amazon Resource Name (ARN) of the IPAM associated with this resolver.
    - IpamRegion (string) –
      
      The Amazon Web Services Region where the associated IPAM is located.
    - Description (string) –
      
      The description of the IPAM prefix list resolver.
    - AddressFamily (string) –
      
      The address family (IPv4 or IPv6) for the IPAM prefix list resolver.
    - State (string) –
      
      The current state of the IPAM prefix list resolver. Valid values include create-in-progress, create-complete, create-failed, modify-in-progress, modify-complete, modify-failed, delete-in-progress, delete-complete, and delete-failed.
    - Tags (list) –
      
      The tags assigned to the IPAM prefix list resolver.
      - (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.
    - LastVersionCreationStatus (string) –
      
      The status for the last time a version was created.
      
      Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
    - LastVersionCreationStatusMessage (string) –
      
      The status message for the last time a version was created.
      
      Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.