|
| 1 | +// smithy-typescript generated code |
| 2 | +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; |
| 3 | +import { getSerdePlugin } from "@smithy/middleware-serde"; |
| 4 | +import { Command as $Command } from "@smithy/smithy-client"; |
| 5 | +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; |
| 6 | + |
| 7 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 8 | +import { |
| 9 | + DescribeQPersonalizationConfigurationRequest, |
| 10 | + DescribeQPersonalizationConfigurationResponse, |
| 11 | +} from "../models/models_3"; |
| 12 | +import { |
| 13 | + de_DescribeQPersonalizationConfigurationCommand, |
| 14 | + se_DescribeQPersonalizationConfigurationCommand, |
| 15 | +} from "../protocols/Aws_restJson1"; |
| 16 | +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; |
| 17 | + |
| 18 | +/** |
| 19 | + * @public |
| 20 | + */ |
| 21 | +export type { __MetadataBearer }; |
| 22 | +export { $Command }; |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The input for {@link DescribeQPersonalizationConfigurationCommand}. |
| 27 | + */ |
| 28 | +export interface DescribeQPersonalizationConfigurationCommandInput |
| 29 | + extends DescribeQPersonalizationConfigurationRequest {} |
| 30 | +/** |
| 31 | + * @public |
| 32 | + * |
| 33 | + * The output of {@link DescribeQPersonalizationConfigurationCommand}. |
| 34 | + */ |
| 35 | +export interface DescribeQPersonalizationConfigurationCommandOutput |
| 36 | + extends DescribeQPersonalizationConfigurationResponse, |
| 37 | + __MetadataBearer {} |
| 38 | + |
| 39 | +/** |
| 40 | + * <p>Describes a personalization configuration.</p> |
| 41 | + * @example |
| 42 | + * Use a bare-bones client and the command you need to make an API call. |
| 43 | + * ```javascript |
| 44 | + * import { QuickSightClient, DescribeQPersonalizationConfigurationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import |
| 45 | + * // const { QuickSightClient, DescribeQPersonalizationConfigurationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import |
| 46 | + * const client = new QuickSightClient(config); |
| 47 | + * const input = { // DescribeQPersonalizationConfigurationRequest |
| 48 | + * AwsAccountId: "STRING_VALUE", // required |
| 49 | + * }; |
| 50 | + * const command = new DescribeQPersonalizationConfigurationCommand(input); |
| 51 | + * const response = await client.send(command); |
| 52 | + * // { // DescribeQPersonalizationConfigurationResponse |
| 53 | + * // PersonalizationMode: "ENABLED" || "DISABLED", |
| 54 | + * // RequestId: "STRING_VALUE", |
| 55 | + * // Status: Number("int"), |
| 56 | + * // }; |
| 57 | + * |
| 58 | + * ``` |
| 59 | + * |
| 60 | + * @param DescribeQPersonalizationConfigurationCommandInput - {@link DescribeQPersonalizationConfigurationCommandInput} |
| 61 | + * @returns {@link DescribeQPersonalizationConfigurationCommandOutput} |
| 62 | + * @see {@link DescribeQPersonalizationConfigurationCommandInput} for command's `input` shape. |
| 63 | + * @see {@link DescribeQPersonalizationConfigurationCommandOutput} for command's `response` shape. |
| 64 | + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. |
| 65 | + * |
| 66 | + * @throws {@link AccessDeniedException} (client fault) |
| 67 | + * <p>You don't have access to this item. The provided credentials couldn't be |
| 68 | + * validated. You might not be authorized to carry out the request. Make sure that your |
| 69 | + * account is authorized to use the Amazon QuickSight service, that your policies have the |
| 70 | + * correct permissions, and that you are using the correct credentials.</p> |
| 71 | + * |
| 72 | + * @throws {@link ConflictException} (client fault) |
| 73 | + * <p>Updating or deleting a resource can cause an inconsistent state.</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 ResourceNotFoundException} (client fault) |
| 82 | + * <p>One or more resources can't be found.</p> |
| 83 | + * |
| 84 | + * @throws {@link ThrottlingException} (client fault) |
| 85 | + * <p>Access is throttled.</p> |
| 86 | + * |
| 87 | + * @throws {@link QuickSightServiceException} |
| 88 | + * <p>Base exception class for all service exceptions from QuickSight service.</p> |
| 89 | + * |
| 90 | + * @public |
| 91 | + */ |
| 92 | +export class DescribeQPersonalizationConfigurationCommand extends $Command |
| 93 | + .classBuilder< |
| 94 | + DescribeQPersonalizationConfigurationCommandInput, |
| 95 | + DescribeQPersonalizationConfigurationCommandOutput, |
| 96 | + QuickSightClientResolvedConfig, |
| 97 | + ServiceInputTypes, |
| 98 | + ServiceOutputTypes |
| 99 | + >() |
| 100 | + .ep(commonParams) |
| 101 | + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { |
| 102 | + return [ |
| 103 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 104 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 105 | + ]; |
| 106 | + }) |
| 107 | + .s("QuickSight_20180401", "DescribeQPersonalizationConfiguration", {}) |
| 108 | + .n("QuickSightClient", "DescribeQPersonalizationConfigurationCommand") |
| 109 | + .f(void 0, void 0) |
| 110 | + .ser(se_DescribeQPersonalizationConfigurationCommand) |
| 111 | + .de(de_DescribeQPersonalizationConfigurationCommand) |
| 112 | + .build() { |
| 113 | + /** @internal type navigation helper, not in runtime. */ |
| 114 | + protected declare static __types: { |
| 115 | + api: { |
| 116 | + input: DescribeQPersonalizationConfigurationRequest; |
| 117 | + output: DescribeQPersonalizationConfigurationResponse; |
| 118 | + }; |
| 119 | + sdk: { |
| 120 | + input: DescribeQPersonalizationConfigurationCommandInput; |
| 121 | + output: DescribeQPersonalizationConfigurationCommandOutput; |
| 122 | + }; |
| 123 | + }; |
| 124 | +} |
0 commit comments