delete_opted_out_number ¶

delete_opted_out_number(
    opt_out_list_name: OptOutListNameOrArn,
    opted_out_number: PhoneNumber,
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
) -> DeleteOptedOutNumberResult

Deletes an existing opted out destination phone number from the specified opt-out list.

Each destination phone number can only be deleted once every 30 days.

If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.

Parameters:

opt_out_list_name (OptOutListNameOrArn) –

The OptOutListName or OptOutListArn to remove the phone number from.

If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
opted_out_number (PhoneNumber) –

The phone number, in E.164 format, to remove from the OptOutList.

Raises:

AccessDeniedException –

The request was denied because you don't have sufficient permissions to access the resource.
ConflictException –

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
InternalServerException –

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
ResourceNotFoundException –

A requested resource couldn't be found.
ThrottlingException –

An error that occurred because too many requests were sent during a certain amount of time.
ValidationException –

A validation exception for a field.
UnknownServiceError –

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

Source code in docs_src/capo_pinpoint_sms_voice_v2/_services/pinpoint_sms_voice_v2.py

def delete_opted_out_number(
    self,
    opt_out_list_name: "capo_pinpoint_sms_voice_v2.types.opt_out_list_name_or_arn.OptOutListNameOrArn",
    opted_out_number: "capo_pinpoint_sms_voice_v2.types.phone_number.PhoneNumber",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
) -> "capo_pinpoint_sms_voice_v2.types.delete_opted_out_number_result.DeleteOptedOutNumberResult":
    """<p>Deletes an existing opted out destination phone number from the specified opt-out list.</p> <p>Each destination phone number can only be deleted once every 30 days.</p> <p>If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.</p>

    Args:
        opt_out_list_name: <p>The OptOutListName or OptOutListArn to remove the phone number from.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
        opted_out_number: <p>The phone number, in E.164 format, to remove from the OptOutList.</p>

    Raises:
        capo_pinpoint_sms_voice_v2.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.conflict_exception.ConflictException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.internal_server_exception.InternalServerException: <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
        capo_pinpoint_sms_voice_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource couldn't be found.</p>
        capo_pinpoint_sms_voice_v2.errors.throttling_exception.ThrottlingException: <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_pinpoint_sms_voice_v2.errors.validation_exception.ValidationException: <p>A validation exception for a field.</p>
        capo_pinpoint_sms_voice_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_sms_voice_v2.types.delete_opted_out_number_request.DeleteOptedOutNumberRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.delete_opted_out_number_result.DeleteOptedOutNumberResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.delete_opted_out_number

        output, http_response = (
            capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.delete_opted_out_number.delete_opted_out_number(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteOptedOutNumber")
    )
    input_: capo_pinpoint_sms_voice_v2.types.delete_opted_out_number_request.DeleteOptedOutNumberRequest = {
        "opt_out_list_name": opt_out_list_name,
        "opted_out_number": opted_out_number,
    }

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