Skip to content

describe_phone_number async

describe_phone_number(
    phone_number_id: PhoneNumberId,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> DescribePhoneNumberResponse

Gets details and status of a phone number that’s claimed to your Connect Customer instance or traffic distribution group.

If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you receive a ResourceNotFoundException.

Parameters:

  • phone_number_id (PhoneNumberId) –

    A unique identifier for the phone number.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def describe_phone_number(
    self,
    phone_number_id: "capo_connect.types.phone_number_id.PhoneNumberId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> (
    "capo_connect.types.describe_phone_number_response.DescribePhoneNumberResponse"
):
    """<p>Gets details and status of a phone number that’s claimed to your Connect Customer instance or traffic distribution group.</p> <important> <p>If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the <code>PhoneNumberId</code> URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you receive a <code>ResourceNotFoundException</code>.</p> </important>

    Args:
        phone_number_id: <p>A unique identifier for the phone number.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.describe_phone_number_request.DescribePhoneNumberRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.describe_phone_number_response.DescribePhoneNumberResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.describe_phone_number

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.describe_phone_number.async_describe_phone_number(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePhoneNumber")
    )
    input_: capo_connect.types.describe_phone_number_request.DescribePhoneNumberRequest = {
        "phone_number_id": phone_number_id
    }

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