Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
Parameters:
-
configuration_set_name
(ConfigurationSetName)
–
The name of the configuration set that you want to obtain more information about.
Raises:
Source code in docs_src/capo_pinpoint_email/_services/async_pinpoint_email.py
| async def get_configuration_set(
self,
configuration_set_name: "capo_pinpoint_email.types.configuration_set_name.ConfigurationSetName",
*,
config_overrides: Optional[AsyncPinpointEmailClientConfig] = None,
) -> "capo_pinpoint_email.types.get_configuration_set_response.GetConfigurationSetResponse":
"""<p>Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.</p> <p>In Amazon Pinpoint, <i>configuration sets</i> are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.</p>
Args:
configuration_set_name: <p>The name of the configuration set that you want to obtain more information about.</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.
"""
async def _handler(
req: "AsyncOperationRequest[capo_pinpoint_email.types.get_configuration_set_request.GetConfigurationSetRequest]",
) -> AsyncOperationResponse[
"capo_pinpoint_email.types.get_configuration_set_response.GetConfigurationSetResponse"
]:
import capo_pinpoint_email._operations.amazon_pinpoint_email_service.get_configuration_set
(
output,
http_response,
) = await capo_pinpoint_email._operations.amazon_pinpoint_email_service.get_configuration_set.async_get_configuration_set(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetConfigurationSet")
)
input_: capo_pinpoint_email.types.get_configuration_set_request.GetConfigurationSetRequest = {
"configuration_set_name": configuration_set_name
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|