delete_user `async` ¶

delete_user(
    identity_store_id: IdentityStoreId,
    user_id: ResourceId,
    *,
    config_overrides: Optional[AsyncidentitystoreClientConfig] = None,
    revision: Optional[ResourceRevision] = None,
) -> DeleteUserResponse

Deletes a user within an identity store given UserId.

Parameters:

identity_store_id (IdentityStoreId) –

The globally unique identifier for the identity store.

You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
user_id (ResourceId) –

The identifier for a user in the identity store.

You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
revision (Optional[ResourceRevision], default: None ) –

The expected current revision of the user. When you provide this value, the user is deleted only if it matches the current revision of the user in the identity store. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the user is deleted regardless of its current revision.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

The request processing has failed because of an unknown error, exception or failure with an internal server.
ThrottlingException –

Indicates that the principal has crossed the throttling limits of the API operations.
ConflictException –
This request cannot be completed for one of the following reasons:
- Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
- The requested resource was being concurrently modified by another request.
ResourceNotFoundException –

Indicates that a requested resource is not found.
ValidationException –

The request failed because it contains a syntax error.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_identitystore/_services/async_identitystore.py

async def delete_user(
    self,
    identity_store_id: "capo_identitystore.types.identity_store_id.IdentityStoreId",
    user_id: "capo_identitystore.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[AsyncidentitystoreClientConfig] = None,
    revision: Optional[
        "capo_identitystore.types.resource_revision.ResourceRevision"
    ] = None,
) -> "capo_identitystore.types.delete_user_response.DeleteUserResponse":
    """<p>Deletes a user within an identity store given <code>UserId</code>.</p>

    Args:
        identity_store_id: <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
        user_id: <p>The identifier for a user in the identity store.</p> <p>You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code> or user ARN <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
        revision: <p>The expected current revision of the user. When you provide this value, the user is deleted only if it matches the current revision of the user in the identity store. If the value doesn't match, the operation fails with a <code>ConflictException</code>. If you don't provide this value, the user is deleted regardless of its current revision.</p>

    Raises:
        capo_identitystore.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_identitystore.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
        capo_identitystore.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_identitystore.errors.conflict_exception.ConflictException: <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
        capo_identitystore.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_identitystore.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_identitystore.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_identitystore.types.delete_user_request.DeleteUserRequest]",
    ) -> AsyncOperationResponse[
        "capo_identitystore.types.delete_user_response.DeleteUserResponse"
    ]:
        import capo_identitystore._operations.aws_identity_store.delete_user

        (
            output,
            http_response,
        ) = await capo_identitystore._operations.aws_identity_store.delete_user.async_delete_user(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteUser")
    )
    input_: capo_identitystore.types.delete_user_request.DeleteUserRequest = {
        "identity_store_id": identity_store_id,
        "user_id": user_id,
    }
    if revision is not None:
        input_["revision"] = revision

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

delete_user async ¶

delete_user `async` ¶