PinpointEmail / Client / put_configuration_set_delivery_options

put_configuration_set_delivery_options#

PinpointEmail.Client.put_configuration_set_delivery_options(**kwargs)#

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

See also: AWS API Documentation

Request Syntax

response = client.put_configuration_set_delivery_options(
    ConfigurationSetName='string',
    TlsPolicy='REQUIRE'|'OPTIONAL',
    SendingPoolName='string'
)
Parameters:

  • ConfigurationSetName (string) –

    [REQUIRED]

    The name of the configuration set that you want to associate with a dedicated IP pool.

  • TlsPolicy (string) – Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can’t be established.

  • SendingPoolName (string) – The name of the dedicated IP pool that you want to associate with the configuration set.

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

  • PinpointEmail.Client.exceptions.TooManyRequestsException

  • PinpointEmail.Client.exceptions.BadRequestException