create_dedicated_ip_pool

PinpointEmail.Client.create_dedicated_ip_pool(**kwargs)

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.

See also: AWS API Documentation

Request Syntax

response = client.create_dedicated_ip_pool(
    PoolName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

• PoolName (string) --

  [REQUIRED]

  The name of the dedicated IP pool.

• Tags (list) --

  An object that defines the tags (keys and values) that you want to associate with the pool.

  • (dict) --

    An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

    Each tag consists of a required tag key and an associated tag value , both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

    • Tag keys and values are case sensitive.
    • For each associated resource, each tag key must be unique and it can have only one value.
    • The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
    • You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.
    • Key (string) -- [REQUIRED]

      One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

    • Value (string) -- [REQUIRED]

      The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

  An HTTP 200 response if the request succeeds, or an error message if the request fails.

Exceptions

• PinpointEmail.Client.exceptions.AlreadyExistsException
• PinpointEmail.Client.exceptions.LimitExceededException
• PinpointEmail.Client.exceptions.TooManyRequestsException
• PinpointEmail.Client.exceptions.BadRequestException
• PinpointEmail.Client.exceptions.ConcurrentModificationException