Skip to content

associate_phone_number_with_user async 

associate_phone_number_with_user(
    account_id: String,
    user_id: String,
    e164_phone_number: E164PhoneNumber,
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
) -> AssociatePhoneNumberWithUserResponse

Associates a phone number with the specified Amazon Chime user.

Parameters:

  • account_id (String) –

    The Amazon Chime account ID.

  • user_id (String) –

    The user ID.

  • e164_phone_number (E164PhoneNumber) –

    The phone number, in E.164 format.

Raises:

Source code in docs_src/capo_chime/_services/async_chime.py 
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
async def associate_phone_number_with_user(
    self,
    account_id: "capo_chime.types.string.String",
    user_id: "capo_chime.types.string.String",
    e164_phone_number: "capo_chime.types.e164_phone_number.E164PhoneNumber",
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
) -> "capo_chime.types.associate_phone_number_with_user_response.AssociatePhoneNumberWithUserResponse":
    """<p>Associates a phone number with the specified Amazon Chime user.</p>

    Args:
        account_id: <p>The Amazon Chime account ID.</p>
        user_id: <p>The user ID.</p>
        e164_phone_number: <p>The phone number, in E.164 format.</p>

    Raises:
        capo_chime.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to perform the requested operation.</p>
        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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime.types.associate_phone_number_with_user_request.AssociatePhoneNumberWithUserRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime.types.associate_phone_number_with_user_response.AssociatePhoneNumberWithUserResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.associate_phone_number_with_user

        (
            output,
            http_response,
        ) = await capo_chime._operations.uc_buzz_console_service.associate_phone_number_with_user.async_associate_phone_number_with_user(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime.types.associate_phone_number_with_user_request.AssociatePhoneNumberWithUserRequest",
    ) -> dict[str, Any]:
        import capo_chime.types.associate_phone_number_with_user_request

        return capo_chime.types.associate_phone_number_with_user_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "AssociatePhoneNumberWithUser", redact_input=_redact_input
        ),
    )
    input_: capo_chime.types.associate_phone_number_with_user_request.AssociatePhoneNumberWithUserRequest = {
        "account_id": account_id,
        "user_id": user_id,
        "e164_phone_number": e164_phone_number,
    }

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