EC2 / Paginator / DescribeIpamPrefixListResolverTargets

DescribeIpamPrefixListResolverTargets

class EC2.Paginator.DescribeIpamPrefixListResolverTargets

paginator = client.get_paginator('describe_ipam_prefix_list_resolver_targets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.describe_ipam_prefix_list_resolver_targets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    IpamPrefixListResolverTargetIds=[
        'string',
    ],
    IpamPrefixListResolverId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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) –

• IpamPrefixListResolverTargetIds (list) –

  The IDs of the IPAM prefix list resolver Targets to describe. If not specified, all targets in your account are described.

  • (string) –

• IpamPrefixListResolverId (string) – The ID of the IPAM prefix list resolver to filter targets by. Only targets associated with this resolver will be returned.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'IpamPrefixListResolverTargets': [
        {
            'IpamPrefixListResolverTargetId': 'string',
            'IpamPrefixListResolverTargetArn': 'string',
            'IpamPrefixListResolverId': 'string',
            'OwnerId': 'string',
            'PrefixListId': 'string',
            'PrefixListRegion': 'string',
            'DesiredVersion': 123,
            'LastSyncedVersion': 123,
            'TrackLatestVersion': True|False,
            'StateMessage': 'string',
            'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'sync-in-progress'|'sync-complete'|'sync-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  • IpamPrefixListResolverTargets (list) –

    Information about the IPAM prefix list resolver Targets.

    • (dict) –

      Describes an IPAM prefix list resolver target.

      An IPAM prefix list resolver target is an association between a specific customer-managed prefix list and an IPAM prefix list resolver. The target enables the resolver to synchronize CIDRs selected by its rules into the specified prefix list, which can then be referenced in Amazon Web Services resources.

      • IpamPrefixListResolverTargetId (string) –

        The ID of the IPAM prefix list resolver target.

      • IpamPrefixListResolverTargetArn (string) –

        The Amazon Resource Name (ARN) of the IPAM prefix list resolver target.

      • IpamPrefixListResolverId (string) –

        The ID of the IPAM prefix list resolver associated with this target.

      • OwnerId (string) –

        The ID of the Amazon Web Services account that owns the IPAM prefix list resolver target.

      • PrefixListId (string) –

        The ID of the managed prefix list associated with this target.

      • PrefixListRegion (string) –

        The Amazon Web Services Region where the prefix list associated with this target is located.

      • DesiredVersion (integer) –

        The desired version of the prefix list that this target should synchronize with.

      • LastSyncedVersion (integer) –

        The version of the prefix list that was last successfully synchronized by this target.

      • TrackLatestVersion (boolean) –

        Indicates whether this target automatically tracks the latest version of the prefix list.

      • StateMessage (string) –

        A message describing the current state of the IPAM prefix list resolver target, including any error information.

      • State (string) –

        The current state of the IPAM prefix list resolver target. 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 target.

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