@aws-sdk/client-quicksight 3.1056.0 → 3.1058.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.
- package/README.md +196 -7
- package/dist-cjs/index.js +442 -5
- package/dist-cjs/schemas/schemas_0.js +979 -262
- package/dist-es/QuickSight.js +56 -0
- package/dist-es/commands/CreateAgentCommand.js +16 -0
- package/dist-es/commands/CreateFlowCommand.js +16 -0
- package/dist-es/commands/CreateOAuthClientApplicationCommand.js +16 -0
- package/dist-es/commands/CreateSpaceCommand.js +16 -0
- package/dist-es/commands/DeleteAgentCommand.js +16 -0
- package/dist-es/commands/DeleteFlowCommand.js +16 -0
- package/dist-es/commands/DeleteOAuthClientApplicationCommand.js +16 -0
- package/dist-es/commands/DeleteSpaceCommand.js +16 -0
- package/dist-es/commands/DescribeAgentCommand.js +16 -0
- package/dist-es/commands/DescribeAgentPermissionsCommand.js +16 -0
- package/dist-es/commands/DescribeFlowCommand.js +16 -0
- package/dist-es/commands/DescribeOAuthClientApplicationCommand.js +16 -0
- package/dist-es/commands/DescribeSpaceCommand.js +16 -0
- package/dist-es/commands/DescribeSpacePermissionsCommand.js +16 -0
- package/dist-es/commands/ListAgentsCommand.js +16 -0
- package/dist-es/commands/ListOAuthClientApplicationsCommand.js +16 -0
- package/dist-es/commands/ListSpaceResourcesCommand.js +16 -0
- package/dist-es/commands/ListSpacesCommand.js +16 -0
- package/dist-es/commands/SearchAgentsCommand.js +16 -0
- package/dist-es/commands/SearchSpacesCommand.js +16 -0
- package/dist-es/commands/UpdateAgentCommand.js +16 -0
- package/dist-es/commands/UpdateAgentPermissionsCommand.js +16 -0
- package/dist-es/commands/UpdateFlowCommand.js +16 -0
- package/dist-es/commands/UpdateOAuthClientApplicationCommand.js +16 -0
- package/dist-es/commands/UpdateSpaceCommand.js +16 -0
- package/dist-es/commands/UpdateSpacePermissionsCommand.js +16 -0
- package/dist-es/commands/UpdateSpaceResourcesCommand.js +16 -0
- package/dist-es/commands/index.js +27 -0
- package/dist-es/models/enums.js +52 -5
- package/dist-es/pagination/ListOAuthClientApplicationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +941 -226
- package/dist-types/QuickSight.d.ts +196 -0
- package/dist-types/QuickSightClient.d.ts +29 -2
- package/dist-types/commands/CreateAgentCommand.d.ts +136 -0
- package/dist-types/commands/CreateFlowCommand.d.ts +119 -0
- package/dist-types/commands/CreateOAuthClientApplicationCommand.d.ts +125 -0
- package/dist-types/commands/CreateSpaceCommand.d.ts +105 -0
- package/dist-types/commands/DeleteAgentCommand.d.ts +98 -0
- package/dist-types/commands/DeleteFlowCommand.d.ts +99 -0
- package/dist-types/commands/DeleteOAuthClientApplicationCommand.d.ts +101 -0
- package/dist-types/commands/DeleteSpaceCommand.d.ts +97 -0
- package/dist-types/commands/DescribeAgentCommand.d.ts +132 -0
- package/dist-types/commands/DescribeAgentPermissionsCommand.d.ts +108 -0
- package/dist-types/commands/DescribeDataSourcePermissionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDefaultQBusinessApplicationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFlowCommand.d.ts +115 -0
- package/dist-types/commands/DescribeFolderCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderResolvedPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIngestionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeKeyRegistrationCommand.d.ts +1 -2
- package/dist-types/commands/DescribeOAuthClientApplicationCommand.d.ts +111 -0
- package/dist-types/commands/DescribeSpaceCommand.d.ts +123 -0
- package/dist-types/commands/DescribeSpacePermissionsCommand.d.ts +105 -0
- package/dist-types/commands/ListAgentsCommand.d.ts +117 -0
- package/dist-types/commands/ListOAuthClientApplicationsCommand.d.ts +115 -0
- package/dist-types/commands/ListSpaceResourcesCommand.d.ts +107 -0
- package/dist-types/commands/ListSpacesCommand.d.ts +114 -0
- package/dist-types/commands/SearchAgentsCommand.d.ts +118 -0
- package/dist-types/commands/SearchSpacesCommand.d.ts +121 -0
- package/dist-types/commands/UpdateAgentCommand.d.ts +168 -0
- package/dist-types/commands/UpdateAgentPermissionsCommand.d.ts +136 -0
- package/dist-types/commands/UpdateBrandAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateBrandPublishedVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardLinksCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardsQAConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDefaultQBusinessApplicationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFlowCommand.d.ts +108 -0
- package/dist-types/commands/UpdateFlowPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFolderCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIdentityPropagationConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateKeyRegistrationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateOAuthClientApplicationCommand.d.ts +115 -0
- package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQPersonalizationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQuickSightQSearchConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSPICECapacityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSelfUpgradeCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSelfUpgradeConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSpaceCommand.d.ts +102 -0
- package/dist-types/commands/UpdateSpacePermissionsCommand.d.ts +133 -0
- package/dist-types/commands/UpdateSpaceResourcesCommand.d.ts +131 -0
- package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplatePermissionsCommand.d.ts +1 -2
- package/dist-types/commands/index.d.ts +27 -0
- package/dist-types/models/enums.d.ts +124 -13
- package/dist-types/models/models_0.d.ts +200 -87
- package/dist-types/models/models_1.d.ts +88 -66
- package/dist-types/models/models_2.d.ts +254 -215
- package/dist-types/models/models_3.d.ts +751 -756
- package/dist-types/models/models_4.d.ts +3961 -4019
- package/dist-types/models/models_5.d.ts +2051 -4
- package/dist-types/pagination/ListOAuthClientApplicationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +102 -0
- package/dist-types/ts3.4/QuickSight.d.ts +466 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +162 -0
- package/dist-types/ts3.4/commands/CreateAgentCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/CreateFlowCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/CreateOAuthClientApplicationCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/CreateSpaceCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/DeleteAgentCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/DeleteFlowCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/DeleteOAuthClientApplicationCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DeleteSpaceCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/DescribeAgentCommand.d.ts +52 -0
- package/dist-types/ts3.4/commands/DescribeAgentPermissionsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DescribeDataSourcePermissionsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeDefaultQBusinessApplicationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeFlowCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/DescribeFolderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeFolderResolvedPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeGroupMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIngestionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIpRestrictionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeKeyRegistrationCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeOAuthClientApplicationCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DescribeSpaceCommand.d.ts +52 -0
- package/dist-types/ts3.4/commands/DescribeSpacePermissionsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListAgentsCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/ListOAuthClientApplicationsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListSpaceResourcesCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListSpacesCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/SearchAgentsCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/SearchSpacesCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/UpdateAgentCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/UpdateAgentPermissionsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/UpdateBrandAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateBrandPublishedVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardLinksCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardsQAConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDefaultQBusinessApplicationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFlowCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/UpdateFlowPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFolderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIdentityPropagationConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIpRestrictionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateKeyRegistrationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateOAuthClientApplicationCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQPersonalizationConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQuickSightQSearchConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSPICECapacityConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSelfUpgradeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSelfUpgradeConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSpaceCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/UpdateSpacePermissionsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/UpdateSpaceResourcesCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/UpdateTemplateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTemplatePermissionsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +27 -0
- package/dist-types/ts3.4/models/enums.d.ts +69 -7
- package/dist-types/ts3.4/models/models_0.d.ts +47 -19
- package/dist-types/ts3.4/models/models_1.d.ts +21 -20
- package/dist-types/ts3.4/models/models_2.d.ts +78 -53
- package/dist-types/ts3.4/models/models_3.d.ts +166 -173
- package/dist-types/ts3.4/models/models_4.d.ts +435 -412
- package/dist-types/ts3.4/models/models_5.d.ts +506 -2
- package/dist-types/ts3.4/pagination/ListOAuthClientApplicationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +102 -0
- package/package.json +2 -2
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DescribeAgentPermissionsRequest, DescribeAgentPermissionsResponse } from "../models/models_3";
|
|
4
|
+
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeAgentPermissionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeAgentPermissionsCommandInput extends DescribeAgentPermissionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeAgentPermissionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeAgentPermissionsCommandOutput extends DescribeAgentPermissionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeAgentPermissionsCommand_base: {
|
|
25
|
+
new (input: DescribeAgentPermissionsCommandInput): import("@smithy/core/client").CommandImpl<DescribeAgentPermissionsCommandInput, DescribeAgentPermissionsCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeAgentPermissionsCommandInput): import("@smithy/core/client").CommandImpl<DescribeAgentPermissionsCommandInput, DescribeAgentPermissionsCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Describes the resource permissions for an agent.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { QuickSightClient, DescribeAgentPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
37
|
+
* // const { QuickSightClient, DescribeAgentPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
38
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
39
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
40
|
+
* const client = new QuickSightClient(config);
|
|
41
|
+
* const input = { // DescribeAgentPermissionsRequest
|
|
42
|
+
* AgentId: "STRING_VALUE", // required
|
|
43
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new DescribeAgentPermissionsCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // DescribeAgentPermissionsResponse
|
|
48
|
+
* // Arn: "STRING_VALUE", // required
|
|
49
|
+
* // AgentId: "STRING_VALUE", // required
|
|
50
|
+
* // Permissions: [ // ResourcePermissionList // required
|
|
51
|
+
* // { // ResourcePermission
|
|
52
|
+
* // Principal: "STRING_VALUE", // required
|
|
53
|
+
* // Actions: [ // ActionList // required
|
|
54
|
+
* // "STRING_VALUE",
|
|
55
|
+
* // ],
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // RequestId: "STRING_VALUE", // required
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @param DescribeAgentPermissionsCommandInput - {@link DescribeAgentPermissionsCommandInput}
|
|
64
|
+
* @returns {@link DescribeAgentPermissionsCommandOutput}
|
|
65
|
+
* @see {@link DescribeAgentPermissionsCommandInput} for command's `input` shape.
|
|
66
|
+
* @see {@link DescribeAgentPermissionsCommandOutput} for command's `response` shape.
|
|
67
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
70
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
71
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
72
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
73
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
76
|
+
* <p>An internal failure occurred.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
79
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
82
|
+
* <p>One or more preconditions aren't met.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
|
+
* <p>One or more resources can't be found.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
88
|
+
* <p>Access is throttled.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link QuickSightServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
92
|
+
*
|
|
93
|
+
*
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare class DescribeAgentPermissionsCommand extends DescribeAgentPermissionsCommand_base {
|
|
97
|
+
/** @internal type navigation helper, not in runtime. */
|
|
98
|
+
protected static __types: {
|
|
99
|
+
api: {
|
|
100
|
+
input: DescribeAgentPermissionsRequest;
|
|
101
|
+
output: DescribeAgentPermissionsResponse;
|
|
102
|
+
};
|
|
103
|
+
sdk: {
|
|
104
|
+
input: DescribeAgentPermissionsCommandInput;
|
|
105
|
+
output: DescribeAgentPermissionsCommandOutput;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeDataSourcePermissionsRequest
|
|
3
|
+
import type { DescribeDataSourcePermissionsRequest } from "../models/models_3";
|
|
4
|
+
import type { DescribeDataSourcePermissionsResponse } from "../models/models_4";
|
|
4
5
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeDefaultQBusinessApplicationRequest, DescribeDefaultQBusinessApplicationResponse } from "../models/
|
|
3
|
+
import type { DescribeDefaultQBusinessApplicationRequest, DescribeDefaultQBusinessApplicationResponse } from "../models/models_4";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DescribeFlowRequest, DescribeFlowResponse } from "../models/models_4";
|
|
4
|
+
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeFlowCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeFlowCommandInput extends DescribeFlowRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeFlowCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeFlowCommandOutput extends DescribeFlowResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeFlowCommand_base: {
|
|
25
|
+
new (input: DescribeFlowCommandInput): import("@smithy/core/client").CommandImpl<DescribeFlowCommandInput, DescribeFlowCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeFlowCommandInput): import("@smithy/core/client").CommandImpl<DescribeFlowCommandInput, DescribeFlowCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Returns the full details of a flow for the latest version of the requested publish state.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { QuickSightClient, DescribeFlowCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
37
|
+
* // const { QuickSightClient, DescribeFlowCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
38
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
39
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
40
|
+
* const client = new QuickSightClient(config);
|
|
41
|
+
* const input = { // DescribeFlowRequest
|
|
42
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
43
|
+
* FlowId: "STRING_VALUE", // required
|
|
44
|
+
* PublishState: "PUBLISHED" || "DRAFT" || "PENDING_APPROVAL", // required
|
|
45
|
+
* };
|
|
46
|
+
* const command = new DescribeFlowCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // DescribeFlowResponse
|
|
49
|
+
* // Flow: { // FlowDetail
|
|
50
|
+
* // Arn: "STRING_VALUE", // required
|
|
51
|
+
* // FlowId: "STRING_VALUE", // required
|
|
52
|
+
* // Name: "STRING_VALUE", // required
|
|
53
|
+
* // Description: "STRING_VALUE",
|
|
54
|
+
* // PublishState: "PUBLISHED" || "DRAFT" || "PENDING_APPROVAL", // required
|
|
55
|
+
* // CreatedTime: new Date("TIMESTAMP"), // required
|
|
56
|
+
* // CreatedBy: "STRING_VALUE",
|
|
57
|
+
* // LastUpdatedTime: new Date("TIMESTAMP"),
|
|
58
|
+
* // LastUpdatedBy: "STRING_VALUE",
|
|
59
|
+
* // FlowDefinition: "DOCUMENT_VALUE", // required
|
|
60
|
+
* // StepAliases: [ // StepAliasList
|
|
61
|
+
* // { // StepAliasMapping
|
|
62
|
+
* // StepId: "STRING_VALUE", // required
|
|
63
|
+
* // StepAlias: "STRING_VALUE", // required
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // },
|
|
67
|
+
* // RequestId: "STRING_VALUE",
|
|
68
|
+
* // Status: Number("int"),
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* @param DescribeFlowCommandInput - {@link DescribeFlowCommandInput}
|
|
74
|
+
* @returns {@link DescribeFlowCommandOutput}
|
|
75
|
+
* @see {@link DescribeFlowCommandInput} for command's `input` shape.
|
|
76
|
+
* @see {@link DescribeFlowCommandOutput} for command's `response` shape.
|
|
77
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
80
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
81
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
82
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
83
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
86
|
+
* <p>An internal failure occurred.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
89
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
92
|
+
* <p>One or more resources can't be found.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
95
|
+
* <p>Access is throttled.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link QuickSightServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
99
|
+
*
|
|
100
|
+
*
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
export declare class DescribeFlowCommand extends DescribeFlowCommand_base {
|
|
104
|
+
/** @internal type navigation helper, not in runtime. */
|
|
105
|
+
protected static __types: {
|
|
106
|
+
api: {
|
|
107
|
+
input: DescribeFlowRequest;
|
|
108
|
+
output: DescribeFlowResponse;
|
|
109
|
+
};
|
|
110
|
+
sdk: {
|
|
111
|
+
input: DescribeFlowCommandInput;
|
|
112
|
+
output: DescribeFlowCommandOutput;
|
|
113
|
+
};
|
|
114
|
+
};
|
|
115
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeFolderRequest, DescribeFolderResponse } from "../models/
|
|
3
|
+
import type { DescribeFolderRequest, DescribeFolderResponse } from "../models/models_4";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeFolderPermissionsRequest, DescribeFolderPermissionsResponse } from "../models/
|
|
3
|
+
import type { DescribeFolderPermissionsRequest, DescribeFolderPermissionsResponse } from "../models/models_4";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeFolderResolvedPermissionsRequest, DescribeFolderResolvedPermissionsResponse } from "../models/
|
|
3
|
+
import type { DescribeFolderResolvedPermissionsRequest, DescribeFolderResolvedPermissionsResponse } from "../models/models_4";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeGroupRequest, DescribeGroupResponse } from "../models/
|
|
3
|
+
import type { DescribeGroupRequest, DescribeGroupResponse } from "../models/models_4";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeGroupMembershipRequest, DescribeGroupMembershipResponse } from "../models/
|
|
3
|
+
import type { DescribeGroupMembershipRequest, DescribeGroupMembershipResponse } from "../models/models_4";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeIAMPolicyAssignmentRequest, DescribeIAMPolicyAssignmentResponse } from "../models/
|
|
3
|
+
import type { DescribeIAMPolicyAssignmentRequest, DescribeIAMPolicyAssignmentResponse } from "../models/models_4";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeIngestionRequest, DescribeIngestionResponse } from "../models/
|
|
3
|
+
import type { DescribeIngestionRequest, DescribeIngestionResponse } from "../models/models_4";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeIpRestrictionRequest, DescribeIpRestrictionResponse } from "../models/
|
|
3
|
+
import type { DescribeIpRestrictionRequest, DescribeIpRestrictionResponse } from "../models/models_4";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeKeyRegistrationRequest } from "../models/
|
|
4
|
-
import type { DescribeKeyRegistrationResponse } from "../models/models_4";
|
|
3
|
+
import type { DescribeKeyRegistrationRequest, DescribeKeyRegistrationResponse } from "../models/models_4";
|
|
5
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DescribeOAuthClientApplicationRequest, DescribeOAuthClientApplicationResponse } from "../models/models_4";
|
|
4
|
+
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeOAuthClientApplicationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeOAuthClientApplicationCommandInput extends DescribeOAuthClientApplicationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeOAuthClientApplicationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeOAuthClientApplicationCommandOutput extends DescribeOAuthClientApplicationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeOAuthClientApplicationCommand_base: {
|
|
25
|
+
new (input: DescribeOAuthClientApplicationCommandInput): import("@smithy/core/client").CommandImpl<DescribeOAuthClientApplicationCommandInput, DescribeOAuthClientApplicationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeOAuthClientApplicationCommandInput): import("@smithy/core/client").CommandImpl<DescribeOAuthClientApplicationCommandInput, DescribeOAuthClientApplicationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Describes an OAuthClientApplication.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { QuickSightClient, DescribeOAuthClientApplicationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
37
|
+
* // const { QuickSightClient, DescribeOAuthClientApplicationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
38
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
39
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
40
|
+
* const client = new QuickSightClient(config);
|
|
41
|
+
* const input = { // DescribeOAuthClientApplicationRequest
|
|
42
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
43
|
+
* OAuthClientApplicationId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new DescribeOAuthClientApplicationCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // DescribeOAuthClientApplicationResponse
|
|
48
|
+
* // OAuthClientApplication: { // OAuthClientApplication
|
|
49
|
+
* // OAuthClientApplicationId: "STRING_VALUE",
|
|
50
|
+
* // Name: "STRING_VALUE",
|
|
51
|
+
* // OAuthClientAuthenticationType: "TOKEN",
|
|
52
|
+
* // OAuthTokenEndpointUrl: "STRING_VALUE",
|
|
53
|
+
* // OAuthAuthorizationEndpointUrl: "STRING_VALUE",
|
|
54
|
+
* // OAuthScopes: "STRING_VALUE",
|
|
55
|
+
* // DataSourceType: "ADOBE_ANALYTICS" || "AMAZON_ELASTICSEARCH" || "ATHENA" || "AURORA" || "AURORA_POSTGRESQL" || "AWS_IOT_ANALYTICS" || "GITHUB" || "JIRA" || "MARIADB" || "MYSQL" || "ORACLE" || "POSTGRESQL" || "PRESTO" || "REDSHIFT" || "S3" || "S3_TABLES" || "SALESFORCE" || "SERVICENOW" || "SNOWFLAKE" || "SPARK" || "SQLSERVER" || "TERADATA" || "TWITTER" || "TIMESTREAM" || "AMAZON_OPENSEARCH" || "EXASOL" || "DATABRICKS" || "STARBURST" || "TRINO" || "BIGQUERY" || "GOOGLESHEETS" || "GOOGLE_DRIVE" || "CONFLUENCE" || "SHAREPOINT" || "ONE_DRIVE" || "WEB_CRAWLER" || "S3_KNOWLEDGE_BASE" || "QBUSINESS",
|
|
56
|
+
* // IdentityProviderVpcConnectionProperties: { // VpcConnectionProperties
|
|
57
|
+
* // VpcConnectionArn: "STRING_VALUE", // required
|
|
58
|
+
* // },
|
|
59
|
+
* // CreatedTime: new Date("TIMESTAMP"),
|
|
60
|
+
* // LastUpdatedTime: new Date("TIMESTAMP"),
|
|
61
|
+
* // Arn: "STRING_VALUE",
|
|
62
|
+
* // },
|
|
63
|
+
* // RequestId: "STRING_VALUE",
|
|
64
|
+
* // Status: Number("int"),
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
69
|
+
* @param DescribeOAuthClientApplicationCommandInput - {@link DescribeOAuthClientApplicationCommandInput}
|
|
70
|
+
* @returns {@link DescribeOAuthClientApplicationCommandOutput}
|
|
71
|
+
* @see {@link DescribeOAuthClientApplicationCommandInput} for command's `input` shape.
|
|
72
|
+
* @see {@link DescribeOAuthClientApplicationCommandOutput} for command's `response` shape.
|
|
73
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
76
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
77
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
78
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
79
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
82
|
+
* <p>An internal failure occurred.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
85
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
88
|
+
* <p>One or more resources can't be found.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
91
|
+
* <p>Access is throttled.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link QuickSightServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
95
|
+
*
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class DescribeOAuthClientApplicationCommand extends DescribeOAuthClientApplicationCommand_base {
|
|
100
|
+
/** @internal type navigation helper, not in runtime. */
|
|
101
|
+
protected static __types: {
|
|
102
|
+
api: {
|
|
103
|
+
input: DescribeOAuthClientApplicationRequest;
|
|
104
|
+
output: DescribeOAuthClientApplicationResponse;
|
|
105
|
+
};
|
|
106
|
+
sdk: {
|
|
107
|
+
input: DescribeOAuthClientApplicationCommandInput;
|
|
108
|
+
output: DescribeOAuthClientApplicationCommandOutput;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
}
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DescribeSpaceRequest, DescribeSpaceResponse } from "../models/models_4";
|
|
4
|
+
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeSpaceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeSpaceCommandInput extends DescribeSpaceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeSpaceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeSpaceCommandOutput extends DescribeSpaceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeSpaceCommand_base: {
|
|
25
|
+
new (input: DescribeSpaceCommandInput): import("@smithy/core/client").CommandImpl<DescribeSpaceCommandInput, DescribeSpaceCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeSpaceCommandInput): import("@smithy/core/client").CommandImpl<DescribeSpaceCommandInput, DescribeSpaceCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Describes an Amazon QuickSight space.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { QuickSightClient, DescribeSpaceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
37
|
+
* // const { QuickSightClient, DescribeSpaceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
38
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
39
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
40
|
+
* const client = new QuickSightClient(config);
|
|
41
|
+
* const input = { // DescribeSpaceRequest
|
|
42
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
43
|
+
* SpaceId: "STRING_VALUE", // required
|
|
44
|
+
* MaxContributors: Number("int"),
|
|
45
|
+
* };
|
|
46
|
+
* const command = new DescribeSpaceCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // DescribeSpaceResponse
|
|
49
|
+
* // spaceId: "STRING_VALUE", // required
|
|
50
|
+
* // spaceArn: "STRING_VALUE",
|
|
51
|
+
* // Space: { // SpaceDetails
|
|
52
|
+
* // name: "STRING_VALUE",
|
|
53
|
+
* // description: "STRING_VALUE",
|
|
54
|
+
* // resources: [ // SpaceQuickSightResources
|
|
55
|
+
* // { // SpaceQuickSightResource
|
|
56
|
+
* // resourceType: "TOPIC" || "DASHBOARD" || "KNOWLEDGE_BASE" || "SPACE" || "ACTION_CONNECTOR" || "DATA_SET" || "ARTIFACT", // required
|
|
57
|
+
* // resourceDetails: { // SpaceQuickSightResourceDetails Union: only one key present
|
|
58
|
+
* // resourceArn: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
63
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
64
|
+
* // consumedSourceSize: Number("long"),
|
|
65
|
+
* // consumedSourceDocCount: Number("int"),
|
|
66
|
+
* // createdBy: "STRING_VALUE",
|
|
67
|
+
* // createdByArn: "STRING_VALUE",
|
|
68
|
+
* // },
|
|
69
|
+
* // Contributors: [ // SpaceContributorList
|
|
70
|
+
* // { // SpaceContributor
|
|
71
|
+
* // userName: "STRING_VALUE",
|
|
72
|
+
* // rawFileSizeBytes: Number("long"), // required
|
|
73
|
+
* // percentage: Number("double"),
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // RequestId: "STRING_VALUE",
|
|
77
|
+
* // };
|
|
78
|
+
*
|
|
79
|
+
* ```
|
|
80
|
+
*
|
|
81
|
+
* @param DescribeSpaceCommandInput - {@link DescribeSpaceCommandInput}
|
|
82
|
+
* @returns {@link DescribeSpaceCommandOutput}
|
|
83
|
+
* @see {@link DescribeSpaceCommandInput} for command's `input` shape.
|
|
84
|
+
* @see {@link DescribeSpaceCommandOutput} for command's `response` shape.
|
|
85
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
88
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
89
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
90
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
91
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
94
|
+
* <p>An internal failure occurred.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
97
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
100
|
+
* <p>One or more resources can't be found.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
103
|
+
* <p>Access is throttled.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link QuickSightServiceException}
|
|
106
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
107
|
+
*
|
|
108
|
+
*
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export declare class DescribeSpaceCommand extends DescribeSpaceCommand_base {
|
|
112
|
+
/** @internal type navigation helper, not in runtime. */
|
|
113
|
+
protected static __types: {
|
|
114
|
+
api: {
|
|
115
|
+
input: DescribeSpaceRequest;
|
|
116
|
+
output: DescribeSpaceResponse;
|
|
117
|
+
};
|
|
118
|
+
sdk: {
|
|
119
|
+
input: DescribeSpaceCommandInput;
|
|
120
|
+
output: DescribeSpaceCommandOutput;
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
}
|