EC2 / Client / create_managed_prefix_list

create_managed_prefix_list#

EC2.Client.create_managed_prefix_list(**kwargs)#

Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.

Request Syntax

response = client.create_managed_prefix_list(
    DryRun=True|False,
    PrefixListName='string',
    Entries=[
        {
            'Cidr': 'string',
            'Description': 'string'
        },
    ],
    MaxEntries=123,
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    AddressFamily='string',
    ClientToken='string'
)

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.
PrefixListName (string) –
[REQUIRED]

A name for the prefix list.

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
Entries (list) –
One or more entries for 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.
MaxEntries (integer) –
[REQUIRED]

The maximum number of entries for the prefix list.
TagSpecifications (list) –
The tags to apply to the prefix list during creation.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
  - ResourceType (string) –
    
    The type of resource to tag on creation.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (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.
AddressFamily (string) –
[REQUIRED]

The IP address type.

Valid Values: IPv4 | IPv6
ClientToken (string) –
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Up to 255 UTF-8 characters in length.

This field is autopopulated if not provided.

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'
    }
}

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.