Skip to content

batch_delete_phone_number

batch_delete_phone_number(
    phone_number_ids: NonEmptyStringList,
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
) -> BatchDeletePhoneNumberResponse

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Parameters:

Raises:

Source code in docs_src/capo_chime/_services/chime.py
def batch_delete_phone_number(
    self,
    phone_number_ids: "capo_chime.types.non_empty_string_list.NonEmptyStringList",
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
) -> "capo_chime.types.batch_delete_phone_number_response.BatchDeletePhoneNumberResponse":
    """<p> Moves phone numbers into the <b>Deletion queue</b>. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. </p> <p> Phone numbers remain in the <b>Deletion queue</b> for 7 days before they are deleted permanently. </p>

    Args:
        phone_number_ids: <p>List of phone number IDs.</p>

    Raises:
        capo_chime.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime.types.batch_delete_phone_number_request.BatchDeletePhoneNumberRequest]",
    ) -> OperationResponse[
        "capo_chime.types.batch_delete_phone_number_response.BatchDeletePhoneNumberResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.batch_delete_phone_number

        output, http_response = (
            capo_chime._operations.uc_buzz_console_service.batch_delete_phone_number.batch_delete_phone_number(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchDeletePhoneNumber")
    )
    input_: capo_chime.types.batch_delete_phone_number_request.BatchDeletePhoneNumberRequest = {
        "phone_number_ids": phone_number_ids
    }

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