@aws-sdk/client-quicksight 3.321.1 → 3.326.0

package/dist-types/commands/DescribeFolderResolvedPermissionsCommand.d.ts

@@ -32,6 +32,21 @@ export interface DescribeFolderResolvedPermissionsCommandOutput extends Describe
  * };
  * const command = new DescribeFolderResolvedPermissionsCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeFolderResolvedPermissionsResponse
+ * //   Status: Number("int"),
+ * //   FolderId: "STRING_VALUE",
+ * //   Arn: "STRING_VALUE",
+ * //   Permissions: [ // ResourcePermissionList
+ * //     { // ResourcePermission
+ * //       Principal: "STRING_VALUE", // required
+ * //       Actions: [ // ActionList // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   ],
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeFolderResolvedPermissionsCommandInput - {@link DescribeFolderResolvedPermissionsCommandInput}
@@ -64,6 +79,8 @@ export interface DescribeFolderResolvedPermissionsCommandOutput extends Describe
  * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
  * 			capability is available in every edition.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeFolderResolvedPermissionsCommand extends $Command<DescribeFolderResolvedPermissionsCommandInput, DescribeFolderResolvedPermissionsCommandOutput, QuickSightClientResolvedConfig> {

package/dist-types/commands/DescribeGroupCommand.d.ts

@@ -33,6 +33,17 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met
  * };
  * const command = new DescribeGroupCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeGroupResponse
+ * //   Group: { // Group
+ * //     Arn: "STRING_VALUE",
+ * //     GroupName: "STRING_VALUE",
+ * //     Description: "STRING_VALUE",
+ * //     PrincipalId: "STRING_VALUE",
+ * //   },
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeGroupCommandInput - {@link DescribeGroupCommandInput}
@@ -65,6 +76,8 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met
  * @throws {@link ThrottlingException} (client fault)
  *  <p>Access is throttled.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeGroupCommand extends $Command<DescribeGroupCommandInput, DescribeGroupCommandOutput, QuickSightClientResolvedConfig> {

package/dist-types/commands/DescribeGroupMembershipCommand.d.ts

@@ -36,6 +36,15 @@ export interface DescribeGroupMembershipCommandOutput extends DescribeGroupMembe
  * };
  * const command = new DescribeGroupMembershipCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeGroupMembershipResponse
+ * //   GroupMember: { // GroupMember
+ * //     Arn: "STRING_VALUE",
+ * //     MemberName: "STRING_VALUE",
+ * //   },
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeGroupMembershipCommandInput - {@link DescribeGroupMembershipCommandInput}
@@ -68,6 +77,8 @@ export interface DescribeGroupMembershipCommandOutput extends DescribeGroupMembe
  * @throws {@link ThrottlingException} (client fault)
  *  <p>Access is throttled.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeGroupMembershipCommand extends $Command<DescribeGroupMembershipCommandInput, DescribeGroupMembershipCommandOutput, QuickSightClientResolvedConfig> {

package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts

@@ -33,6 +33,23 @@ export interface DescribeIAMPolicyAssignmentCommandOutput extends DescribeIAMPol
  * };
  * const command = new DescribeIAMPolicyAssignmentCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeIAMPolicyAssignmentResponse
+ * //   IAMPolicyAssignment: { // IAMPolicyAssignment
+ * //     AwsAccountId: "STRING_VALUE",
+ * //     AssignmentId: "STRING_VALUE",
+ * //     AssignmentName: "STRING_VALUE",
+ * //     PolicyArn: "STRING_VALUE",
+ * //     Identities: { // IdentityMap
+ * //       "<keys>": [ // IdentityNameList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     AssignmentStatus: "ENABLED" || "DRAFT" || "DISABLED",
+ * //   },
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeIAMPolicyAssignmentCommandInput - {@link DescribeIAMPolicyAssignmentCommandInput}
@@ -62,6 +79,8 @@ export interface DescribeIAMPolicyAssignmentCommandOutput extends DescribeIAMPol
  * @throws {@link ThrottlingException} (client fault)
  *  <p>Access is throttled.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeIAMPolicyAssignmentCommand extends $Command<DescribeIAMPolicyAssignmentCommandInput, DescribeIAMPolicyAssignmentCommandOutput, QuickSightClientResolvedConfig> {

package/dist-types/commands/DescribeIngestionCommand.d.ts

@@ -33,6 +33,34 @@ export interface DescribeIngestionCommandOutput extends DescribeIngestionRespons
  * };
  * const command = new DescribeIngestionCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeIngestionResponse
+ * //   Ingestion: { // Ingestion
+ * //     Arn: "STRING_VALUE", // required
+ * //     IngestionId: "STRING_VALUE",
+ * //     IngestionStatus: "INITIALIZED" || "QUEUED" || "RUNNING" || "FAILED" || "COMPLETED" || "CANCELLED", // required
+ * //     ErrorInfo: { // ErrorInfo
+ * //       Type: "FAILURE_TO_ASSUME_ROLE" || "INGESTION_SUPERSEDED" || "INGESTION_CANCELED" || "DATA_SET_DELETED" || "DATA_SET_NOT_SPICE" || "S3_UPLOADED_FILE_DELETED" || "S3_MANIFEST_ERROR" || "DATA_TOLERANCE_EXCEPTION" || "SPICE_TABLE_NOT_FOUND" || "DATA_SET_SIZE_LIMIT_EXCEEDED" || "ROW_SIZE_LIMIT_EXCEEDED" || "ACCOUNT_CAPACITY_LIMIT_EXCEEDED" || "CUSTOMER_ERROR" || "DATA_SOURCE_NOT_FOUND" || "IAM_ROLE_NOT_AVAILABLE" || "CONNECTION_FAILURE" || "SQL_TABLE_NOT_FOUND" || "PERMISSION_DENIED" || "SSL_CERTIFICATE_VALIDATION_FAILURE" || "OAUTH_TOKEN_FAILURE" || "SOURCE_API_LIMIT_EXCEEDED_FAILURE" || "PASSWORD_AUTHENTICATION_FAILURE" || "SQL_SCHEMA_MISMATCH_ERROR" || "INVALID_DATE_FORMAT" || "INVALID_DATAPREP_SYNTAX" || "SOURCE_RESOURCE_LIMIT_EXCEEDED" || "SQL_INVALID_PARAMETER_VALUE" || "QUERY_TIMEOUT" || "SQL_NUMERIC_OVERFLOW" || "UNRESOLVABLE_HOST" || "UNROUTABLE_HOST" || "SQL_EXCEPTION" || "S3_FILE_INACCESSIBLE" || "IOT_FILE_NOT_FOUND" || "IOT_DATA_SET_FILE_EMPTY" || "INVALID_DATA_SOURCE_CONFIG" || "DATA_SOURCE_AUTH_FAILED" || "DATA_SOURCE_CONNECTION_FAILED" || "FAILURE_TO_PROCESS_JSON_FILE" || "INTERNAL_SERVICE_ERROR" || "REFRESH_SUPPRESSED_BY_EDIT" || "PERMISSION_NOT_FOUND" || "ELASTICSEARCH_CURSOR_NOT_ENABLED" || "CURSOR_NOT_ENABLED" || "DUPLICATE_COLUMN_NAMES_FOUND",
+ * //       Message: "STRING_VALUE",
+ * //     },
+ * //     RowInfo: { // RowInfo
+ * //       RowsIngested: Number("long"),
+ * //       RowsDropped: Number("long"),
+ * //       TotalRowsInDataset: Number("long"),
+ * //     },
+ * //     QueueInfo: { // QueueInfo
+ * //       WaitingOnIngestion: "STRING_VALUE", // required
+ * //       QueuedIngestion: "STRING_VALUE", // required
+ * //     },
+ * //     CreatedTime: new Date("TIMESTAMP"), // required
+ * //     IngestionTimeInSeconds: Number("long"),
+ * //     IngestionSizeInBytes: Number("long"),
+ * //     RequestSource: "MANUAL" || "SCHEDULED",
+ * //     RequestType: "INITIAL_INGESTION" || "EDIT" || "INCREMENTAL_REFRESH" || "FULL_REFRESH",
+ * //   },
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeIngestionCommandInput - {@link DescribeIngestionCommandInput}
@@ -62,6 +90,8 @@ export interface DescribeIngestionCommandOutput extends DescribeIngestionRespons
  * @throws {@link ThrottlingException} (client fault)
  *  <p>Access is throttled.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeIngestionCommand extends $Command<DescribeIngestionCommandInput, DescribeIngestionCommandOutput, QuickSightClientResolvedConfig> {

package/dist-types/commands/DescribeIpRestrictionCommand.d.ts

@@ -31,6 +31,16 @@ export interface DescribeIpRestrictionCommandOutput extends DescribeIpRestrictio
  * };
  * const command = new DescribeIpRestrictionCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeIpRestrictionResponse
+ * //   AwsAccountId: "STRING_VALUE",
+ * //   IpRestrictionRuleMap: { // IpRestrictionRuleMap
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   Enabled: true || false,
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeIpRestrictionCommandInput - {@link DescribeIpRestrictionCommandInput}
@@ -57,6 +67,8 @@ export interface DescribeIpRestrictionCommandOutput extends DescribeIpRestrictio
  * @throws {@link ThrottlingException} (client fault)
  *  <p>Access is throttled.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeIpRestrictionCommand extends $Command<DescribeIpRestrictionCommandInput, DescribeIpRestrictionCommandOutput, QuickSightClientResolvedConfig> {

package/dist-types/commands/DescribeNamespaceCommand.d.ts

@@ -32,6 +32,22 @@ export interface DescribeNamespaceCommandOutput extends DescribeNamespaceRespons
  * };
  * const command = new DescribeNamespaceCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeNamespaceResponse
+ * //   Namespace: { // NamespaceInfoV2
+ * //     Name: "STRING_VALUE",
+ * //     Arn: "STRING_VALUE",
+ * //     CapacityRegion: "STRING_VALUE",
+ * //     CreationStatus: "CREATED" || "CREATING" || "DELETING" || "RETRYABLE_FAILURE" || "NON_RETRYABLE_FAILURE",
+ * //     IdentityStore: "QUICKSIGHT",
+ * //     NamespaceError: { // NamespaceError
+ * //       Type: "PERMISSION_DENIED" || "INTERNAL_SERVICE_ERROR",
+ * //       Message: "STRING_VALUE",
+ * //     },
+ * //   },
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeNamespaceCommandInput - {@link DescribeNamespaceCommandInput}
@@ -61,6 +77,8 @@ export interface DescribeNamespaceCommandOutput extends DescribeNamespaceRespons
  * @throws {@link ThrottlingException} (client fault)
  *  <p>Access is throttled.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeNamespaceCommand extends $Command<DescribeNamespaceCommandInput, DescribeNamespaceCommandOutput, QuickSightClientResolvedConfig> {

package/dist-types/commands/DescribeRefreshScheduleCommand.d.ts

@@ -33,6 +33,27 @@ export interface DescribeRefreshScheduleCommandOutput extends DescribeRefreshSch
  * };
  * const command = new DescribeRefreshScheduleCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeRefreshScheduleResponse
+ * //   RefreshSchedule: { // RefreshSchedule
+ * //     ScheduleId: "STRING_VALUE", // required
+ * //     ScheduleFrequency: { // RefreshFrequency
+ * //       Interval: "MINUTE15" || "MINUTE30" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY", // required
+ * //       RefreshOnDay: { // ScheduleRefreshOnEntity
+ * //         DayOfWeek: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY",
+ * //         DayOfMonth: "STRING_VALUE",
+ * //       },
+ * //       Timezone: "STRING_VALUE",
+ * //       TimeOfTheDay: "STRING_VALUE",
+ * //     },
+ * //     StartAfterDateTime: new Date("TIMESTAMP"),
+ * //     RefreshType: "INCREMENTAL_REFRESH" || "FULL_REFRESH", // required
+ * //     Arn: "STRING_VALUE",
+ * //   },
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * //   Arn: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeRefreshScheduleCommandInput - {@link DescribeRefreshScheduleCommandInput}
@@ -62,6 +83,8 @@ export interface DescribeRefreshScheduleCommandOutput extends DescribeRefreshSch
  * @throws {@link ThrottlingException} (client fault)
  *  <p>Access is throttled.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeRefreshScheduleCommand extends $Command<DescribeRefreshScheduleCommandInput, DescribeRefreshScheduleCommandOutput, QuickSightClientResolvedConfig> {

package/dist-types/commands/DescribeTemplateAliasCommand.d.ts

@@ -33,6 +33,16 @@ export interface DescribeTemplateAliasCommandOutput extends DescribeTemplateAlia
  * };
  * const command = new DescribeTemplateAliasCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeTemplateAliasResponse
+ * //   TemplateAlias: { // TemplateAlias
+ * //     AliasName: "STRING_VALUE",
+ * //     Arn: "STRING_VALUE",
+ * //     TemplateVersionNumber: Number("long"),
+ * //   },
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeTemplateAliasCommandInput - {@link DescribeTemplateAliasCommandInput}
@@ -56,6 +66,8 @@ export interface DescribeTemplateAliasCommandOutput extends DescribeTemplateAlia
  * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
  * 			capability is available in every edition.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeTemplateAliasCommand extends $Command<DescribeTemplateAliasCommandInput, DescribeTemplateAliasCommandOutput, QuickSightClientResolvedConfig> {

package/dist-types/commands/DescribeTemplateCommand.d.ts

@@ -34,6 +34,67 @@ export interface DescribeTemplateCommandOutput extends DescribeTemplateResponse,
  * };
  * const command = new DescribeTemplateCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeTemplateResponse
+ * //   Template: { // Template
+ * //     Arn: "STRING_VALUE",
+ * //     Name: "STRING_VALUE",
+ * //     Version: { // TemplateVersion
+ * //       CreatedTime: new Date("TIMESTAMP"),
+ * //       Errors: [ // TemplateErrorList
+ * //         { // TemplateError
+ * //           Type: "SOURCE_NOT_FOUND" || "DATA_SET_NOT_FOUND" || "INTERNAL_FAILURE" || "ACCESS_DENIED",
+ * //           Message: "STRING_VALUE",
+ * //           ViolatedEntities: [ // EntityList
+ * //             { // Entity
+ * //               Path: "STRING_VALUE",
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //       VersionNumber: Number("long"),
+ * //       Status: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
+ * //       DataSetConfigurations: [ // DataSetConfigurationList
+ * //         { // DataSetConfiguration
+ * //           Placeholder: "STRING_VALUE",
+ * //           DataSetSchema: { // DataSetSchema
+ * //             ColumnSchemaList: [ // ColumnSchemaList
+ * //               { // ColumnSchema
+ * //                 Name: "STRING_VALUE",
+ * //                 DataType: "STRING_VALUE",
+ * //                 GeographicRole: "STRING_VALUE",
+ * //               },
+ * //             ],
+ * //           },
+ * //           ColumnGroupSchemaList: [ // ColumnGroupSchemaList
+ * //             { // ColumnGroupSchema
+ * //               Name: "STRING_VALUE",
+ * //               ColumnGroupColumnSchemaList: [ // ColumnGroupColumnSchemaList
+ * //                 { // ColumnGroupColumnSchema
+ * //                   Name: "STRING_VALUE",
+ * //                 },
+ * //               ],
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //       Description: "STRING_VALUE",
+ * //       SourceEntityArn: "STRING_VALUE",
+ * //       ThemeArn: "STRING_VALUE",
+ * //       Sheets: [ // SheetList
+ * //         { // Sheet
+ * //           SheetId: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //     },
+ * //     TemplateId: "STRING_VALUE",
+ * //     LastUpdatedTime: new Date("TIMESTAMP"),
+ * //     CreatedTime: new Date("TIMESTAMP"),
+ * //   },
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeTemplateCommandInput - {@link DescribeTemplateCommandInput}
@@ -72,6 +133,8 @@ export interface DescribeTemplateCommandOutput extends DescribeTemplateResponse,
  * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
  * 			capability is available in every edition.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeTemplateCommand extends $Command<DescribeTemplateCommandInput, DescribeTemplateCommandOutput, QuickSightClientResolvedConfig> {