Skip to content

list_configuration_sets async

list_configuration_sets(
    *,
    config_overrides: Optional[AsyncPinpointEmailClientConfig] = None,
    next_token: Optional[NextToken] = None,
    page_size: Optional[MaxItems] = None,
) -> ListConfigurationSetsResponse

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

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:

  • 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_pinpoint_email/_services/async_pinpoint_email.py
async def list_configuration_sets(
    self,
    *,
    config_overrides: Optional[AsyncPinpointEmailClientConfig] = None,
    next_token: Optional["capo_pinpoint_email.types.next_token.NextToken"] = None,
    page_size: Optional["capo_pinpoint_email.types.max_items.MaxItems"] = None,
) -> "capo_pinpoint_email.types.list_configuration_sets_response.ListConfigurationSetsResponse":
    """<p>List all of the configuration sets associated with your Amazon Pinpoint account in the current region.</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:
        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_pinpoint_email.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</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.list_configuration_sets_request.ListConfigurationSetsRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint_email.types.list_configuration_sets_response.ListConfigurationSetsResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.list_configuration_sets

        (
            output,
            http_response,
        ) = await capo_pinpoint_email._operations.amazon_pinpoint_email_service.list_configuration_sets.async_list_configuration_sets(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListConfigurationSets")
    )
    input_: capo_pinpoint_email.types.list_configuration_sets_request.ListConfigurationSetsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if page_size is not None:
        input_["page_size"] = page_size

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output