@aws-sdk/client-quicksight 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/dist-types/QuickSight.d.ts +127 -0
  2. package/dist-types/QuickSightClient.d.ts +24 -4
  3. package/dist-types/commands/CancelIngestionCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateAnalysisCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateDashboardCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateDataSetCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateDataSourceCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateFolderCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateFolderMembershipCommand.d.ts +16 -0
  12. package/dist-types/commands/CreateGroupCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateGroupMembershipCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateIngestionCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateNamespaceCommand.d.ts +16 -0
  17. package/dist-types/commands/CreateTemplateAliasCommand.d.ts +16 -0
  18. package/dist-types/commands/CreateTemplateCommand.d.ts +16 -0
  19. package/dist-types/commands/CreateThemeAliasCommand.d.ts +16 -0
  20. package/dist-types/commands/CreateThemeCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteAnalysisCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteDashboardCommand.d.ts +16 -0
  25. package/dist-types/commands/DeleteDataSetCommand.d.ts +16 -0
  26. package/dist-types/commands/DeleteDataSourceCommand.d.ts +16 -0
  27. package/dist-types/commands/DeleteFolderCommand.d.ts +16 -0
  28. package/dist-types/commands/DeleteFolderMembershipCommand.d.ts +16 -0
  29. package/dist-types/commands/DeleteGroupCommand.d.ts +16 -0
  30. package/dist-types/commands/DeleteGroupMembershipCommand.d.ts +16 -0
  31. package/dist-types/commands/DeleteIAMPolicyAssignmentCommand.d.ts +16 -0
  32. package/dist-types/commands/DeleteNamespaceCommand.d.ts +16 -0
  33. package/dist-types/commands/DeleteTemplateAliasCommand.d.ts +16 -0
  34. package/dist-types/commands/DeleteTemplateCommand.d.ts +16 -0
  35. package/dist-types/commands/DeleteThemeAliasCommand.d.ts +16 -0
  36. package/dist-types/commands/DeleteThemeCommand.d.ts +16 -0
  37. package/dist-types/commands/DeleteUserByPrincipalIdCommand.d.ts +16 -0
  38. package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeAccountCustomizationCommand.d.ts +16 -0
  40. package/dist-types/commands/DescribeAccountSettingsCommand.d.ts +16 -0
  41. package/dist-types/commands/DescribeAccountSubscriptionCommand.d.ts +16 -0
  42. package/dist-types/commands/DescribeAnalysisCommand.d.ts +16 -0
  43. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +16 -0
  44. package/dist-types/commands/DescribeAnalysisPermissionsCommand.d.ts +16 -0
  45. package/dist-types/commands/DescribeDashboardCommand.d.ts +16 -0
  46. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +16 -0
  47. package/dist-types/commands/DescribeDashboardPermissionsCommand.d.ts +16 -0
  48. package/dist-types/commands/DescribeDataSetCommand.d.ts +16 -0
  49. package/dist-types/commands/DescribeDataSetPermissionsCommand.d.ts +16 -0
  50. package/dist-types/commands/DescribeDataSourceCommand.d.ts +16 -0
  51. package/dist-types/commands/DescribeDataSourcePermissionsCommand.d.ts +16 -0
  52. package/dist-types/commands/DescribeFolderCommand.d.ts +16 -0
  53. package/dist-types/commands/DescribeFolderPermissionsCommand.d.ts +16 -0
  54. package/dist-types/commands/DescribeFolderResolvedPermissionsCommand.d.ts +16 -0
  55. package/dist-types/commands/DescribeGroupCommand.d.ts +16 -0
  56. package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +16 -0
  57. package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +16 -0
  58. package/dist-types/commands/DescribeIngestionCommand.d.ts +16 -0
  59. package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +16 -0
  60. package/dist-types/commands/DescribeNamespaceCommand.d.ts +16 -0
  61. package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +16 -0
  62. package/dist-types/commands/DescribeTemplateCommand.d.ts +16 -0
  63. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +16 -0
  64. package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +16 -0
  65. package/dist-types/commands/DescribeThemeAliasCommand.d.ts +16 -0
  66. package/dist-types/commands/DescribeThemeCommand.d.ts +16 -0
  67. package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +16 -0
  68. package/dist-types/commands/DescribeUserCommand.d.ts +16 -0
  69. package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +16 -0
  70. package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +16 -0
  71. package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +16 -0
  72. package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +16 -0
  73. package/dist-types/commands/ListAnalysesCommand.d.ts +16 -0
  74. package/dist-types/commands/ListDashboardVersionsCommand.d.ts +16 -0
  75. package/dist-types/commands/ListDashboardsCommand.d.ts +16 -0
  76. package/dist-types/commands/ListDataSetsCommand.d.ts +16 -0
  77. package/dist-types/commands/ListDataSourcesCommand.d.ts +16 -0
  78. package/dist-types/commands/ListFolderMembersCommand.d.ts +16 -0
  79. package/dist-types/commands/ListFoldersCommand.d.ts +16 -0
  80. package/dist-types/commands/ListGroupMembershipsCommand.d.ts +16 -0
  81. package/dist-types/commands/ListGroupsCommand.d.ts +16 -0
  82. package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +16 -0
  83. package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +16 -0
  84. package/dist-types/commands/ListIngestionsCommand.d.ts +16 -0
  85. package/dist-types/commands/ListNamespacesCommand.d.ts +16 -0
  86. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  87. package/dist-types/commands/ListTemplateAliasesCommand.d.ts +16 -0
  88. package/dist-types/commands/ListTemplateVersionsCommand.d.ts +16 -0
  89. package/dist-types/commands/ListTemplatesCommand.d.ts +16 -0
  90. package/dist-types/commands/ListThemeAliasesCommand.d.ts +16 -0
  91. package/dist-types/commands/ListThemeVersionsCommand.d.ts +16 -0
  92. package/dist-types/commands/ListThemesCommand.d.ts +16 -0
  93. package/dist-types/commands/ListUserGroupsCommand.d.ts +16 -0
  94. package/dist-types/commands/ListUsersCommand.d.ts +16 -0
  95. package/dist-types/commands/RegisterUserCommand.d.ts +16 -0
  96. package/dist-types/commands/RestoreAnalysisCommand.d.ts +16 -0
  97. package/dist-types/commands/SearchAnalysesCommand.d.ts +16 -0
  98. package/dist-types/commands/SearchDashboardsCommand.d.ts +16 -0
  99. package/dist-types/commands/SearchDataSetsCommand.d.ts +16 -0
  100. package/dist-types/commands/SearchDataSourcesCommand.d.ts +16 -0
  101. package/dist-types/commands/SearchFoldersCommand.d.ts +16 -0
  102. package/dist-types/commands/SearchGroupsCommand.d.ts +16 -0
  103. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  104. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  105. package/dist-types/commands/UpdateAccountCustomizationCommand.d.ts +16 -0
  106. package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +16 -0
  107. package/dist-types/commands/UpdateAnalysisCommand.d.ts +16 -0
  108. package/dist-types/commands/UpdateAnalysisPermissionsCommand.d.ts +16 -0
  109. package/dist-types/commands/UpdateDashboardCommand.d.ts +16 -0
  110. package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +16 -0
  111. package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +16 -0
  112. package/dist-types/commands/UpdateDataSetCommand.d.ts +16 -0
  113. package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +16 -0
  114. package/dist-types/commands/UpdateDataSourceCommand.d.ts +16 -0
  115. package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +16 -0
  116. package/dist-types/commands/UpdateFolderCommand.d.ts +16 -0
  117. package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +16 -0
  118. package/dist-types/commands/UpdateGroupCommand.d.ts +16 -0
  119. package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +16 -0
  120. package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +16 -0
  121. package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +16 -0
  122. package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +16 -0
  123. package/dist-types/commands/UpdateTemplateCommand.d.ts +16 -0
  124. package/dist-types/commands/UpdateTemplatePermissionsCommand.d.ts +16 -0
  125. package/dist-types/commands/UpdateThemeAliasCommand.d.ts +16 -0
  126. package/dist-types/commands/UpdateThemeCommand.d.ts +16 -0
  127. package/dist-types/commands/UpdateThemePermissionsCommand.d.ts +16 -0
  128. package/dist-types/commands/UpdateUserCommand.d.ts +16 -0
  129. package/dist-types/models/QuickSightServiceException.d.ts +2 -0
  130. package/dist-types/models/models_0.d.ts +422 -0
  131. package/dist-types/models/models_1.d.ts +416 -4
  132. package/dist-types/models/models_2.d.ts +629 -0
  133. package/dist-types/models/models_3.d.ts +360 -3
  134. package/dist-types/pagination/Interfaces.d.ts +3 -0
  135. package/dist-types/pagination/ListAnalysesPaginator.d.ts +3 -0
  136. package/dist-types/pagination/ListDashboardVersionsPaginator.d.ts +3 -0
  137. package/dist-types/pagination/ListDashboardsPaginator.d.ts +3 -0
  138. package/dist-types/pagination/ListDataSetsPaginator.d.ts +3 -0
  139. package/dist-types/pagination/ListDataSourcesPaginator.d.ts +3 -0
  140. package/dist-types/pagination/ListIngestionsPaginator.d.ts +3 -0
  141. package/dist-types/pagination/ListNamespacesPaginator.d.ts +3 -0
  142. package/dist-types/pagination/ListTemplateAliasesPaginator.d.ts +3 -0
  143. package/dist-types/pagination/ListTemplateVersionsPaginator.d.ts +3 -0
  144. package/dist-types/pagination/ListTemplatesPaginator.d.ts +3 -0
  145. package/dist-types/pagination/ListThemeVersionsPaginator.d.ts +3 -0
  146. package/dist-types/pagination/ListThemesPaginator.d.ts +3 -0
  147. package/dist-types/pagination/SearchAnalysesPaginator.d.ts +3 -0
  148. package/dist-types/pagination/SearchDashboardsPaginator.d.ts +3 -0
  149. package/dist-types/pagination/SearchDataSetsPaginator.d.ts +3 -0
  150. package/dist-types/pagination/SearchDataSourcesPaginator.d.ts +3 -0
  151. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAccountCustomizationRequest, DescribeAccountCustomizationResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAccountCustomizationCommand}.
8
10
  */
9
11
  export interface DescribeAccountCustomizationCommandInput extends DescribeAccountCustomizationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAccountCustomizationCommand}.
13
17
  */
14
18
  export interface DescribeAccountCustomizationCommandOutput extends DescribeAccountCustomizationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the customizations associated with the provided Amazon Web Services account and Amazon
18
23
  * Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which
19
24
  * customizations to apply by running this API operation with the <code>Resolved</code> flag
@@ -81,6 +86,8 @@ export interface DescribeAccountCustomizationCommandOutput extends DescribeAccou
81
86
  * const response = await client.send(command);
82
87
  * ```
83
88
  *
89
+ * @param DescribeAccountCustomizationCommandInput - {@link DescribeAccountCustomizationCommandInput}
90
+ * @returns {@link DescribeAccountCustomizationCommandOutput}
84
91
  * @see {@link DescribeAccountCustomizationCommandInput} for command's `input` shape.
85
92
  * @see {@link DescribeAccountCustomizationCommandOutput} for command's `response` shape.
86
93
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -111,11 +118,20 @@ export interface DescribeAccountCustomizationCommandOutput extends DescribeAccou
111
118
  export declare class DescribeAccountCustomizationCommand extends $Command<DescribeAccountCustomizationCommandInput, DescribeAccountCustomizationCommandOutput, QuickSightClientResolvedConfig> {
112
119
  readonly input: DescribeAccountCustomizationCommandInput;
113
120
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
121
+ /**
122
+ * @public
123
+ */
114
124
  constructor(input: DescribeAccountCustomizationCommandInput);
115
125
  /**
116
126
  * @internal
117
127
  */
118
128
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAccountCustomizationCommandInput, DescribeAccountCustomizationCommandOutput>;
129
+ /**
130
+ * @internal
131
+ */
119
132
  private serialize;
133
+ /**
134
+ * @internal
135
+ */
120
136
  private deserialize;
121
137
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAccountSettingsRequest, DescribeAccountSettingsResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAccountSettingsCommand}.
8
10
  */
9
11
  export interface DescribeAccountSettingsCommandInput extends DescribeAccountSettingsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAccountSettingsCommand}.
13
17
  */
14
18
  export interface DescribeAccountSettingsCommandOutput extends DescribeAccountSettingsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the settings that were used when your Amazon QuickSight subscription was first
18
23
  * created in this Amazon Web Services account.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeAccountSettingsCommandOutput extends DescribeAccountSet
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeAccountSettingsCommandInput - {@link DescribeAccountSettingsCommandInput}
35
+ * @returns {@link DescribeAccountSettingsCommandOutput}
29
36
  * @see {@link DescribeAccountSettingsCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeAccountSettingsCommandOutput} for command's `response` shape.
31
38
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -56,11 +63,20 @@ export interface DescribeAccountSettingsCommandOutput extends DescribeAccountSet
56
63
  export declare class DescribeAccountSettingsCommand extends $Command<DescribeAccountSettingsCommandInput, DescribeAccountSettingsCommandOutput, QuickSightClientResolvedConfig> {
57
64
  readonly input: DescribeAccountSettingsCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: DescribeAccountSettingsCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAccountSettingsCommandInput, DescribeAccountSettingsCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAccountSubscriptionRequest, DescribeAccountSubscriptionResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAccountSubscriptionCommand}.
8
10
  */
9
11
  export interface DescribeAccountSubscriptionCommandInput extends DescribeAccountSubscriptionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAccountSubscriptionCommand}.
13
17
  */
14
18
  export interface DescribeAccountSubscriptionCommandOutput extends DescribeAccountSubscriptionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an <code>AccountInfo</code> object that includes an account's name, subscription status, authentication type, edition, and notification email address.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeAccountSubscriptionCommandOutput extends DescribeAccoun
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAccountSubscriptionCommandInput - {@link DescribeAccountSubscriptionCommandInput}
34
+ * @returns {@link DescribeAccountSubscriptionCommandOutput}
28
35
  * @see {@link DescribeAccountSubscriptionCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAccountSubscriptionCommandOutput} for command's `response` shape.
30
37
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -55,11 +62,20 @@ export interface DescribeAccountSubscriptionCommandOutput extends DescribeAccoun
55
62
  export declare class DescribeAccountSubscriptionCommand extends $Command<DescribeAccountSubscriptionCommandInput, DescribeAccountSubscriptionCommandOutput, QuickSightClientResolvedConfig> {
56
63
  readonly input: DescribeAccountSubscriptionCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: DescribeAccountSubscriptionCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAccountSubscriptionCommandInput, DescribeAccountSubscriptionCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAnalysisRequest, DescribeAnalysisResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAnalysisCommand}.
8
10
  */
9
11
  export interface DescribeAnalysisCommandInput extends DescribeAnalysisRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAnalysisCommand}.
13
17
  */
14
18
  export interface DescribeAnalysisCommandOutput extends DescribeAnalysisResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides a summary of the metadata for an analysis.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeAnalysisCommandOutput extends DescribeAnalysisResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAnalysisCommandInput - {@link DescribeAnalysisCommandInput}
34
+ * @returns {@link DescribeAnalysisCommandOutput}
28
35
  * @see {@link DescribeAnalysisCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAnalysisCommandOutput} for command's `response` shape.
30
37
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DescribeAnalysisCommandOutput extends DescribeAnalysisResponse,
58
65
  export declare class DescribeAnalysisCommand extends $Command<DescribeAnalysisCommandInput, DescribeAnalysisCommandOutput, QuickSightClientResolvedConfig> {
59
66
  readonly input: DescribeAnalysisCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DescribeAnalysisCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAnalysisCommandInput, DescribeAnalysisCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAnalysisDefinitionRequest, DescribeAnalysisDefinitionResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAnalysisDefinitionCommand}.
8
10
  */
9
11
  export interface DescribeAnalysisDefinitionCommandInput extends DescribeAnalysisDefinitionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAnalysisDefinitionCommand}.
13
17
  */
14
18
  export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysisDefinitionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides a detailed description of the definition of an analysis.</p>
18
23
  * <note>
19
24
  * <p>If you do not need to know details about the content of an Analysis, for instance if you
@@ -33,6 +38,8 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param DescribeAnalysisDefinitionCommandInput - {@link DescribeAnalysisDefinitionCommandInput}
42
+ * @returns {@link DescribeAnalysisDefinitionCommandOutput}
36
43
  * @see {@link DescribeAnalysisDefinitionCommandInput} for command's `input` shape.
37
44
  * @see {@link DescribeAnalysisDefinitionCommandOutput} for command's `response` shape.
38
45
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -72,11 +79,20 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
72
79
  export declare class DescribeAnalysisDefinitionCommand extends $Command<DescribeAnalysisDefinitionCommandInput, DescribeAnalysisDefinitionCommandOutput, QuickSightClientResolvedConfig> {
73
80
  readonly input: DescribeAnalysisDefinitionCommandInput;
74
81
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
75
85
  constructor(input: DescribeAnalysisDefinitionCommandInput);
76
86
  /**
77
87
  * @internal
78
88
  */
79
89
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAnalysisDefinitionCommandInput, DescribeAnalysisDefinitionCommandOutput>;
90
+ /**
91
+ * @internal
92
+ */
80
93
  private serialize;
94
+ /**
95
+ * @internal
96
+ */
81
97
  private deserialize;
82
98
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAnalysisPermissionsRequest, DescribeAnalysisPermissionsResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAnalysisPermissionsCommand}.
8
10
  */
9
11
  export interface DescribeAnalysisPermissionsCommandInput extends DescribeAnalysisPermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAnalysisPermissionsCommand}.
13
17
  */
14
18
  export interface DescribeAnalysisPermissionsCommandOutput extends DescribeAnalysisPermissionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides the read and write permissions for an analysis.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeAnalysisPermissionsCommandOutput extends DescribeAnalys
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAnalysisPermissionsCommandInput - {@link DescribeAnalysisPermissionsCommandInput}
34
+ * @returns {@link DescribeAnalysisPermissionsCommandOutput}
28
35
  * @see {@link DescribeAnalysisPermissionsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAnalysisPermissionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DescribeAnalysisPermissionsCommandOutput extends DescribeAnalys
52
59
  export declare class DescribeAnalysisPermissionsCommand extends $Command<DescribeAnalysisPermissionsCommandInput, DescribeAnalysisPermissionsCommandOutput, QuickSightClientResolvedConfig> {
53
60
  readonly input: DescribeAnalysisPermissionsCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DescribeAnalysisPermissionsCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAnalysisPermissionsCommandInput, DescribeAnalysisPermissionsCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeDashboardRequest, DescribeDashboardResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDashboardCommand}.
8
10
  */
9
11
  export interface DescribeDashboardCommandInput extends DescribeDashboardRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDashboardCommand}.
13
17
  */
14
18
  export interface DescribeDashboardCommandOutput extends DescribeDashboardResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides a summary for a dashboard.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeDashboardCommandOutput extends DescribeDashboardRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeDashboardCommandInput - {@link DescribeDashboardCommandInput}
34
+ * @returns {@link DescribeDashboardCommandOutput}
28
35
  * @see {@link DescribeDashboardCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeDashboardCommandOutput} for command's `response` shape.
30
37
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DescribeDashboardCommandOutput extends DescribeDashboardRespons
58
65
  export declare class DescribeDashboardCommand extends $Command<DescribeDashboardCommandInput, DescribeDashboardCommandOutput, QuickSightClientResolvedConfig> {
59
66
  readonly input: DescribeDashboardCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DescribeDashboardCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDashboardCommandInput, DescribeDashboardCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeDashboardDefinitionRequest, DescribeDashboardDefinitionResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDashboardDefinitionCommand}.
8
10
  */
9
11
  export interface DescribeDashboardDefinitionCommandInput extends DescribeDashboardDefinitionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDashboardDefinitionCommand}.
13
17
  */
14
18
  export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashboardDefinitionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides a detailed description of the definition of a dashboard.</p>
18
23
  * <note>
19
24
  * <p>If you do not need to know details about the content of a dashboard, for instance if you
@@ -33,6 +38,8 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param DescribeDashboardDefinitionCommandInput - {@link DescribeDashboardDefinitionCommandInput}
42
+ * @returns {@link DescribeDashboardDefinitionCommandOutput}
36
43
  * @see {@link DescribeDashboardDefinitionCommandInput} for command's `input` shape.
37
44
  * @see {@link DescribeDashboardDefinitionCommandOutput} for command's `response` shape.
38
45
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -72,11 +79,20 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
72
79
  export declare class DescribeDashboardDefinitionCommand extends $Command<DescribeDashboardDefinitionCommandInput, DescribeDashboardDefinitionCommandOutput, QuickSightClientResolvedConfig> {
73
80
  readonly input: DescribeDashboardDefinitionCommandInput;
74
81
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
75
85
  constructor(input: DescribeDashboardDefinitionCommandInput);
76
86
  /**
77
87
  * @internal
78
88
  */
79
89
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDashboardDefinitionCommandInput, DescribeDashboardDefinitionCommandOutput>;
90
+ /**
91
+ * @internal
92
+ */
80
93
  private serialize;
94
+ /**
95
+ * @internal
96
+ */
81
97
  private deserialize;
82
98
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeDashboardPermissionsRequest, DescribeDashboardPermissionsResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDashboardPermissionsCommand}.
8
10
  */
9
11
  export interface DescribeDashboardPermissionsCommandInput extends DescribeDashboardPermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDashboardPermissionsCommand}.
13
17
  */
14
18
  export interface DescribeDashboardPermissionsCommandOutput extends DescribeDashboardPermissionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes read and write permissions for a dashboard.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeDashboardPermissionsCommandOutput extends DescribeDashb
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeDashboardPermissionsCommandInput - {@link DescribeDashboardPermissionsCommandInput}
34
+ * @returns {@link DescribeDashboardPermissionsCommandOutput}
28
35
  * @see {@link DescribeDashboardPermissionsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeDashboardPermissionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DescribeDashboardPermissionsCommandOutput extends DescribeDashb
52
59
  export declare class DescribeDashboardPermissionsCommand extends $Command<DescribeDashboardPermissionsCommandInput, DescribeDashboardPermissionsCommandOutput, QuickSightClientResolvedConfig> {
53
60
  readonly input: DescribeDashboardPermissionsCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DescribeDashboardPermissionsCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDashboardPermissionsCommandInput, DescribeDashboardPermissionsCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeDataSetRequest, DescribeDataSetResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDataSetCommand}.
8
10
  */
9
11
  export interface DescribeDataSetCommandInput extends DescribeDataSetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDataSetCommand}.
13
17
  */
14
18
  export interface DescribeDataSetCommandOutput extends DescribeDataSetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeDataSetCommandOutput extends DescribeDataSetResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeDataSetCommandInput - {@link DescribeDataSetCommandInput}
34
+ * @returns {@link DescribeDataSetCommandOutput}
28
35
  * @see {@link DescribeDataSetCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeDataSetCommandOutput} for command's `response` shape.
30
37
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DescribeDataSetCommandOutput extends DescribeDataSetResponse, _
52
59
  export declare class DescribeDataSetCommand extends $Command<DescribeDataSetCommandInput, DescribeDataSetCommandOutput, QuickSightClientResolvedConfig> {
53
60
  readonly input: DescribeDataSetCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DescribeDataSetCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDataSetCommandInput, DescribeDataSetCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeDataSetPermissionsRequest, DescribeDataSetPermissionsResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDataSetPermissionsCommand}.
8
10
  */
9
11
  export interface DescribeDataSetPermissionsCommandInput extends DescribeDataSetPermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDataSetPermissionsCommand}.
13
17
  */
14
18
  export interface DescribeDataSetPermissionsCommandOutput extends DescribeDataSetPermissionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the permissions on a dataset.</p>
18
23
  * <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/data-set-id</code>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeDataSetPermissionsCommandOutput extends DescribeDataSet
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeDataSetPermissionsCommandInput - {@link DescribeDataSetPermissionsCommandInput}
35
+ * @returns {@link DescribeDataSetPermissionsCommandOutput}
29
36
  * @see {@link DescribeDataSetPermissionsCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeDataSetPermissionsCommandOutput} for command's `response` shape.
31
38
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DescribeDataSetPermissionsCommandOutput extends DescribeDataSet
53
60
  export declare class DescribeDataSetPermissionsCommand extends $Command<DescribeDataSetPermissionsCommandInput, DescribeDataSetPermissionsCommandOutput, QuickSightClientResolvedConfig> {
54
61
  readonly input: DescribeDataSetPermissionsCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DescribeDataSetPermissionsCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDataSetPermissionsCommandInput, DescribeDataSetPermissionsCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeDataSourceRequest, DescribeDataSourceResponse } from "../models/models_2";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDataSourceCommand}.
8
10
  */
9
11
  export interface DescribeDataSourceCommandInput extends DescribeDataSourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDataSourceCommand}.
13
17
  */
14
18
  export interface DescribeDataSourceCommandOutput extends DescribeDataSourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a data source.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeDataSourceCommandInput - {@link DescribeDataSourceCommandInput}
34
+ * @returns {@link DescribeDataSourceCommandOutput}
28
35
  * @see {@link DescribeDataSourceCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeDataSourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo
52
59
  export declare class DescribeDataSourceCommand extends $Command<DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput, QuickSightClientResolvedConfig> {
53
60
  readonly input: DescribeDataSourceCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DescribeDataSourceCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }