|
| 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 { CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudTrailClient"; |
| 8 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 9 | +import { GetEventConfigurationRequest, GetEventConfigurationResponse } from "../models/models_0"; |
| 10 | +import { de_GetEventConfigurationCommand, se_GetEventConfigurationCommand } from "../protocols/Aws_json1_1"; |
| 11 | + |
| 12 | +/** |
| 13 | + * @public |
| 14 | + */ |
| 15 | +export type { __MetadataBearer }; |
| 16 | +export { $Command }; |
| 17 | +/** |
| 18 | + * @public |
| 19 | + * |
| 20 | + * The input for {@link GetEventConfigurationCommand}. |
| 21 | + */ |
| 22 | +export interface GetEventConfigurationCommandInput extends GetEventConfigurationRequest {} |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The output of {@link GetEventConfigurationCommand}. |
| 27 | + */ |
| 28 | +export interface GetEventConfigurationCommandOutput extends GetEventConfigurationResponse, __MetadataBearer {} |
| 29 | + |
| 30 | +/** |
| 31 | + * <p>Retrieves the current event configuration settings for the specified event data store, including details |
| 32 | + * about maximum event size and context key selectors configured for the event data store.</p> |
| 33 | + * @example |
| 34 | + * Use a bare-bones client and the command you need to make an API call. |
| 35 | + * ```javascript |
| 36 | + * import { CloudTrailClient, GetEventConfigurationCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import |
| 37 | + * // const { CloudTrailClient, GetEventConfigurationCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import |
| 38 | + * const client = new CloudTrailClient(config); |
| 39 | + * const input = { // GetEventConfigurationRequest |
| 40 | + * EventDataStore: "STRING_VALUE", |
| 41 | + * }; |
| 42 | + * const command = new GetEventConfigurationCommand(input); |
| 43 | + * const response = await client.send(command); |
| 44 | + * // { // GetEventConfigurationResponse |
| 45 | + * // EventDataStoreArn: "STRING_VALUE", |
| 46 | + * // MaxEventSize: "Standard" || "Large", |
| 47 | + * // ContextKeySelectors: [ // ContextKeySelectors |
| 48 | + * // { // ContextKeySelector |
| 49 | + * // Type: "TagContext" || "RequestContext", // required |
| 50 | + * // Equals: [ // OperatorTargetList // required |
| 51 | + * // "STRING_VALUE", |
| 52 | + * // ], |
| 53 | + * // }, |
| 54 | + * // ], |
| 55 | + * // }; |
| 56 | + * |
| 57 | + * ``` |
| 58 | + * |
| 59 | + * @param GetEventConfigurationCommandInput - {@link GetEventConfigurationCommandInput} |
| 60 | + * @returns {@link GetEventConfigurationCommandOutput} |
| 61 | + * @see {@link GetEventConfigurationCommandInput} for command's `input` shape. |
| 62 | + * @see {@link GetEventConfigurationCommandOutput} for command's `response` shape. |
| 63 | + * @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape. |
| 64 | + * |
| 65 | + * @throws {@link CloudTrailARNInvalidException} (client fault) |
| 66 | + * <p>This exception is thrown when an operation is called with an ARN that is not valid.</p> |
| 67 | + * <p>The following is the format of a trail ARN: <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code> |
| 68 | + * </p> |
| 69 | + * <p>The following is the format of an event data store ARN: |
| 70 | + * <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code> |
| 71 | + * </p> |
| 72 | + * <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code> |
| 73 | + * </p> |
| 74 | + * <p>The following is the format of a channel ARN: |
| 75 | + * <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code> |
| 76 | + * </p> |
| 77 | + * |
| 78 | + * @throws {@link EventDataStoreARNInvalidException} (client fault) |
| 79 | + * <p>The specified event data store ARN is not valid or does not map to an event data store |
| 80 | + * in your account.</p> |
| 81 | + * |
| 82 | + * @throws {@link EventDataStoreNotFoundException} (client fault) |
| 83 | + * <p>The specified event data store was not found.</p> |
| 84 | + * |
| 85 | + * @throws {@link InvalidEventDataStoreCategoryException} (client fault) |
| 86 | + * <p>This exception is thrown when event categories of specified event data stores are not |
| 87 | + * valid.</p> |
| 88 | + * |
| 89 | + * @throws {@link InvalidEventDataStoreStatusException} (client fault) |
| 90 | + * <p>The event data store is not in a status that supports the operation.</p> |
| 91 | + * |
| 92 | + * @throws {@link InvalidParameterCombinationException} (client fault) |
| 93 | + * <p>This exception is thrown when the combination of parameters provided is not |
| 94 | + * valid.</p> |
| 95 | + * |
| 96 | + * @throws {@link InvalidParameterException} (client fault) |
| 97 | + * <p>The request includes a parameter that is not valid.</p> |
| 98 | + * |
| 99 | + * @throws {@link NoManagementAccountSLRExistsException} (client fault) |
| 100 | + * <p> This exception is thrown when the management account does not have a service-linked |
| 101 | + * role. </p> |
| 102 | + * |
| 103 | + * @throws {@link OperationNotPermittedException} (client fault) |
| 104 | + * <p>This exception is thrown when the requested operation is not permitted.</p> |
| 105 | + * |
| 106 | + * @throws {@link UnsupportedOperationException} (client fault) |
| 107 | + * <p>This exception is thrown when the requested operation is not supported.</p> |
| 108 | + * |
| 109 | + * @throws {@link CloudTrailServiceException} |
| 110 | + * <p>Base exception class for all service exceptions from CloudTrail service.</p> |
| 111 | + * |
| 112 | + * |
| 113 | + * @public |
| 114 | + */ |
| 115 | +export class GetEventConfigurationCommand extends $Command |
| 116 | + .classBuilder< |
| 117 | + GetEventConfigurationCommandInput, |
| 118 | + GetEventConfigurationCommandOutput, |
| 119 | + CloudTrailClientResolvedConfig, |
| 120 | + ServiceInputTypes, |
| 121 | + ServiceOutputTypes |
| 122 | + >() |
| 123 | + .ep(commonParams) |
| 124 | + .m(function (this: any, Command: any, cs: any, config: CloudTrailClientResolvedConfig, o: any) { |
| 125 | + return [ |
| 126 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 127 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 128 | + ]; |
| 129 | + }) |
| 130 | + .s("CloudTrail_20131101", "GetEventConfiguration", {}) |
| 131 | + .n("CloudTrailClient", "GetEventConfigurationCommand") |
| 132 | + .f(void 0, void 0) |
| 133 | + .ser(se_GetEventConfigurationCommand) |
| 134 | + .de(de_GetEventConfigurationCommand) |
| 135 | + .build() { |
| 136 | + /** @internal type navigation helper, not in runtime. */ |
| 137 | + protected declare static __types: { |
| 138 | + api: { |
| 139 | + input: GetEventConfigurationRequest; |
| 140 | + output: GetEventConfigurationResponse; |
| 141 | + }; |
| 142 | + sdk: { |
| 143 | + input: GetEventConfigurationCommandInput; |
| 144 | + output: GetEventConfigurationCommandOutput; |
| 145 | + }; |
| 146 | + }; |
| 147 | +} |
0 commit comments