release_sender_id `async` ¶

release_sender_id(
    sender_id: SenderIdOrArn,
    iso_country_code: IsoCountryCode,
    *,
    config_overrides: Optional[AsyncPinpointSMSVoiceV2ClientConfig] = None,
) -> ReleaseSenderIdResult

Releases an existing sender ID in your account.

Parameters:

sender_id (SenderIdOrArn) –

The sender ID to release.
iso_country_code (IsoCountryCode) –

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

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/async_pinpoint_sms_voice_v2.py

async def release_sender_id(
    self,
    sender_id: "capo_pinpoint_sms_voice_v2.types.sender_id_or_arn.SenderIdOrArn",
    iso_country_code: "capo_pinpoint_sms_voice_v2.types.iso_country_code.IsoCountryCode",
    *,
    config_overrides: Optional[AsyncPinpointSMSVoiceV2ClientConfig] = None,
) -> "capo_pinpoint_sms_voice_v2.types.release_sender_id_result.ReleaseSenderIdResult":
    """<p>Releases an existing sender ID in your account.</p>

    Args:
        sender_id: <p>The sender ID to release.</p>
        iso_country_code: <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pinpoint_sms_voice_v2.types.release_sender_id_request.ReleaseSenderIdRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint_sms_voice_v2.types.release_sender_id_result.ReleaseSenderIdResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.release_sender_id

        (
            output,
            http_response,
        ) = await capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.release_sender_id.async_release_sender_id(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ReleaseSenderId")
    )
    input_: capo_pinpoint_sms_voice_v2.types.release_sender_id_request.ReleaseSenderIdRequest = {
        "sender_id": sender_id,
        "iso_country_code": iso_country_code,
    }

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

release_sender_id async ¶

release_sender_id `async` ¶