Skip to content

update_user

update_user(
    account_id: NonEmptyString,
    user_id: NonEmptyString,
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
    license_type: Optional[License] = None,
    user_type: Optional[UserType] = None,
    alexa_for_business_metadata: Optional[AlexaForBusinessMetadata] = None,
) -> UpdateUserResponse

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

Parameters:

  • account_id (NonEmptyString) –

    The Amazon Chime account ID.

  • user_id (NonEmptyString) –

    The user ID.

  • license_type (Optional[License], default: None ) –

    The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

  • user_type (Optional[UserType], default: None ) –

    The user type.

  • alexa_for_business_metadata (Optional[AlexaForBusinessMetadata], default: None ) –

    The Alexa for Business metadata.

Raises:

Source code in docs_src/capo_chime/_services/chime.py
def update_user(
    self,
    account_id: "capo_chime.types.non_empty_string.NonEmptyString",
    user_id: "capo_chime.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
    license_type: Optional["capo_chime.types.license.License"] = None,
    user_type: Optional["capo_chime.types.user_type.UserType"] = None,
    alexa_for_business_metadata: Optional[
        "capo_chime.types.alexa_for_business_metadata.AlexaForBusinessMetadata"
    ] = None,
) -> "capo_chime.types.update_user_response.UpdateUserResponse":
    """<p>Updates user details for a specified user ID. Currently, only <code>LicenseType</code> updates are supported for this action.</p>

    Args:
        account_id: <p>The Amazon Chime account ID.</p>
        user_id: <p>The user ID.</p>
        license_type: <p>The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.</p>
        user_type: <p>The user type.</p>
        alexa_for_business_metadata: <p>The Alexa for Business metadata.</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.update_user_request.UpdateUserRequest]",
    ) -> OperationResponse[
        "capo_chime.types.update_user_response.UpdateUserResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.update_user

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

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

        return capo_chime.types.update_user_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_chime.types.update_user_response.UpdateUserResponse",
    ) -> dict[str, Any]:
        import capo_chime.types.update_user_response

        return capo_chime.types.update_user_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateUser", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_chime.types.update_user_request.UpdateUserRequest = {
        "account_id": account_id,
        "user_id": user_id,
    }
    if license_type is not None:
        input_["license_type"] = license_type
    if user_type is not None:
        input_["user_type"] = user_type
    if alexa_for_business_metadata is not None:
        input_["alexa_for_business_metadata"] = alexa_for_business_metadata

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