EC2 / Client / delete_ipam_prefix_list_resolver

delete_ipam_prefix_list_resolver

EC2.Client.delete_ipam_prefix_list_resolver(**kwargs)

Deletes an IPAM prefix list resolver. Before deleting a resolver, you must first delete all resolver targets associated with it.

See also: AWS API Documentation

Request Syntax

response = client.delete_ipam_prefix_list_resolver(
    DryRun=True|False,
    IpamPrefixListResolverId='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.

• IpamPrefixListResolverId (string) –

  [REQUIRED]

  The ID of the IPAM prefix list resolver to delete.

Return type:

dict

Returns:

Response Syntax

{
    'IpamPrefixListResolver': {
        '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) –

  • IpamPrefixListResolver (dict) –

    Information about the IPAM prefix list resolver that was deleted.

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