Skip to content

Commit

Permalink
feat(client-finspace-data): Adding deprecated trait to APIs in this n…
Browse files Browse the repository at this point in the history
…ame space.
  • Loading branch information
awstools committed Nov 15, 2023
1 parent e91d398 commit 7fb7599
Show file tree
Hide file tree
Showing 32 changed files with 155 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ export interface AssociateUserToPermissionGroupCommandOutput

/**
* @public
* @deprecated
*
* <p>Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface CreateChangesetCommandOutput extends CreateChangesetResponse, _

/**
* @public
* @deprecated
*
* <p>Creates a new Changeset in a FinSpace Dataset.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface CreateDataViewCommandOutput extends CreateDataViewResponse, __M

/**
* @public
* @deprecated
*
* <p>Creates a Dataview for a Dataset.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met

/**
* @public
* @deprecated
*
* <p>Creates a new FinSpace Dataset.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ export interface CreatePermissionGroupCommandOutput extends CreatePermissionGrou

/**
* @public
* @deprecated
*
* <p>Creates a group of permissions for various actions that a user can perform in FinSpace.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB

/**
* @public
* @deprecated
*
* <p>Creates a new user in FinSpace.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met

/**
* @public
* @deprecated
*
* <p>Deletes a FinSpace Dataset.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface DeletePermissionGroupCommandOutput extends DeletePermissionGrou

/**
* @public
* @deprecated
*
* <p>Deletes a permission group. This action is irreversible.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface DisableUserCommandOutput extends DisableUserResponse, __Metadat

/**
* @public
* @deprecated
*
* <p>Denies access to the FinSpace web application and API for the specified user.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ export interface DisassociateUserFromPermissionGroupCommandOutput

/**
* @public
* @deprecated
*
* <p>Removes a user from a permission group.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface EnableUserCommandOutput extends EnableUserResponse, __MetadataB

/**
* @public
* @deprecated
*
* <p> Allows the specified user to access the FinSpace web application and API.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface GetChangesetCommandOutput extends GetChangesetResponse, __Metad

/**
* @public
* @deprecated
*
* <p>Get information about a Changeset.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface GetDataViewCommandOutput extends GetDataViewResponse, __Metadat

/**
* @public
* @deprecated
*
* <p>Gets information about a Dataview.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface GetDatasetCommandOutput extends GetDatasetResponse, __MetadataB

/**
* @public
* @deprecated
*
* <p>Returns information about a Dataset.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export interface GetExternalDataViewAccessDetailsCommandOutput

/**
* @public
* @deprecated
*
* <p>Returns the credentials to access the external Dataview from an S3 location. To call this API:</p>
* <ul>
* <li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ export interface GetPermissionGroupCommandOutput extends GetPermissionGroupRespo

/**
* @public
* @deprecated
*
* <p>Retrieves the details of a specific permission group.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export interface GetProgrammaticAccessCredentialsCommandOutput

/**
* @public
* @deprecated
*
* <p>Request programmatic credentials to use with FinSpace SDK. For more information, see <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#accessing-credentials">Step 2. Access credentials programmatically using IAM access key id and secret access key</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
2 changes: 2 additions & 0 deletions clients/client-finspace-data/src/commands/GetUserCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer

/**
* @public
* @deprecated
*
* <p>Retrieves details for a specific user.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface GetWorkingLocationCommandOutput extends GetWorkingLocationRespo

/**
* @public
* @deprecated
*
* <p>A temporary Amazon S3 location, where you can copy your files from a source location to stage or use
* as a scratch space in FinSpace notebook.</p>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface ListChangesetsCommandOutput extends ListChangesetsResponse, __M

/**
* @public
* @deprecated
*
* <p>Lists the FinSpace Changesets for a Dataset.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface ListDataViewsCommandOutput extends ListDataViewsResponse, __Met

/**
* @public
* @deprecated
*
* <p>Lists all available Dataviews for a Dataset.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad

/**
* @public
* @deprecated
*
* <p>Lists all of the active Datasets that a user has access to.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ export interface ListPermissionGroupsByUserCommandOutput extends ListPermissionG

/**
* @public
* @deprecated
*
* <p>Lists all the permission groups that are associated with a specific user.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ export interface ListPermissionGroupsCommandOutput extends ListPermissionGroupsR

/**
* @public
* @deprecated
*
* <p>Lists all available permission groups in FinSpace.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ export interface ListUsersByPermissionGroupCommandOutput extends ListUsersByPerm

/**
* @public
* @deprecated
*
* <p>Lists details of all the users in a specific permission group.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
2 changes: 2 additions & 0 deletions clients/client-finspace-data/src/commands/ListUsersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea

/**
* @public
* @deprecated
*
* <p>Lists all available users in FinSpace.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ export interface ResetUserPasswordCommandOutput extends ResetUserPasswordRespons

/**
* @public
* @deprecated
*
* <p>Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface UpdateChangesetCommandOutput extends UpdateChangesetResponse, _

/**
* @public
* @deprecated
*
* <p>Updates a FinSpace Changeset.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface UpdateDatasetCommandOutput extends UpdateDatasetResponse, __Met

/**
* @public
* @deprecated
*
* <p>Updates a FinSpace Dataset.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ export interface UpdatePermissionGroupCommandOutput extends UpdatePermissionGrou

/**
* @public
* @deprecated
*
* <p>Modifies the details of a permission group. You cannot modify a <code>permissionGroupID</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB

/**
* @public
* @deprecated
*
* <p>Modifies the details of the specified user. You cannot update the <code>userId</code> for a user.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Loading

0 comments on commit 7fb7599

Please sign in to comment.