|
| 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 { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient"; |
| 8 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 9 | +import { DescribeConfigurationTemplatesRequest, DescribeConfigurationTemplatesResponse } from "../models/models_0"; |
| 10 | +import { |
| 11 | + de_DescribeConfigurationTemplatesCommand, |
| 12 | + se_DescribeConfigurationTemplatesCommand, |
| 13 | +} from "../protocols/Aws_json1_1"; |
| 14 | + |
| 15 | +/** |
| 16 | + * @public |
| 17 | + */ |
| 18 | +export type { __MetadataBearer }; |
| 19 | +export { $Command }; |
| 20 | +/** |
| 21 | + * @public |
| 22 | + * |
| 23 | + * The input for {@link DescribeConfigurationTemplatesCommand}. |
| 24 | + */ |
| 25 | +export interface DescribeConfigurationTemplatesCommandInput extends DescribeConfigurationTemplatesRequest {} |
| 26 | +/** |
| 27 | + * @public |
| 28 | + * |
| 29 | + * The output of {@link DescribeConfigurationTemplatesCommand}. |
| 30 | + */ |
| 31 | +export interface DescribeConfigurationTemplatesCommandOutput |
| 32 | + extends DescribeConfigurationTemplatesResponse, |
| 33 | + __MetadataBearer {} |
| 34 | + |
| 35 | +/** |
| 36 | + * <p>Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. |
| 37 | + * For more information about deliveries, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>.</p> |
| 38 | + * @example |
| 39 | + * Use a bare-bones client and the command you need to make an API call. |
| 40 | + * ```javascript |
| 41 | + * import { CloudWatchLogsClient, DescribeConfigurationTemplatesCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import |
| 42 | + * // const { CloudWatchLogsClient, DescribeConfigurationTemplatesCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import |
| 43 | + * const client = new CloudWatchLogsClient(config); |
| 44 | + * const input = { // DescribeConfigurationTemplatesRequest |
| 45 | + * service: "STRING_VALUE", |
| 46 | + * logTypes: [ // LogTypes |
| 47 | + * "STRING_VALUE", |
| 48 | + * ], |
| 49 | + * resourceTypes: [ // ResourceTypes |
| 50 | + * "STRING_VALUE", |
| 51 | + * ], |
| 52 | + * deliveryDestinationTypes: [ // DeliveryDestinationTypes |
| 53 | + * "S3" || "CWL" || "FH", |
| 54 | + * ], |
| 55 | + * nextToken: "STRING_VALUE", |
| 56 | + * limit: Number("int"), |
| 57 | + * }; |
| 58 | + * const command = new DescribeConfigurationTemplatesCommand(input); |
| 59 | + * const response = await client.send(command); |
| 60 | + * // { // DescribeConfigurationTemplatesResponse |
| 61 | + * // configurationTemplates: [ // ConfigurationTemplates |
| 62 | + * // { // ConfigurationTemplate |
| 63 | + * // service: "STRING_VALUE", |
| 64 | + * // logType: "STRING_VALUE", |
| 65 | + * // resourceType: "STRING_VALUE", |
| 66 | + * // deliveryDestinationType: "S3" || "CWL" || "FH", |
| 67 | + * // defaultDeliveryConfigValues: { // ConfigurationTemplateDeliveryConfigValues |
| 68 | + * // recordFields: [ // RecordFields |
| 69 | + * // "STRING_VALUE", |
| 70 | + * // ], |
| 71 | + * // fieldDelimiter: "STRING_VALUE", |
| 72 | + * // s3DeliveryConfiguration: { // S3DeliveryConfiguration |
| 73 | + * // suffixPath: "STRING_VALUE", |
| 74 | + * // enableHiveCompatiblePath: true || false, |
| 75 | + * // }, |
| 76 | + * // }, |
| 77 | + * // allowedFields: [ // AllowedFields |
| 78 | + * // { // RecordField |
| 79 | + * // name: "STRING_VALUE", |
| 80 | + * // mandatory: true || false, |
| 81 | + * // }, |
| 82 | + * // ], |
| 83 | + * // allowedOutputFormats: [ // OutputFormats |
| 84 | + * // "json" || "plain" || "w3c" || "raw" || "parquet", |
| 85 | + * // ], |
| 86 | + * // allowedActionForAllowVendedLogsDeliveryForResource: "STRING_VALUE", |
| 87 | + * // allowedFieldDelimiters: [ // AllowedFieldDelimiters |
| 88 | + * // "STRING_VALUE", |
| 89 | + * // ], |
| 90 | + * // allowedSuffixPathFields: [ |
| 91 | + * // "STRING_VALUE", |
| 92 | + * // ], |
| 93 | + * // }, |
| 94 | + * // ], |
| 95 | + * // nextToken: "STRING_VALUE", |
| 96 | + * // }; |
| 97 | + * |
| 98 | + * ``` |
| 99 | + * |
| 100 | + * @param DescribeConfigurationTemplatesCommandInput - {@link DescribeConfigurationTemplatesCommandInput} |
| 101 | + * @returns {@link DescribeConfigurationTemplatesCommandOutput} |
| 102 | + * @see {@link DescribeConfigurationTemplatesCommandInput} for command's `input` shape. |
| 103 | + * @see {@link DescribeConfigurationTemplatesCommandOutput} for command's `response` shape. |
| 104 | + * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape. |
| 105 | + * |
| 106 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 107 | + * <p>The specified resource does not exist.</p> |
| 108 | + * |
| 109 | + * @throws {@link ServiceUnavailableException} (server fault) |
| 110 | + * <p>The service cannot complete the request.</p> |
| 111 | + * |
| 112 | + * @throws {@link ThrottlingException} (client fault) |
| 113 | + * <p>The request was throttled because of quota limits.</p> |
| 114 | + * |
| 115 | + * @throws {@link ValidationException} (client fault) |
| 116 | + * <p>One of the parameters for the request is not valid.</p> |
| 117 | + * |
| 118 | + * @throws {@link CloudWatchLogsServiceException} |
| 119 | + * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p> |
| 120 | + * |
| 121 | + * @public |
| 122 | + */ |
| 123 | +export class DescribeConfigurationTemplatesCommand extends $Command |
| 124 | + .classBuilder< |
| 125 | + DescribeConfigurationTemplatesCommandInput, |
| 126 | + DescribeConfigurationTemplatesCommandOutput, |
| 127 | + CloudWatchLogsClientResolvedConfig, |
| 128 | + ServiceInputTypes, |
| 129 | + ServiceOutputTypes |
| 130 | + >() |
| 131 | + .ep({ |
| 132 | + ...commonParams, |
| 133 | + }) |
| 134 | + .m(function (this: any, Command: any, cs: any, config: CloudWatchLogsClientResolvedConfig, o: any) { |
| 135 | + return [ |
| 136 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 137 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 138 | + ]; |
| 139 | + }) |
| 140 | + .s("Logs_20140328", "DescribeConfigurationTemplates", {}) |
| 141 | + .n("CloudWatchLogsClient", "DescribeConfigurationTemplatesCommand") |
| 142 | + .f(void 0, void 0) |
| 143 | + .ser(se_DescribeConfigurationTemplatesCommand) |
| 144 | + .de(de_DescribeConfigurationTemplatesCommand) |
| 145 | + .build() {} |
0 commit comments