Skip to content

list_notify_code_configurations

list_notify_code_configurations(
    *,
    config_overrides: Optional[EndUserMessagingClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListNotifyCodeConfigurationsOutput

Retrieves a paginated list of the notify code configurations in your account.

Parameters:

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return per page.

  • next_token (Optional[NextToken], default: None ) –

    The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

  • InternalServerException –

    An unexpected error occurred during the processing of the request.

  • ThrottlingException –

    The request was denied because it exceeded the allowed request rate.

  • ValidationException –

    A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Examples:

List notify code configurations

>>> client.list_notify_code_configurations(max_results=10)
Source code in docs_src/capo_endusermessaging/_services/end_user_messaging.py
def list_notify_code_configurations(
    self,
    *,
    config_overrides: Optional[EndUserMessagingClientConfig] = None,
    max_results: Optional[
        "capo_endusermessaging.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_endusermessaging.types.next_token.NextToken"] = None,
) -> "capo_endusermessaging.types.list_notify_code_configurations_output.ListNotifyCodeConfigurationsOutput":
    """<p>Retrieves a paginated list of the notify code configurations in your account.</p>

    Args:
        max_results: <p>The maximum number of results to return per page.</p>
        next_token: <p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>

    Raises:
        capo_endusermessaging.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_endusermessaging.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
        capo_endusermessaging.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed request rate.</p>
        capo_endusermessaging.errors.validation_exception.ValidationException: A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
        capo_endusermessaging.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List notify code configurations

        >>> client.list_notify_code_configurations(max_results=10)
    """

    def _handler(
        req: "OperationRequest[capo_endusermessaging.types.list_notify_code_configurations_input.ListNotifyCodeConfigurationsInput]",
    ) -> OperationResponse[
        "capo_endusermessaging.types.list_notify_code_configurations_output.ListNotifyCodeConfigurationsOutput"
    ]:
        import capo_endusermessaging._operations.end_user_messaging.list_notify_code_configurations

        output, http_response = (
            capo_endusermessaging._operations.end_user_messaging.list_notify_code_configurations.list_notify_code_configurations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_endusermessaging.types.list_notify_code_configurations_output.ListNotifyCodeConfigurationsOutput",
    ) -> dict[str, Any]:
        import capo_endusermessaging.types.list_notify_code_configurations_output

        return capo_endusermessaging.types.list_notify_code_configurations_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListNotifyCodeConfigurations", redact_output=_redact_output
        ),
    )
    input_: capo_endusermessaging.types.list_notify_code_configurations_input.ListNotifyCodeConfigurationsInput = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output