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.
Parameters:
-
configuration_set_name
(ConfigurationSetName)
–
The name of the configuration set that you want to associate with a dedicated IP pool.
-
tls_policy
(Optional[TlsPolicy], default:
None
)
–
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.
-
sending_pool_name
(Optional[SendingPoolName], default:
None
)
–
The name of the dedicated IP pool that you want to associate with the configuration set.
Raises:
Source code in docs_src/capo_pinpoint_email/_services/pinpoint_email.py
| def put_configuration_set_delivery_options(
self,
configuration_set_name: "capo_pinpoint_email.types.configuration_set_name.ConfigurationSetName",
*,
config_overrides: Optional[PinpointEmailClientConfig] = None,
tls_policy: Optional["capo_pinpoint_email.types.tls_policy.TlsPolicy"] = None,
sending_pool_name: Optional[
"capo_pinpoint_email.types.sending_pool_name.SendingPoolName"
] = None,
) -> "capo_pinpoint_email.types.put_configuration_set_delivery_options_response.PutConfigurationSetDeliveryOptionsResponse":
"""<p>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.</p>
Args:
configuration_set_name: <p>The name of the configuration set that you want to associate with a dedicated IP pool.</p>
tls_policy: <p>Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only delivered if a TLS connection can be established. If the value is <code>Optional</code>, messages can be delivered in plain text if a TLS connection can't be established.</p>
sending_pool_name: <p>The name of the dedicated IP pool that you want to associate with the configuration set.</p>
Raises:
capo_pinpoint_email.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
capo_pinpoint_email.errors.not_found_exception.NotFoundException: <p>The resource you attempted to access doesn't exist.</p>
capo_pinpoint_email.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
capo_pinpoint_email.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_pinpoint_email.types.put_configuration_set_delivery_options_request.PutConfigurationSetDeliveryOptionsRequest]",
) -> OperationResponse[
"capo_pinpoint_email.types.put_configuration_set_delivery_options_response.PutConfigurationSetDeliveryOptionsResponse"
]:
import capo_pinpoint_email._operations.amazon_pinpoint_email_service.put_configuration_set_delivery_options
output, http_response = (
capo_pinpoint_email._operations.amazon_pinpoint_email_service.put_configuration_set_delivery_options.put_configuration_set_delivery_options(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("PutConfigurationSetDeliveryOptions")
)
input_: capo_pinpoint_email.types.put_configuration_set_delivery_options_request.PutConfigurationSetDeliveryOptionsRequest = {
"configuration_set_name": configuration_set_name
}
if tls_policy is not None:
input_["tls_policy"] = tls_policy
if sending_pool_name is not None:
input_["sending_pool_name"] = sending_pool_name
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|