EC2 / Client / modify_managed_prefix_list

modify_managed_prefix_list

EC2.Client.modify_managed_prefix_list(**kwargs)

Modifies the specified managed prefix list.

Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.

If you specify a current version number that does not match the true current version number, the request fails.

See also: AWS API Documentation

Request Syntax

response = client.modify_managed_prefix_list(
    DryRun=True|False,
    PrefixListId='string',
    CurrentVersion=123,
    PrefixListName='string',
    AddEntries=[
        {
            'Cidr': 'string',
            'Description': 'string'
        },
    ],
    RemoveEntries=[
        {
            'Cidr': 'string'
        },
    ],
    MaxEntries=123,
    IpamPrefixListResolverSyncEnabled=True|False
)

Parameters:

• DryRun (boolean) – Checks 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.

• PrefixListId (string) –

  [REQUIRED]

  The ID of the prefix list.

• CurrentVersion (integer) – The current version of the prefix list.

• PrefixListName (string) – A name for the prefix list.

• AddEntries (list) –

  One or more entries to add to the prefix list.

  • (dict) –

    An entry for a prefix list.

    • Cidr (string) – [REQUIRED]

      The CIDR block.

    • Description (string) –

      A description for the entry.

      Constraints: Up to 255 characters in length.

• RemoveEntries (list) –

  One or more entries to remove from the prefix list.

  • (dict) –

    An entry for a prefix list.

    • Cidr (string) – [REQUIRED]

      The CIDR block.

• MaxEntries (integer) –

  The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.

  If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.

• IpamPrefixListResolverSyncEnabled (boolean) – Indicates whether synchronization with an IPAM prefix list resolver should be enabled for this managed prefix list. When enabled, the prefix list CIDRs are automatically updated based on the associated resolver’s CIDR selection rules.

Return type:

dict

Returns:

Response Syntax

{
    'PrefixList': {
        'PrefixListId': 'string',
        'AddressFamily': 'string',
        'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'restore-in-progress'|'restore-complete'|'restore-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
        'StateMessage': 'string',
        'PrefixListArn': 'string',
        'PrefixListName': 'string',
        'MaxEntries': 123,
        'Version': 123,
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OwnerId': 'string',
        'IpamPrefixListResolverTargetId': 'string',
        'IpamPrefixListResolverSyncEnabled': True|False
    }
}

Response Structure

• (dict) –

  • PrefixList (dict) –

    Information about the prefix list.

    • PrefixListId (string) –

      The ID of the prefix list.

    • AddressFamily (string) –

      The IP address version.

    • State (string) –

      The current state of the prefix list.

    • StateMessage (string) –

      The state message.

    • PrefixListArn (string) –

      The Amazon Resource Name (ARN) for the prefix list.

    • PrefixListName (string) –

      The name of the prefix list.

    • MaxEntries (integer) –

      The maximum number of entries for the prefix list.

    • Version (integer) –

      The version of the prefix list.

    • Tags (list) –

      The tags for the prefix list.

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

    • OwnerId (string) –

      The ID of the owner of the prefix list.

    • IpamPrefixListResolverTargetId (string) –

      The ID of the IPAM prefix list resolver target associated with this managed prefix list. When set, this prefix list becomes an IPAM managed prefix list.

      An IPAM-managed prefix list is a customer-managed prefix list that has been associated with an IPAM prefix list resolver target. When a prefix list becomes IPAM managed, its CIDRs are automatically synchronized based on the IPAM prefix list resolver’s CIDR selection rules, and direct CIDR modifications are restricted.

    • IpamPrefixListResolverSyncEnabled (boolean) –

      Indicates whether synchronization with an IPAM prefix list resolver is enabled for this managed prefix list. When enabled, the prefix list CIDRs are automatically updated based on the resolver’s CIDR selection rules.