Skip to content

list_origination_numbers

list_origination_numbers(
    *,
    config_overrides: Optional[SNSClientConfig] = None,
    next_token: Optional[nextToken] = None,
    max_results: Optional[MaxItemsListOriginationNumbers] = None,
) -> ListOriginationNumbersResult

Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.

Parameters:

Raises:

Source code in docs_src/capo_sns/_services/sns.py
def list_origination_numbers(
    self,
    *,
    config_overrides: Optional[SNSClientConfig] = None,
    next_token: Optional["capo_sns.types.next_token.nextToken"] = None,
    max_results: Optional[
        "capo_sns.types.max_items_list_origination_numbers.MaxItemsListOriginationNumbers"
    ] = None,
) -> "capo_sns.types.list_origination_numbers_result.ListOriginationNumbersResult":
    """<p>Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see <a href="https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html">Origination numbers</a> in the <i>Amazon SNS Developer Guide</i>.</p>

    Args:
        next_token: <p>Token that the previous <code>ListOriginationNumbers</code> request returns.</p>
        max_results: <p>The maximum number of origination numbers to return.</p>

    Raises:
        capo_sns.errors.authorization_error_exception.AuthorizationErrorException: <p>Indicates that the user has been denied access to the requested resource.</p>
        capo_sns.errors.internal_error_exception.InternalErrorException: <p>Indicates an internal service error.</p>
        capo_sns.errors.invalid_parameter_exception.InvalidParameterException: <p>Indicates that a request parameter does not comply with the associated constraints.</p>
        capo_sns.errors.throttled_exception.ThrottledException: <p>Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.</p>
        capo_sns.errors.validation_exception.ValidationException: <p>Indicates that a parameter in the request is invalid.</p>
        capo_sns.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sns.types.list_origination_numbers_request.ListOriginationNumbersRequest]",
    ) -> OperationResponse[
        "capo_sns.types.list_origination_numbers_result.ListOriginationNumbersResult"
    ]:
        import capo_sns._operations.amazon_simple_notification_service.list_origination_numbers

        output, http_response = (
            capo_sns._operations.amazon_simple_notification_service.list_origination_numbers.list_origination_numbers(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_sns.types.list_origination_numbers_result.ListOriginationNumbersResult",
    ) -> dict[str, Any]:
        import capo_sns.types.list_origination_numbers_result

        return capo_sns.types.list_origination_numbers_result.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListOriginationNumbers", redact_output=_redact_output),
    )
    input_: capo_sns.types.list_origination_numbers_request.ListOriginationNumbersRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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