Skip to content

disable_user async 

disable_user(
    user_id: UserId,
    *,
    config_overrides: Optional[AsyncfinspacedataClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> DisableUserResponse

Denies access to the FinSpace web application and API for the specified user.

Parameters:

  • user_id (UserId) –

    The unique identifier for the user that you want to deactivate.

  • client_token (Optional[ClientToken], default: None ) –

    A token that ensures idempotency. This token expires in 10 minutes.

Raises:

Source code in docs_src/capo_finspace_data/_services/async_finspacedata.py 
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
async def disable_user(
    self,
    user_id: "capo_finspace_data.types.user_id.UserId",
    *,
    config_overrides: Optional[AsyncfinspacedataClientConfig] = None,
    client_token: Optional[
        "capo_finspace_data.types.client_token.ClientToken"
    ] = None,
) -> "capo_finspace_data.types.disable_user_response.DisableUserResponse":
    """<p>Denies access to the FinSpace web application and API for the specified user.</p>

    Args:
        user_id: <p>The unique identifier for the user that you want to deactivate.</p>
        client_token: <p>A token that ensures idempotency. This token expires in 10 minutes.</p>

    Raises:
        capo_finspace_data.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace_data.errors.conflict_exception.ConflictException: <p>The request conflicts with an existing resource.</p>
        capo_finspace_data.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace_data.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace_data.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace_data.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_finspace_data.types.disable_user_request.DisableUserRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace_data.types.disable_user_response.DisableUserResponse"
    ]:
        import capo_finspace_data._operations.aws_habanero_public_api.disable_user

        (
            output,
            http_response,
        ) = await capo_finspace_data._operations.aws_habanero_public_api.disable_user.async_disable_user(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisableUser")
    )
    input_: capo_finspace_data.types.disable_user_request.DisableUserRequest = {
        "user_id": user_id
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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