@aws-sdk/client-finspace-data 3.296.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { FinspaceDataServiceException as __BaseException } from "./FinspaceDataServiceException";
 /**
+ * @public
  * <p>You do not have sufficient access to perform this action.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -11,10 +12,16 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum ApiAccess {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
+/**
+ * @public
+ */
 export declare enum ApplicationPermission {
     AccessNotebooks = "AccessNotebooks",
     CreateDataset = "CreateDataset",
@@ -24,6 +31,9 @@ export declare enum ApplicationPermission {
     ManageUsersAndGroups = "ManageUsersAndGroups",
     ViewAuditData = "ViewAuditData"
 }
+/**
+ * @public
+ */
 export interface AssociateUserToPermissionGroupRequest {
     /**
      * <p>The unique identifier for the permission group.</p>
@@ -38,6 +48,9 @@ export interface AssociateUserToPermissionGroupRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface AssociateUserToPermissionGroupResponse {
     /**
      * <p>The returned status code of the response.</p>
@@ -45,6 +58,7 @@ export interface AssociateUserToPermissionGroupResponse {
     statusCode?: number;
 }
 /**
+ * @public
  * <p>The request conflicts with an existing resource.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -57,6 +71,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request processing has failed because of an unknown error, exception or
  *       failure.</p>
  */
@@ -69,6 +84,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>One or more resources can't be found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -81,6 +97,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was denied due to request throttling.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -92,6 +109,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -104,6 +122,7 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
+ * @public
  * <p> The credentials required to access the external Dataview from the S3 location.</p>
  */
 export interface AwsCredentials {
@@ -124,12 +143,16 @@ export interface AwsCredentials {
      */
     expiration?: number;
 }
+/**
+ * @public
+ */
 export declare enum ChangeType {
     APPEND = "APPEND",
     MODIFY = "MODIFY",
     REPLACE = "REPLACE"
 }
 /**
+ * @public
  * The request for a CreateChangeset operation.
  */
 export interface CreateChangesetRequest {
@@ -169,10 +192,10 @@ export interface CreateChangesetRequest {
      *          <p>
      *             <code>
      *         "sourceParams":
-     *         {
+     *         \{
      *         "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
      *         "sourceType": "S3"
-     *         }
+     *         \}
      *       </code>
      *          </p>
      *          <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets">Loading data from an Amazon S3 Bucket using the FinSpace API</a> section.</p>
@@ -207,21 +230,21 @@ export interface CreateChangesetRequest {
      *          <p>
      *             <code>
      *           "formatParams":
-     *         {
+     *         \{
      *          "formatType": "CSV",
      *          "withHeader": "true",
      *          "separator": ",",
      *          "compression":"None"
-     *          }
+     *          \}
      *       </code>
      *          </p>
      *          <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p>
      *          <p>
      *             <code>
-     *           {
+     *           \{
      *           "withHeader": "true",
      *           "separator": ","
-     *            }
+     *            \}
      *         </code>
      *          </p>
      *          <p> For more information about supported file formats, see <a href="https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>
@@ -229,6 +252,7 @@ export interface CreateChangesetRequest {
     formatParams: Record<string, string> | undefined;
 }
 /**
+ * @public
  * The response from a CreateChangeset operation.
  */
 export interface CreateChangesetResponse {
@@ -242,6 +266,7 @@ export interface CreateChangesetResponse {
     changesetId?: string;
 }
 /**
+ * @public
  * <p>A limit has exceeded.</p>
  */
 export declare class LimitExceededException extends __BaseException {
@@ -252,11 +277,15 @@ export declare class LimitExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum DatasetKind {
     NON_TABULAR = "NON_TABULAR",
     TABULAR = "TABULAR"
 }
 /**
+ * @public
  * <p>A structure for Dataset owner info.</p>
  */
 export interface DatasetOwnerInfo {
@@ -274,6 +303,7 @@ export interface DatasetOwnerInfo {
     email?: string;
 }
 /**
+ * @public
  * <p>Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.</p>
  *          <p>The following is a list of valid dataset permissions that you can apply:
  *
@@ -319,19 +349,20 @@ export interface ResourcePermission {
     permission?: string;
 }
 /**
+ * @public
  * <p>Permission group parameters for Dataset permissions.</p>
  *          <p>Here is an example of how you could specify the <code>PermissionGroupParams</code>:</p>
  *          <p>
  *             <code>
- *         {
+ *         \{
  *         "permissionGroupId": "0r6fCRtSTUk4XPfXQe3M0g",
  *         "datasetPermissions": [
- *         {"permission": "ViewDatasetDetails"},
- *         {"permission": "AddDatasetData"},
- *         {"permission": "EditDatasetMetadata"},
- *         {"permission": "DeleteDataset"}
+ *         \{"permission": "ViewDatasetDetails"\},
+ *         \{"permission": "AddDatasetData"\},
+ *         \{"permission": "EditDatasetMetadata"\},
+ *         \{"permission": "DeleteDataset"\}
  *         ]
- *         }
+ *         \}
  *       </code>
  *          </p>
  */
@@ -345,6 +376,9 @@ export interface PermissionGroupParams {
      */
     datasetPermissions?: ResourcePermission[];
 }
+/**
+ * @public
+ */
 export declare enum ColumnDataType {
     BIGINT = "BIGINT",
     BINARY = "BINARY",
@@ -360,6 +394,7 @@ export declare enum ColumnDataType {
     TINYINT = "TINYINT"
 }
 /**
+ * @public
  * <p>The definition of a column in a tabular Dataset.</p>
  */
 export interface ColumnDefinition {
@@ -405,6 +440,7 @@ export interface ColumnDefinition {
     columnDescription?: string;
 }
 /**
+ * @public
  * <p>Definition for a schema on a tabular Dataset.</p>
  */
 export interface SchemaDefinition {
@@ -418,6 +454,7 @@ export interface SchemaDefinition {
     primaryKeyColumns?: string[];
 }
 /**
+ * @public
  * <p>A union of schema types.</p>
  */
 export interface SchemaUnion {
@@ -427,6 +464,7 @@ export interface SchemaUnion {
     tabularSchemaConfig?: SchemaDefinition;
 }
 /**
+ * @public
  * The request for a CreateDataset operation
  */
 export interface CreateDatasetRequest {
@@ -474,6 +512,7 @@ export interface CreateDatasetRequest {
     schemaDefinition?: SchemaUnion;
 }
 /**
+ * @public
  * The response from a CreateDataset operation
  */
 export interface CreateDatasetResponse {
@@ -482,11 +521,15 @@ export interface CreateDatasetResponse {
      */
     datasetId?: string;
 }
+/**
+ * @public
+ */
 export declare enum ExportFileFormat {
     DELIMITED_TEXT = "DELIMITED_TEXT",
     PARQUET = "PARQUET"
 }
 /**
+ * @public
  * <p>Structure for the Dataview destination type parameters.</p>
  */
 export interface DataViewDestinationTypeParams {
@@ -524,16 +567,17 @@ export interface DataViewDestinationTypeParams {
      *          </p>
      *          <p>
      *             <code>
-     *         {
+     *         \{
      *         "header": "true",
      *         "delimiter": ",",
      *         "compression": "gzip"
-     *         }</code>
+     *         \}</code>
      *          </p>
      */
     s3DestinationExportFileFormatOptions?: Record<string, string>;
 }
 /**
+ * @public
  * Request for creating a data view.
  */
 export interface CreateDataViewRequest {
@@ -567,6 +611,7 @@ export interface CreateDataViewRequest {
     destinationTypeParams: DataViewDestinationTypeParams | undefined;
 }
 /**
+ * @public
  * Response for creating a data view.
  */
 export interface CreateDataViewResponse {
@@ -579,6 +624,9 @@ export interface CreateDataViewResponse {
      */
     dataViewId?: string;
 }
+/**
+ * @public
+ */
 export interface CreatePermissionGroupRequest {
     /**
      * <p>The name of the permission group.</p>
@@ -630,16 +678,25 @@ export interface CreatePermissionGroupRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreatePermissionGroupResponse {
     /**
      * <p>The unique identifier for the permission group.</p>
      */
     permissionGroupId?: string;
 }
+/**
+ * @public
+ */
 export declare enum UserType {
     APP_USER = "APP_USER",
     SUPER_USER = "SUPER_USER"
 }
+/**
+ * @public
+ */
 export interface CreateUserRequest {
     /**
      * <p>The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.</p>
@@ -690,6 +747,9 @@ export interface CreateUserRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreateUserResponse {
     /**
      * <p>The unique identifier for the user.</p>
@@ -697,6 +757,7 @@ export interface CreateUserResponse {
     userId?: string;
 }
 /**
+ * @public
  * The request for a DeleteDataset operation.
  */
 export interface DeleteDatasetRequest {
@@ -710,6 +771,7 @@ export interface DeleteDatasetRequest {
     datasetId: string | undefined;
 }
 /**
+ * @public
  * The response from an DeleteDataset operation
  */
 export interface DeleteDatasetResponse {
@@ -718,6 +780,9 @@ export interface DeleteDatasetResponse {
      */
     datasetId?: string;
 }
+/**
+ * @public
+ */
 export interface DeletePermissionGroupRequest {
     /**
      * <p>The unique identifier for the permission group that you want to delete.</p>
@@ -728,12 +793,18 @@ export interface DeletePermissionGroupRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface DeletePermissionGroupResponse {
     /**
      * <p>The unique identifier for the deleted permission group.</p>
      */
     permissionGroupId?: string;
 }
+/**
+ * @public
+ */
 export interface DisableUserRequest {
     /**
      * <p>The unique identifier for the user account that you want to disable.</p>
@@ -744,12 +815,18 @@ export interface DisableUserRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface DisableUserResponse {
     /**
      * <p>The unique identifier for the disabled user account.</p>
      */
     userId?: string;
 }
+/**
+ * @public
+ */
 export interface DisassociateUserFromPermissionGroupRequest {
     /**
      * <p>The unique identifier for the permission group.</p>
@@ -764,12 +841,18 @@ export interface DisassociateUserFromPermissionGroupRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface DisassociateUserFromPermissionGroupResponse {
     /**
      * <p>The returned status code of the response.</p>
      */
     statusCode?: number;
 }
+/**
+ * @public
+ */
 export interface EnableUserRequest {
     /**
      * <p>The unique identifier for the user account that you want to enable.</p>
@@ -780,6 +863,9 @@ export interface EnableUserRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface EnableUserResponse {
     /**
      * <p>The unique identifier for the enabled user account.</p>
@@ -787,6 +873,7 @@ export interface EnableUserResponse {
     userId?: string;
 }
 /**
+ * @public
  * Request to describe a changeset.
  */
 export interface GetChangesetRequest {
@@ -799,6 +886,9 @@ export interface GetChangesetRequest {
      */
     changesetId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ErrorCategory {
     ACCESS_DENIED = "ACCESS_DENIED",
     CANCELLED = "CANCELLED",
@@ -810,6 +900,7 @@ export declare enum ErrorCategory {
     VALIDATION = "VALIDATION"
 }
 /**
+ * @public
  * <p>The structure with error messages.</p>
  */
 export interface ChangesetErrorInfo {
@@ -861,6 +952,9 @@ export interface ChangesetErrorInfo {
      */
     errorCategory?: ErrorCategory | string;
 }
+/**
+ * @public
+ */
 export declare enum IngestionStatus {
     FAILED = "FAILED",
     PENDING = "PENDING",
@@ -869,6 +963,7 @@ export declare enum IngestionStatus {
     SUCCESS = "SUCCESS"
 }
 /**
+ * @public
  * The response from a describe changeset operation
  */
 export interface GetChangesetResponse {
@@ -940,6 +1035,7 @@ export interface GetChangesetResponse {
     updatedByChangesetId?: string;
 }
 /**
+ * @public
  * Request for the GetDataset operation.
  */
 export interface GetDatasetRequest {
@@ -948,6 +1044,9 @@ export interface GetDatasetRequest {
      */
     datasetId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum DatasetStatus {
     FAILED = "FAILED",
     PENDING = "PENDING",
@@ -955,6 +1054,7 @@ export declare enum DatasetStatus {
     SUCCESS = "SUCCESS"
 }
 /**
+ * @public
  * Response for the GetDataset operation
  */
 export interface GetDatasetResponse {
@@ -1028,6 +1128,7 @@ export interface GetDatasetResponse {
     status?: DatasetStatus | string;
 }
 /**
+ * @public
  * Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.
  */
 export interface GetDataViewRequest {
@@ -1041,6 +1142,7 @@ export interface GetDataViewRequest {
     datasetId: string | undefined;
 }
 /**
+ * @public
  * <p>The structure with error messages.</p>
  */
 export interface DataViewErrorInfo {
@@ -1092,6 +1194,9 @@ export interface DataViewErrorInfo {
      */
     errorCategory?: ErrorCategory | string;
 }
+/**
+ * @public
+ */
 export declare enum DataViewStatus {
     CANCELLED = "CANCELLED",
     FAILED = "FAILED",
@@ -1103,6 +1208,7 @@ export declare enum DataViewStatus {
     TIMEOUT = "TIMEOUT"
 }
 /**
+ * @public
  * Response from retrieving a dataview, which includes details on the target database and table name
  */
 export interface GetDataViewResponse {
@@ -1189,6 +1295,9 @@ export interface GetDataViewResponse {
      */
     status?: DataViewStatus | string;
 }
+/**
+ * @public
+ */
 export interface GetExternalDataViewAccessDetailsRequest {
     /**
      * <p>The unique identifier for the Dataview that you want to access.</p>
@@ -1200,6 +1309,7 @@ export interface GetExternalDataViewAccessDetailsRequest {
     datasetId: string | undefined;
 }
 /**
+ * @public
  * <p>The location of an external Dataview in an S3 bucket.</p>
  */
 export interface S3Location {
@@ -1212,6 +1322,9 @@ export interface S3Location {
      */
     key: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetExternalDataViewAccessDetailsResponse {
     /**
      * <p>The credentials required to access the external Dataview from the S3 location.</p>
@@ -1222,18 +1335,25 @@ export interface GetExternalDataViewAccessDetailsResponse {
      */
     s3Location?: S3Location;
 }
+/**
+ * @public
+ */
 export interface GetPermissionGroupRequest {
     /**
      * <p>The unique identifier for the permission group.</p>
      */
     permissionGroupId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum PermissionGroupMembershipStatus {
     ADDITION_IN_PROGRESS = "ADDITION_IN_PROGRESS",
     ADDITION_SUCCESS = "ADDITION_SUCCESS",
     REMOVAL_IN_PROGRESS = "REMOVAL_IN_PROGRESS"
 }
 /**
+ * @public
  * <p>The structure for a permission group.</p>
  */
 export interface PermissionGroup {
@@ -1315,6 +1435,9 @@ export interface PermissionGroup {
      */
     membershipStatus?: PermissionGroupMembershipStatus | string;
 }
+/**
+ * @public
+ */
 export interface GetPermissionGroupResponse {
     /**
      * <p>The structure for a permission group.</p>
@@ -1322,6 +1445,7 @@ export interface GetPermissionGroupResponse {
     permissionGroup?: PermissionGroup;
 }
 /**
+ * @public
  * Request for GetProgrammaticAccessCredentials operation
  */
 export interface GetProgrammaticAccessCredentialsRequest {
@@ -1335,6 +1459,7 @@ export interface GetProgrammaticAccessCredentialsRequest {
     environmentId: string | undefined;
 }
 /**
+ * @public
  * <p>Short term API credentials.</p>
  */
 export interface Credentials {
@@ -1352,6 +1477,7 @@ export interface Credentials {
     sessionToken?: string;
 }
 /**
+ * @public
  * Response for GetProgrammaticAccessCredentials operation
  */
 export interface GetProgrammaticAccessCredentialsResponse {
@@ -1364,17 +1490,26 @@ export interface GetProgrammaticAccessCredentialsResponse {
      */
     durationInMinutes?: number;
 }
+/**
+ * @public
+ */
 export interface GetUserRequest {
     /**
      * <p>The unique identifier of the user to get data for.</p>
      */
     userId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum UserStatus {
     CREATING = "CREATING",
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
+/**
+ * @public
+ */
 export interface GetUserResponse {
     /**
      * <p>The unique identifier for the user account that is retrieved.</p>
@@ -1465,10 +1600,16 @@ export interface GetUserResponse {
      */
     lastLoginTime?: number;
 }
+/**
+ * @public
+ */
 export declare enum LocationType {
     INGESTION = "INGESTION",
     SAGEMAKER = "SAGEMAKER"
 }
+/**
+ * @public
+ */
 export interface GetWorkingLocationRequest {
     /**
      * <p>Specify the type of the working location.</p>
@@ -1487,6 +1628,9 @@ export interface GetWorkingLocationRequest {
      */
     locationType?: LocationType | string;
 }
+/**
+ * @public
+ */
 export interface GetWorkingLocationResponse {
     /**
      * <p>Returns the Amazon S3 URI for the working location.</p>
@@ -1502,6 +1646,7 @@ export interface GetWorkingLocationResponse {
     s3Bucket?: string;
 }
 /**
+ * @public
  * Request to ListChangesetsRequest. It exposes minimal query filters.
  */
 export interface ListChangesetsRequest {
@@ -1519,6 +1664,7 @@ export interface ListChangesetsRequest {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>A Changeset is unit of data in a Dataset.</p>
  */
 export interface ChangesetSummary {
@@ -1615,6 +1761,7 @@ export interface ChangesetSummary {
     updatedByChangesetId?: string;
 }
 /**
+ * @public
  * Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.
  */
 export interface ListChangesetsResponse {
@@ -1628,6 +1775,7 @@ export interface ListChangesetsResponse {
     nextToken?: string;
 }
 /**
+ * @public
  * Request for the ListDatasets operation.
  */
 export interface ListDatasetsRequest {
@@ -1641,6 +1789,7 @@ export interface ListDatasetsRequest {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>The structure for a Dataset.</p>
  */
 export interface Dataset {
@@ -1696,6 +1845,7 @@ export interface Dataset {
     alias?: string;
 }
 /**
+ * @public
  * Response for the ListDatasets operation
  */
 export interface ListDatasetsResponse {
@@ -1709,6 +1859,7 @@ export interface ListDatasetsResponse {
     nextToken?: string;
 }
 /**
+ * @public
  * Request for a list data views.
  */
 export interface ListDataViewsRequest {
@@ -1726,6 +1877,7 @@ export interface ListDataViewsRequest {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>Structure for the summary of a Dataview.</p>
  */
 export interface DataViewSummary {
@@ -1812,6 +1964,9 @@ export interface DataViewSummary {
      */
     lastModifiedTime?: number;
 }
+/**
+ * @public
+ */
 export interface ListDataViewsResponse {
     /**
      * <p>A token that indicates where a results page should begin.</p>
@@ -1822,6 +1977,9 @@ export interface ListDataViewsResponse {
      */
     dataViews?: DataViewSummary[];
 }
+/**
+ * @public
+ */
 export interface ListPermissionGroupsRequest {
     /**
      * <p>A token that indicates where a results page should begin.</p>
@@ -1832,6 +1990,9 @@ export interface ListPermissionGroupsRequest {
      */
     maxResults: number | undefined;
 }
+/**
+ * @public
+ */
 export interface ListPermissionGroupsResponse {
     /**
      * <p>A list of all the permission groups.</p>
@@ -1842,6 +2003,9 @@ export interface ListPermissionGroupsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListPermissionGroupsByUserRequest {
     /**
      * <p>The unique identifier for the user.</p>
@@ -1857,6 +2021,7 @@ export interface ListPermissionGroupsByUserRequest {
     maxResults: number | undefined;
 }
 /**
+ * @public
  * <p>The structure of a permission group associated with a user account.</p>
  */
 export interface PermissionGroupByUser {
@@ -1887,6 +2052,9 @@ export interface PermissionGroupByUser {
      */
     membershipStatus?: PermissionGroupMembershipStatus | string;
 }
+/**
+ * @public
+ */
 export interface ListPermissionGroupsByUserResponse {
     /**
      * <p>A list of returned permission groups.</p>
@@ -1897,6 +2065,9 @@ export interface ListPermissionGroupsByUserResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListUsersRequest {
     /**
      * <p>A token that indicates where a results page should begin.</p>
@@ -1908,6 +2079,7 @@ export interface ListUsersRequest {
     maxResults: number | undefined;
 }
 /**
+ * @public
  * <p>The details of the user account.</p>
  */
 export interface User {
@@ -2001,6 +2173,9 @@ export interface User {
      */
     lastLoginTime?: number;
 }
+/**
+ * @public
+ */
 export interface ListUsersResponse {
     /**
      * <p>A list of all the user accounts.</p>
@@ -2011,6 +2186,9 @@ export interface ListUsersResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListUsersByPermissionGroupRequest {
     /**
      * <p>The unique identifier for the permission group.</p>
@@ -2026,6 +2204,7 @@ export interface ListUsersByPermissionGroupRequest {
     maxResults: number | undefined;
 }
 /**
+ * @public
  * <p>The structure of a user account associated with a permission group.</p>
  */
 export interface UserByPermissionGroup {
@@ -2114,6 +2293,9 @@ export interface UserByPermissionGroup {
      */
     membershipStatus?: PermissionGroupMembershipStatus | string;
 }
+/**
+ * @public
+ */
 export interface ListUsersByPermissionGroupResponse {
     /**
      * <p>Lists details of all users in a specific permission group.</p>
@@ -2124,6 +2306,9 @@ export interface ListUsersByPermissionGroupResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ResetUserPasswordRequest {
     /**
      * <p>The unique identifier of the user that a temporary password is requested for.</p>
@@ -2134,6 +2319,9 @@ export interface ResetUserPasswordRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface ResetUserPasswordResponse {
     /**
      * <p>The unique identifier of the user that a new password is generated for.</p>
@@ -2145,6 +2333,7 @@ export interface ResetUserPasswordResponse {
     temporaryPassword?: string;
 }
 /**
+ * @public
  * Request to update an existing changeset.
  */
 export interface UpdateChangesetRequest {
@@ -2167,10 +2356,10 @@ export interface UpdateChangesetRequest {
      *          <p>
      *             <code>
      *         "sourceParams":
-     *         {
+     *         \{
      *         "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
      *         "sourceType": "S3"
-     *         }
+     *         \}
      *       </code>
      *          </p>
      *          <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</p>
@@ -2205,21 +2394,21 @@ export interface UpdateChangesetRequest {
      *          <p>
      *             <code>
      *         "formatParams":
-     *         {
+     *         \{
      *         "formatType": "CSV",
      *         "withHeader": "true",
      *         "separator": ",",
      *         "compression":"None"
-     *         }
+     *         \}
      *       </code>
      *          </p>
      *          <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p>
      *          <p>
      *             <code>
-     *         {
+     *         \{
      *         "withHeader": "true",
      *         "separator": ","
-     *         }
+     *         \}
      *         </code>
      *          </p>
      *          <p> For more information about supported file formats, see <a href="https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>
@@ -2227,6 +2416,7 @@ export interface UpdateChangesetRequest {
     formatParams: Record<string, string> | undefined;
 }
 /**
+ * @public
  * The response from a update changeset operation.
  */
 export interface UpdateChangesetResponse {
@@ -2240,6 +2430,7 @@ export interface UpdateChangesetResponse {
     datasetId?: string;
 }
 /**
+ * @public
  * The request for an UpdateDataset operation
  */
 export interface UpdateDatasetRequest {
@@ -2283,6 +2474,7 @@ export interface UpdateDatasetRequest {
     schemaDefinition?: SchemaUnion;
 }
 /**
+ * @public
  * The response from an UpdateDataset operation
  */
 export interface UpdateDatasetResponse {
@@ -2291,6 +2483,9 @@ export interface UpdateDatasetResponse {
      */
     datasetId?: string;
 }
+/**
+ * @public
+ */
 export interface UpdatePermissionGroupRequest {
     /**
      * <p>The unique identifier for the permission group to update.</p>
@@ -2346,12 +2541,18 @@ export interface UpdatePermissionGroupRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface UpdatePermissionGroupResponse {
     /**
      * <p>The unique identifier for the updated permission group.</p>
      */
     permissionGroupId?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateUserRequest {
     /**
      * <p>The unique identifier for the user account to update.</p>
@@ -2402,6 +2603,9 @@ export interface UpdateUserRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateUserResponse {
     /**
      * <p>The unique identifier of the updated user account.</p>