Skip to content

update_app_instance_user

update_app_instance_user(
    app_instance_user_arn: ChimeArn,
    name: UserName,
    metadata: Metadata,
    *,
    config_overrides: Optional[ChimeSDKIdentityClientConfig] = None,
) -> UpdateAppInstanceUserResponse

Updates the details of an AppInstanceUser. You can update names and metadata.

Parameters:

  • app_instance_user_arn (ChimeArn) –

    The ARN of the AppInstanceUser.

  • name (UserName) –

    The name of the AppInstanceUser.

  • metadata (Metadata) –

    The metadata of the AppInstanceUser.

Raises:

Source code in docs_src/capo_chime_sdk_identity/_services/chime_sdk_identity.py
def update_app_instance_user(
    self,
    app_instance_user_arn: "capo_chime_sdk_identity.types.chime_arn.ChimeArn",
    name: "capo_chime_sdk_identity.types.user_name.UserName",
    metadata: "capo_chime_sdk_identity.types.metadata.Metadata",
    *,
    config_overrides: Optional[ChimeSDKIdentityClientConfig] = None,
) -> "capo_chime_sdk_identity.types.update_app_instance_user_response.UpdateAppInstanceUserResponse":
    """<p>Updates the details of an <code>AppInstanceUser</code>. You can update names and metadata.</p>

    Args:
        app_instance_user_arn: <p>The ARN of the <code>AppInstanceUser</code>.</p>
        name: <p>The name of the <code>AppInstanceUser</code>.</p>
        metadata: <p>The metadata of the <code>AppInstanceUser</code>.</p>

    Raises:
        capo_chime_sdk_identity.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_identity.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource.</p>
        capo_chime_sdk_identity.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_identity.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>The request exceeds the resource limit.</p>
        capo_chime_sdk_identity.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_identity.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_identity.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_identity.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_identity.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_identity.types.update_app_instance_user_request.UpdateAppInstanceUserRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_identity.types.update_app_instance_user_response.UpdateAppInstanceUserResponse"
    ]:
        import capo_chime_sdk_identity._operations.chime_identity_service.update_app_instance_user

        output, http_response = (
            capo_chime_sdk_identity._operations.chime_identity_service.update_app_instance_user.update_app_instance_user(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime_sdk_identity.types.update_app_instance_user_request.UpdateAppInstanceUserRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_identity.types.update_app_instance_user_request

        return capo_chime_sdk_identity.types.update_app_instance_user_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateAppInstanceUser", redact_input=_redact_input),
    )
    input_: capo_chime_sdk_identity.types.update_app_instance_user_request.UpdateAppInstanceUserRequest = {
        "app_instance_user_arn": app_instance_user_arn,
        "name": name,
        "metadata": metadata,
    }

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