List all of the configuration sets associated with your account in the current region.
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:
-
filter
(Optional[ConfigurationSetFilter], default:
None
)
–
An object that contains filters to apply when listing configuration sets. You can filter by a substring of the configuration set name.
-
next_token
(Optional[NextToken], default:
None
)
–
A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.
-
page_size
(Optional[MaxItems], default:
None
)
–
The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
Raises:
Source code in docs_src/capo_sesv2/_services/se_sv2.py
| def list_configuration_sets(
self,
*,
config_overrides: Optional[SESv2ClientConfig] = None,
filter: Optional[
"capo_sesv2.types.configuration_set_filter.ConfigurationSetFilter"
] = None,
next_token: Optional["capo_sesv2.types.next_token.NextToken"] = None,
page_size: Optional["capo_sesv2.types.max_items.MaxItems"] = None,
) -> "capo_sesv2.types.list_configuration_sets_response.ListConfigurationSetsResponse":
"""<p>List all of the configuration sets associated with your account in the current region.</p> <p> <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:
filter: <p>An object that contains filters to apply when listing configuration sets. You can filter by a substring of the configuration set name.</p>
next_token: <p>A token returned from a previous call to <code>ListConfigurationSets</code> to indicate the position in the list of configuration sets.</p>
page_size: <p>The number of results to show in a single call to <code>ListConfigurationSets</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.</p>
Raises:
capo_sesv2.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
capo_sesv2.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
capo_sesv2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_sesv2.types.list_configuration_sets_request.ListConfigurationSetsRequest]",
) -> OperationResponse[
"capo_sesv2.types.list_configuration_sets_response.ListConfigurationSetsResponse"
]:
import capo_sesv2._operations.simple_email_service_v2.list_configuration_sets
output, http_response = (
capo_sesv2._operations.simple_email_service_v2.list_configuration_sets.list_configuration_sets(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListConfigurationSets")
)
input_: capo_sesv2.types.list_configuration_sets_request.ListConfigurationSetsRequest = {}
if filter is not None:
input_["filter"] = filter
if next_token is not None:
input_["next_token"] = next_token
if page_size is not None:
input_["page_size"] = page_size
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|