Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) +resources and the applications you run on Amazon Web Services in real time. You can use +CloudWatch to collect and track metrics, which are the variables you want to +measure for your resources and applications.
+CloudWatch alarms send notifications or automatically change the resources you are +monitoring based on rules that you define. For example, you can monitor the CPU usage +and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine +whether you should launch additional instances to handle increased load. You can also +use this data to stop under-used instances to save money.
+In addition to monitoring the built-in metrics that come with Amazon Web Services, +you can monitor your own custom metrics. With CloudWatch, you gain system-wide +visibility into resource utilization, application performance, and operational +health.
+ +## Installing + +To install this package, simply type add or install @aws-sdk/client-cloudwatch +using your favorite package manager: + +- `npm install @aws-sdk/client-cloudwatch` +- `yarn add @aws-sdk/client-cloudwatch` +- `pnpm add @aws-sdk/client-cloudwatch` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `CloudWatchClient` and +the commands you need, for example `ListMetricsCommand`: + +```js +// ES5 example +const { CloudWatchClient, ListMetricsCommand } = require("@aws-sdk/client-cloudwatch"); +``` + +```ts +// ES6+ example +import { CloudWatchClient, ListMetricsCommand } from "@aws-sdk/client-cloudwatch"; +``` + +### Usage + +To send a request, you: + +- Initiate client with configuration (e.g. credentials, region). +- Initiate command with input parameters. +- Call `send` operation on client with command object as input. +- If you are using a custom http handler, you may call `destroy()` to close open connections. + +```js +// a client can be shared by different commands. +const client = new CloudWatchClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new ListMetricsCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // process err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-cloudwatch"; +const client = new AWS.CloudWatch({ region: "REGION" }); + +// async/await. +try { + const data = await client.listMetrics(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .listMetrics(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.listMetrics(params, (err, data) => { + // process err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-cloudwatch` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. + +## Client Commands (Operations List) + +Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) + * resources and the applications you run on Amazon Web Services in real time. You can use + * CloudWatch to collect and track metrics, which are the variables you want to + * measure for your resources and applications.
+ *CloudWatch alarms send notifications or automatically change the resources you are + * monitoring based on rules that you define. For example, you can monitor the CPU usage + * and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine + * whether you should launch additional instances to handle increased load. You can also + * use this data to stop under-used instances to save money.
+ *In addition to monitoring the built-in metrics that come with Amazon Web Services, + * you can monitor your own custom metrics. With CloudWatch, you gain system-wide + * visibility into resource utilization, application performance, and operational + * health.
+ * @public + */ +export class CloudWatch extends CloudWatchClient implements CloudWatch {} +createAggregatedClient(commands, CloudWatch); diff --git a/clients/client-cloudwatch-cbor/src/CloudWatchClient.ts b/clients/client-cloudwatch-cbor/src/CloudWatchClient.ts new file mode 100644 index 000000000000..24cee6713537 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/CloudWatchClient.ts @@ -0,0 +1,474 @@ +// smithy-typescript generated code +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver"; +import { + DefaultIdentityProviderConfig, + getHttpAuthSchemeEndpointRuleSetPlugin, + getHttpSigningPlugin, +} from "@smithy/core"; +import { + CompressionInputConfig, + CompressionResolvedConfig, + resolveCompressionConfig, +} from "@smithy/middleware-compression"; +import { getContentLengthPlugin } from "@smithy/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint"; +import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"; +import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http"; +import { + Client as __Client, + DefaultsMode as __DefaultsMode, + SmithyConfiguration as __SmithyConfiguration, + SmithyResolvedConfiguration as __SmithyResolvedConfiguration, +} from "@smithy/smithy-client"; +import { + AwsCredentialIdentityProvider, + BodyLengthCalculator as __BodyLengthCalculator, + CheckOptionalClientConfig as __CheckOptionalClientConfig, + ChecksumConstructor as __ChecksumConstructor, + Decoder as __Decoder, + Encoder as __Encoder, + EndpointV2 as __EndpointV2, + HashConstructor as __HashConstructor, + HttpHandlerOptions as __HttpHandlerOptions, + Logger as __Logger, + Provider as __Provider, + Provider, + StreamCollector as __StreamCollector, + UrlParser as __UrlParser, + UserAgent as __UserAgent, +} from "@smithy/types"; + +import { + defaultCloudWatchHttpAuthSchemeParametersProvider, + HttpAuthSchemeInputConfig, + HttpAuthSchemeResolvedConfig, + resolveHttpAuthSchemeConfig, +} from "./auth/httpAuthSchemeProvider"; +import { DeleteAlarmsCommandInput, DeleteAlarmsCommandOutput } from "./commands/DeleteAlarmsCommand"; +import { + DeleteAnomalyDetectorCommandInput, + DeleteAnomalyDetectorCommandOutput, +} from "./commands/DeleteAnomalyDetectorCommand"; +import { DeleteDashboardsCommandInput, DeleteDashboardsCommandOutput } from "./commands/DeleteDashboardsCommand"; +import { DeleteInsightRulesCommandInput, DeleteInsightRulesCommandOutput } from "./commands/DeleteInsightRulesCommand"; +import { DeleteMetricStreamCommandInput, DeleteMetricStreamCommandOutput } from "./commands/DeleteMetricStreamCommand"; +import { + DescribeAlarmHistoryCommandInput, + DescribeAlarmHistoryCommandOutput, +} from "./commands/DescribeAlarmHistoryCommand"; +import { DescribeAlarmsCommandInput, DescribeAlarmsCommandOutput } from "./commands/DescribeAlarmsCommand"; +import { + DescribeAlarmsForMetricCommandInput, + DescribeAlarmsForMetricCommandOutput, +} from "./commands/DescribeAlarmsForMetricCommand"; +import { + DescribeAnomalyDetectorsCommandInput, + DescribeAnomalyDetectorsCommandOutput, +} from "./commands/DescribeAnomalyDetectorsCommand"; +import { + DescribeInsightRulesCommandInput, + DescribeInsightRulesCommandOutput, +} from "./commands/DescribeInsightRulesCommand"; +import { + DisableAlarmActionsCommandInput, + DisableAlarmActionsCommandOutput, +} from "./commands/DisableAlarmActionsCommand"; +import { + DisableInsightRulesCommandInput, + DisableInsightRulesCommandOutput, +} from "./commands/DisableInsightRulesCommand"; +import { EnableAlarmActionsCommandInput, EnableAlarmActionsCommandOutput } from "./commands/EnableAlarmActionsCommand"; +import { EnableInsightRulesCommandInput, EnableInsightRulesCommandOutput } from "./commands/EnableInsightRulesCommand"; +import { GetDashboardCommandInput, GetDashboardCommandOutput } from "./commands/GetDashboardCommand"; +import { + GetInsightRuleReportCommandInput, + GetInsightRuleReportCommandOutput, +} from "./commands/GetInsightRuleReportCommand"; +import { GetMetricDataCommandInput, GetMetricDataCommandOutput } from "./commands/GetMetricDataCommand"; +import { + GetMetricStatisticsCommandInput, + GetMetricStatisticsCommandOutput, +} from "./commands/GetMetricStatisticsCommand"; +import { GetMetricStreamCommandInput, GetMetricStreamCommandOutput } from "./commands/GetMetricStreamCommand"; +import { + GetMetricWidgetImageCommandInput, + GetMetricWidgetImageCommandOutput, +} from "./commands/GetMetricWidgetImageCommand"; +import { ListDashboardsCommandInput, ListDashboardsCommandOutput } from "./commands/ListDashboardsCommand"; +import { + ListManagedInsightRulesCommandInput, + ListManagedInsightRulesCommandOutput, +} from "./commands/ListManagedInsightRulesCommand"; +import { ListMetricsCommandInput, ListMetricsCommandOutput } from "./commands/ListMetricsCommand"; +import { ListMetricStreamsCommandInput, ListMetricStreamsCommandOutput } from "./commands/ListMetricStreamsCommand"; +import { + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "./commands/ListTagsForResourceCommand"; +import { PutAnomalyDetectorCommandInput, PutAnomalyDetectorCommandOutput } from "./commands/PutAnomalyDetectorCommand"; +import { PutCompositeAlarmCommandInput, PutCompositeAlarmCommandOutput } from "./commands/PutCompositeAlarmCommand"; +import { PutDashboardCommandInput, PutDashboardCommandOutput } from "./commands/PutDashboardCommand"; +import { PutInsightRuleCommandInput, PutInsightRuleCommandOutput } from "./commands/PutInsightRuleCommand"; +import { + PutManagedInsightRulesCommandInput, + PutManagedInsightRulesCommandOutput, +} from "./commands/PutManagedInsightRulesCommand"; +import { PutMetricAlarmCommandInput, PutMetricAlarmCommandOutput } from "./commands/PutMetricAlarmCommand"; +import { PutMetricDataCommandInput, PutMetricDataCommandOutput } from "./commands/PutMetricDataCommand"; +import { PutMetricStreamCommandInput, PutMetricStreamCommandOutput } from "./commands/PutMetricStreamCommand"; +import { SetAlarmStateCommandInput, SetAlarmStateCommandOutput } from "./commands/SetAlarmStateCommand"; +import { StartMetricStreamsCommandInput, StartMetricStreamsCommandOutput } from "./commands/StartMetricStreamsCommand"; +import { StopMetricStreamsCommandInput, StopMetricStreamsCommandOutput } from "./commands/StopMetricStreamsCommand"; +import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; +import { + ClientInputEndpointParameters, + ClientResolvedEndpointParameters, + EndpointParameters, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; +import { resolveRuntimeExtensions, RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions"; + +export { __Client }; + +/** + * @public + */ +export type ServiceInputTypes = + | DeleteAlarmsCommandInput + | DeleteAnomalyDetectorCommandInput + | DeleteDashboardsCommandInput + | DeleteInsightRulesCommandInput + | DeleteMetricStreamCommandInput + | DescribeAlarmHistoryCommandInput + | DescribeAlarmsCommandInput + | DescribeAlarmsForMetricCommandInput + | DescribeAnomalyDetectorsCommandInput + | DescribeInsightRulesCommandInput + | DisableAlarmActionsCommandInput + | DisableInsightRulesCommandInput + | EnableAlarmActionsCommandInput + | EnableInsightRulesCommandInput + | GetDashboardCommandInput + | GetInsightRuleReportCommandInput + | GetMetricDataCommandInput + | GetMetricStatisticsCommandInput + | GetMetricStreamCommandInput + | GetMetricWidgetImageCommandInput + | ListDashboardsCommandInput + | ListManagedInsightRulesCommandInput + | ListMetricStreamsCommandInput + | ListMetricsCommandInput + | ListTagsForResourceCommandInput + | PutAnomalyDetectorCommandInput + | PutCompositeAlarmCommandInput + | PutDashboardCommandInput + | PutInsightRuleCommandInput + | PutManagedInsightRulesCommandInput + | PutMetricAlarmCommandInput + | PutMetricDataCommandInput + | PutMetricStreamCommandInput + | SetAlarmStateCommandInput + | StartMetricStreamsCommandInput + | StopMetricStreamsCommandInput + | TagResourceCommandInput + | UntagResourceCommandInput; + +/** + * @public + */ +export type ServiceOutputTypes = + | DeleteAlarmsCommandOutput + | DeleteAnomalyDetectorCommandOutput + | DeleteDashboardsCommandOutput + | DeleteInsightRulesCommandOutput + | DeleteMetricStreamCommandOutput + | DescribeAlarmHistoryCommandOutput + | DescribeAlarmsCommandOutput + | DescribeAlarmsForMetricCommandOutput + | DescribeAnomalyDetectorsCommandOutput + | DescribeInsightRulesCommandOutput + | DisableAlarmActionsCommandOutput + | DisableInsightRulesCommandOutput + | EnableAlarmActionsCommandOutput + | EnableInsightRulesCommandOutput + | GetDashboardCommandOutput + | GetInsightRuleReportCommandOutput + | GetMetricDataCommandOutput + | GetMetricStatisticsCommandOutput + | GetMetricStreamCommandOutput + | GetMetricWidgetImageCommandOutput + | ListDashboardsCommandOutput + | ListManagedInsightRulesCommandOutput + | ListMetricStreamsCommandOutput + | ListMetricsCommandOutput + | ListTagsForResourceCommandOutput + | PutAnomalyDetectorCommandOutput + | PutCompositeAlarmCommandOutput + | PutDashboardCommandOutput + | PutInsightRuleCommandOutput + | PutManagedInsightRulesCommandOutput + | PutMetricAlarmCommandOutput + | PutMetricDataCommandOutput + | PutMetricStreamCommandOutput + | SetAlarmStateCommandOutput + | StartMetricStreamsCommandOutput + | StopMetricStreamsCommandOutput + | TagResourceCommandOutput + | UntagResourceCommandOutput; + +/** + * @public + */ +export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> { + /** + * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. + */ + requestHandler?: __HttpHandlerUserInput; + + /** + * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface + * that computes the SHA-256 HMAC or checksum of a string or binary buffer. + * @internal + */ + sha256?: __ChecksumConstructor | __HashConstructor; + + /** + * The function that will be used to convert strings into HTTP endpoints. + * @internal + */ + urlParser?: __UrlParser; + + /** + * A function that can calculate the length of a request body. + * @internal + */ + bodyLengthChecker?: __BodyLengthCalculator; + + /** + * A function that converts a stream into an array of bytes. + * @internal + */ + streamCollector?: __StreamCollector; + + /** + * The function that will be used to convert a base64-encoded string to a byte array. + * @internal + */ + base64Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a base64-encoded string. + * @internal + */ + base64Encoder?: __Encoder; + + /** + * The function that will be used to convert a UTF8-encoded string to a byte array. + * @internal + */ + utf8Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a UTF-8 encoded string. + * @internal + */ + utf8Encoder?: __Encoder; + + /** + * The runtime environment. + * @internal + */ + runtime?: string; + + /** + * Disable dynamically changing the endpoint of the client based on the hostPrefix + * trait of an operation. + */ + disableHostPrefix?: boolean; + + /** + * Unique service identifier. + * @internal + */ + serviceId?: string; + + /** + * Enables IPv6/IPv4 dualstack endpoint. + */ + useDualstackEndpoint?: boolean | __ProviderAmazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) + * resources and the applications you run on Amazon Web Services in real time. You can use + * CloudWatch to collect and track metrics, which are the variables you want to + * measure for your resources and applications.
+ *CloudWatch alarms send notifications or automatically change the resources you are + * monitoring based on rules that you define. For example, you can monitor the CPU usage + * and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine + * whether you should launch additional instances to handle increased load. You can also + * use this data to stop under-used instances to save money.
+ *In addition to monitoring the built-in metrics that come with Amazon Web Services, + * you can monitor your own custom metrics. With CloudWatch, you gain system-wide + * visibility into resource utilization, application performance, and operational + * health.
+ * @public + */ +export class CloudWatchClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + CloudWatchClientResolvedConfig +> { + /** + * The resolved configuration of CloudWatchClient class. This is resolved and normalized from the {@link CloudWatchClientConfig | constructor configuration interface}. + */ + readonly config: CloudWatchClientResolvedConfig; + + constructor(...[configuration]: __CheckOptionalClientConfigDeletes the specified alarms. You can delete up to 100 alarms in one operation. + * However, this total can include no more than one composite alarm. For example, you could + * delete 99 metric alarms and one composite alarms with one operation, but you can't + * delete two composite alarms with one operation.
+ * If you specify an incorrect alarm name or make any other error in the operation,
+ * no alarms are deleted. To confirm that alarms were deleted successfully, you can use the
+ * DescribeAlarms operation after using DeleteAlarms.
It is possible to create a loop or cycle of composite alarms, where composite + * alarm A depends on composite alarm B, and composite alarm B also depends on + * composite alarm A. In this scenario, you can't delete any composite alarm that is + * part of the cycle because there is always still a composite alarm that depends on + * that alarm that you want to delete.
+ *To get out of such a situation, you must break the cycle by changing the rule of
+ * one of the composite alarms in the cycle to remove a dependency that creates the
+ * cycle. The simplest change to make to break a cycle is to change the
+ * AlarmRule of one of the alarms to false.
Additionally, the evaluation of composite alarms stops if CloudWatch + * detects a cycle in the evaluation path.
+ *The named resource does not exist.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DeleteAlarmsCommand extends $Command + .classBuilder< + DeleteAlarmsCommandInput, + DeleteAlarmsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DeleteAlarms", {}) + .n("CloudWatchClient", "DeleteAlarmsCommand") + .f(void 0, void 0) + .ser(se_DeleteAlarmsCommand) + .de(de_DeleteAlarmsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteAlarmsInput; + output: {}; + }; + sdk: { + input: DeleteAlarmsCommandInput; + output: DeleteAlarmsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/DeleteAnomalyDetectorCommand.ts b/clients/client-cloudwatch-cbor/src/commands/DeleteAnomalyDetectorCommand.ts new file mode 100644 index 000000000000..f35dc53dd404 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/DeleteAnomalyDetectorCommand.ts @@ -0,0 +1,150 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteAnomalyDetectorInput, DeleteAnomalyDetectorOutput } from "../models/models_0"; +import { de_DeleteAnomalyDetectorCommand, se_DeleteAnomalyDetectorCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteAnomalyDetectorCommand}. + */ +export interface DeleteAnomalyDetectorCommandInput extends DeleteAnomalyDetectorInput {} +/** + * @public + * + * The output of {@link DeleteAnomalyDetectorCommand}. + */ +export interface DeleteAnomalyDetectorCommandOutput extends DeleteAnomalyDetectorOutput, __MetadataBearer {} + +/** + *Deletes the specified anomaly detection model from your account. For more information + * about how to delete an anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User + * Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DeleteAnomalyDetectorCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DeleteAnomalyDetectorCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // DeleteAnomalyDetectorInput + * Namespace: "STRING_VALUE", + * MetricName: "STRING_VALUE", + * Dimensions: [ // Dimensions + * { // Dimension + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * Stat: "STRING_VALUE", + * SingleMetricAnomalyDetector: { // SingleMetricAnomalyDetector + * AccountId: "STRING_VALUE", + * Namespace: "STRING_VALUE", + * MetricName: "STRING_VALUE", + * Dimensions: [ + * { + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * Stat: "STRING_VALUE", + * }, + * MetricMathAnomalyDetector: { // MetricMathAnomalyDetector + * MetricDataQueries: [ // MetricDataQueries + * { // MetricDataQuery + * Id: "STRING_VALUE", // required + * MetricStat: { // MetricStat + * Metric: { // Metric + * Namespace: "STRING_VALUE", + * MetricName: "STRING_VALUE", + * Dimensions: "Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterCombinationException} (client fault) + *Parameters were used together that cannot be used together.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The named resource does not exist.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DeleteAnomalyDetectorCommand extends $Command + .classBuilder< + DeleteAnomalyDetectorCommandInput, + DeleteAnomalyDetectorCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DeleteAnomalyDetector", {}) + .n("CloudWatchClient", "DeleteAnomalyDetectorCommand") + .f(void 0, void 0) + .ser(se_DeleteAnomalyDetectorCommand) + .de(de_DeleteAnomalyDetectorCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteAnomalyDetectorInput; + output: {}; + }; + sdk: { + input: DeleteAnomalyDetectorCommandInput; + output: DeleteAnomalyDetectorCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/DeleteDashboardsCommand.ts b/clients/client-cloudwatch-cbor/src/commands/DeleteDashboardsCommand.ts new file mode 100644 index 000000000000..6f94d6a7fdc4 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/DeleteDashboardsCommand.ts @@ -0,0 +1,103 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteDashboardsInput, DeleteDashboardsOutput } from "../models/models_0"; +import { de_DeleteDashboardsCommand, se_DeleteDashboardsCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteDashboardsCommand}. + */ +export interface DeleteDashboardsCommandInput extends DeleteDashboardsInput {} +/** + * @public + * + * The output of {@link DeleteDashboardsCommand}. + */ +export interface DeleteDashboardsCommandOutput extends DeleteDashboardsOutput, __MetadataBearer {} + +/** + *Deletes all dashboards that you specify. You can specify up to 100 dashboards to + * delete. If there is an error during this call, no dashboards are deleted.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DeleteDashboardsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DeleteDashboardsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // DeleteDashboardsInput + * DashboardNames: [ // DashboardNames // required + * "STRING_VALUE", + * ], + * }; + * const command = new DeleteDashboardsCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteDashboardsCommandInput - {@link DeleteDashboardsCommandInput} + * @returns {@link DeleteDashboardsCommandOutput} + * @see {@link DeleteDashboardsCommandInput} for command's `input` shape. + * @see {@link DeleteDashboardsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link DashboardNotFoundError} (client fault) + *The specified dashboard does not exist.
+ * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DeleteDashboardsCommand extends $Command + .classBuilder< + DeleteDashboardsCommandInput, + DeleteDashboardsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DeleteDashboards", {}) + .n("CloudWatchClient", "DeleteDashboardsCommand") + .f(void 0, void 0) + .ser(se_DeleteDashboardsCommand) + .de(de_DeleteDashboardsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteDashboardsInput; + output: {}; + }; + sdk: { + input: DeleteDashboardsCommandInput; + output: DeleteDashboardsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/DeleteInsightRulesCommand.ts b/clients/client-cloudwatch-cbor/src/commands/DeleteInsightRulesCommand.ts new file mode 100644 index 000000000000..8305efc4c231 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/DeleteInsightRulesCommand.ts @@ -0,0 +1,109 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteInsightRulesInput, DeleteInsightRulesOutput } from "../models/models_0"; +import { de_DeleteInsightRulesCommand, se_DeleteInsightRulesCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteInsightRulesCommand}. + */ +export interface DeleteInsightRulesCommandInput extends DeleteInsightRulesInput {} +/** + * @public + * + * The output of {@link DeleteInsightRulesCommand}. + */ +export interface DeleteInsightRulesCommandOutput extends DeleteInsightRulesOutput, __MetadataBearer {} + +/** + *Permanently deletes the specified Contributor Insights rules.
+ *If you create a rule, delete it, and then re-create it with the same name, historical + * data from the first time the rule was created might not be available.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DeleteInsightRulesCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DeleteInsightRulesCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // DeleteInsightRulesInput + * RuleNames: [ // InsightRuleNames // required + * "STRING_VALUE", + * ], + * }; + * const command = new DeleteInsightRulesCommand(input); + * const response = await client.send(command); + * // { // DeleteInsightRulesOutput + * // Failures: [ // BatchFailures + * // { // PartialFailure + * // FailureResource: "STRING_VALUE", + * // ExceptionType: "STRING_VALUE", + * // FailureCode: "STRING_VALUE", + * // FailureDescription: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param DeleteInsightRulesCommandInput - {@link DeleteInsightRulesCommandInput} + * @returns {@link DeleteInsightRulesCommandOutput} + * @see {@link DeleteInsightRulesCommandInput} for command's `input` shape. + * @see {@link DeleteInsightRulesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DeleteInsightRulesCommand extends $Command + .classBuilder< + DeleteInsightRulesCommandInput, + DeleteInsightRulesCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DeleteInsightRules", {}) + .n("CloudWatchClient", "DeleteInsightRulesCommand") + .f(void 0, void 0) + .ser(se_DeleteInsightRulesCommand) + .de(de_DeleteInsightRulesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteInsightRulesInput; + output: DeleteInsightRulesOutput; + }; + sdk: { + input: DeleteInsightRulesCommandInput; + output: DeleteInsightRulesCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/DeleteMetricStreamCommand.ts b/clients/client-cloudwatch-cbor/src/commands/DeleteMetricStreamCommand.ts new file mode 100644 index 000000000000..401d6323b678 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/DeleteMetricStreamCommand.ts @@ -0,0 +1,100 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteMetricStreamInput, DeleteMetricStreamOutput } from "../models/models_0"; +import { de_DeleteMetricStreamCommand, se_DeleteMetricStreamCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteMetricStreamCommand}. + */ +export interface DeleteMetricStreamCommandInput extends DeleteMetricStreamInput {} +/** + * @public + * + * The output of {@link DeleteMetricStreamCommand}. + */ +export interface DeleteMetricStreamCommandOutput extends DeleteMetricStreamOutput, __MetadataBearer {} + +/** + *Permanently deletes the metric stream that you specify.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DeleteMetricStreamCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DeleteMetricStreamCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // DeleteMetricStreamInput + * Name: "STRING_VALUE", // required + * }; + * const command = new DeleteMetricStreamCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteMetricStreamCommandInput - {@link DeleteMetricStreamCommandInput} + * @returns {@link DeleteMetricStreamCommandOutput} + * @see {@link DeleteMetricStreamCommandInput} for command's `input` shape. + * @see {@link DeleteMetricStreamCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DeleteMetricStreamCommand extends $Command + .classBuilder< + DeleteMetricStreamCommandInput, + DeleteMetricStreamCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DeleteMetricStream", {}) + .n("CloudWatchClient", "DeleteMetricStreamCommand") + .f(void 0, void 0) + .ser(se_DeleteMetricStreamCommand) + .de(de_DeleteMetricStreamCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteMetricStreamInput; + output: {}; + }; + sdk: { + input: DeleteMetricStreamCommandInput; + output: DeleteMetricStreamCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/DescribeAlarmHistoryCommand.ts b/clients/client-cloudwatch-cbor/src/commands/DescribeAlarmHistoryCommand.ts new file mode 100644 index 000000000000..deb7e1aec2a7 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/DescribeAlarmHistoryCommand.ts @@ -0,0 +1,121 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeAlarmHistoryInput, DescribeAlarmHistoryOutput } from "../models/models_0"; +import { de_DescribeAlarmHistoryCommand, se_DescribeAlarmHistoryCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeAlarmHistoryCommand}. + */ +export interface DescribeAlarmHistoryCommandInput extends DescribeAlarmHistoryInput {} +/** + * @public + * + * The output of {@link DescribeAlarmHistoryCommand}. + */ +export interface DescribeAlarmHistoryCommandOutput extends DescribeAlarmHistoryOutput, __MetadataBearer {} + +/** + *Retrieves the history for the specified alarm. You can filter the results by date + * range or item type. If an alarm name is not specified, the histories for either all + * metric alarms or all composite alarms are returned.
+ *CloudWatch retains the history of an alarm even if you delete the alarm.
+ *To use this operation and return information about a composite alarm, you must be
+ * signed on with the cloudwatch:DescribeAlarmHistory permission that is
+ * scoped to *. You can't return information about composite alarms if your
+ * cloudwatch:DescribeAlarmHistory permission has a narrower scope.
The next token specified is invalid.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DescribeAlarmHistoryCommand extends $Command + .classBuilder< + DescribeAlarmHistoryCommandInput, + DescribeAlarmHistoryCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DescribeAlarmHistory", {}) + .n("CloudWatchClient", "DescribeAlarmHistoryCommand") + .f(void 0, void 0) + .ser(se_DescribeAlarmHistoryCommand) + .de(de_DescribeAlarmHistoryCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeAlarmHistoryInput; + output: DescribeAlarmHistoryOutput; + }; + sdk: { + input: DescribeAlarmHistoryCommandInput; + output: DescribeAlarmHistoryCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/DescribeAlarmsCommand.ts b/clients/client-cloudwatch-cbor/src/commands/DescribeAlarmsCommand.ts new file mode 100644 index 000000000000..62d5bd35236e --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/DescribeAlarmsCommand.ts @@ -0,0 +1,207 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeAlarmsInput, DescribeAlarmsOutput } from "../models/models_0"; +import { de_DescribeAlarmsCommand, se_DescribeAlarmsCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeAlarmsCommand}. + */ +export interface DescribeAlarmsCommandInput extends DescribeAlarmsInput {} +/** + * @public + * + * The output of {@link DescribeAlarmsCommand}. + */ +export interface DescribeAlarmsCommandOutput extends DescribeAlarmsOutput, __MetadataBearer {} + +/** + *Retrieves the specified alarms. You can filter the results by specifying a prefix + * for the alarm name, the alarm state, or a prefix for any action.
+ *To use this operation and return information about composite alarms, you must be
+ * signed on with the cloudwatch:DescribeAlarms permission that is scoped to
+ * *. You can't return information about composite alarms if your
+ * cloudwatch:DescribeAlarms permission has a narrower scope.
The next token specified is invalid.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DescribeAlarmsCommand extends $Command + .classBuilder< + DescribeAlarmsCommandInput, + DescribeAlarmsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DescribeAlarms", {}) + .n("CloudWatchClient", "DescribeAlarmsCommand") + .f(void 0, void 0) + .ser(se_DescribeAlarmsCommand) + .de(de_DescribeAlarmsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeAlarmsInput; + output: DescribeAlarmsOutput; + }; + sdk: { + input: DescribeAlarmsCommandInput; + output: DescribeAlarmsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/DescribeAlarmsForMetricCommand.ts b/clients/client-cloudwatch-cbor/src/commands/DescribeAlarmsForMetricCommand.ts new file mode 100644 index 000000000000..ebd50418e426 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/DescribeAlarmsForMetricCommand.ts @@ -0,0 +1,174 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeAlarmsForMetricInput, DescribeAlarmsForMetricOutput } from "../models/models_0"; +import { de_DescribeAlarmsForMetricCommand, se_DescribeAlarmsForMetricCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeAlarmsForMetricCommand}. + */ +export interface DescribeAlarmsForMetricCommandInput extends DescribeAlarmsForMetricInput {} +/** + * @public + * + * The output of {@link DescribeAlarmsForMetricCommand}. + */ +export interface DescribeAlarmsForMetricCommandOutput extends DescribeAlarmsForMetricOutput, __MetadataBearer {} + +/** + *Retrieves the alarms for the specified metric. To filter the results, specify a + * statistic, period, or unit.
+ *This operation retrieves only standard alarms that are based on the specified + * metric. It does not return alarms based on math expressions that use the specified + * metric, or composite alarms that use the specified metric.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DescribeAlarmsForMetricCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DescribeAlarmsForMetricCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // DescribeAlarmsForMetricInput + * MetricName: "STRING_VALUE", // required + * Namespace: "STRING_VALUE", // required + * Statistic: "SampleCount" || "Average" || "Sum" || "Minimum" || "Maximum", + * ExtendedStatistic: "STRING_VALUE", + * Dimensions: [ // Dimensions + * { // Dimension + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * Period: Number("int"), + * Unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None", + * }; + * const command = new DescribeAlarmsForMetricCommand(input); + * const response = await client.send(command); + * // { // DescribeAlarmsForMetricOutput + * // MetricAlarms: [ // MetricAlarms + * // { // MetricAlarm + * // AlarmName: "STRING_VALUE", + * // AlarmArn: "STRING_VALUE", + * // AlarmDescription: "STRING_VALUE", + * // AlarmConfigurationUpdatedTimestamp: new Date("TIMESTAMP"), + * // ActionsEnabled: true || false, + * // OKActions: [ // ResourceList + * // "STRING_VALUE", + * // ], + * // AlarmActions: [ + * // "STRING_VALUE", + * // ], + * // InsufficientDataActions: [ + * // "STRING_VALUE", + * // ], + * // StateValue: "OK" || "ALARM" || "INSUFFICIENT_DATA", + * // StateReason: "STRING_VALUE", + * // StateReasonData: "STRING_VALUE", + * // StateUpdatedTimestamp: new Date("TIMESTAMP"), + * // MetricName: "STRING_VALUE", + * // Namespace: "STRING_VALUE", + * // Statistic: "SampleCount" || "Average" || "Sum" || "Minimum" || "Maximum", + * // ExtendedStatistic: "STRING_VALUE", + * // Dimensions: [ // Dimensions + * // { // Dimension + * // Name: "STRING_VALUE", // required + * // Value: "STRING_VALUE", // required + * // }, + * // ], + * // Period: Number("int"), + * // Unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None", + * // EvaluationPeriods: Number("int"), + * // DatapointsToAlarm: Number("int"), + * // Threshold: Number("double"), + * // ComparisonOperator: "GreaterThanOrEqualToThreshold" || "GreaterThanThreshold" || "LessThanThreshold" || "LessThanOrEqualToThreshold" || "LessThanLowerOrGreaterThanUpperThreshold" || "LessThanLowerThreshold" || "GreaterThanUpperThreshold", + * // TreatMissingData: "STRING_VALUE", + * // EvaluateLowSampleCountPercentile: "STRING_VALUE", + * // Metrics: [ // MetricDataQueries + * // { // MetricDataQuery + * // Id: "STRING_VALUE", // required + * // MetricStat: { // MetricStat + * // Metric: { // Metric + * // Namespace: "STRING_VALUE", + * // MetricName: "STRING_VALUE", + * // Dimensions: [ + * // { + * // Name: "STRING_VALUE", // required + * // Value: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // Period: Number("int"), // required + * // Stat: "STRING_VALUE", // required + * // Unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None", + * // }, + * // Expression: "STRING_VALUE", + * // Label: "STRING_VALUE", + * // ReturnData: true || false, + * // Period: Number("int"), + * // AccountId: "STRING_VALUE", + * // }, + * // ], + * // ThresholdMetricId: "STRING_VALUE", + * // EvaluationState: "PARTIAL_DATA", + * // StateTransitionedTimestamp: new Date("TIMESTAMP"), + * // }, + * // ], + * // }; + * + * ``` + * + * @param DescribeAlarmsForMetricCommandInput - {@link DescribeAlarmsForMetricCommandInput} + * @returns {@link DescribeAlarmsForMetricCommandOutput} + * @see {@link DescribeAlarmsForMetricCommandInput} for command's `input` shape. + * @see {@link DescribeAlarmsForMetricCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DescribeAlarmsForMetricCommand extends $Command + .classBuilder< + DescribeAlarmsForMetricCommandInput, + DescribeAlarmsForMetricCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DescribeAlarmsForMetric", {}) + .n("CloudWatchClient", "DescribeAlarmsForMetricCommand") + .f(void 0, void 0) + .ser(se_DescribeAlarmsForMetricCommand) + .de(de_DescribeAlarmsForMetricCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeAlarmsForMetricInput; + output: DescribeAlarmsForMetricOutput; + }; + sdk: { + input: DescribeAlarmsForMetricCommandInput; + output: DescribeAlarmsForMetricCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/DescribeAnomalyDetectorsCommand.ts b/clients/client-cloudwatch-cbor/src/commands/DescribeAnomalyDetectorsCommand.ts new file mode 100644 index 000000000000..4629ec28d7d0 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/DescribeAnomalyDetectorsCommand.ts @@ -0,0 +1,182 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeAnomalyDetectorsInput, DescribeAnomalyDetectorsOutput } from "../models/models_0"; +import { de_DescribeAnomalyDetectorsCommand, se_DescribeAnomalyDetectorsCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeAnomalyDetectorsCommand}. + */ +export interface DescribeAnomalyDetectorsCommandInput extends DescribeAnomalyDetectorsInput {} +/** + * @public + * + * The output of {@link DescribeAnomalyDetectorsCommand}. + */ +export interface DescribeAnomalyDetectorsCommandOutput extends DescribeAnomalyDetectorsOutput, __MetadataBearer {} + +/** + *Lists the anomaly detection models that you have created in your account. For single
+ * metric anomaly detectors, you can list all of the models in your account or filter the
+ * results to only the models that are related to a certain namespace, metric name, or
+ * metric dimension. For metric math anomaly detectors, you can list them by adding
+ * METRIC_MATH to the AnomalyDetectorTypes array. This will
+ * return all metric math anomaly detectors in your account.
Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidNextToken} (client fault) + *The next token specified is invalid.
+ * + * @throws {@link InvalidParameterCombinationException} (client fault) + *Parameters were used together that cannot be used together.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DescribeAnomalyDetectorsCommand extends $Command + .classBuilder< + DescribeAnomalyDetectorsCommandInput, + DescribeAnomalyDetectorsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DescribeAnomalyDetectors", {}) + .n("CloudWatchClient", "DescribeAnomalyDetectorsCommand") + .f(void 0, void 0) + .ser(se_DescribeAnomalyDetectorsCommand) + .de(de_DescribeAnomalyDetectorsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeAnomalyDetectorsInput; + output: DescribeAnomalyDetectorsOutput; + }; + sdk: { + input: DescribeAnomalyDetectorsCommandInput; + output: DescribeAnomalyDetectorsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/DescribeInsightRulesCommand.ts b/clients/client-cloudwatch-cbor/src/commands/DescribeInsightRulesCommand.ts new file mode 100644 index 000000000000..8c41201aef2a --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/DescribeInsightRulesCommand.ts @@ -0,0 +1,107 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeInsightRulesInput, DescribeInsightRulesOutput } from "../models/models_0"; +import { de_DescribeInsightRulesCommand, se_DescribeInsightRulesCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeInsightRulesCommand}. + */ +export interface DescribeInsightRulesCommandInput extends DescribeInsightRulesInput {} +/** + * @public + * + * The output of {@link DescribeInsightRulesCommand}. + */ +export interface DescribeInsightRulesCommandOutput extends DescribeInsightRulesOutput, __MetadataBearer {} + +/** + *Returns a list of all the Contributor Insights rules in your account.
+ *For more information about Contributor Insights, see Using Contributor + * Insights to Analyze High-Cardinality Data.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DescribeInsightRulesCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DescribeInsightRulesCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // DescribeInsightRulesInput + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new DescribeInsightRulesCommand(input); + * const response = await client.send(command); + * // { // DescribeInsightRulesOutput + * // NextToken: "STRING_VALUE", + * // InsightRules: [ // InsightRules + * // { // InsightRule + * // Name: "STRING_VALUE", // required + * // State: "STRING_VALUE", // required + * // Schema: "STRING_VALUE", // required + * // Definition: "STRING_VALUE", // required + * // ManagedRule: true || false, + * // }, + * // ], + * // }; + * + * ``` + * + * @param DescribeInsightRulesCommandInput - {@link DescribeInsightRulesCommandInput} + * @returns {@link DescribeInsightRulesCommandOutput} + * @see {@link DescribeInsightRulesCommandInput} for command's `input` shape. + * @see {@link DescribeInsightRulesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InvalidNextToken} (client fault) + *The next token specified is invalid.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DescribeInsightRulesCommand extends $Command + .classBuilder< + DescribeInsightRulesCommandInput, + DescribeInsightRulesCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DescribeInsightRules", {}) + .n("CloudWatchClient", "DescribeInsightRulesCommand") + .f(void 0, void 0) + .ser(se_DescribeInsightRulesCommand) + .de(de_DescribeInsightRulesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeInsightRulesInput; + output: DescribeInsightRulesOutput; + }; + sdk: { + input: DescribeInsightRulesCommandInput; + output: DescribeInsightRulesCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/DisableAlarmActionsCommand.ts b/clients/client-cloudwatch-cbor/src/commands/DisableAlarmActionsCommand.ts new file mode 100644 index 000000000000..ddb994b9df90 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/DisableAlarmActionsCommand.ts @@ -0,0 +1,93 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DisableAlarmActionsInput } from "../models/models_0"; +import { de_DisableAlarmActionsCommand, se_DisableAlarmActionsCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DisableAlarmActionsCommand}. + */ +export interface DisableAlarmActionsCommandInput extends DisableAlarmActionsInput {} +/** + * @public + * + * The output of {@link DisableAlarmActionsCommand}. + */ +export interface DisableAlarmActionsCommandOutput extends __MetadataBearer {} + +/** + *Disables the actions for the specified alarms. When an alarm's actions are + * disabled, the alarm actions do not execute when the alarm state changes.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DisableAlarmActionsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DisableAlarmActionsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // DisableAlarmActionsInput + * AlarmNames: [ // AlarmNames // required + * "STRING_VALUE", + * ], + * }; + * const command = new DisableAlarmActionsCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DisableAlarmActionsCommandInput - {@link DisableAlarmActionsCommandInput} + * @returns {@link DisableAlarmActionsCommandOutput} + * @see {@link DisableAlarmActionsCommandInput} for command's `input` shape. + * @see {@link DisableAlarmActionsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DisableAlarmActionsCommand extends $Command + .classBuilder< + DisableAlarmActionsCommandInput, + DisableAlarmActionsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DisableAlarmActions", {}) + .n("CloudWatchClient", "DisableAlarmActionsCommand") + .f(void 0, void 0) + .ser(se_DisableAlarmActionsCommand) + .de(de_DisableAlarmActionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DisableAlarmActionsInput; + output: {}; + }; + sdk: { + input: DisableAlarmActionsCommandInput; + output: DisableAlarmActionsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/DisableInsightRulesCommand.ts b/clients/client-cloudwatch-cbor/src/commands/DisableInsightRulesCommand.ts new file mode 100644 index 000000000000..af8ef075068c --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/DisableInsightRulesCommand.ts @@ -0,0 +1,108 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DisableInsightRulesInput, DisableInsightRulesOutput } from "../models/models_0"; +import { de_DisableInsightRulesCommand, se_DisableInsightRulesCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DisableInsightRulesCommand}. + */ +export interface DisableInsightRulesCommandInput extends DisableInsightRulesInput {} +/** + * @public + * + * The output of {@link DisableInsightRulesCommand}. + */ +export interface DisableInsightRulesCommandOutput extends DisableInsightRulesOutput, __MetadataBearer {} + +/** + *Disables the specified Contributor Insights rules. When rules are disabled, they do + * not analyze log groups and do not incur costs.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DisableInsightRulesCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DisableInsightRulesCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // DisableInsightRulesInput + * RuleNames: [ // InsightRuleNames // required + * "STRING_VALUE", + * ], + * }; + * const command = new DisableInsightRulesCommand(input); + * const response = await client.send(command); + * // { // DisableInsightRulesOutput + * // Failures: [ // BatchFailures + * // { // PartialFailure + * // FailureResource: "STRING_VALUE", + * // ExceptionType: "STRING_VALUE", + * // FailureCode: "STRING_VALUE", + * // FailureDescription: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param DisableInsightRulesCommandInput - {@link DisableInsightRulesCommandInput} + * @returns {@link DisableInsightRulesCommandOutput} + * @see {@link DisableInsightRulesCommandInput} for command's `input` shape. + * @see {@link DisableInsightRulesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class DisableInsightRulesCommand extends $Command + .classBuilder< + DisableInsightRulesCommandInput, + DisableInsightRulesCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "DisableInsightRules", {}) + .n("CloudWatchClient", "DisableInsightRulesCommand") + .f(void 0, void 0) + .ser(se_DisableInsightRulesCommand) + .de(de_DisableInsightRulesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DisableInsightRulesInput; + output: DisableInsightRulesOutput; + }; + sdk: { + input: DisableInsightRulesCommandInput; + output: DisableInsightRulesCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/EnableAlarmActionsCommand.ts b/clients/client-cloudwatch-cbor/src/commands/EnableAlarmActionsCommand.ts new file mode 100644 index 000000000000..aaa6b2722367 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/EnableAlarmActionsCommand.ts @@ -0,0 +1,92 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { EnableAlarmActionsInput } from "../models/models_0"; +import { de_EnableAlarmActionsCommand, se_EnableAlarmActionsCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link EnableAlarmActionsCommand}. + */ +export interface EnableAlarmActionsCommandInput extends EnableAlarmActionsInput {} +/** + * @public + * + * The output of {@link EnableAlarmActionsCommand}. + */ +export interface EnableAlarmActionsCommandOutput extends __MetadataBearer {} + +/** + *Enables the actions for the specified alarms.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, EnableAlarmActionsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, EnableAlarmActionsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // EnableAlarmActionsInput + * AlarmNames: [ // AlarmNames // required + * "STRING_VALUE", + * ], + * }; + * const command = new EnableAlarmActionsCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param EnableAlarmActionsCommandInput - {@link EnableAlarmActionsCommandInput} + * @returns {@link EnableAlarmActionsCommandOutput} + * @see {@link EnableAlarmActionsCommandInput} for command's `input` shape. + * @see {@link EnableAlarmActionsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class EnableAlarmActionsCommand extends $Command + .classBuilder< + EnableAlarmActionsCommandInput, + EnableAlarmActionsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "EnableAlarmActions", {}) + .n("CloudWatchClient", "EnableAlarmActionsCommand") + .f(void 0, void 0) + .ser(se_EnableAlarmActionsCommand) + .de(de_EnableAlarmActionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: EnableAlarmActionsInput; + output: {}; + }; + sdk: { + input: EnableAlarmActionsCommandInput; + output: EnableAlarmActionsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/EnableInsightRulesCommand.ts b/clients/client-cloudwatch-cbor/src/commands/EnableInsightRulesCommand.ts new file mode 100644 index 000000000000..3d20285a64b4 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/EnableInsightRulesCommand.ts @@ -0,0 +1,111 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { EnableInsightRulesInput, EnableInsightRulesOutput } from "../models/models_0"; +import { de_EnableInsightRulesCommand, se_EnableInsightRulesCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link EnableInsightRulesCommand}. + */ +export interface EnableInsightRulesCommandInput extends EnableInsightRulesInput {} +/** + * @public + * + * The output of {@link EnableInsightRulesCommand}. + */ +export interface EnableInsightRulesCommandOutput extends EnableInsightRulesOutput, __MetadataBearer {} + +/** + *Enables the specified Contributor Insights rules. When rules are enabled, they + * immediately begin analyzing log data.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, EnableInsightRulesCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, EnableInsightRulesCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // EnableInsightRulesInput + * RuleNames: [ // InsightRuleNames // required + * "STRING_VALUE", + * ], + * }; + * const command = new EnableInsightRulesCommand(input); + * const response = await client.send(command); + * // { // EnableInsightRulesOutput + * // Failures: [ // BatchFailures + * // { // PartialFailure + * // FailureResource: "STRING_VALUE", + * // ExceptionType: "STRING_VALUE", + * // FailureCode: "STRING_VALUE", + * // FailureDescription: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param EnableInsightRulesCommandInput - {@link EnableInsightRulesCommandInput} + * @returns {@link EnableInsightRulesCommandOutput} + * @see {@link EnableInsightRulesCommandInput} for command's `input` shape. + * @see {@link EnableInsightRulesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link LimitExceededException} (client fault) + *The operation exceeded one or more limits.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class EnableInsightRulesCommand extends $Command + .classBuilder< + EnableInsightRulesCommandInput, + EnableInsightRulesCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "EnableInsightRules", {}) + .n("CloudWatchClient", "EnableInsightRulesCommand") + .f(void 0, void 0) + .ser(se_EnableInsightRulesCommand) + .de(de_EnableInsightRulesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: EnableInsightRulesInput; + output: EnableInsightRulesOutput; + }; + sdk: { + input: EnableInsightRulesCommandInput; + output: EnableInsightRulesCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/GetDashboardCommand.ts b/clients/client-cloudwatch-cbor/src/commands/GetDashboardCommand.ts new file mode 100644 index 000000000000..6dcaf15c0908 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/GetDashboardCommand.ts @@ -0,0 +1,107 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetDashboardInput, GetDashboardOutput } from "../models/models_0"; +import { de_GetDashboardCommand, se_GetDashboardCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetDashboardCommand}. + */ +export interface GetDashboardCommandInput extends GetDashboardInput {} +/** + * @public + * + * The output of {@link GetDashboardCommand}. + */ +export interface GetDashboardCommandOutput extends GetDashboardOutput, __MetadataBearer {} + +/** + *Displays the details of the dashboard that you specify.
+ *To copy an existing dashboard, use GetDashboard, and then use the data
+ * returned within DashboardBody as the template for the new dashboard when
+ * you call PutDashboard to create the copy.
The specified dashboard does not exist.
+ * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class GetDashboardCommand extends $Command + .classBuilder< + GetDashboardCommandInput, + GetDashboardCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "GetDashboard", {}) + .n("CloudWatchClient", "GetDashboardCommand") + .f(void 0, void 0) + .ser(se_GetDashboardCommand) + .de(de_GetDashboardCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetDashboardInput; + output: GetDashboardOutput; + }; + sdk: { + input: GetDashboardCommandInput; + output: GetDashboardCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/GetInsightRuleReportCommand.ts b/clients/client-cloudwatch-cbor/src/commands/GetInsightRuleReportCommand.ts new file mode 100644 index 000000000000..494445170f61 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/GetInsightRuleReportCommand.ts @@ -0,0 +1,185 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetInsightRuleReportInput, GetInsightRuleReportOutput } from "../models/models_0"; +import { de_GetInsightRuleReportCommand, se_GetInsightRuleReportCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetInsightRuleReportCommand}. + */ +export interface GetInsightRuleReportCommandInput extends GetInsightRuleReportInput {} +/** + * @public + * + * The output of {@link GetInsightRuleReportCommand}. + */ +export interface GetInsightRuleReportCommandOutput extends GetInsightRuleReportOutput, __MetadataBearer {} + +/** + *This operation returns the time series data collected by a Contributor Insights rule. + * The data includes the identity and number of contributors to the log group.
+ *You can also optionally return one or more statistics about each data point in the + * time series. These statistics can include the following:
+ *
+ * UniqueContributors -- the number of unique contributors for each
+ * data point.
+ * MaxContributorValue -- the value of the top contributor for each
+ * data point. The identity of the contributor might change for each data point in
+ * the graph.
If this rule aggregates by COUNT, the top contributor for each data point is
+ * the contributor with the most occurrences in that period. If the rule aggregates
+ * by SUM, the top contributor is the contributor with the highest sum in the log
+ * field specified by the rule's Value, during that period.
+ * SampleCount -- the number of data points matched by the
+ * rule.
+ * Sum -- the sum of the values from all contributors during the
+ * time period represented by that data point.
+ * Minimum -- the minimum value from a single observation during the
+ * time period represented by that data point.
+ * Maximum -- the maximum value from a single observation during the
+ * time period represented by that data point.
+ * Average -- the average value from all contributors during the
+ * time period represented by that data point.
The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The named resource does not exist.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class GetInsightRuleReportCommand extends $Command + .classBuilder< + GetInsightRuleReportCommandInput, + GetInsightRuleReportCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "GetInsightRuleReport", {}) + .n("CloudWatchClient", "GetInsightRuleReportCommand") + .f(void 0, void 0) + .ser(se_GetInsightRuleReportCommand) + .de(de_GetInsightRuleReportCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetInsightRuleReportInput; + output: GetInsightRuleReportOutput; + }; + sdk: { + input: GetInsightRuleReportCommandInput; + output: GetInsightRuleReportCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/GetMetricDataCommand.ts b/clients/client-cloudwatch-cbor/src/commands/GetMetricDataCommand.ts new file mode 100644 index 000000000000..1b42fa3df83e --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/GetMetricDataCommand.ts @@ -0,0 +1,215 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetMetricDataInput, GetMetricDataOutput } from "../models/models_0"; +import { de_GetMetricDataCommand, se_GetMetricDataCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetMetricDataCommand}. + */ +export interface GetMetricDataCommandInput extends GetMetricDataInput {} +/** + * @public + * + * The output of {@link GetMetricDataCommand}. + */ +export interface GetMetricDataCommandOutput extends GetMetricDataOutput, __MetadataBearer {} + +/** + *You can use the GetMetricData API to retrieve CloudWatch metric
+ * values. The operation can also include a CloudWatch Metrics Insights query, and
+ * one or more metric math functions.
A GetMetricData operation that does not include a query can retrieve
+ * as many as 500 different metrics in a single request, with a total of as many as 100,800
+ * data points. You can also optionally perform metric math expressions on the values of
+ * the returned statistics, to create new time series that represent new insights into your
+ * data. For example, using Lambda metrics, you could divide the Errors metric by the
+ * Invocations metric to get an error rate time series. For more information about metric
+ * math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User
+ * Guide.
If you include a Metrics Insights query, each GetMetricData operation can
+ * include only one query. But the same GetMetricData operation can also
+ * retrieve other metrics. Metrics Insights queries can query only the most recent three
+ * hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights.
Calls to the GetMetricData API have a different pricing structure than
+ * calls to GetMetricStatistics. For more information about pricing, see
+ * Amazon CloudWatch
+ * Pricing.
Amazon CloudWatch retains metric data as follows:
+ *Data points with a period of less than 60 seconds are available for 3
+ * hours. These data points are high-resolution metrics and are available only for
+ * custom metrics that have been defined with a StorageResolution of
+ * 1.
Data points with a period of 60 seconds (1-minute) are available for 15 + * days.
+ *Data points with a period of 300 seconds (5-minute) are available for 63 + * days.
+ *Data points with a period of 3600 seconds (1 hour) are available for 455 + * days (15 months).
+ *Data points that are initially published with a shorter period are aggregated + * together for long-term storage. For example, if you collect data using a period of 1 + * minute, the data remains available for 15 days with 1-minute resolution. After 15 days, + * this data is still available, but is aggregated and retrievable only with a resolution + * of 5 minutes. After 63 days, the data is further aggregated and is available with a + * resolution of 1 hour.
+ *If you omit Unit in your request, all data that was collected with any
+ * unit is returned, along with the corresponding units that were specified when the data
+ * was reported to CloudWatch. If you specify a unit, the operation returns only data that
+ * was collected with that unit specified. If you specify a unit that does not match the
+ * data collected, the results of the operation are null. CloudWatch does not perform unit
+ * conversions.
+ * Using Metrics Insights queries with metric + * math + *
+ *You can't mix a Metric Insights query and metric math syntax in the same expression, + * but you can reference results from a Metrics Insights query within other Metric math + * expressions. A Metrics Insights query without a GROUP + * BY clause returns a single time-series (TS), and can be used as input for + * a metric math expression that expects a single time series. A Metrics Insights query + * with a GROUP BY clause returns an array of time-series + * (TS[]), and can be used as input for a metric math expression that expects an array of + * time series.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, GetMetricDataCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, GetMetricDataCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // GetMetricDataInput + * MetricDataQueries: [ // MetricDataQueries // required + * { // MetricDataQuery + * Id: "STRING_VALUE", // required + * MetricStat: { // MetricStat + * Metric: { // Metric + * Namespace: "STRING_VALUE", + * MetricName: "STRING_VALUE", + * Dimensions: [ // Dimensions + * { // Dimension + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }, + * Period: Number("int"), // required + * Stat: "STRING_VALUE", // required + * Unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None", + * }, + * Expression: "STRING_VALUE", + * Label: "STRING_VALUE", + * ReturnData: true || false, + * Period: Number("int"), + * AccountId: "STRING_VALUE", + * }, + * ], + * StartTime: new Date("TIMESTAMP"), // required + * EndTime: new Date("TIMESTAMP"), // required + * NextToken: "STRING_VALUE", + * ScanBy: "TimestampDescending" || "TimestampAscending", + * MaxDatapoints: Number("int"), + * LabelOptions: { // LabelOptions + * Timezone: "STRING_VALUE", + * }, + * }; + * const command = new GetMetricDataCommand(input); + * const response = await client.send(command); + * // { // GetMetricDataOutput + * // MetricDataResults: [ // MetricDataResults + * // { // MetricDataResult + * // Id: "STRING_VALUE", + * // Label: "STRING_VALUE", + * // Timestamps: [ // Timestamps + * // new Date("TIMESTAMP"), + * // ], + * // Values: [ // DatapointValues + * // Number("double"), + * // ], + * // StatusCode: "Complete" || "InternalError" || "PartialData" || "Forbidden", + * // Messages: [ // MetricDataResultMessages + * // { // MessageData + * // Code: "STRING_VALUE", + * // Value: "STRING_VALUE", + * // }, + * // ], + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // Messages: [ + * // { + * // Code: "STRING_VALUE", + * // Value: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param GetMetricDataCommandInput - {@link GetMetricDataCommandInput} + * @returns {@link GetMetricDataCommandOutput} + * @see {@link GetMetricDataCommandInput} for command's `input` shape. + * @see {@link GetMetricDataCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InvalidNextToken} (client fault) + *The next token specified is invalid.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class GetMetricDataCommand extends $Command + .classBuilder< + GetMetricDataCommandInput, + GetMetricDataCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "GetMetricData", {}) + .n("CloudWatchClient", "GetMetricDataCommand") + .f(void 0, void 0) + .ser(se_GetMetricDataCommand) + .de(de_GetMetricDataCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetMetricDataInput; + output: GetMetricDataOutput; + }; + sdk: { + input: GetMetricDataCommandInput; + output: GetMetricDataCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/GetMetricStatisticsCommand.ts b/clients/client-cloudwatch-cbor/src/commands/GetMetricStatisticsCommand.ts new file mode 100644 index 000000000000..ec025906f17f --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/GetMetricStatisticsCommand.ts @@ -0,0 +1,192 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetMetricStatisticsInput, GetMetricStatisticsOutput } from "../models/models_0"; +import { de_GetMetricStatisticsCommand, se_GetMetricStatisticsCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetMetricStatisticsCommand}. + */ +export interface GetMetricStatisticsCommandInput extends GetMetricStatisticsInput {} +/** + * @public + * + * The output of {@link GetMetricStatisticsCommand}. + */ +export interface GetMetricStatisticsCommandOutput extends GetMetricStatisticsOutput, __MetadataBearer {} + +/** + *Gets statistics for the specified metric.
+ *The maximum number of data points returned from a single call is 1,440. If you + * request more than 1,440 data points, CloudWatch returns an error. To reduce the number + * of data points, you can narrow the specified time range and make multiple requests + * across adjacent time ranges, or you can increase the specified period. Data points are + * not returned in chronological order.
+ *CloudWatch aggregates data points based on the length of the period that you + * specify. For example, if you request statistics with a one-hour period, CloudWatch + * aggregates all data points with time stamps that fall within each one-hour period. + * Therefore, the number of values aggregated by CloudWatch is larger than the number of + * data points returned.
+ *CloudWatch needs raw data points to calculate percentile statistics. If you publish + * data using a statistic set instead, you can only retrieve percentile statistics for this + * data if one of the following conditions is true:
+ *The SampleCount value of the statistic set is 1.
+ *The Min and the Max values of the statistic set are equal.
+ *Percentile statistics are not available for metrics when any of the metric values + * are negative numbers.
+ *Amazon CloudWatch retains metric data as follows:
+ *Data points with a period of less than 60 seconds are available for 3
+ * hours. These data points are high-resolution metrics and are available only for
+ * custom metrics that have been defined with a StorageResolution of
+ * 1.
Data points with a period of 60 seconds (1-minute) are available for 15 + * days.
+ *Data points with a period of 300 seconds (5-minute) are available for 63 + * days.
+ *Data points with a period of 3600 seconds (1 hour) are available for 455 + * days (15 months).
+ *Data points that are initially published with a shorter period are aggregated + * together for long-term storage. For example, if you collect data using a period of 1 + * minute, the data remains available for 15 days with 1-minute resolution. After 15 days, + * this data is still available, but is aggregated and retrievable only with a resolution + * of 5 minutes. After 63 days, the data is further aggregated and is available with a + * resolution of 1 hour.
+ *CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, + * 2016.
+ *For information about metrics and dimensions supported by Amazon Web Services + * services, see the Amazon CloudWatch + * Metrics and Dimensions Reference in the Amazon CloudWatch User + * Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, GetMetricStatisticsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, GetMetricStatisticsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // GetMetricStatisticsInput + * Namespace: "STRING_VALUE", // required + * MetricName: "STRING_VALUE", // required + * Dimensions: [ // Dimensions + * { // Dimension + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * StartTime: new Date("TIMESTAMP"), // required + * EndTime: new Date("TIMESTAMP"), // required + * Period: Number("int"), // required + * Statistics: [ // Statistics + * "SampleCount" || "Average" || "Sum" || "Minimum" || "Maximum", + * ], + * ExtendedStatistics: [ // ExtendedStatistics + * "STRING_VALUE", + * ], + * Unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None", + * }; + * const command = new GetMetricStatisticsCommand(input); + * const response = await client.send(command); + * // { // GetMetricStatisticsOutput + * // Label: "STRING_VALUE", + * // Datapoints: [ // Datapoints + * // { // Datapoint + * // Timestamp: new Date("TIMESTAMP"), + * // SampleCount: Number("double"), + * // Average: Number("double"), + * // Sum: Number("double"), + * // Minimum: Number("double"), + * // Maximum: Number("double"), + * // Unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None", + * // ExtendedStatistics: { // DatapointValueMap + * // "Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterCombinationException} (client fault) + *Parameters were used together that cannot be used together.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class GetMetricStatisticsCommand extends $Command + .classBuilder< + GetMetricStatisticsCommandInput, + GetMetricStatisticsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "GetMetricStatistics", {}) + .n("CloudWatchClient", "GetMetricStatisticsCommand") + .f(void 0, void 0) + .ser(se_GetMetricStatisticsCommand) + .de(de_GetMetricStatisticsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetMetricStatisticsInput; + output: GetMetricStatisticsOutput; + }; + sdk: { + input: GetMetricStatisticsCommandInput; + output: GetMetricStatisticsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/GetMetricStreamCommand.ts b/clients/client-cloudwatch-cbor/src/commands/GetMetricStreamCommand.ts new file mode 100644 index 000000000000..d45c764919ed --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/GetMetricStreamCommand.ts @@ -0,0 +1,145 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetMetricStreamInput, GetMetricStreamOutput } from "../models/models_0"; +import { de_GetMetricStreamCommand, se_GetMetricStreamCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetMetricStreamCommand}. + */ +export interface GetMetricStreamCommandInput extends GetMetricStreamInput {} +/** + * @public + * + * The output of {@link GetMetricStreamCommand}. + */ +export interface GetMetricStreamCommandOutput extends GetMetricStreamOutput, __MetadataBearer {} + +/** + *Returns information about the metric stream that you specify.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, GetMetricStreamCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, GetMetricStreamCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // GetMetricStreamInput + * Name: "STRING_VALUE", // required + * }; + * const command = new GetMetricStreamCommand(input); + * const response = await client.send(command); + * // { // GetMetricStreamOutput + * // Arn: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // IncludeFilters: [ // MetricStreamFilters + * // { // MetricStreamFilter + * // Namespace: "STRING_VALUE", + * // MetricNames: [ // MetricStreamFilterMetricNames + * // "STRING_VALUE", + * // ], + * // }, + * // ], + * // ExcludeFilters: [ + * // { + * // Namespace: "STRING_VALUE", + * // MetricNames: [ + * // "STRING_VALUE", + * // ], + * // }, + * // ], + * // FirehoseArn: "STRING_VALUE", + * // RoleArn: "STRING_VALUE", + * // State: "STRING_VALUE", + * // CreationDate: new Date("TIMESTAMP"), + * // LastUpdateDate: new Date("TIMESTAMP"), + * // OutputFormat: "json" || "opentelemetry0.7" || "opentelemetry1.0", + * // StatisticsConfigurations: [ // MetricStreamStatisticsConfigurations + * // { // MetricStreamStatisticsConfiguration + * // IncludeMetrics: [ // MetricStreamStatisticsIncludeMetrics // required + * // { // MetricStreamStatisticsMetric + * // Namespace: "STRING_VALUE", // required + * // MetricName: "STRING_VALUE", // required + * // }, + * // ], + * // AdditionalStatistics: [ // MetricStreamStatisticsAdditionalStatistics // required + * // "STRING_VALUE", + * // ], + * // }, + * // ], + * // IncludeLinkedAccountsMetrics: true || false, + * // }; + * + * ``` + * + * @param GetMetricStreamCommandInput - {@link GetMetricStreamCommandInput} + * @returns {@link GetMetricStreamCommandOutput} + * @see {@link GetMetricStreamCommandInput} for command's `input` shape. + * @see {@link GetMetricStreamCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterCombinationException} (client fault) + *Parameters were used together that cannot be used together.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The named resource does not exist.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class GetMetricStreamCommand extends $Command + .classBuilder< + GetMetricStreamCommandInput, + GetMetricStreamCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "GetMetricStream", {}) + .n("CloudWatchClient", "GetMetricStreamCommand") + .f(void 0, void 0) + .ser(se_GetMetricStreamCommand) + .de(de_GetMetricStreamCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetMetricStreamInput; + output: GetMetricStreamOutput; + }; + sdk: { + input: GetMetricStreamCommandInput; + output: GetMetricStreamCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/GetMetricWidgetImageCommand.ts b/clients/client-cloudwatch-cbor/src/commands/GetMetricWidgetImageCommand.ts new file mode 100644 index 000000000000..d7781001cb49 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/GetMetricWidgetImageCommand.ts @@ -0,0 +1,109 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetMetricWidgetImageInput, GetMetricWidgetImageOutput } from "../models/models_0"; +import { de_GetMetricWidgetImageCommand, se_GetMetricWidgetImageCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetMetricWidgetImageCommand}. + */ +export interface GetMetricWidgetImageCommandInput extends GetMetricWidgetImageInput {} +/** + * @public + * + * The output of {@link GetMetricWidgetImageCommand}. + */ +export interface GetMetricWidgetImageCommandOutput extends GetMetricWidgetImageOutput, __MetadataBearer {} + +/** + *You can use the GetMetricWidgetImage API to retrieve a snapshot graph
+ * of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this
+ * image into your services and products, such as wiki pages, reports, and documents. You
+ * could also retrieve images regularly, such as every minute, and create your own custom
+ * live dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including + * metric math and horizontal and vertical annotations.
+ *There is a limit of 20 transactions per second for this API. Each
+ * GetMetricWidgetImage action has the following limits:
As many as 100 metrics in the graph.
+ *Up to 100 KB uncompressed payload.
+ *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class GetMetricWidgetImageCommand extends $Command + .classBuilder< + GetMetricWidgetImageCommandInput, + GetMetricWidgetImageCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "GetMetricWidgetImage", {}) + .n("CloudWatchClient", "GetMetricWidgetImageCommand") + .f(void 0, void 0) + .ser(se_GetMetricWidgetImageCommand) + .de(de_GetMetricWidgetImageCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetMetricWidgetImageInput; + output: GetMetricWidgetImageOutput; + }; + sdk: { + input: GetMetricWidgetImageCommandInput; + output: GetMetricWidgetImageCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/ListDashboardsCommand.ts b/clients/client-cloudwatch-cbor/src/commands/ListDashboardsCommand.ts new file mode 100644 index 000000000000..de77a4da8367 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/ListDashboardsCommand.ts @@ -0,0 +1,115 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListDashboardsInput, ListDashboardsOutput } from "../models/models_0"; +import { de_ListDashboardsCommand, se_ListDashboardsCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListDashboardsCommand}. + */ +export interface ListDashboardsCommandInput extends ListDashboardsInput {} +/** + * @public + * + * The output of {@link ListDashboardsCommand}. + */ +export interface ListDashboardsCommandOutput extends ListDashboardsOutput, __MetadataBearer {} + +/** + *Returns a list of the dashboards for your account. If you include
+ * DashboardNamePrefix, only those dashboards with names starting with the
+ * prefix are listed. Otherwise, all dashboards in your account are listed.
+ * ListDashboards returns up to 1000 results on one page. If there are
+ * more than 1000 dashboards, you can call ListDashboards again and include
+ * the value you received for NextToken in the first call, to receive the next
+ * 1000 results.
Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class ListDashboardsCommand extends $Command + .classBuilder< + ListDashboardsCommandInput, + ListDashboardsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "ListDashboards", {}) + .n("CloudWatchClient", "ListDashboardsCommand") + .f(void 0, void 0) + .ser(se_ListDashboardsCommand) + .de(de_ListDashboardsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListDashboardsInput; + output: ListDashboardsOutput; + }; + sdk: { + input: ListDashboardsCommandInput; + output: ListDashboardsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/ListManagedInsightRulesCommand.ts b/clients/client-cloudwatch-cbor/src/commands/ListManagedInsightRulesCommand.ts new file mode 100644 index 000000000000..090db0e2419c --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/ListManagedInsightRulesCommand.ts @@ -0,0 +1,116 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListManagedInsightRulesInput, ListManagedInsightRulesOutput } from "../models/models_0"; +import { de_ListManagedInsightRulesCommand, se_ListManagedInsightRulesCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListManagedInsightRulesCommand}. + */ +export interface ListManagedInsightRulesCommandInput extends ListManagedInsightRulesInput {} +/** + * @public + * + * The output of {@link ListManagedInsightRulesCommand}. + */ +export interface ListManagedInsightRulesCommandOutput extends ListManagedInsightRulesOutput, __MetadataBearer {} + +/** + *Returns a list that contains the number of managed Contributor Insights rules in your + * account. + * + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, ListManagedInsightRulesCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, ListManagedInsightRulesCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // ListManagedInsightRulesInput + * ResourceARN: "STRING_VALUE", // required + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new ListManagedInsightRulesCommand(input); + * const response = await client.send(command); + * // { // ListManagedInsightRulesOutput + * // ManagedRules: [ // ManagedRuleDescriptions + * // { // ManagedRuleDescription + * // TemplateName: "STRING_VALUE", + * // ResourceARN: "STRING_VALUE", + * // RuleState: { // ManagedRuleState + * // RuleName: "STRING_VALUE", // required + * // State: "STRING_VALUE", // required + * // }, + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListManagedInsightRulesCommandInput - {@link ListManagedInsightRulesCommandInput} + * @returns {@link ListManagedInsightRulesCommandOutput} + * @see {@link ListManagedInsightRulesCommandInput} for command's `input` shape. + * @see {@link ListManagedInsightRulesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InvalidNextToken} (client fault) + *The next token specified is invalid.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class ListManagedInsightRulesCommand extends $Command + .classBuilder< + ListManagedInsightRulesCommandInput, + ListManagedInsightRulesCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "ListManagedInsightRules", {}) + .n("CloudWatchClient", "ListManagedInsightRulesCommand") + .f(void 0, void 0) + .ser(se_ListManagedInsightRulesCommand) + .de(de_ListManagedInsightRulesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListManagedInsightRulesInput; + output: ListManagedInsightRulesOutput; + }; + sdk: { + input: ListManagedInsightRulesCommandInput; + output: ListManagedInsightRulesCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/ListMetricStreamsCommand.ts b/clients/client-cloudwatch-cbor/src/commands/ListMetricStreamsCommand.ts new file mode 100644 index 000000000000..92ebd788cb12 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/ListMetricStreamsCommand.ts @@ -0,0 +1,117 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListMetricStreamsInput, ListMetricStreamsOutput } from "../models/models_0"; +import { de_ListMetricStreamsCommand, se_ListMetricStreamsCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListMetricStreamsCommand}. + */ +export interface ListMetricStreamsCommandInput extends ListMetricStreamsInput {} +/** + * @public + * + * The output of {@link ListMetricStreamsCommand}. + */ +export interface ListMetricStreamsCommandOutput extends ListMetricStreamsOutput, __MetadataBearer {} + +/** + *Returns a list of metric streams in this account.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, ListMetricStreamsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, ListMetricStreamsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // ListMetricStreamsInput + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new ListMetricStreamsCommand(input); + * const response = await client.send(command); + * // { // ListMetricStreamsOutput + * // NextToken: "STRING_VALUE", + * // Entries: [ // MetricStreamEntries + * // { // MetricStreamEntry + * // Arn: "STRING_VALUE", + * // CreationDate: new Date("TIMESTAMP"), + * // LastUpdateDate: new Date("TIMESTAMP"), + * // Name: "STRING_VALUE", + * // FirehoseArn: "STRING_VALUE", + * // State: "STRING_VALUE", + * // OutputFormat: "json" || "opentelemetry0.7" || "opentelemetry1.0", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListMetricStreamsCommandInput - {@link ListMetricStreamsCommandInput} + * @returns {@link ListMetricStreamsCommandOutput} + * @see {@link ListMetricStreamsCommandInput} for command's `input` shape. + * @see {@link ListMetricStreamsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidNextToken} (client fault) + *The next token specified is invalid.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class ListMetricStreamsCommand extends $Command + .classBuilder< + ListMetricStreamsCommandInput, + ListMetricStreamsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "ListMetricStreams", {}) + .n("CloudWatchClient", "ListMetricStreamsCommand") + .f(void 0, void 0) + .ser(se_ListMetricStreamsCommand) + .de(de_ListMetricStreamsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListMetricStreamsInput; + output: ListMetricStreamsOutput; + }; + sdk: { + input: ListMetricStreamsCommandInput; + output: ListMetricStreamsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/ListMetricsCommand.ts b/clients/client-cloudwatch-cbor/src/commands/ListMetricsCommand.ts new file mode 100644 index 000000000000..f1c207031c10 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/ListMetricsCommand.ts @@ -0,0 +1,135 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListMetricsInput, ListMetricsOutput } from "../models/models_0"; +import { de_ListMetricsCommand, se_ListMetricsCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListMetricsCommand}. + */ +export interface ListMetricsCommandInput extends ListMetricsInput {} +/** + * @public + * + * The output of {@link ListMetricsCommand}. + */ +export interface ListMetricsCommandOutput extends ListMetricsOutput, __MetadataBearer {} + +/** + *List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.
+ *Up to 500 results are returned for any one call. To retrieve additional results, + * use the returned token with subsequent calls.
+ *After you create a metric, allow up to 15 minutes for the metric to appear. To see + * metric statistics sooner, use GetMetricData or GetMetricStatistics.
+ *If you are using CloudWatch cross-account observability, you can use this + * operation in a monitoring account and view metrics from the linked source accounts. For + * more information, see CloudWatch cross-account observability.
+ *
+ * ListMetrics doesn't return information about metrics if those metrics
+ * haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.
Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class ListMetricsCommand extends $Command + .classBuilder< + ListMetricsCommandInput, + ListMetricsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "ListMetrics", {}) + .n("CloudWatchClient", "ListMetricsCommand") + .f(void 0, void 0) + .ser(se_ListMetricsCommand) + .de(de_ListMetricsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListMetricsInput; + output: ListMetricsOutput; + }; + sdk: { + input: ListMetricsCommandInput; + output: ListMetricsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/ListTagsForResourceCommand.ts b/clients/client-cloudwatch-cbor/src/commands/ListTagsForResourceCommand.ts new file mode 100644 index 000000000000..bf278bd223ed --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/ListTagsForResourceCommand.ts @@ -0,0 +1,108 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListTagsForResourceInput, ListTagsForResourceOutput } from "../models/models_0"; +import { de_ListTagsForResourceCommand, se_ListTagsForResourceCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListTagsForResourceCommand}. + */ +export interface ListTagsForResourceCommandInput extends ListTagsForResourceInput {} +/** + * @public + * + * The output of {@link ListTagsForResourceCommand}. + */ +export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {} + +/** + *Displays the tags associated with a CloudWatch resource. Currently, alarms and + * Contributor Insights rules support tagging.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, ListTagsForResourceCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, ListTagsForResourceCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // ListTagsForResourceInput + * ResourceARN: "STRING_VALUE", // required + * }; + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * // { // ListTagsForResourceOutput + * // Tags: [ // TagList + * // { // Tag + * // Key: "STRING_VALUE", // required + * // Value: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput} + * @returns {@link ListTagsForResourceCommandOutput} + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The named resource does not exist.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class ListTagsForResourceCommand extends $Command + .classBuilder< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "ListTagsForResource", {}) + .n("CloudWatchClient", "ListTagsForResourceCommand") + .f(void 0, void 0) + .ser(se_ListTagsForResourceCommand) + .de(de_ListTagsForResourceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListTagsForResourceInput; + output: ListTagsForResourceOutput; + }; + sdk: { + input: ListTagsForResourceCommandInput; + output: ListTagsForResourceCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/PutAnomalyDetectorCommand.ts b/clients/client-cloudwatch-cbor/src/commands/PutAnomalyDetectorCommand.ts new file mode 100644 index 000000000000..0d60a68c2378 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/PutAnomalyDetectorCommand.ts @@ -0,0 +1,166 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutAnomalyDetectorInput, PutAnomalyDetectorOutput } from "../models/models_0"; +import { de_PutAnomalyDetectorCommand, se_PutAnomalyDetectorCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutAnomalyDetectorCommand}. + */ +export interface PutAnomalyDetectorCommandInput extends PutAnomalyDetectorInput {} +/** + * @public + * + * The output of {@link PutAnomalyDetectorCommand}. + */ +export interface PutAnomalyDetectorCommandOutput extends PutAnomalyDetectorOutput, __MetadataBearer {} + +/** + *Creates an anomaly detection model for a CloudWatch metric. You can use the model to + * display a band of expected normal values when the metric is graphed.
+ *If you have enabled unified cross-account observability, and this account is a
+ * monitoring account, the metric can be in the same account or a source account. You can
+ * specify the account ID in the object you specify in the
+ * SingleMetricAnomalyDetector parameter.
For more information, see CloudWatch Anomaly Detection.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, PutAnomalyDetectorCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, PutAnomalyDetectorCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // PutAnomalyDetectorInput + * Namespace: "STRING_VALUE", + * MetricName: "STRING_VALUE", + * Dimensions: [ // Dimensions + * { // Dimension + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * Stat: "STRING_VALUE", + * Configuration: { // AnomalyDetectorConfiguration + * ExcludedTimeRanges: [ // AnomalyDetectorExcludedTimeRanges + * { // Range + * StartTime: new Date("TIMESTAMP"), // required + * EndTime: new Date("TIMESTAMP"), // required + * }, + * ], + * MetricTimezone: "STRING_VALUE", + * }, + * MetricCharacteristics: { // MetricCharacteristics + * PeriodicSpikes: true || false, + * }, + * SingleMetricAnomalyDetector: { // SingleMetricAnomalyDetector + * AccountId: "STRING_VALUE", + * Namespace: "STRING_VALUE", + * MetricName: "STRING_VALUE", + * Dimensions: [ + * { + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * Stat: "STRING_VALUE", + * }, + * MetricMathAnomalyDetector: { // MetricMathAnomalyDetector + * MetricDataQueries: [ // MetricDataQueries + * { // MetricDataQuery + * Id: "STRING_VALUE", // required + * MetricStat: { // MetricStat + * Metric: { // Metric + * Namespace: "STRING_VALUE", + * MetricName: "STRING_VALUE", + * Dimensions: "Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterCombinationException} (client fault) + *Parameters were used together that cannot be used together.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link LimitExceededException} (client fault) + *The operation exceeded one or more limits.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class PutAnomalyDetectorCommand extends $Command + .classBuilder< + PutAnomalyDetectorCommandInput, + PutAnomalyDetectorCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "PutAnomalyDetector", {}) + .n("CloudWatchClient", "PutAnomalyDetectorCommand") + .f(void 0, void 0) + .ser(se_PutAnomalyDetectorCommand) + .de(de_PutAnomalyDetectorCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutAnomalyDetectorInput; + output: {}; + }; + sdk: { + input: PutAnomalyDetectorCommandInput; + output: PutAnomalyDetectorCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/PutCompositeAlarmCommand.ts b/clients/client-cloudwatch-cbor/src/commands/PutCompositeAlarmCommand.ts new file mode 100644 index 000000000000..b3c3f74f5476 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/PutCompositeAlarmCommand.ts @@ -0,0 +1,167 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutCompositeAlarmInput } from "../models/models_0"; +import { de_PutCompositeAlarmCommand, se_PutCompositeAlarmCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutCompositeAlarmCommand}. + */ +export interface PutCompositeAlarmCommandInput extends PutCompositeAlarmInput {} +/** + * @public + * + * The output of {@link PutCompositeAlarmCommand}. + */ +export interface PutCompositeAlarmCommandOutput extends __MetadataBearer {} + +/** + *Creates or updates a composite alarm. When you create a composite + * alarm, you specify a rule expression for the alarm that takes into account the alarm + * states of other alarms that you have created. The composite alarm goes into ALARM state + * only if all conditions of the rule are met.
+ *The alarms specified in a composite alarm's rule expression can include metric alarms + * and other composite alarms. The rule expression of a composite alarm can include as many + * as 100 underlying alarms. Any single alarm can be included in the rule expressions of as + * many as 150 composite alarms.
+ *Using composite alarms can reduce alarm noise. You can create multiple metric alarms, + * and also create a composite alarm and set up alerts only for the composite alarm. For + * example, you could create a composite alarm that goes into ALARM state only when more + * than one of the underlying metric alarms are in ALARM state.
+ *Composite alarms can take the following actions:
+ *Notify Amazon SNS topics.
+ *Invoke Lambda functions.
+ *Create OpsItems in Systems Manager Ops Center.
+ *Create incidents in Systems Manager Incident Manager.
+ *It is possible to create a loop or cycle of composite alarms, where composite + * alarm A depends on composite alarm B, and composite alarm B also depends on + * composite alarm A. In this scenario, you can't delete any composite alarm that is + * part of the cycle because there is always still a composite alarm that depends on + * that alarm that you want to delete.
+ *To get out of such a situation, you must break the cycle by changing the rule of
+ * one of the composite alarms in the cycle to remove a dependency that creates the
+ * cycle. The simplest change to make to break a cycle is to change the
+ * AlarmRule of one of the alarms to false.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a + * cycle in the evaluation path.
+ *When this operation creates an alarm, the alarm state is immediately set to
+ * INSUFFICIENT_DATA. The alarm is then evaluated and its state is set
+ * appropriately. Any actions associated with the new state are then executed. For a
+ * composite alarm, this initial time after creation is the only time that the alarm can be
+ * in INSUFFICIENT_DATA state.
When you update an existing alarm, its state is left unchanged, but the update + * completely overwrites the previous configuration of the alarm.
+ *To use this operation, you must be signed on with the
+ * cloudwatch:PutCompositeAlarm permission that is scoped to
+ * *. You can't create a composite alarms if your
+ * cloudwatch:PutCompositeAlarm permission has a narrower scope.
If you are an IAM user, you must have
+ * iam:CreateServiceLinkedRole to create a composite alarm that has
+ * Systems Manager OpsItem actions.
The quota for alarms for this customer has already been reached.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class PutCompositeAlarmCommand extends $Command + .classBuilder< + PutCompositeAlarmCommandInput, + PutCompositeAlarmCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "PutCompositeAlarm", {}) + .n("CloudWatchClient", "PutCompositeAlarmCommand") + .f(void 0, void 0) + .ser(se_PutCompositeAlarmCommand) + .de(de_PutCompositeAlarmCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutCompositeAlarmInput; + output: {}; + }; + sdk: { + input: PutCompositeAlarmCommandInput; + output: PutCompositeAlarmCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/PutDashboardCommand.ts b/clients/client-cloudwatch-cbor/src/commands/PutDashboardCommand.ts new file mode 100644 index 000000000000..060739a6985b --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/PutDashboardCommand.ts @@ -0,0 +1,120 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutDashboardInput, PutDashboardOutput } from "../models/models_0"; +import { de_PutDashboardCommand, se_PutDashboardCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutDashboardCommand}. + */ +export interface PutDashboardCommandInput extends PutDashboardInput {} +/** + * @public + * + * The output of {@link PutDashboardCommand}. + */ +export interface PutDashboardCommandOutput extends PutDashboardOutput, __MetadataBearer {} + +/** + *Creates a dashboard if it does not already exist, or updates an existing dashboard. + * If you update a dashboard, the entire contents are replaced with what you specify + * here.
+ *All dashboards in your account are global, not region-specific.
+ *A simple way to create a dashboard using PutDashboard is to copy an
+ * existing dashboard. To copy an existing dashboard using the console, you can load the
+ * dashboard and then use the View/edit source command in the Actions menu to display the
+ * JSON block for that dashboard. Another way to copy a dashboard is to use
+ * GetDashboard, and then use the data returned within
+ * DashboardBody as the template for the new dashboard when you call
+ * PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to
+ * add a text widget at the top of the dashboard with a message that the dashboard was
+ * created by script and should not be changed in the console. This message could also
+ * point console users to the location of the DashboardBody script or the
+ * CloudFormation template used to create the dashboard.
Some part of the dashboard data is invalid.
+ * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class PutDashboardCommand extends $Command + .classBuilder< + PutDashboardCommandInput, + PutDashboardCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "PutDashboard", {}) + .n("CloudWatchClient", "PutDashboardCommand") + .f(void 0, void 0) + .ser(se_PutDashboardCommand) + .de(de_PutDashboardCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutDashboardInput; + output: PutDashboardOutput; + }; + sdk: { + input: PutDashboardCommandInput; + output: PutDashboardCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/PutInsightRuleCommand.ts b/clients/client-cloudwatch-cbor/src/commands/PutInsightRuleCommand.ts new file mode 100644 index 000000000000..5d0d3d91fe77 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/PutInsightRuleCommand.ts @@ -0,0 +1,112 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutInsightRuleInput, PutInsightRuleOutput } from "../models/models_0"; +import { de_PutInsightRuleCommand, se_PutInsightRuleCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutInsightRuleCommand}. + */ +export interface PutInsightRuleCommandInput extends PutInsightRuleInput {} +/** + * @public + * + * The output of {@link PutInsightRuleCommand}. + */ +export interface PutInsightRuleCommandOutput extends PutInsightRuleOutput, __MetadataBearer {} + +/** + *Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs + * log group, enabling you to find contributor data for the log events in that log group. + * For more information, see Using Contributor + * Insights to Analyze High-Cardinality Data.
+ *If you create a rule, delete it, and then re-create it with the same name, historical + * data from the first time the rule was created might not be available.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, PutInsightRuleCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, PutInsightRuleCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // PutInsightRuleInput + * RuleName: "STRING_VALUE", // required + * RuleState: "STRING_VALUE", + * RuleDefinition: "STRING_VALUE", // required + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new PutInsightRuleCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param PutInsightRuleCommandInput - {@link PutInsightRuleCommandInput} + * @returns {@link PutInsightRuleCommandOutput} + * @see {@link PutInsightRuleCommandInput} for command's `input` shape. + * @see {@link PutInsightRuleCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link LimitExceededException} (client fault) + *The operation exceeded one or more limits.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class PutInsightRuleCommand extends $Command + .classBuilder< + PutInsightRuleCommandInput, + PutInsightRuleCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "PutInsightRule", {}) + .n("CloudWatchClient", "PutInsightRuleCommand") + .f(void 0, void 0) + .ser(se_PutInsightRuleCommand) + .de(de_PutInsightRuleCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutInsightRuleInput; + output: {}; + }; + sdk: { + input: PutInsightRuleCommandInput; + output: PutInsightRuleCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/PutManagedInsightRulesCommand.ts b/clients/client-cloudwatch-cbor/src/commands/PutManagedInsightRulesCommand.ts new file mode 100644 index 000000000000..fbec8e719587 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/PutManagedInsightRulesCommand.ts @@ -0,0 +1,125 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutManagedInsightRulesInput, PutManagedInsightRulesOutput } from "../models/models_0"; +import { de_PutManagedInsightRulesCommand, se_PutManagedInsightRulesCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutManagedInsightRulesCommand}. + */ +export interface PutManagedInsightRulesCommandInput extends PutManagedInsightRulesInput {} +/** + * @public + * + * The output of {@link PutManagedInsightRulesCommand}. + */ +export interface PutManagedInsightRulesCommandOutput extends PutManagedInsightRulesOutput, __MetadataBearer {} + +/** + * Creates a managed Contributor Insights rule for a specified Amazon Web Services
+ * resource. When you enable a managed rule, you create a Contributor Insights rule that
+ * collects data from Amazon Web Services services. You cannot edit these rules with
+ * PutInsightRule. The rules can be enabled, disabled, and deleted using
+ * EnableInsightRules, DisableInsightRules, and
+ * DeleteInsightRules. If a previously created managed rule is currently
+ * disabled, a subsequent call to this API will re-enable it. Use
+ * ListManagedInsightRules to describe all available rules.
+ *
+ *
The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class PutManagedInsightRulesCommand extends $Command + .classBuilder< + PutManagedInsightRulesCommandInput, + PutManagedInsightRulesCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "PutManagedInsightRules", {}) + .n("CloudWatchClient", "PutManagedInsightRulesCommand") + .f(void 0, void 0) + .ser(se_PutManagedInsightRulesCommand) + .de(de_PutManagedInsightRulesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutManagedInsightRulesInput; + output: PutManagedInsightRulesOutput; + }; + sdk: { + input: PutManagedInsightRulesCommandInput; + output: PutManagedInsightRulesCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/PutMetricAlarmCommand.ts b/clients/client-cloudwatch-cbor/src/commands/PutMetricAlarmCommand.ts new file mode 100644 index 000000000000..b81406fd6bb1 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/PutMetricAlarmCommand.ts @@ -0,0 +1,203 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutMetricAlarmInput } from "../models/models_0"; +import { de_PutMetricAlarmCommand, se_PutMetricAlarmCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutMetricAlarmCommand}. + */ +export interface PutMetricAlarmCommandInput extends PutMetricAlarmInput {} +/** + * @public + * + * The output of {@link PutMetricAlarmCommand}. + */ +export interface PutMetricAlarmCommandOutput extends __MetadataBearer {} + +/** + *Creates or updates an alarm and associates it with the specified metric, metric + * math expression, anomaly detection model, or Metrics Insights query. For more + * information about using a Metrics Insights query for an alarm, see Create + * alarms on Metrics Insights queries.
+ *Alarms based on anomaly detection models cannot have Auto Scaling actions.
+ *When this operation creates an alarm, the alarm state is immediately set to
+ * INSUFFICIENT_DATA. The alarm is then evaluated and its state is set
+ * appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update + * completely overwrites the previous configuration of the alarm.
+ *If you are an IAM user, you must have Amazon EC2 permissions for + * some alarm operations:
+ *The iam:CreateServiceLinkedRole permission for all alarms with
+ * EC2 actions
The iam:CreateServiceLinkedRole permissions to create an alarm
+ * with Systems Manager OpsItem or response plan actions.
The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary
+ * service-linked role for you. The service-linked roles are called
+ * AWSServiceRoleForCloudWatchEvents and
+ * AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see
+ * Amazon Web Services service-linked role.
Each PutMetricAlarm action has a maximum uncompressed payload of 120
+ * KB.
+ * Cross-account alarms + *
+ *You can set an alarm on metrics in the current account, or in another account. To + * create a cross-account alarm that watches a metric in a different account, you must have + * completed the following pre-requisites:
+ *The account where the metrics are located (the sharing + * account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not + * already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy + * for that role must grant access to the ID of the account where you are creating + * the alarm.
+ *The account where you are creating the alarm (the monitoring + * account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow + * CloudWatch to assume the sharing role in the sharing account. If it + * does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.
+ *The quota for alarms for this customer has already been reached.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class PutMetricAlarmCommand extends $Command + .classBuilder< + PutMetricAlarmCommandInput, + PutMetricAlarmCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "PutMetricAlarm", {}) + .n("CloudWatchClient", "PutMetricAlarmCommand") + .f(void 0, void 0) + .ser(se_PutMetricAlarmCommand) + .de(de_PutMetricAlarmCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutMetricAlarmInput; + output: {}; + }; + sdk: { + input: PutMetricAlarmCommandInput; + output: PutMetricAlarmCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/PutMetricDataCommand.ts b/clients/client-cloudwatch-cbor/src/commands/PutMetricDataCommand.ts new file mode 100644 index 000000000000..7d33110fdad0 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/PutMetricDataCommand.ts @@ -0,0 +1,222 @@ +// smithy-typescript generated code +import { getCompressionPlugin } from "@smithy/middleware-compression"; +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutMetricDataInput } from "../models/models_0"; +import { de_PutMetricDataCommand, se_PutMetricDataCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutMetricDataCommand}. + */ +export interface PutMetricDataCommandInput extends PutMetricDataInput {} +/** + * @public + * + * The output of {@link PutMetricDataCommand}. + */ +export interface PutMetricDataCommandOutput extends __MetadataBearer {} + +/** + *Publishes metric data to Amazon CloudWatch. CloudWatch associates the data with the + * specified metric. If the specified metric does not exist, CloudWatch creates the metric. + * When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to + * appear in calls to ListMetrics.
+ *You can publish metrics with associated entity data (so that related telemetry can be
+ * found and viewed together), or publish metric data by itself. To send entity data with
+ * your metrics, use the EntityMetricData parameter. To send metrics without
+ * entity data, use the MetricData parameter. The
+ * EntityMetricData structure includes MetricData structures
+ * for the metric data.
You can publish either individual values in the Value field, or arrays of
+ * values and the number of times each value occurred during the period by using the
+ * Values and Counts fields in the MetricData
+ * structure. Using the Values and Counts method enables you to
+ * publish up to 150 values per metric with one PutMetricData request, and
+ * supports retrieving percentile statistics on this data.
Each PutMetricData request is limited to 1 MB in size for HTTP POST
+ * requests. You can send a payload compressed by gzip. Each request is also limited to no
+ * more than 1000 different metrics (across both the MetricData and
+ * EntityMetricData properties).
Although the Value parameter accepts numbers of type Double,
+ * CloudWatch rejects values that are either too small or too large. Values must be in the
+ * range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
+ * -Infinity) are not supported.
You can use up to 30 dimensions per metric to further clarify what data the metric + * collects. Each dimension consists of a Name and Value pair. For more information about + * specifying dimensions, see Publishing + * Metrics in the Amazon CloudWatch User Guide.
+ *You specify the time stamp to be associated with each data point. You can specify time + * stamps that are as much as two weeks before the current date, and as much as 2 hours + * after the current day and time.
+ *Data points with time stamps from 24 hours ago or longer can take at least 48 hours to + * become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time + * stamps between 3 and 24 hours ago can take as much as 2 hours to become available for + * GetMetricData or GetMetricStatistics.
+ *CloudWatch needs raw data points to calculate percentile statistics. If you publish + * data using a statistic set instead, you can only retrieve percentile statistics for this + * data if one of the following conditions is true:
+ *The SampleCount value of the statistic set is 1 and
+ * Min, Max, and Sum are all
+ * equal.
The Min and Max are equal, and Sum
+ * is equal to Min multiplied by SampleCount.
Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterCombinationException} (client fault) + *Parameters were used together that cannot be used together.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class PutMetricDataCommand extends $Command + .classBuilder< + PutMetricDataCommandInput, + PutMetricDataCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + getCompressionPlugin(config, { + encodings: ["gzip"], + }), + ]; + }) + .s("GraniteServiceVersion20100801", "PutMetricData", {}) + .n("CloudWatchClient", "PutMetricDataCommand") + .f(void 0, void 0) + .ser(se_PutMetricDataCommand) + .de(de_PutMetricDataCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutMetricDataInput; + output: {}; + }; + sdk: { + input: PutMetricDataCommandInput; + output: PutMetricDataCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/PutMetricStreamCommand.ts b/clients/client-cloudwatch-cbor/src/commands/PutMetricStreamCommand.ts new file mode 100644 index 000000000000..51b04ba7ba85 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/PutMetricStreamCommand.ts @@ -0,0 +1,180 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutMetricStreamInput, PutMetricStreamOutput } from "../models/models_0"; +import { de_PutMetricStreamCommand, se_PutMetricStreamCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutMetricStreamCommand}. + */ +export interface PutMetricStreamCommandInput extends PutMetricStreamInput {} +/** + * @public + * + * The output of {@link PutMetricStreamCommand}. + */ +export interface PutMetricStreamCommandOutput extends PutMetricStreamOutput, __MetadataBearer {} + +/** + *Creates or updates a metric stream. Metric streams can automatically stream CloudWatch + * metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party + * solutions.
+ *For more information, see Using + * Metric Streams.
+ *To create a metric stream, you must be signed in to an account that has the
+ * iam:PassRole permission and either the
+ * CloudWatchFullAccess policy or the
+ * cloudwatch:PutMetricStream permission.
When you create or update a metric stream, you choose one of the following:
+ *Stream metrics from all metric namespaces in the account.
+ *Stream metrics from all metric namespaces in the account, except for the
+ * namespaces that you list in ExcludeFilters.
Stream metrics from only the metric namespaces that you list in
+ * IncludeFilters.
By default, a metric stream always sends the MAX, MIN,
+ * SUM, and SAMPLECOUNT statistics for each metric that is
+ * streamed. You can use the StatisticsConfigurations parameter to have the
+ * metric stream send additional statistics in the stream. Streaming additional statistics
+ * incurs additional costs. For more information, see Amazon CloudWatch Pricing.
When you use PutMetricStream to create a new metric stream, the stream is
+ * created in the running state. If you use it to update an existing stream,
+ * the state of the stream is not changed.
If you are using CloudWatch cross-account observability and you create a metric + * stream in a monitoring account, you can choose whether to include metrics from source + * accounts in the stream. For more information, see CloudWatch cross-account observability.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, PutMetricStreamCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, PutMetricStreamCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // PutMetricStreamInput + * Name: "STRING_VALUE", // required + * IncludeFilters: [ // MetricStreamFilters + * { // MetricStreamFilter + * Namespace: "STRING_VALUE", + * MetricNames: [ // MetricStreamFilterMetricNames + * "STRING_VALUE", + * ], + * }, + * ], + * ExcludeFilters: [ + * { + * Namespace: "STRING_VALUE", + * MetricNames: [ + * "STRING_VALUE", + * ], + * }, + * ], + * FirehoseArn: "STRING_VALUE", // required + * RoleArn: "STRING_VALUE", // required + * OutputFormat: "json" || "opentelemetry0.7" || "opentelemetry1.0", // required + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * StatisticsConfigurations: [ // MetricStreamStatisticsConfigurations + * { // MetricStreamStatisticsConfiguration + * IncludeMetrics: [ // MetricStreamStatisticsIncludeMetrics // required + * { // MetricStreamStatisticsMetric + * Namespace: "STRING_VALUE", // required + * MetricName: "STRING_VALUE", // required + * }, + * ], + * AdditionalStatistics: [ // MetricStreamStatisticsAdditionalStatistics // required + * "STRING_VALUE", + * ], + * }, + * ], + * IncludeLinkedAccountsMetrics: true || false, + * }; + * const command = new PutMetricStreamCommand(input); + * const response = await client.send(command); + * // { // PutMetricStreamOutput + * // Arn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param PutMetricStreamCommandInput - {@link PutMetricStreamCommandInput} + * @returns {@link PutMetricStreamCommandOutput} + * @see {@link PutMetricStreamCommandInput} for command's `input` shape. + * @see {@link PutMetricStreamCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link ConcurrentModificationException} (client fault) + *More than one process tried to modify a resource at the same time.
+ * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterCombinationException} (client fault) + *Parameters were used together that cannot be used together.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class PutMetricStreamCommand extends $Command + .classBuilder< + PutMetricStreamCommandInput, + PutMetricStreamCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "PutMetricStream", {}) + .n("CloudWatchClient", "PutMetricStreamCommand") + .f(void 0, void 0) + .ser(se_PutMetricStreamCommand) + .de(de_PutMetricStreamCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutMetricStreamInput; + output: PutMetricStreamOutput; + }; + sdk: { + input: PutMetricStreamCommandInput; + output: PutMetricStreamCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/SetAlarmStateCommand.ts b/clients/client-cloudwatch-cbor/src/commands/SetAlarmStateCommand.ts new file mode 100644 index 000000000000..bfedb38bf5a5 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/SetAlarmStateCommand.ts @@ -0,0 +1,114 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { SetAlarmStateInput } from "../models/models_0"; +import { de_SetAlarmStateCommand, se_SetAlarmStateCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link SetAlarmStateCommand}. + */ +export interface SetAlarmStateCommandInput extends SetAlarmStateInput {} +/** + * @public + * + * The output of {@link SetAlarmStateCommand}. + */ +export interface SetAlarmStateCommandOutput extends __MetadataBearer {} + +/** + *Temporarily sets the state of an alarm for testing purposes. When the updated state
+ * differs from the previous value, the action configured for the appropriate state is
+ * invoked. For example, if your alarm is configured to send an Amazon SNS message when an
+ * alarm is triggered, temporarily changing the alarm state to ALARM sends an
+ * SNS message.
Metric alarms returns to their actual state quickly, often within seconds. Because + * the metric alarm state change happens quickly, it is typically only visible in the + * alarm's History tab in the Amazon CloudWatch console or + * through DescribeAlarmHistory.
+ *If you use SetAlarmState on a composite alarm, the composite alarm is
+ * not guaranteed to return to its actual state. It returns to its actual state only once
+ * any of its children alarms change state. It is also reevaluated if you update its
+ * configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling
+ * policies, you must include information in the StateReasonData parameter to
+ * enable the policy to take the correct action.
Data was not syntactically valid JSON.
+ * + * @throws {@link ResourceNotFound} (client fault) + *The named resource does not exist.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class SetAlarmStateCommand extends $Command + .classBuilder< + SetAlarmStateCommandInput, + SetAlarmStateCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "SetAlarmState", {}) + .n("CloudWatchClient", "SetAlarmStateCommand") + .f(void 0, void 0) + .ser(se_SetAlarmStateCommand) + .de(de_SetAlarmStateCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: SetAlarmStateInput; + output: {}; + }; + sdk: { + input: SetAlarmStateCommandInput; + output: SetAlarmStateCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/StartMetricStreamsCommand.ts b/clients/client-cloudwatch-cbor/src/commands/StartMetricStreamsCommand.ts new file mode 100644 index 000000000000..d108894473dd --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/StartMetricStreamsCommand.ts @@ -0,0 +1,102 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { StartMetricStreamsInput, StartMetricStreamsOutput } from "../models/models_0"; +import { de_StartMetricStreamsCommand, se_StartMetricStreamsCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link StartMetricStreamsCommand}. + */ +export interface StartMetricStreamsCommandInput extends StartMetricStreamsInput {} +/** + * @public + * + * The output of {@link StartMetricStreamsCommand}. + */ +export interface StartMetricStreamsCommandOutput extends StartMetricStreamsOutput, __MetadataBearer {} + +/** + *Starts the streaming of metrics for one or more of your metric streams.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, StartMetricStreamsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, StartMetricStreamsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // StartMetricStreamsInput + * Names: [ // MetricStreamNames // required + * "STRING_VALUE", + * ], + * }; + * const command = new StartMetricStreamsCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param StartMetricStreamsCommandInput - {@link StartMetricStreamsCommandInput} + * @returns {@link StartMetricStreamsCommandOutput} + * @see {@link StartMetricStreamsCommandInput} for command's `input` shape. + * @see {@link StartMetricStreamsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class StartMetricStreamsCommand extends $Command + .classBuilder< + StartMetricStreamsCommandInput, + StartMetricStreamsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "StartMetricStreams", {}) + .n("CloudWatchClient", "StartMetricStreamsCommand") + .f(void 0, void 0) + .ser(se_StartMetricStreamsCommand) + .de(de_StartMetricStreamsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: StartMetricStreamsInput; + output: {}; + }; + sdk: { + input: StartMetricStreamsCommandInput; + output: StartMetricStreamsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/StopMetricStreamsCommand.ts b/clients/client-cloudwatch-cbor/src/commands/StopMetricStreamsCommand.ts new file mode 100644 index 000000000000..2e0e0275c075 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/StopMetricStreamsCommand.ts @@ -0,0 +1,102 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { StopMetricStreamsInput, StopMetricStreamsOutput } from "../models/models_0"; +import { de_StopMetricStreamsCommand, se_StopMetricStreamsCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link StopMetricStreamsCommand}. + */ +export interface StopMetricStreamsCommandInput extends StopMetricStreamsInput {} +/** + * @public + * + * The output of {@link StopMetricStreamsCommand}. + */ +export interface StopMetricStreamsCommandOutput extends StopMetricStreamsOutput, __MetadataBearer {} + +/** + *Stops the streaming of metrics for one or more of your metric streams.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, StopMetricStreamsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, StopMetricStreamsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // StopMetricStreamsInput + * Names: [ // MetricStreamNames // required + * "STRING_VALUE", + * ], + * }; + * const command = new StopMetricStreamsCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param StopMetricStreamsCommandInput - {@link StopMetricStreamsCommandInput} + * @returns {@link StopMetricStreamsCommandOutput} + * @see {@link StopMetricStreamsCommandInput} for command's `input` shape. + * @see {@link StopMetricStreamsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link MissingRequiredParameterException} (client fault) + *An input parameter that is required is missing.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class StopMetricStreamsCommand extends $Command + .classBuilder< + StopMetricStreamsCommandInput, + StopMetricStreamsCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "StopMetricStreams", {}) + .n("CloudWatchClient", "StopMetricStreamsCommand") + .f(void 0, void 0) + .ser(se_StopMetricStreamsCommand) + .de(de_StopMetricStreamsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: StopMetricStreamsInput; + output: {}; + }; + sdk: { + input: StopMetricStreamsCommandInput; + output: StopMetricStreamsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/TagResourceCommand.ts b/clients/client-cloudwatch-cbor/src/commands/TagResourceCommand.ts new file mode 100644 index 000000000000..6857eb042dc6 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/TagResourceCommand.ts @@ -0,0 +1,122 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { TagResourceInput, TagResourceOutput } from "../models/models_0"; +import { de_TagResourceCommand, se_TagResourceCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link TagResourceCommand}. + */ +export interface TagResourceCommandInput extends TagResourceInput {} +/** + * @public + * + * The output of {@link TagResourceCommand}. + */ +export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {} + +/** + *Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. + * Currently, the only CloudWatch resources that can be tagged are alarms and Contributor + * Insights rules.
+ *Tags can help you organize and categorize your resources. You can also use them to + * scope user permissions by granting a user permission to access or change only resources + * with certain tag values.
+ *Tags don't have any semantic meaning to Amazon Web Services and are interpreted + * strictly as strings of characters.
+ *You can use the TagResource action with an alarm that already has tags.
+ * If you specify a new tag key for the alarm, this tag is appended to the list of tags
+ * associated with the alarm. If you specify a tag key that is already associated with the
+ * alarm, the new tag value that you specify replaces the previous value for that
+ * tag.
You can associate as many as 50 tags with a CloudWatch resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, TagResourceCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, TagResourceCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // TagResourceInput + * ResourceARN: "STRING_VALUE", // required + * Tags: [ // TagList // required + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param TagResourceCommandInput - {@link TagResourceCommandInput} + * @returns {@link TagResourceCommandOutput} + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link ConcurrentModificationException} (client fault) + *More than one process tried to modify a resource at the same time.
+ * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The named resource does not exist.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class TagResourceCommand extends $Command + .classBuilder< + TagResourceCommandInput, + TagResourceCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "TagResource", {}) + .n("CloudWatchClient", "TagResourceCommand") + .f(void 0, void 0) + .ser(se_TagResourceCommand) + .de(de_TagResourceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: TagResourceInput; + output: {}; + }; + sdk: { + input: TagResourceCommandInput; + output: TagResourceCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/UntagResourceCommand.ts b/clients/client-cloudwatch-cbor/src/commands/UntagResourceCommand.ts new file mode 100644 index 000000000000..d484cc4bf21a --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/UntagResourceCommand.ts @@ -0,0 +1,106 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { UntagResourceInput, UntagResourceOutput } from "../models/models_0"; +import { de_UntagResourceCommand, se_UntagResourceCommand } from "../protocols/Rpcv2cbor"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandInput extends UntagResourceInput {} +/** + * @public + * + * The output of {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {} + +/** + *Removes one or more tags from the specified resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, UntagResourceCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, UntagResourceCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const input = { // UntagResourceInput + * ResourceARN: "STRING_VALUE", // required + * TagKeys: [ // TagKeyList // required + * "STRING_VALUE", + * ], + * }; + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UntagResourceCommandInput - {@link UntagResourceCommandInput} + * @returns {@link UntagResourceCommandOutput} + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. + * + * @throws {@link ConcurrentModificationException} (client fault) + *More than one process tried to modify a resource at the same time.
+ * + * @throws {@link InternalServiceFault} (server fault) + *Request processing has failed due to some unknown error, exception, or + * failure.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *The value of an input parameter is bad or out-of-range.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The named resource does not exist.
+ * + * @throws {@link CloudWatchServiceException} + *Base exception class for all service exceptions from CloudWatch service.
+ * + * @public + */ +export class UntagResourceCommand extends $Command + .classBuilder< + UntagResourceCommandInput, + UntagResourceCommandOutput, + CloudWatchClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("GraniteServiceVersion20100801", "UntagResource", {}) + .n("CloudWatchClient", "UntagResourceCommand") + .f(void 0, void 0) + .ser(se_UntagResourceCommand) + .de(de_UntagResourceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UntagResourceInput; + output: {}; + }; + sdk: { + input: UntagResourceCommandInput; + output: UntagResourceCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-cbor/src/commands/index.ts b/clients/client-cloudwatch-cbor/src/commands/index.ts new file mode 100644 index 000000000000..b683c66327bd --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/commands/index.ts @@ -0,0 +1,39 @@ +// smithy-typescript generated code +export * from "./DeleteAlarmsCommand"; +export * from "./DeleteAnomalyDetectorCommand"; +export * from "./DeleteDashboardsCommand"; +export * from "./DeleteInsightRulesCommand"; +export * from "./DeleteMetricStreamCommand"; +export * from "./DescribeAlarmHistoryCommand"; +export * from "./DescribeAlarmsCommand"; +export * from "./DescribeAlarmsForMetricCommand"; +export * from "./DescribeAnomalyDetectorsCommand"; +export * from "./DescribeInsightRulesCommand"; +export * from "./DisableAlarmActionsCommand"; +export * from "./DisableInsightRulesCommand"; +export * from "./EnableAlarmActionsCommand"; +export * from "./EnableInsightRulesCommand"; +export * from "./GetDashboardCommand"; +export * from "./GetInsightRuleReportCommand"; +export * from "./GetMetricDataCommand"; +export * from "./GetMetricStatisticsCommand"; +export * from "./GetMetricStreamCommand"; +export * from "./GetMetricWidgetImageCommand"; +export * from "./ListDashboardsCommand"; +export * from "./ListManagedInsightRulesCommand"; +export * from "./ListMetricStreamsCommand"; +export * from "./ListMetricsCommand"; +export * from "./ListTagsForResourceCommand"; +export * from "./PutAnomalyDetectorCommand"; +export * from "./PutCompositeAlarmCommand"; +export * from "./PutDashboardCommand"; +export * from "./PutInsightRuleCommand"; +export * from "./PutManagedInsightRulesCommand"; +export * from "./PutMetricAlarmCommand"; +export * from "./PutMetricDataCommand"; +export * from "./PutMetricStreamCommand"; +export * from "./SetAlarmStateCommand"; +export * from "./StartMetricStreamsCommand"; +export * from "./StopMetricStreamsCommand"; +export * from "./TagResourceCommand"; +export * from "./UntagResourceCommand"; diff --git a/clients/client-cloudwatch-cbor/src/endpoint/EndpointParameters.ts b/clients/client-cloudwatch-cbor/src/endpoint/EndpointParameters.ts new file mode 100644 index 000000000000..89e75ae2e936 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/endpoint/EndpointParameters.ts @@ -0,0 +1,41 @@ +// smithy-typescript generated code +import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types"; + +/** + * @public + */ +export interface ClientInputEndpointParameters { + region?: string | ProviderAmazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) + * resources and the applications you run on Amazon Web Services in real time. You can use + * CloudWatch to collect and track metrics, which are the variables you want to + * measure for your resources and applications.
+ *CloudWatch alarms send notifications or automatically change the resources you are + * monitoring based on rules that you define. For example, you can monitor the CPU usage + * and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine + * whether you should launch additional instances to handle increased load. You can also + * use this data to stop under-used instances to save money.
+ *In addition to monitoring the built-in metrics that come with Amazon Web Services, + * you can monitor your own custom metrics. With CloudWatch, you gain system-wide + * visibility into resource utilization, application performance, and operational + * health.
+ * + * @packageDocumentation + */ +export * from "./CloudWatchClient"; +export * from "./CloudWatch"; +export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters"; +export type { RuntimeExtension } from "./runtimeExtensions"; +export type { CloudWatchExtensionConfiguration } from "./extensionConfiguration"; +export * from "./commands"; +export * from "./pagination"; +export * from "./waiters"; +export * from "./models"; + +export { CloudWatchServiceException } from "./models/CloudWatchServiceException"; diff --git a/clients/client-cloudwatch-cbor/src/models/CloudWatchServiceException.ts b/clients/client-cloudwatch-cbor/src/models/CloudWatchServiceException.ts new file mode 100644 index 000000000000..051f7f8e2a3a --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/models/CloudWatchServiceException.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { + ServiceException as __ServiceException, + ServiceExceptionOptions as __ServiceExceptionOptions, +} from "@smithy/smithy-client"; + +export type { __ServiceExceptionOptions }; + +export { __ServiceException }; + +/** + * @public + * + * Base exception class for all service exceptions from CloudWatch service. + */ +export class CloudWatchServiceException extends __ServiceException { + /** + * @internal + */ + constructor(options: __ServiceExceptionOptions) { + super(options); + Object.setPrototypeOf(this, CloudWatchServiceException.prototype); + } +} diff --git a/clients/client-cloudwatch-cbor/src/models/index.ts b/clients/client-cloudwatch-cbor/src/models/index.ts new file mode 100644 index 000000000000..9eaceb12865f --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/models/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./models_0"; diff --git a/clients/client-cloudwatch-cbor/src/models/models_0.ts b/clients/client-cloudwatch-cbor/src/models/models_0.ts new file mode 100644 index 000000000000..afbc14643101 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/models/models_0.ts @@ -0,0 +1,5152 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; + +import { CloudWatchServiceException as __BaseException } from "./CloudWatchServiceException"; + +/** + * @public + * @enum + */ +export const ActionsSuppressedBy = { + Alarm: "Alarm", + ExtensionPeriod: "ExtensionPeriod", + WaitPeriod: "WaitPeriod", +} as const; + +/** + * @public + */ +export type ActionsSuppressedBy = (typeof ActionsSuppressedBy)[keyof typeof ActionsSuppressedBy]; + +/** + * @public + * @enum + */ +export const AlarmType = { + CompositeAlarm: "CompositeAlarm", + MetricAlarm: "MetricAlarm", +} as const; + +/** + * @public + */ +export type AlarmType = (typeof AlarmType)[keyof typeof AlarmType]; + +/** + * @public + * @enum + */ +export const HistoryItemType = { + Action: "Action", + ConfigurationUpdate: "ConfigurationUpdate", + StateUpdate: "StateUpdate", +} as const; + +/** + * @public + */ +export type HistoryItemType = (typeof HistoryItemType)[keyof typeof HistoryItemType]; + +/** + *Represents the history of a specific alarm.
+ * @public + */ +export interface AlarmHistoryItem { + /** + *The descriptive name for the alarm.
+ * @public + */ + AlarmName?: string | undefined; + + /** + *The type of alarm, either metric alarm or composite alarm.
+ * @public + */ + AlarmType?: AlarmType | undefined; + + /** + *The time stamp for the alarm history item.
+ * @public + */ + Timestamp?: Date | undefined; + + /** + *The type of alarm history item.
+ * @public + */ + HistoryItemType?: HistoryItemType | undefined; + + /** + *A summary of the alarm history, in text format.
+ * @public + */ + HistorySummary?: string | undefined; + + /** + *Data about the alarm, in JSON format.
+ * @public + */ + HistoryData?: string | undefined; +} + +/** + *Specifies one range of days or times to exclude from use for training an anomaly + * detection model.
+ * @public + */ +export interface Range { + /** + *The start time of the range to exclude. The format is
+ * yyyy-MM-dd'T'HH:mm:ss. For example,
+ * 2019-07-01T23:59:59.
The end time of the range to exclude. The format is
+ * yyyy-MM-dd'T'HH:mm:ss. For example,
+ * 2019-07-01T23:59:59.
The configuration specifies details about how the anomaly detection model is to be + * trained, including time ranges to exclude from use for training the model and the time + * zone to use for the metric.
+ * @public + */ +export interface AnomalyDetectorConfiguration { + /** + *An array of time ranges to exclude from use when the anomaly detection model is + * trained. Use this to make sure that events that could cause unusual values for the + * metric, such as deployments, aren't used when CloudWatch creates the model.
+ * @public + */ + ExcludedTimeRanges?: Range[] | undefined; + + /** + *The time zone to use for the metric. This is useful to enable the model to + * automatically account for daylight savings time changes if the metric is sensitive to + * such time changes.
+ *To specify a time zone, use the name of the time zone as specified in the standard + * tz database. For more information, see tz database.
+ * @public + */ + MetricTimezone?: string | undefined; +} + +/** + *A dimension is a name/value pair that is part of the identity of a metric. Because
+ * dimensions are part of the unique identifier for a metric, whenever you add a unique
+ * name/value pair to one of your metrics, you are creating a new variation of that metric.
+ * For example, many Amazon EC2 metrics publish InstanceId as a
+ * dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
+ * @public + */ +export interface Dimension { + /** + *The name of the dimension. Dimension names must contain only ASCII characters, must
+ * include at least one non-whitespace character, and cannot start with a colon
+ * (:). ASCII control characters are not supported as part of dimension
+ * names.
The value of the dimension. Dimension values must contain only ASCII characters and + * must include at least one non-whitespace character. ASCII control characters are not + * supported as part of dimension values.
+ * @public + */ + Value: string | undefined; +} + +/** + *This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.
+ * @public + */ +export interface MetricCharacteristics { + /** + *Set this parameter to true if values for this metric consistently include
+ * spikes that should not be considered to be anomalies. With this set to
+ * true, CloudWatch will expect to see spikes that occurred
+ * consistently during the model training period, and won't flag future similar spikes as
+ * anomalies.
Represents a specific metric.
+ * @public + */ +export interface Metric { + /** + *The namespace of the metric.
+ * @public + */ + Namespace?: string | undefined; + + /** + *The name of the metric. This is a required field.
+ * @public + */ + MetricName?: string | undefined; + + /** + *The dimensions for the metric.
+ * @public + */ + Dimensions?: Dimension[] | undefined; +} + +/** + * @public + * @enum + */ +export const StandardUnit = { + Bits: "Bits", + Bits_Second: "Bits/Second", + Bytes: "Bytes", + Bytes_Second: "Bytes/Second", + Count: "Count", + Count_Second: "Count/Second", + Gigabits: "Gigabits", + Gigabits_Second: "Gigabits/Second", + Gigabytes: "Gigabytes", + Gigabytes_Second: "Gigabytes/Second", + Kilobits: "Kilobits", + Kilobits_Second: "Kilobits/Second", + Kilobytes: "Kilobytes", + Kilobytes_Second: "Kilobytes/Second", + Megabits: "Megabits", + Megabits_Second: "Megabits/Second", + Megabytes: "Megabytes", + Megabytes_Second: "Megabytes/Second", + Microseconds: "Microseconds", + Milliseconds: "Milliseconds", + None: "None", + Percent: "Percent", + Seconds: "Seconds", + Terabits: "Terabits", + Terabits_Second: "Terabits/Second", + Terabytes: "Terabytes", + Terabytes_Second: "Terabytes/Second", +} as const; + +/** + * @public + */ +export type StandardUnit = (typeof StandardUnit)[keyof typeof StandardUnit]; + +/** + *This structure defines the metric to be returned, along with the statistics, period, + * and units.
+ * @public + */ +export interface MetricStat { + /** + *The metric to return, including the metric name, namespace, and dimensions.
+ * @public + */ + Metric: Metric | undefined; + + /** + *The granularity, in seconds, of the returned data points. For metrics with regular
+ * resolution, a period can be as short as one minute (60 seconds) and must be a multiple
+ * of 60. For high-resolution metrics that are collected at intervals of less than one
+ * minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
+ * metrics are those metrics stored by a PutMetricData call that includes a
+ * StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than
+ * 3 hours ago, you must specify the period as follows or no data points in that time range
+ * is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds + * (1 minute).
+ *Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 + * minutes).
+ *Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 + * hour).
+ *The statistic to return. It can include any CloudWatch statistic or extended + * statistic.
+ * @public + */ + Stat: string | undefined; + + /** + *When you are using a Put operation, this defines what unit you want to
+ * use when storing the metric.
In a Get operation, if you omit Unit then all data that
+ * was collected with any unit is returned, along with the corresponding units that were
+ * specified when the data was reported to CloudWatch. If you specify a unit, the operation
+ * returns only data that was collected with that unit specified. If you specify a unit
+ * that does not match the data collected, the results of the operation are null.
+ * CloudWatch does not perform unit conversions.
This structure is used in both GetMetricData and
+ * PutMetricAlarm. The supported use of this structure is different for
+ * those two operations.
When used in GetMetricData, it indicates the metric data to return, and
+ * whether this call is just retrieving a batch set of data for one metric, or is
+ * performing a Metrics Insights query or a math expression. A single
+ * GetMetricData call can include up to 500 MetricDataQuery
+ * structures.
When used in PutMetricAlarm, it enables you to create an alarm based on a
+ * metric math expression. Each MetricDataQuery in the array specifies either
+ * a metric to retrieve, or a math expression to be performed on retrieved metrics. A
+ * single PutMetricAlarm call can include up to 20
+ * MetricDataQuery structures in the array. The 20 structures can include
+ * as many as 10 structures that contain a MetricStat parameter to retrieve a
+ * metric, and as many as 10 structures that contain the Expression parameter
+ * to perform a math expression. Of those Expression structures, one must have
+ * true as the value for ReturnData. The result of this
+ * expression is the value the alarm watches.
Any expression used in a PutMetricAlarm operation must return a single
+ * time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User
+ * Guide.
Some of the parameters of this structure also have different uses whether you are
+ * using this structure in a GetMetricData operation or a
+ * PutMetricAlarm operation. These differences are explained in the
+ * following parameter list.
A short name used to tie this object to the results in the response. This name must be
+ * unique within a single call to GetMetricData. If you are performing math
+ * expressions on this set of data, this name represents that data and can serve as a
+ * variable in the mathematical expression. The valid characters are letters, numbers, and
+ * underscore. The first character must be a lowercase letter.
The metric to be returned, along with statistics, period, and units. Use this + * parameter only if this object is retrieving a metric and not performing a math + * expression on returned data.
+ *Within one MetricDataQuery object, you must specify either Expression or
+ * MetricStat but not both.
This field can contain either a Metrics Insights query, or a metric math expression to + * be performed on the returned data. For more information about Metrics Insights queries, + * see Metrics Insights query components and syntax in the Amazon + * CloudWatch User Guide.
+ *A math expression can use the Id of the other metrics or queries to refer
+ * to those metrics, and can also use the Id of other expressions to use the
+ * result of those expressions. For more information about metric math expressions, see
+ * Metric Math Syntax and Functions in the Amazon CloudWatch User
+ * Guide.
Within each MetricDataQuery object, you must specify either Expression or
+ * MetricStat but not both.
A human-readable label for this metric or expression. This is especially useful if + * this is an expression, so that you know what the value represents. If the metric or + * expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is + * omitted, CloudWatch generates a default.
+ *You can put dynamic expressions into a label, so that it is more descriptive. For more + * information, see Using Dynamic + * Labels.
+ * @public + */ + Label?: string | undefined; + + /** + *When used in GetMetricData, this option indicates whether to return the
+ * timestamps and raw data values of this metric. If you are performing this call just to
+ * do math expressions and do not also need the raw data returned, you can specify
+ * false. If you omit this, the default of true is
+ * used.
When used in PutMetricAlarm, specify true for the one
+ * expression result to use as the alarm. For all other metrics and expressions in the same
+ * PutMetricAlarm operation, specify ReturnData as
+ * False.
The granularity, in seconds, of the returned data points. For metrics with regular
+ * resolution, a period can be as short as one minute (60 seconds) and must be a multiple
+ * of 60. For high-resolution metrics that are collected at intervals of less than one
+ * minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
+ * metrics are those metrics stored by a PutMetricData operation that includes
+ * a StorageResolution of 1 second.
The ID of the account where the metrics are located.
+ *If you are performing a GetMetricData operation in a monitoring account,
+ * use this to specify which account to retrieve this metric from.
If you are performing a PutMetricAlarm operation, use this to specify
+ * which account contains the metric that the alarm is watching.
Indicates the CloudWatch math expression that provides the time series the anomaly + * detector uses as input. The designated math expression must return a single time + * series.
+ * @public + */ +export interface MetricMathAnomalyDetector { + /** + *An array of metric data query structures that enables you to create an anomaly
+ * detector based on the result of a metric math expression. Each item in
+ * MetricDataQueries gets a metric or performs a math expression. One item
+ * in MetricDataQueries is the expression that provides the time series that
+ * the anomaly detector uses as input. Designate the expression by setting
+ * ReturnData to true for this object in the array. For all
+ * other expressions and metrics, set ReturnData to false. The
+ * designated expression must return a single time series.
Designates the CloudWatch metric and statistic that provides the time series the + * anomaly detector uses as input. If you have enabled unified cross-account observability, + * and this account is a monitoring account, the metric can be in the same account or a + * source account.
+ * @public + */ +export interface SingleMetricAnomalyDetector { + /** + *If the CloudWatch metric that provides the time series that the anomaly + * detector uses as input is in another account, specify that account ID here. If you omit + * this parameter, the current account is used.
+ * @public + */ + AccountId?: string | undefined; + + /** + *The namespace of the metric to create the anomaly detection model for.
+ * @public + */ + Namespace?: string | undefined; + + /** + *The name of the metric to create the anomaly detection model for.
+ * @public + */ + MetricName?: string | undefined; + + /** + *The metric dimensions to create the anomaly detection model for.
+ * @public + */ + Dimensions?: Dimension[] | undefined; + + /** + *The statistic to use for the metric and anomaly detection model.
+ * @public + */ + Stat?: string | undefined; +} + +/** + * @public + * @enum + */ +export const AnomalyDetectorStateValue = { + PENDING_TRAINING: "PENDING_TRAINING", + TRAINED: "TRAINED", + TRAINED_INSUFFICIENT_DATA: "TRAINED_INSUFFICIENT_DATA", +} as const; + +/** + * @public + */ +export type AnomalyDetectorStateValue = (typeof AnomalyDetectorStateValue)[keyof typeof AnomalyDetectorStateValue]; + +/** + *An anomaly detection model associated with a particular CloudWatch metric, statistic, + * or metric math expression. You can use the model to display a band of expected, normal + * values when the metric is graphed.
+ *If you have enabled unified cross-account observability, and this account is a + * monitoring account, the metric can be in the same account or a source account.
+ * @public + */ +export interface AnomalyDetector { + /** + * @deprecated + * + *The namespace of the metric associated with the anomaly detection model.
+ * @public + */ + Namespace?: string | undefined; + + /** + * @deprecated + * + *The name of the metric associated with the anomaly detection model.
+ * @public + */ + MetricName?: string | undefined; + + /** + * @deprecated + * + *The metric dimensions associated with the anomaly detection model.
+ * @public + */ + Dimensions?: Dimension[] | undefined; + + /** + * @deprecated + * + *The statistic associated with the anomaly detection model.
+ * @public + */ + Stat?: string | undefined; + + /** + *The configuration specifies details about how the anomaly detection model is to be + * trained, including time ranges to exclude from use for training the model, and the time + * zone to use for the metric.
+ * @public + */ + Configuration?: AnomalyDetectorConfiguration | undefined; + + /** + *The current status of the anomaly detector's training.
+ * @public + */ + StateValue?: AnomalyDetectorStateValue | undefined; + + /** + *This object includes parameters that you can use to provide information about your
+ * metric to CloudWatch to help it build more accurate anomaly detection models.
+ * Currently, it includes the PeriodicSpikes parameter.
The CloudWatch metric and statistic for this anomaly detector.
+ * @public + */ + SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector | undefined; + + /** + *The CloudWatch metric math expression for this anomaly detector.
+ * @public + */ + MetricMathAnomalyDetector?: MetricMathAnomalyDetector | undefined; +} + +/** + * @public + * @enum + */ +export const AnomalyDetectorType = { + METRIC_MATH: "METRIC_MATH", + SINGLE_METRIC: "SINGLE_METRIC", +} as const; + +/** + * @public + */ +export type AnomalyDetectorType = (typeof AnomalyDetectorType)[keyof typeof AnomalyDetectorType]; + +/** + *This array is empty if the API operation was successful for all the rules specified in + * the request. If the operation could not process one of the rules, the following data is + * returned for each of those rules.
+ * @public + */ +export interface PartialFailure { + /** + *The specified rule that could not be deleted.
+ * @public + */ + FailureResource?: string | undefined; + + /** + *The type of error.
+ * @public + */ + ExceptionType?: string | undefined; + + /** + *The code of the error.
+ * @public + */ + FailureCode?: string | undefined; + + /** + *A description of the error.
+ * @public + */ + FailureDescription?: string | undefined; +} + +/** + * @public + * @enum + */ +export const ComparisonOperator = { + GreaterThanOrEqualToThreshold: "GreaterThanOrEqualToThreshold", + GreaterThanThreshold: "GreaterThanThreshold", + GreaterThanUpperThreshold: "GreaterThanUpperThreshold", + LessThanLowerOrGreaterThanUpperThreshold: "LessThanLowerOrGreaterThanUpperThreshold", + LessThanLowerThreshold: "LessThanLowerThreshold", + LessThanOrEqualToThreshold: "LessThanOrEqualToThreshold", + LessThanThreshold: "LessThanThreshold", +} as const; + +/** + * @public + */ +export type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof ComparisonOperator]; + +/** + * @public + * @enum + */ +export const StateValue = { + ALARM: "ALARM", + INSUFFICIENT_DATA: "INSUFFICIENT_DATA", + OK: "OK", +} as const; + +/** + * @public + */ +export type StateValue = (typeof StateValue)[keyof typeof StateValue]; + +/** + *The details about a composite alarm.
+ * @public + */ +export interface CompositeAlarm { + /** + *Indicates whether actions should be executed during any changes to the alarm + * state.
+ * @public + */ + ActionsEnabled?: boolean | undefined; + + /** + *The actions to execute when this alarm transitions to the ALARM state from any other + * state. Each action is specified as an Amazon Resource Name (ARN).
+ * @public + */ + AlarmActions?: string[] | undefined; + + /** + *The Amazon Resource Name (ARN) of the alarm.
+ * @public + */ + AlarmArn?: string | undefined; + + /** + *The time stamp of the last update to the alarm configuration.
+ * @public + */ + AlarmConfigurationUpdatedTimestamp?: Date | undefined; + + /** + *The description of the alarm.
+ * @public + */ + AlarmDescription?: string | undefined; + + /** + *The name of the alarm.
+ * @public + */ + AlarmName?: string | undefined; + + /** + *The rule that this alarm uses to evaluate its alarm state.
+ * @public + */ + AlarmRule?: string | undefined; + + /** + *The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from + * any other state. Each action is specified as an Amazon Resource Name (ARN).
+ * @public + */ + InsufficientDataActions?: string[] | undefined; + + /** + *The actions to execute when this alarm transitions to the OK state from any other + * state. Each action is specified as an Amazon Resource Name (ARN).
+ * @public + */ + OKActions?: string[] | undefined; + + /** + *An explanation for the alarm state, in text format.
+ * @public + */ + StateReason?: string | undefined; + + /** + *An explanation for the alarm state, in JSON format.
+ * @public + */ + StateReasonData?: string | undefined; + + /** + *Tracks the timestamp of any state update, even if StateValue doesn't
+ * change.
The state value for the alarm.
+ * @public + */ + StateValue?: StateValue | undefined; + + /** + * The timestamp of the last change to the alarm's StateValue.
When the value is ALARM, it means that the actions are suppressed
+ * because the suppressor alarm is in ALARM When the value is
+ * WaitPeriod, it means that the actions are suppressed because the
+ * composite alarm is waiting for the suppressor alarm to go into into the
+ * ALARM state. The maximum waiting time is as specified in
+ * ActionsSuppressorWaitPeriod. After this time, the composite alarm
+ * performs its actions. When the value is ExtensionPeriod, it means that the
+ * actions are suppressed because the composite alarm is waiting after the suppressor alarm
+ * went out of the ALARM state. The maximum waiting time is as specified in
+ * ActionsSuppressorExtensionPeriod. After this time, the composite alarm
+ * performs its actions.
Captures the reason for action suppression.
+ * @public + */ + ActionsSuppressedReason?: string | undefined; + + /** + * Actions will be suppressed if the suppressor alarm is in the ALARM
+ * state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name
+ * (ARN) from an existing alarm.
The maximum time in seconds that the composite alarm waits for the suppressor alarm
+ * to go into the ALARM state. After this time, the composite alarm performs
+ * its actions.
+ * WaitPeriod is required only when ActionsSuppressor is
+ * specified.
The maximum time in seconds that the composite alarm waits after suppressor alarm
+ * goes out of the ALARM state. After this time, the composite alarm performs
+ * its actions.
+ * ExtensionPeriod is required only when ActionsSuppressor is
+ * specified.
More than one process tried to modify a resource at the same time.
+ * @public + */ +export class ConcurrentModificationException extends __BaseException { + readonly name: "ConcurrentModificationException" = "ConcurrentModificationException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeRepresents a specific dashboard.
+ * @public + */ +export interface DashboardEntry { + /** + *The name of the dashboard.
+ * @public + */ + DashboardName?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the dashboard.
+ * @public + */ + DashboardArn?: string | undefined; + + /** + *The time stamp of when the dashboard was last modified, either by an API call or + * through the console. This number is expressed as the number of milliseconds since Jan 1, + * 1970 00:00:00 UTC.
+ * @public + */ + LastModified?: Date | undefined; + + /** + *The size of the dashboard, in bytes.
+ * @public + */ + Size?: number | undefined; +} + +/** + *An error or warning for the operation.
+ * @public + */ +export interface DashboardValidationMessage { + /** + *The data path related to the message.
+ * @public + */ + DataPath?: string | undefined; + + /** + *A message describing the error or warning.
+ * @public + */ + Message?: string | undefined; +} + +/** + *Some part of the dashboard data is invalid.
+ * @public + */ +export class DashboardInvalidInputError extends __BaseException { + readonly name: "DashboardInvalidInputError" = "DashboardInvalidInputError"; + readonly $fault: "client" = "client"; + dashboardValidationMessages?: DashboardValidationMessage[] | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe specified dashboard does not exist.
+ * @public + */ +export class DashboardNotFoundError extends __BaseException { + readonly name: "DashboardNotFoundError" = "DashboardNotFoundError"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeEncapsulates the statistical data that CloudWatch computes from metric + * data.
+ * @public + */ +export interface Datapoint { + /** + *The time stamp used for the data point.
+ * @public + */ + Timestamp?: Date | undefined; + + /** + *The number of metric values that contributed to the aggregate value of this data + * point.
+ * @public + */ + SampleCount?: number | undefined; + + /** + *The average of the metric values that correspond to the data point.
+ * @public + */ + Average?: number | undefined; + + /** + *The sum of the metric values for the data point.
+ * @public + */ + Sum?: number | undefined; + + /** + *The minimum metric value for the data point.
+ * @public + */ + Minimum?: number | undefined; + + /** + *The maximum metric value for the data point.
+ * @public + */ + Maximum?: number | undefined; + + /** + *The standard unit for the data point.
+ * @public + */ + Unit?: StandardUnit | undefined; + + /** + *The percentile statistic for the data point.
+ * @public + */ + ExtendedStatistics?: RecordThe alarms to be deleted. Do not enclose the alarm names in quote marks.
+ * @public + */ + AlarmNames: string[] | undefined; +} + +/** + *The named resource does not exist.
+ * @public + */ +export class ResourceNotFound extends __BaseException { + readonly name: "ResourceNotFound" = "ResourceNotFound"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe namespace associated with the anomaly detection model to delete.
+ * @public + */ + Namespace?: string | undefined; + + /** + * @deprecated + * + *The metric name associated with the anomaly detection model to delete.
+ * @public + */ + MetricName?: string | undefined; + + /** + * @deprecated + * + *The metric dimensions associated with the anomaly detection model to delete.
+ * @public + */ + Dimensions?: Dimension[] | undefined; + + /** + * @deprecated + * + *The statistic associated with the anomaly detection model to delete.
+ * @public + */ + Stat?: string | undefined; + + /** + *A single metric anomaly detector to be deleted.
+ *When using SingleMetricAnomalyDetector, you cannot include the following
+ * parameters in the same operation:
+ * Dimensions,
+ * MetricName
+ *
+ * Namespace
+ *
+ * Stat
+ *
the MetricMathAnomalyDetector parameters of
+ * DeleteAnomalyDetectorInput
+ *
Instead, specify the single metric anomaly detector attributes as part of the
+ * SingleMetricAnomalyDetector property.
The metric math anomaly detector to be deleted.
+ *When using MetricMathAnomalyDetector, you cannot include following
+ * parameters in the same operation:
+ * Dimensions,
+ * MetricName
+ *
+ * Namespace
+ *
+ * Stat
+ *
the SingleMetricAnomalyDetector parameters of
+ * DeleteAnomalyDetectorInput
+ *
Instead, specify the metric math anomaly detector attributes as part of the
+ * MetricMathAnomalyDetector property.
Request processing has failed due to some unknown error, exception, or + * failure.
+ * @public + */ +export class InternalServiceFault extends __BaseException { + readonly name: "InternalServiceFault" = "InternalServiceFault"; + readonly $fault: "server" = "server"; + /** + * + * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeParameters were used together that cannot be used together.
+ * @public + */ +export class InvalidParameterCombinationException extends __BaseException { + readonly name: "InvalidParameterCombinationException" = "InvalidParameterCombinationException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe value of an input parameter is bad or out-of-range.
+ * @public + */ +export class InvalidParameterValueException extends __BaseException { + readonly name: "InvalidParameterValueException" = "InvalidParameterValueException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeAn input parameter that is required is missing.
+ * @public + */ +export class MissingRequiredParameterException extends __BaseException { + readonly name: "MissingRequiredParameterException" = "MissingRequiredParameterException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe named resource does not exist.
+ * @public + */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + ResourceType?: string | undefined; + ResourceId?: string | undefined; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe dashboards to be deleted. This parameter is required.
+ * @public + */ + DashboardNames: string[] | undefined; +} + +/** + * @public + */ +export interface DeleteDashboardsOutput {} + +/** + * @public + */ +export interface DeleteInsightRulesInput { + /** + *An array of the rule names to delete. If you need to find out the names of your rules, + * use DescribeInsightRules.
+ * @public + */ + RuleNames: string[] | undefined; +} + +/** + * @public + */ +export interface DeleteInsightRulesOutput { + /** + *An array listing the rules that could not be deleted. You cannot delete built-in + * rules.
+ * @public + */ + Failures?: PartialFailure[] | undefined; +} + +/** + * @public + */ +export interface DeleteMetricStreamInput { + /** + *The name of the metric stream to delete.
+ * @public + */ + Name: string | undefined; +} + +/** + * @public + */ +export interface DeleteMetricStreamOutput {} + +/** + * @public + * @enum + */ +export const ScanBy = { + TIMESTAMP_ASCENDING: "TimestampAscending", + TIMESTAMP_DESCENDING: "TimestampDescending", +} as const; + +/** + * @public + */ +export type ScanBy = (typeof ScanBy)[keyof typeof ScanBy]; + +/** + * @public + */ +export interface DescribeAlarmHistoryInput { + /** + *The name of the alarm.
+ * @public + */ + AlarmName?: string | undefined; + + /** + *Use this parameter to specify whether you want the operation to return metric alarms + * or composite alarms. If you omit this parameter, only metric alarms are returned.
+ * @public + */ + AlarmTypes?: AlarmType[] | undefined; + + /** + *The type of alarm histories to retrieve.
+ * @public + */ + HistoryItemType?: HistoryItemType | undefined; + + /** + *The starting date to retrieve alarm history.
+ * @public + */ + StartDate?: Date | undefined; + + /** + *The ending date to retrieve alarm history.
+ * @public + */ + EndDate?: Date | undefined; + + /** + *The maximum number of alarm history records to retrieve.
+ * @public + */ + MaxRecords?: number | undefined; + + /** + *The token returned by a previous call to indicate that there is more data + * available.
+ * @public + */ + NextToken?: string | undefined; + + /** + *Specified whether to return the newest or oldest alarm history first. Specify
+ * TimestampDescending to have the newest event history returned first,
+ * and specify TimestampAscending to have the oldest history returned
+ * first.
The alarm histories, in JSON format.
+ * @public + */ + AlarmHistoryItems?: AlarmHistoryItem[] | undefined; + + /** + *The token that marks the start of the next batch of returned results.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + *The next token specified is invalid.
+ * @public + */ +export class InvalidNextToken extends __BaseException { + readonly name: "InvalidNextToken" = "InvalidNextToken"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe names of the alarms to retrieve information about.
+ * @public + */ + AlarmNames?: string[] | undefined; + + /** + *An alarm name prefix. If you specify this parameter, you receive information about + * all alarms that have names that start with this prefix.
+ *If this parameter is specified, you cannot specify
+ * AlarmNames.
Use this parameter to specify whether you want the operation to return metric alarms + * or composite alarms. If you omit this parameter, only metric alarms are returned, even + * if composite alarms exist in the account.
+ *For example, if you omit this parameter or specify MetricAlarms, the
+ * operation returns only a list of metric alarms. It does not return any composite alarms,
+ * even if composite alarms exist in the account.
If you specify CompositeAlarms, the operation returns only a list of
+ * composite alarms, and does not return any metric alarms.
If you use this parameter and specify the name of a composite alarm, the operation
+ * returns information about the "children" alarms of the alarm you specify. These are the
+ * metric alarms and composite alarms referenced in the AlarmRule field of the
+ * composite alarm that you specify in ChildrenOfAlarmName. Information about
+ * the composite alarm that you name in ChildrenOfAlarmName is not
+ * returned.
If you specify ChildrenOfAlarmName, you cannot specify any other
+ * parameters in the request except for MaxRecords and NextToken.
+ * If you do so, you receive a validation error.
Only the Alarm Name, ARN, StateValue
+ * (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are
+ * returned by this operation when you use this parameter. To get complete information
+ * about these alarms, perform another DescribeAlarms operation and
+ * specify the parent alarm names in the AlarmNames parameter.
If you use this parameter and specify the name of a metric or composite alarm, the
+ * operation returns information about the "parent" alarms of the alarm you specify. These
+ * are the composite alarms that have AlarmRule parameters that reference the
+ * alarm named in ParentsOfAlarmName. Information about the alarm that you
+ * specify in ParentsOfAlarmName is not returned.
If you specify ParentsOfAlarmName, you cannot specify any other
+ * parameters in the request except for MaxRecords and NextToken.
+ * If you do so, you receive a validation error.
Only the Alarm Name and ARN are returned by this operation when you use this
+ * parameter. To get complete information about these alarms, perform another
+ * DescribeAlarms operation and specify the parent alarm names in the
+ * AlarmNames parameter.
Specify this parameter to receive information only about alarms that are currently + * in the state that you specify.
+ * @public + */ + StateValue?: StateValue | undefined; + + /** + *Use this parameter to filter the results of the operation to only those alarms that + * use a certain alarm action. For example, you could specify the ARN of an SNS topic to + * find all alarms that send notifications to that topic.
+ * @public + */ + ActionPrefix?: string | undefined; + + /** + *The maximum number of alarm descriptions to retrieve.
+ * @public + */ + MaxRecords?: number | undefined; + + /** + *The token returned by a previous call to indicate that there is more data + * available.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const EvaluationState = { + PARTIAL_DATA: "PARTIAL_DATA", +} as const; + +/** + * @public + */ +export type EvaluationState = (typeof EvaluationState)[keyof typeof EvaluationState]; + +/** + * @public + * @enum + */ +export const Statistic = { + Average: "Average", + Maximum: "Maximum", + Minimum: "Minimum", + SampleCount: "SampleCount", + Sum: "Sum", +} as const; + +/** + * @public + */ +export type Statistic = (typeof Statistic)[keyof typeof Statistic]; + +/** + *The details about a metric alarm.
+ * @public + */ +export interface MetricAlarm { + /** + *The name of the alarm.
+ * @public + */ + AlarmName?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the alarm.
+ * @public + */ + AlarmArn?: string | undefined; + + /** + *The description of the alarm.
+ * @public + */ + AlarmDescription?: string | undefined; + + /** + *The time stamp of the last update to the alarm configuration.
+ * @public + */ + AlarmConfigurationUpdatedTimestamp?: Date | undefined; + + /** + *Indicates whether actions should be executed during any changes to the alarm + * state.
+ * @public + */ + ActionsEnabled?: boolean | undefined; + + /** + *The actions to execute when this alarm transitions to the OK state
+ * from any other state. Each action is specified as an Amazon Resource Name
+ * (ARN).
The actions to execute when this alarm transitions to the ALARM state
+ * from any other state. Each action is specified as an Amazon Resource Name
+ * (ARN).
The actions to execute when this alarm transitions to the
+ * INSUFFICIENT_DATA state from any other state. Each action is specified
+ * as an Amazon Resource Name (ARN).
The state value for the alarm.
+ * @public + */ + StateValue?: StateValue | undefined; + + /** + *An explanation for the alarm state, in text format.
+ * @public + */ + StateReason?: string | undefined; + + /** + *An explanation for the alarm state, in JSON format.
+ * @public + */ + StateReasonData?: string | undefined; + + /** + *The time stamp of the last update to the value of either the
+ * StateValue or EvaluationState parameters.
The name of the metric associated with the alarm, if this is an alarm based on a + * single metric.
+ * @public + */ + MetricName?: string | undefined; + + /** + *The namespace of the metric associated with the alarm.
+ * @public + */ + Namespace?: string | undefined; + + /** + *The statistic for the metric associated with the alarm, other than percentile. For
+ * percentile statistics, use ExtendedStatistic.
The percentile statistic for the metric associated with the alarm. Specify a value + * between p0.0 and p100.
+ * @public + */ + ExtendedStatistic?: string | undefined; + + /** + *The dimensions for the metric associated with the alarm.
+ * @public + */ + Dimensions?: Dimension[] | undefined; + + /** + *The period, in seconds, over which the statistic is applied.
+ * @public + */ + Period?: number | undefined; + + /** + *The unit of the metric associated with the alarm.
+ * @public + */ + Unit?: StandardUnit | undefined; + + /** + *The number of periods over which data is compared to the specified + * threshold.
+ * @public + */ + EvaluationPeriods?: number | undefined; + + /** + *The number of data points that must be breaching to trigger the alarm.
+ * @public + */ + DatapointsToAlarm?: number | undefined; + + /** + *The value to compare with the specified statistic.
+ * @public + */ + Threshold?: number | undefined; + + /** + *The arithmetic operation to use when comparing the specified statistic and + * threshold. The specified statistic value is used as the first operand.
+ * @public + */ + ComparisonOperator?: ComparisonOperator | undefined; + + /** + *Sets how this alarm is to handle missing data points. The valid values are
+ * breaching, notBreaching, ignore, and
+ * missing. For more information, see Configuring how CloudWatch alarms treat missing data.
If this parameter is omitted, the default behavior of missing is
+ * used.
Used only for alarms based on percentiles. If ignore, the alarm state
+ * does not change during periods with too few data points to be statistically significant.
+ * If evaluate or this parameter is not used, the alarm is always evaluated
+ * and possibly changes state no matter how many data points are available.
An array of MetricDataQuery structures, used in an alarm based on a metric math
+ * expression. Each structure either retrieves a metric or performs a math expression. One
+ * item in the Metrics array is the math expression that the alarm watches. This expression
+ * by designated by having ReturnData set to true.
In an alarm based on an anomaly detection model, this is the ID of the
+ * ANOMALY_DETECTION_BAND function used as the threshold for the
+ * alarm.
If the value of this field is PARTIAL_DATA, the alarm is being evaluated
+ * based on only partial data. This happens if the query used for the alarm returns more
+ * than 10,000 metrics. For more information, see Create
+ * alarms on Metrics Insights queries.
The date and time that the alarm's StateValue most recently
+ * changed.
The information about any composite alarms returned by the operation.
+ * @public + */ + CompositeAlarms?: CompositeAlarm[] | undefined; + + /** + *The information about any metric alarms returned by the operation.
+ * @public + */ + MetricAlarms?: MetricAlarm[] | undefined; + + /** + *The token that marks the start of the next batch of returned results.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + * @public + */ +export interface DescribeAlarmsForMetricInput { + /** + *The name of the metric.
+ * @public + */ + MetricName: string | undefined; + + /** + *The namespace of the metric.
+ * @public + */ + Namespace: string | undefined; + + /** + *The statistic for the metric, other than percentiles. For percentile statistics,
+ * use ExtendedStatistics.
The percentile statistic for the metric. Specify a value between p0.0 and + * p100.
+ * @public + */ + ExtendedStatistic?: string | undefined; + + /** + *The dimensions associated with the metric. If the metric has any associated + * dimensions, you must specify them in order for the call to succeed.
+ * @public + */ + Dimensions?: Dimension[] | undefined; + + /** + *The period, in seconds, over which the statistic is applied.
+ * @public + */ + Period?: number | undefined; + + /** + *The unit for the metric.
+ * @public + */ + Unit?: StandardUnit | undefined; +} + +/** + * @public + */ +export interface DescribeAlarmsForMetricOutput { + /** + *The information for each alarm with the specified metric.
+ * @public + */ + MetricAlarms?: MetricAlarm[] | undefined; +} + +/** + * @public + */ +export interface DescribeAnomalyDetectorsInput { + /** + *Use the token returned by the previous operation to request the next page of + * results.
+ * @public + */ + NextToken?: string | undefined; + + /** + *The maximum number of results to return in one operation. The maximum value that you + * can specify is 100.
+ *To retrieve the remaining results, make another call with the returned
+ * NextToken value.
Limits the results to only the anomaly detection models that are associated with the + * specified namespace.
+ * @public + */ + Namespace?: string | undefined; + + /** + *Limits the results to only the anomaly detection models that are associated with the + * specified metric name. If there are multiple metrics with this name in different + * namespaces that have anomaly detection models, they're all returned.
+ * @public + */ + MetricName?: string | undefined; + + /** + *Limits the results to only the anomaly detection models that are associated with the + * specified metric dimensions. If there are multiple metrics that have these dimensions + * and have anomaly detection models associated, they're all returned.
+ * @public + */ + Dimensions?: Dimension[] | undefined; + + /** + *The anomaly detector types to request when using
+ * DescribeAnomalyDetectorsInput. If empty, defaults to
+ * SINGLE_METRIC.
The list of anomaly detection models returned by the operation.
+ * @public + */ + AnomalyDetectors?: AnomalyDetector[] | undefined; + + /** + *A token that you can use in a subsequent operation to retrieve the next set of + * results.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + * @public + */ +export interface DescribeInsightRulesInput { + /** + *Include this value, if it was returned by the previous operation, to get the next set + * of rules.
+ * @public + */ + NextToken?: string | undefined; + + /** + *The maximum number of results to return in one operation. If you omit this parameter, + * the default of 500 is used.
+ * @public + */ + MaxResults?: number | undefined; +} + +/** + *This structure contains the definition for a Contributor Insights rule. For more + * information about this rule, see Using Constributor Insights to analyze high-cardinality data in the + * Amazon CloudWatch User Guide.
+ * @public + */ +export interface InsightRule { + /** + *The name of the rule.
+ * @public + */ + Name: string | undefined; + + /** + *Indicates whether the rule is enabled or disabled.
+ * @public + */ + State: string | undefined; + + /** + *For rules that you create, this is always \{"Name": "CloudWatchLogRule",
+ * "Version": 1\}. For managed rules, this is \{"Name": "ServiceLogRule",
+ * "Version": 1\}
+ *
The definition of the rule, as a JSON object. The definition contains the keywords + * used to define contributors, the value to aggregate on if this rule returns a sum + * instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.
+ * @public + */ + Definition: string | undefined; + + /** + *An optional built-in rule that Amazon Web Services manages.
+ * @public + */ + ManagedRule?: boolean | undefined; +} + +/** + * @public + */ +export interface DescribeInsightRulesOutput { + /** + *If this parameter is present, it is a token that marks the start of the next batch of + * returned results.
+ * @public + */ + NextToken?: string | undefined; + + /** + *The rules returned by the operation.
+ * @public + */ + InsightRules?: InsightRule[] | undefined; +} + +/** + *Represents filters for a dimension.
+ * @public + */ +export interface DimensionFilter { + /** + *The dimension name to be matched.
+ * @public + */ + Name: string | undefined; + + /** + *The value of the dimension to be matched.
+ * @public + */ + Value?: string | undefined; +} + +/** + * @public + */ +export interface DisableAlarmActionsInput { + /** + *The names of the alarms.
+ * @public + */ + AlarmNames: string[] | undefined; +} + +/** + * @public + */ +export interface DisableInsightRulesInput { + /** + *An array of the rule names to disable. If you need to find out the names of your + * rules, use DescribeInsightRules.
+ * @public + */ + RuleNames: string[] | undefined; +} + +/** + * @public + */ +export interface DisableInsightRulesOutput { + /** + *An array listing the rules that could not be disabled. You cannot disable built-in + * rules.
+ * @public + */ + Failures?: PartialFailure[] | undefined; +} + +/** + * @public + */ +export interface EnableAlarmActionsInput { + /** + *The names of the alarms.
+ * @public + */ + AlarmNames: string[] | undefined; +} + +/** + * @public + */ +export interface EnableInsightRulesInput { + /** + *An array of the rule names to enable. If you need to find out the names of your rules, + * use DescribeInsightRules.
+ * @public + */ + RuleNames: string[] | undefined; +} + +/** + * @public + */ +export interface EnableInsightRulesOutput { + /** + *An array listing the rules that could not be enabled. You cannot disable or enable + * built-in rules.
+ * @public + */ + Failures?: PartialFailure[] | undefined; +} + +/** + *The operation exceeded one or more limits.
+ * @public + */ +export class LimitExceededException extends __BaseException { + readonly name: "LimitExceededException" = "LimitExceededException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeAn entity associated with metrics, to allow for finding related telemetry. An entity + * is typically a resource or service within your system. For example, metrics from an + * Amazon EC2 instance could be associated with that instance as the entity. + * Similarly, metrics from a service that you own could be associated with that service as + * the entity.
+ * @public + */ +export interface Entity { + /** + *The attributes of the entity which identify the specific entity, as a list of
+ * key-value pairs. Entities with the same KeyAttributes are considered to be
+ * the same entity. For an entity to be valid, the KeyAttributes must exist
+ * and be formatted correctly.
There are five allowed attributes (key names): Type,
+ * ResourceType, Identifier, Name, and
+ * Environment.
For details about how to use the key attributes to specify an entity, see How to add related + * information to telemetry in the CloudWatch User + * Guide.
+ * @public + */ + KeyAttributes?: RecordAdditional attributes of the entity that are not used to specify the identity of the + * entity. A list of key-value pairs.
+ *For details about how to use the attributes, see How to add related information to + * telemetry in the CloudWatch User Guide.
+ * @public + */ + Attributes?: RecordRepresents a set of statistics that describes a specific metric.
+ * @public + */ +export interface StatisticSet { + /** + *The number of samples used for the statistic set.
+ * @public + */ + SampleCount: number | undefined; + + /** + *The sum of values for the sample set.
+ * @public + */ + Sum: number | undefined; + + /** + *The minimum value of the sample set.
+ * @public + */ + Minimum: number | undefined; + + /** + *The maximum value of the sample set.
+ * @public + */ + Maximum: number | undefined; +} + +/** + *Encapsulates the information sent to either create a metric or add new values to be + * aggregated into an existing metric.
+ * @public + */ +export interface MetricDatum { + /** + *The name of the metric.
+ * @public + */ + MetricName: string | undefined; + + /** + *The dimensions associated with the metric.
+ * @public + */ + Dimensions?: Dimension[] | undefined; + + /** + *The time the metric data was received, expressed as the number of milliseconds + * since Jan 1, 1970 00:00:00 UTC.
+ * @public + */ + Timestamp?: Date | undefined; + + /** + *The value for the metric.
+ *Although the parameter accepts numbers of type Double, CloudWatch rejects values + * that are either too small or too large. Values must be in the range of -2^360 to 2^360. + * In addition, special values (for example, NaN, +Infinity, -Infinity) are not + * supported.
+ * @public + */ + Value?: number | undefined; + + /** + *The statistical values for the metric.
+ * @public + */ + StatisticValues?: StatisticSet | undefined; + + /** + *Array of numbers representing the values for the metric during the period. Each unique
+ * value is listed just once in this array, and the corresponding number in the
+ * Counts array specifies the number of times that value occurred during
+ * the period. You can include up to 150 unique values in each PutMetricData
+ * action that specifies a Values array.
Although the Values array accepts numbers of type Double,
+ * CloudWatch rejects values that are either too small or too large. Values must be in the
+ * range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
+ * -Infinity) are not supported.
Array of numbers that is used along with the Values array. Each number in
+ * the Count array is the number of times the corresponding value in the
+ * Values array occurred during the period.
If you omit the Counts array, the default of 1 is used as the value for
+ * each count. If you include a Counts array, it must include the same amount
+ * of values as the Values array.
When you are using a Put operation, this defines what unit you want to
+ * use when storing the metric.
In a Get operation, this displays the unit that is used for the
+ * metric.
Valid values are 1 and 60. Setting this to 1 specifies this metric as a + * high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution + * down to one second. Setting this to 60 specifies this metric as a regular-resolution + * metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is + * available only for custom metrics. For more information about high-resolution metrics, + * see High-Resolution Metrics in the Amazon CloudWatch User + * Guide.
+ *This field is optional, if you do not specify it the default of 60 is + * used.
+ * @public + */ + StorageResolution?: number | undefined; +} + +/** + *A set of metrics that are associated with an entity, such as a specific service + * or resource. Contains the entity and the list of metric data associated with it.
+ * @public + */ +export interface EntityMetricData { + /** + *The entity associated with the metrics.
+ * @public + */ + Entity?: Entity | undefined; + + /** + *The metric data.
+ * @public + */ + MetricData?: MetricDatum[] | undefined; +} + +/** + * @public + */ +export interface GetDashboardInput { + /** + *The name of the dashboard to be described.
+ * @public + */ + DashboardName: string | undefined; +} + +/** + * @public + */ +export interface GetDashboardOutput { + /** + *The Amazon Resource Name (ARN) of the dashboard.
+ * @public + */ + DashboardArn?: string | undefined; + + /** + *The detailed information about the dashboard, including what widgets are included
+ * and their location on the dashboard. For more information about the
+ * DashboardBody syntax, see Dashboard Body Structure and Syntax.
The name of the dashboard.
+ * @public + */ + DashboardName?: string | undefined; +} + +/** + * @public + */ +export interface GetInsightRuleReportInput { + /** + *The name of the rule that you want to see data from.
+ * @public + */ + RuleName: string | undefined; + + /** + *The start time of the data to use in the report. When used in a raw HTTP Query API, it
+ * is formatted as yyyy-MM-dd'T'HH:mm:ss. For example,
+ * 2019-07-01T23:59:59.
The end time of the data to use in the report. When used in a raw HTTP Query API, it
+ * is formatted as yyyy-MM-dd'T'HH:mm:ss. For example,
+ * 2019-07-01T23:59:59.
The period, in seconds, to use for the statistics in the
+ * InsightRuleMetricDatapoint results.
The maximum number of contributors to include in the report. The range is 1 to 100. If + * you omit this, the default of 10 is used.
+ * @public + */ + MaxContributorCount?: number | undefined; + + /** + *Specifies which metrics to use for aggregation of contributor values for the report. + * You can specify one or more of the following metrics:
+ *
+ * UniqueContributors -- the number of unique contributors for each
+ * data point.
+ * MaxContributorValue -- the value of the top contributor for each
+ * data point. The identity of the contributor might change for each data point in
+ * the graph.
If this rule aggregates by COUNT, the top contributor for each data point is
+ * the contributor with the most occurrences in that period. If the rule aggregates
+ * by SUM, the top contributor is the contributor with the highest sum in the log
+ * field specified by the rule's Value, during that period.
+ * SampleCount -- the number of data points matched by the
+ * rule.
+ * Sum -- the sum of the values from all contributors during the
+ * time period represented by that data point.
+ * Minimum -- the minimum value from a single observation during the
+ * time period represented by that data point.
+ * Maximum -- the maximum value from a single observation during the
+ * time period represented by that data point.
+ * Average -- the average value from all contributors during the
+ * time period represented by that data point.
Determines what statistic to use to rank the contributors. Valid values are
+ * Sum and Maximum.
One data point related to one contributor.
+ *For more information, see GetInsightRuleReport and InsightRuleContributor.
+ * @public + */ +export interface InsightRuleContributorDatapoint { + /** + *The timestamp of the data point.
+ * @public + */ + Timestamp: Date | undefined; + + /** + *The approximate value that this contributor added during this timestamp.
+ * @public + */ + ApproximateValue: number | undefined; +} + +/** + *One of the unique contributors found by a Contributor Insights rule. If the rule + * contains multiple keys, then a unique contributor is a unique combination of values from + * all the keys in the rule.
+ *If the rule contains a single key, then each unique contributor is each unique value + * for this key.
+ *For more information, see GetInsightRuleReport.
+ * @public + */ +export interface InsightRuleContributor { + /** + *One of the log entry field keywords that is used to define contributors for this + * rule.
+ * @public + */ + Keys: string[] | undefined; + + /** + *An approximation of the aggregate value that comes from this contributor.
+ * @public + */ + ApproximateAggregateValue: number | undefined; + + /** + *An array of the data points where this contributor is present. Only the data points + * when this contributor appeared are included in the array.
+ * @public + */ + Datapoints: InsightRuleContributorDatapoint[] | undefined; +} + +/** + *One data point from the metric time series returned in a Contributor Insights rule + * report.
+ *For more information, see GetInsightRuleReport.
+ * @public + */ +export interface InsightRuleMetricDatapoint { + /** + *The timestamp of the data point.
+ * @public + */ + Timestamp: Date | undefined; + + /** + *The number of unique contributors who published data during this timestamp.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
The maximum value provided by one contributor during this timestamp. Each timestamp is + * evaluated separately, so the identity of the max contributor could be different for each + * timestamp.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
The number of occurrences that matched the rule during this data point.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
The average value from all contributors during the time period represented by that + * data point.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
The sum of the values from all contributors during the time period represented by that + * data point.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
The minimum value from a single contributor during the time period represented by that + * data point.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
The maximum value from a single occurence from a single contributor during the time + * period represented by that data point.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
An array of the strings used as the keys for this rule. The keys are the dimensions + * used to classify contributors. If the rule contains more than one key, then each unique + * combination of values for the keys is counted as a unique contributor.
+ * @public + */ + KeyLabels?: string[] | undefined; + + /** + *Specifies whether this rule aggregates contributor data by COUNT or SUM.
+ * @public + */ + AggregationStatistic?: string | undefined; + + /** + *The sum of the values from all individual contributors that match the rule.
+ * @public + */ + AggregateValue?: number | undefined; + + /** + *An approximate count of the unique contributors found by this rule in this time + * period.
+ * @public + */ + ApproximateUniqueCount?: number | undefined; + + /** + *An array of the unique contributors found by this rule in this time period. If the + * rule contains multiple keys, each combination of values for the keys counts as a unique + * contributor.
+ * @public + */ + Contributors?: InsightRuleContributor[] | undefined; + + /** + *A time series of metric data points that matches the time period in the rule + * request.
+ * @public + */ + MetricDatapoints?: InsightRuleMetricDatapoint[] | undefined; +} + +/** + *This structure includes the Timezone parameter, which you can use to
+ * specify your time zone so that the labels that are associated with returned metrics
+ * display the correct time for your time zone.
The Timezone value affects a label only if you have a time-based dynamic
+ * expression in the label. For more information about dynamic expressions in labels, see
+ * Using Dynamic
+ * Labels.
The time zone to use for metric data return in this operation. The format is
+ * + or - followed by four digits. The first two digits
+ * indicate the number of hours ahead or behind of UTC, and the final two digits are the
+ * number of minutes. For example, +0130 indicates a time zone that is 1 hour and 30
+ * minutes ahead of UTC. The default is +0000.
The metric queries to be returned. A single GetMetricData call can
+ * include as many as 500 MetricDataQuery structures. Each of these structures
+ * can specify either a metric to retrieve, a Metrics Insights query, or a math expression
+ * to perform on retrieved data.
The time stamp indicating the earliest data to be returned.
+ *The value specified is inclusive; results include data points with the specified + * time stamp.
+ *CloudWatch rounds the specified time stamp as follows:
+ *Start time less than 15 days ago - Round down to the nearest whole minute. + * For example, 12:32:34 is rounded down to 12:32:00.
+ *Start time between 15 and 63 days ago - Round down to the nearest 5-minute + * clock interval. For example, 12:32:34 is rounded down to 12:30:00.
+ *Start time greater than 63 days ago - Round down to the nearest 1-hour + * clock interval. For example, 12:32:34 is rounded down to 12:00:00.
+ *If you set Period to 5, 10, or 30, the start time of your request is
+ * rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second
+ * divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the
+ * previous 10-second period, the start time of your request is rounded down and you
+ * receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous
+ * 5 minutes of data, using a period of 5 seconds, you receive data timestamped between
+ * 15:02:15 and 15:07:15.
For better performance, specify StartTime and EndTime values
+ * that align with the value of the metric's Period and sync up with the
+ * beginning and end of an hour. For example, if the Period of a metric is 5
+ * minutes, specifying 12:05 or 12:30 as StartTime can get a faster response
+ * from CloudWatch than setting 12:07 or 12:29 as the StartTime.
The time stamp indicating the latest data to be returned.
+ *The value specified is exclusive; results include data points up to the specified + * time stamp.
+ *For better performance, specify StartTime and EndTime values
+ * that align with the value of the metric's Period and sync up with the
+ * beginning and end of an hour. For example, if the Period of a metric is 5
+ * minutes, specifying 12:05 or 12:30 as EndTime can get a faster response
+ * from CloudWatch than setting 12:07 or 12:29 as the EndTime.
Include this value, if it was returned by the previous GetMetricData
+ * operation, to get the next set of data points.
The order in which data points should be returned. TimestampDescending
+ * returns the newest data first and paginates when the MaxDatapoints limit is
+ * reached. TimestampAscending returns the oldest data first and paginates
+ * when the MaxDatapoints limit is reached.
If you omit this parameter, the default of TimestampDescending is
+ * used.
The maximum number of data points the request should return before paginating. If you + * omit this, the default of 100,800 is used.
+ * @public + */ + MaxDatapoints?: number | undefined; + + /** + *This structure includes the Timezone parameter, which you can use to
+ * specify your time zone so that the labels of returned data display the correct time for
+ * your time zone.
A message returned by the GetMetricDataAPI, including a code and a
+ * description.
If a cross-Region GetMetricData operation fails with a code of
+ * Forbidden and a value of Authentication too complex to retrieve
+ * cross region data, you can correct the problem by running the
+ * GetMetricData operation in the same Region where the metric data
+ * is.
The error code or status code associated with the message.
+ * @public + */ + Code?: string | undefined; + + /** + *The message text.
+ * @public + */ + Value?: string | undefined; +} + +/** + * @public + * @enum + */ +export const StatusCode = { + COMPLETE: "Complete", + FORBIDDEN: "Forbidden", + INTERNAL_ERROR: "InternalError", + PARTIAL_DATA: "PartialData", +} as const; + +/** + * @public + */ +export type StatusCode = (typeof StatusCode)[keyof typeof StatusCode]; + +/** + *A GetMetricData call returns an array of MetricDataResult
+ * structures. Each of these structures includes the data points for that metric, along
+ * with the timestamps of those data points and other identifying information.
The short name you specified to represent this metric.
+ * @public + */ + Id?: string | undefined; + + /** + *The human-readable label associated with the data.
+ * @public + */ + Label?: string | undefined; + + /** + *The timestamps for the data points, formatted in Unix timestamp format. The number of + * timestamps always matches the number of values and the value for Timestamps[x] is + * Values[x].
+ * @public + */ + Timestamps?: Date[] | undefined; + + /** + *The data points for the metric corresponding to Timestamps. The number of
+ * values always matches the number of timestamps and the timestamp for Values[x] is
+ * Timestamps[x].
The status of the returned data. Complete indicates that all data points
+ * in the requested time range were returned. PartialData means that an
+ * incomplete set of data points were returned. You can use the NextToken
+ * value that was returned and repeat your request to get more data points.
+ * NextToken is not returned if you are performing a math expression.
+ * InternalError indicates that an error occurred. Retry your request
+ * using NextToken, if present.
A list of messages with additional information about the data returned.
+ * @public + */ + Messages?: MessageData[] | undefined; +} + +/** + * @public + */ +export interface GetMetricDataOutput { + /** + *The metrics that are returned, including the metric name, namespace, and + * dimensions.
+ * @public + */ + MetricDataResults?: MetricDataResult[] | undefined; + + /** + *A token that marks the next batch of returned results.
+ * @public + */ + NextToken?: string | undefined; + + /** + *Contains a message about this GetMetricData operation, if the operation
+ * results in such a message. An example of a message that might be returned is
+ * Maximum number of allowed metrics exceeded. If there is a message, as
+ * much of the operation as possible is still executed.
A message appears here only if it is related to the global GetMetricData
+ * operation. Any message about a specific metric returned by the operation appears in the
+ * MetricDataResult object returned for that metric.
The namespace of the metric, with or without spaces.
+ * @public + */ + Namespace: string | undefined; + + /** + *The name of the metric, with or without spaces.
+ * @public + */ + MetricName: string | undefined; + + /** + *The dimensions. If the metric contains multiple dimensions, you must include a + * value for each dimension. CloudWatch treats each unique combination of dimensions as a + * separate metric. If a specific combination of dimensions was not published, you can't + * retrieve statistics for it. You must specify the same dimensions that were used when the + * metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User + * Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User + * Guide.
+ * @public + */ + Dimensions?: Dimension[] | undefined; + + /** + *The time stamp that determines the first data point to return. Start times are + * evaluated relative to the time that CloudWatch receives the request.
+ *The value specified is inclusive; results include data points with the specified + * time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for + * example, 2016-10-03T23:00:00Z).
+ *CloudWatch rounds the specified time stamp as follows:
+ *Start time less than 15 days ago - Round down to the nearest whole minute. + * For example, 12:32:34 is rounded down to 12:32:00.
+ *Start time between 15 and 63 days ago - Round down to the nearest 5-minute + * clock interval. For example, 12:32:34 is rounded down to 12:30:00.
+ *Start time greater than 63 days ago - Round down to the nearest 1-hour + * clock interval. For example, 12:32:34 is rounded down to 12:00:00.
+ *If you set Period to 5, 10, or 30, the start time of your request is
+ * rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second
+ * divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the
+ * previous 10-second period, the start time of your request is rounded down and you
+ * receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous
+ * 5 minutes of data, using a period of 5 seconds, you receive data timestamped between
+ * 15:02:15 and 15:07:15.
The time stamp that determines the last data point to return.
+ *The value specified is exclusive; results include data points up to the specified + * time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for + * example, 2016-10-10T23:00:00Z).
+ * @public + */ + EndTime: Date | undefined; + + /** + *The granularity, in seconds, of the returned data points. For metrics with regular
+ * resolution, a period can be as short as one minute (60 seconds) and must be a multiple
+ * of 60. For high-resolution metrics that are collected at intervals of less than one
+ * minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
+ * metrics are those metrics stored by a PutMetricData call that includes a
+ * StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than
+ * 3 hours ago, you must specify the period as follows or no data points in that time range
+ * is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds + * (1 minute).
+ *Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 + * minutes).
+ *Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 + * hour).
+ *The metric statistics, other than percentile. For percentile statistics, use
+ * ExtendedStatistics. When calling GetMetricStatistics, you
+ * must specify either Statistics or ExtendedStatistics, but not
+ * both.
The percentile statistics. Specify values between p0.0 and p100. When calling
+ * GetMetricStatistics, you must specify either Statistics or
+ * ExtendedStatistics, but not both. Percentile statistics are not
+ * available for metrics when any of the metric values are negative numbers.
The unit for a given metric. If you omit Unit, all data that was
+ * collected with any unit is returned, along with the corresponding units that were
+ * specified when the data was reported to CloudWatch. If you specify a unit, the operation
+ * returns only data that was collected with that unit specified. If you specify a unit
+ * that does not match the data collected, the results of the operation are null.
+ * CloudWatch does not perform unit conversions.
A label for the specified metric.
+ * @public + */ + Label?: string | undefined; + + /** + *The data points for the specified metric.
+ * @public + */ + Datapoints?: Datapoint[] | undefined; +} + +/** + * @public + */ +export interface GetMetricStreamInput { + /** + *The name of the metric stream to retrieve information about.
+ * @public + */ + Name: string | undefined; +} + +/** + *This structure contains a metric namespace and optionally, a list of metric names, to + * either include in a metric stream or exclude from a metric stream.
+ *A metric stream's filters can include up to 1000 total names. This limit applies to + * the sum of namespace names and metric names in the filters. For example, this could + * include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with + * 49 metrics specified in each filter.
+ * @public + */ +export interface MetricStreamFilter { + /** + *The name of the metric namespace for this filter.
+ *The namespace can contain only ASCII printable characters (ASCII range 32 through + * 126). It must contain at least one non-whitespace character.
+ * @public + */ + Namespace?: string | undefined; + + /** + *The names of the metrics to either include or exclude from the metric stream.
+ *If you omit this parameter, all metrics in the namespace are included or excluded, + * depending on whether this filter is specified as an exclude filter or an include + * filter.
+ *Each metric name can contain only ASCII printable characters (ASCII range 32 through + * 126). Each metric name must contain at least one non-whitespace character.
+ * @public + */ + MetricNames?: string[] | undefined; +} + +/** + * @public + * @enum + */ +export const MetricStreamOutputFormat = { + JSON: "json", + OPEN_TELEMETRY_0_7: "opentelemetry0.7", + OPEN_TELEMETRY_1_0: "opentelemetry1.0", +} as const; + +/** + * @public + */ +export type MetricStreamOutputFormat = (typeof MetricStreamOutputFormat)[keyof typeof MetricStreamOutputFormat]; + +/** + *This object contains the information for one metric that is to be streamed with + * additional statistics.
+ * @public + */ +export interface MetricStreamStatisticsMetric { + /** + *The namespace of the metric.
+ * @public + */ + Namespace: string | undefined; + + /** + *The name of the metric.
+ * @public + */ + MetricName: string | undefined; +} + +/** + *By default, a metric stream always sends the MAX, MIN,
+ * SUM, and SAMPLECOUNT statistics for each metric that is
+ * streamed. This structure contains information for one metric that includes additional
+ * statistics in the stream. For more information about statistics, see CloudWatch,
+ * listed in
+ * CloudWatch statistics definitions.
An array of metric name and namespace pairs that stream the additional statistics
+ * listed in the value of the AdditionalStatistics parameter. There can be as
+ * many as 100 pairs in the array.
All metrics that match the combination of metric name and namespace will be streamed + * with the additional statistics, no matter their dimensions.
+ * @public + */ + IncludeMetrics: MetricStreamStatisticsMetric[] | undefined; + + /** + *The list of additional statistics that are to be streamed for the metrics listed in
+ * the IncludeMetrics array in this structure. This list can include as many
+ * as 20 statistics.
If the OutputFormat for the stream is opentelemetry1.0 or
+ * opentelemetry0.7, the only valid values are
+ * p??
+ * percentile statistics such as
+ * p90, p99 and so on.
If the OutputFormat for the stream is json, the valid values
+ * include the abbreviations for all of the statistics listed in
+ * CloudWatch statistics definitions. For example, this includes
+ * tm98,
+ * wm90, PR(:300), and so on.
The ARN of the metric stream.
+ * @public + */ + Arn?: string | undefined; + + /** + *The name of the metric stream.
+ * @public + */ + Name?: string | undefined; + + /** + *If this array of metric namespaces is present, then these namespaces are the only + * metric namespaces that are streamed by this metric stream.
+ * @public + */ + IncludeFilters?: MetricStreamFilter[] | undefined; + + /** + *If this array of metric namespaces is present, then these namespaces are the only + * metric namespaces that are not streamed by this metric stream. In this case, all other + * metric namespaces in the account are streamed by this metric stream.
+ * @public + */ + ExcludeFilters?: MetricStreamFilter[] | undefined; + + /** + *The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this + * metric stream.
+ * @public + */ + FirehoseArn?: string | undefined; + + /** + *The ARN of the IAM role that is used by this metric stream.
+ * @public + */ + RoleArn?: string | undefined; + + /** + *The state of the metric stream. The possible values are running and
+ * stopped.
The date that the metric stream was created.
+ * @public + */ + CreationDate?: Date | undefined; + + /** + *The date of the most recent update to the metric stream's configuration.
+ * @public + */ + LastUpdateDate?: Date | undefined; + + /** + *The output format for the stream. Valid values are json,
+ * opentelemetry1.0, and opentelemetry0.7. For more
+ * information about metric stream output formats, see Metric streams output formats.
Each entry in this array displays information about one or more metrics that include + * additional statistics in the metric stream. For more information about the additional + * statistics, see + * CloudWatch statistics definitions.
+ * @public + */ + StatisticsConfigurations?: MetricStreamStatisticsConfiguration[] | undefined; + + /** + *If this is true and this metric stream is in a monitoring account, then
+ * the stream includes metrics from source accounts that the monitoring account is linked
+ * to.
A JSON string that defines the bitmap graph to be retrieved. The string includes
+ * the metrics to include in the graph, statistics, annotations, title, axis limits, and so
+ * on. You can include only one MetricWidget parameter in each
+ * GetMetricWidgetImage call.
For more information about the syntax of MetricWidget see GetMetricWidgetImage: Metric Widget Structure and Syntax.
If any metric on the graph could not load all the requested data points, an orange + * triangle with an exclamation point appears next to the graph legend.
+ * @public + */ + MetricWidget: string | undefined; + + /** + *The format of the resulting image. Only PNG images are supported.
+ *The default is png. If you specify png, the API returns
+ * an HTTP response with the content-type set to text/xml. The image data is
+ * in a MetricWidgetImage field. For example:
+ *
+ *
+ *
+ *
+ *
+ *
+ * iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
The image/png setting is intended only for custom HTTP requests. For
+ * most use cases, and all actions using an Amazon Web Services SDK, you should use
+ * png. If you specify image/png, the HTTP response has a
+ * content-type set to image/png, and the body of the response is a PNG
+ * image.
The image of the graph, in the output format specified. The output is + * base64-encoded.
+ * @public + */ + MetricWidgetImage?: Uint8Array | undefined; +} + +/** + * @public + */ +export interface ListDashboardsInput { + /** + *If you specify this parameter, only the dashboards with names starting with the + * specified string are listed. The maximum length is 255, and valid characters are A-Z, + * a-z, 0-9, ".", "-", and "_".
+ * @public + */ + DashboardNamePrefix?: string | undefined; + + /** + *The token returned by a previous call to indicate that there is more data + * available.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + * @public + */ +export interface ListDashboardsOutput { + /** + *The list of matching dashboards.
+ * @public + */ + DashboardEntries?: DashboardEntry[] | undefined; + + /** + *The token that marks the start of the next batch of returned results.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + * @public + */ +export interface ListManagedInsightRulesInput { + /** + *The ARN of an Amazon Web Services resource that has managed Contributor Insights + * rules.
+ * @public + */ + ResourceARN: string | undefined; + + /** + *Include this value to get the next set of rules if the value was returned by the + * previous operation.
+ * @public + */ + NextToken?: string | undefined; + + /** + * The maximum number of results to return in one operation. If you omit this parameter,
+ * the default number is used. The default number is 100.
The status of a managed Contributor Insights rule.
+ * @public + */ +export interface ManagedRuleState { + /** + *The name of the Contributor Insights rule that contains data for the specified + * Amazon Web Services resource.
+ * @public + */ + RuleName: string | undefined; + + /** + *Indicates whether the rule is enabled or disabled.
+ * @public + */ + State: string | undefined; +} + +/** + * Contains information about managed Contributor Insights rules, as returned by
+ * ListManagedInsightRules.
+ *
The template name for the managed rule. Used to enable managed rules using
+ * PutManagedInsightRules.
If a managed rule is enabled, this is the ARN for the related Amazon Web Services + * resource.
+ * @public + */ + ResourceARN?: string | undefined; + + /** + *Describes the state of a managed rule. If present, it contains information about the + * Contributor Insights rule that contains information about the related Amazon Web Services + * resource.
+ * @public + */ + RuleState?: ManagedRuleState | undefined; +} + +/** + * @public + */ +export interface ListManagedInsightRulesOutput { + /** + *The managed rules that are available for the specified Amazon Web Services resource. + *
+ * @public + */ + ManagedRules?: ManagedRuleDescription[] | undefined; + + /** + *Include this value to get the next set of rules if the value was returned by the + * previous operation.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const RecentlyActive = { + PT3H: "PT3H", +} as const; + +/** + * @public + */ +export type RecentlyActive = (typeof RecentlyActive)[keyof typeof RecentlyActive]; + +/** + * @public + */ +export interface ListMetricsInput { + /** + *The metric namespace to filter against. Only the namespace that matches exactly + * will be returned.
+ * @public + */ + Namespace?: string | undefined; + + /** + *The name of the metric to filter against. Only the metrics with names that match + * exactly will be returned.
+ * @public + */ + MetricName?: string | undefined; + + /** + *The dimensions to filter against. Only the dimensions that match exactly will be + * returned.
+ * @public + */ + Dimensions?: DimensionFilter[] | undefined; + + /** + *The token returned by a previous call to indicate that there is more data + * available.
+ * @public + */ + NextToken?: string | undefined; + + /** + *To filter the results to show only metrics that have had data points published in the
+ * past three hours, specify this parameter with a value of PT3H. This is the
+ * only valid value for this parameter.
The results that are returned are an approximation of the value you specify. There is + * a low probability that the returned results include metrics with last published data as + * much as 50 minutes more than the specified time interval.
+ * @public + */ + RecentlyActive?: RecentlyActive | undefined; + + /** + *If you are using this operation in a monitoring account, specify true to
+ * include metrics from source accounts in the returned data.
The default is false.
When you use this operation in a monitoring account, use this field to return metrics
+ * only from one source account. To do so, specify that source account ID in this field,
+ * and also specify true for IncludeLinkedAccounts.
The metrics that match your request.
+ * @public + */ + Metrics?: Metric[] | undefined; + + /** + *The token that marks the start of the next batch of returned results.
+ * @public + */ + NextToken?: string | undefined; + + /** + *If you are using this operation in a monitoring account, this array contains the + * account IDs of the source accounts where the metrics in the returned data are + * from.
+ *This field is a 1:1 mapping between each metric that is returned and the ID of the + * owning account.
+ * @public + */ + OwningAccounts?: string[] | undefined; +} + +/** + * @public + */ +export interface ListMetricStreamsInput { + /** + *Include this value, if it was returned by the previous call, to get the next set of + * metric streams.
+ * @public + */ + NextToken?: string | undefined; + + /** + *The maximum number of results to return in one operation.
+ * @public + */ + MaxResults?: number | undefined; +} + +/** + *This structure contains the configuration information about one metric stream.
+ * @public + */ +export interface MetricStreamEntry { + /** + *The ARN of the metric stream.
+ * @public + */ + Arn?: string | undefined; + + /** + *The date that the metric stream was originally created.
+ * @public + */ + CreationDate?: Date | undefined; + + /** + *The date that the configuration of this metric stream was most recently + * updated.
+ * @public + */ + LastUpdateDate?: Date | undefined; + + /** + *The name of the metric stream.
+ * @public + */ + Name?: string | undefined; + + /** + *The ARN of the Kinesis Firehose devlivery stream that is used for this metric + * stream.
+ * @public + */ + FirehoseArn?: string | undefined; + + /** + *The current state of this stream. Valid values are running and
+ * stopped.
The output format of this metric stream. Valid values are json,
+ * opentelemetry1.0, and opentelemetry0.7.
The token that marks the start of the next batch of returned results. You can use + * this token in a subsequent operation to get the next batch of results.
+ * @public + */ + NextToken?: string | undefined; + + /** + *The array of metric stream information.
+ * @public + */ + Entries?: MetricStreamEntry[] | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceInput { + /** + *The ARN of the CloudWatch resource that you want to view tags for.
+ *The ARN format of an alarm is
+ * arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
+ *
+ *
The ARN format of a Contributor Insights rule is
+ * arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
+ *
+ *
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web + * Services General Reference.
+ * @public + */ + ResourceARN: string | undefined; +} + +/** + *A key-value pair associated with a CloudWatch resource.
+ * @public + */ +export interface Tag { + /** + *A string that you can use to assign a value. The combination of tag keys and values + * can help you organize and categorize your resources.
+ * @public + */ + Key: string | undefined; + + /** + *The value for the specified tag key.
+ * @public + */ + Value: string | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceOutput { + /** + *The list of tag keys and values associated with the resource you specified.
+ * @public + */ + Tags?: Tag[] | undefined; +} + +/** + * @public + */ +export interface PutAnomalyDetectorInput { + /** + * @deprecated + * + *The namespace of the metric to create the anomaly detection model for.
+ * @public + */ + Namespace?: string | undefined; + + /** + * @deprecated + * + *The name of the metric to create the anomaly detection model for.
+ * @public + */ + MetricName?: string | undefined; + + /** + * @deprecated + * + *The metric dimensions to create the anomaly detection model for.
+ * @public + */ + Dimensions?: Dimension[] | undefined; + + /** + * @deprecated + * + *The statistic to use for the metric and the anomaly detection model.
+ * @public + */ + Stat?: string | undefined; + + /** + *The configuration specifies details about how the anomaly detection model is to be + * trained, including time ranges to exclude when training and updating the model. You can + * specify as many as 10 time ranges.
+ *The configuration can also include the time zone to use for the metric.
+ * @public + */ + Configuration?: AnomalyDetectorConfiguration | undefined; + + /** + *Use this object to include parameters to provide information about your metric to
+ * CloudWatch to help it build more accurate anomaly detection models.
+ * Currently, it includes the PeriodicSpikes parameter.
A single metric anomaly detector to be created.
+ *When using SingleMetricAnomalyDetector, you cannot include the following
+ * parameters in the same operation:
+ * Dimensions
+ *
+ * MetricName
+ *
+ * Namespace
+ *
+ * Stat
+ *
the MetricMathAnomalyDetector parameters of
+ * PutAnomalyDetectorInput
+ *
Instead, specify the single metric anomaly detector attributes as part of the property
+ * SingleMetricAnomalyDetector.
The metric math anomaly detector to be created.
+ *When using MetricMathAnomalyDetector, you cannot include the following
+ * parameters in the same operation:
+ * Dimensions
+ *
+ * MetricName
+ *
+ * Namespace
+ *
+ * Stat
+ *
the SingleMetricAnomalyDetector parameters of
+ * PutAnomalyDetectorInput
+ *
Instead, specify the metric math anomaly detector attributes as part of the property
+ * MetricMathAnomalyDetector.
The quota for alarms for this customer has already been reached.
+ * @public + */ +export class LimitExceededFault extends __BaseException { + readonly name: "LimitExceededFault" = "LimitExceededFault"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeIndicates whether actions should be executed during any changes to the alarm state of
+ * the composite alarm. The default is TRUE.
The actions to execute when this alarm transitions to the ALARM state
+ * from any other state. Each action is specified as an Amazon Resource Name
+ * (ARN).
Valid Values: ]
+ *+ * Amazon SNS actions: + *
+ *
+ * arn:aws:sns:region:account-id:sns-topic-name
+ *
+ *
+ * Lambda actions: + *
+ *Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ *
+ *
Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ *
+ *
Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ *
+ *
+ * Systems Manager actions: + *
+ *
+ * arn:aws:ssm:region:account-id:opsitem:severity
+ *
+ *
The description for the composite alarm.
+ * @public + */ + AlarmDescription?: string | undefined; + + /** + *The name for the composite alarm. This name must be unique within the + * Region.
+ * @public + */ + AlarmName: string | undefined; + + /** + *An expression that specifies which other alarms are to be evaluated to determine this + * composite alarm's state. For each alarm that you reference, you designate a function + * that specifies whether that alarm needs to be in ALARM state, OK state, or + * INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple + * functions in a single expression. You can use parenthesis to logically group the + * functions in your expression.
+ *You can use either alarm names or ARNs to reference the other alarms that are to be + * evaluated.
+ *Functions can include the following:
+ *
+ * ALARM("alarm-name or
+ * alarm-ARN") is TRUE if the named alarm is in
+ * ALARM state.
+ * OK("alarm-name or
+ * alarm-ARN") is TRUE if the named alarm is in OK
+ * state.
+ * INSUFFICIENT_DATA("alarm-name or
+ * alarm-ARN") is TRUE if the named alarm is in
+ * INSUFFICIENT_DATA state.
+ * TRUE always evaluates to TRUE.
+ * FALSE always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule structure, and
+ * for testing your alarm actions.
Alarm names specified in AlarmRule can be surrounded with double-quotes
+ * ("), but do not have to be.
The following are some examples of AlarmRule:
+ * ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)
+ * specifies that the composite alarm goes into ALARM state only if both
+ * CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.
+ * ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)
+ * specifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in
+ * ALARM state and DeploymentInProgress is not in ALARM state. This example reduces
+ * alarm noise during a known deployment window.
+ * (ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND
+ * OK(NetworkOutTooHigh) goes into ALARM state if CPUUtilizationTooHigh
+ * OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK
+ * state. This provides another example of using a composite alarm to prevent
+ * noise. This rule ensures that you are not notified with an alarm action on high
+ * CPU or disk usage if a known network problem is also occurring.
The AlarmRule can specify as many as 100 "children" alarms. The
+ * AlarmRule expression can have as many as 500 elements. Elements are
+ * child alarms, TRUE or FALSE statements, and parentheses.
The actions to execute when this alarm transitions to the
+ * INSUFFICIENT_DATA state from any other state. Each action is specified
+ * as an Amazon Resource Name (ARN).
Valid Values: ]
+ *+ * Amazon SNS actions: + *
+ *
+ * arn:aws:sns:region:account-id:sns-topic-name
+ *
+ *
+ * Lambda actions: + *
+ *Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ *
+ *
Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ *
+ *
Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ *
+ *
The actions to execute when this alarm transitions to an OK state from
+ * any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
+ *+ * Amazon SNS actions: + *
+ *
+ * arn:aws:sns:region:account-id:sns-topic-name
+ *
+ *
+ * Lambda actions: + *
+ *Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ *
+ *
Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ *
+ *
Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ *
+ *
A list of key-value pairs to associate with the alarm. You can associate as many as
+ * 50 tags with an alarm. To be able to associate tags with the alarm when you create the
+ * alarm, you must have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to + * scope user permissions by granting a user permission to access or change only resources + * with certain tag values.
+ *If you are using this operation to update an existing alarm, any tags you specify in + * this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
+ * @public + */ + Tags?: Tag[] | undefined; + + /** + * Actions will be suppressed if the suppressor alarm is in the ALARM
+ * state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name
+ * (ARN) from an existing alarm.
The maximum time in seconds that the composite alarm waits for the suppressor alarm
+ * to go into the ALARM state. After this time, the composite alarm performs
+ * its actions.
+ * WaitPeriod is required only when ActionsSuppressor is
+ * specified.
The maximum time in seconds that the composite alarm waits after suppressor alarm
+ * goes out of the ALARM state. After this time, the composite alarm performs
+ * its actions.
+ * ExtensionPeriod is required only when ActionsSuppressor is
+ * specified.
The name of the dashboard. If a dashboard with this name already exists, this call + * modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is + * created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and + * "_". This parameter is required.
+ * @public + */ + DashboardName: string | undefined; + + /** + *The detailed information about the dashboard in JSON format, including the widgets + * to include and their location on the dashboard. This parameter is required.
+ *For more information about the syntax, see Dashboard Body Structure and Syntax.
+ * @public + */ + DashboardBody: string | undefined; +} + +/** + * @public + */ +export interface PutDashboardOutput { + /** + *If the input for PutDashboard was correct and the dashboard was
+ * successfully created or modified, this result is empty.
If this result includes only warning messages, then the input was valid enough for + * the dashboard to be created or modified, but some elements of the dashboard might not + * render.
+ *If this result includes error messages, the input was not valid and the operation + * failed.
+ * @public + */ + DashboardValidationMessages?: DashboardValidationMessage[] | undefined; +} + +/** + * @public + */ +export interface PutInsightRuleInput { + /** + *A unique name for the rule.
+ * @public + */ + RuleName: string | undefined; + + /** + *The state of the rule. Valid values are ENABLED and DISABLED.
+ * @public + */ + RuleState?: string | undefined; + + /** + *The definition of the rule, as a JSON object. For details on the valid syntax, see + * Contributor Insights Rule Syntax.
+ * @public + */ + RuleDefinition: string | undefined; + + /** + *A list of key-value pairs to associate with the Contributor Insights rule. You can + * associate as many as 50 tags with a rule.
+ *Tags can help you organize and categorize your resources. You can also use them to + * scope user permissions, by granting a user permission to access or change only the + * resources that have certain tag values.
+ *To be able to associate tags with a rule, you must have the
+ * cloudwatch:TagResource permission in addition to the
+ * cloudwatch:PutInsightRule permission.
If you are using this operation to update an existing Contributor Insights rule, any + * tags you specify in this parameter are ignored. To change the tags of an existing rule, + * use TagResource.
+ * @public + */ + Tags?: Tag[] | undefined; +} + +/** + * @public + */ +export interface PutInsightRuleOutput {} + +/** + *Contains the information that's required to enable a managed Contributor Insights + * rule for an Amazon Web Services resource. + * + *
+ * @public + */ +export interface ManagedRule { + /** + * The template name for the managed Contributor Insights rule, as returned by
+ * ListManagedInsightRules.
The ARN of an Amazon Web Services resource that has managed Contributor Insights + * rules.
+ * @public + */ + ResourceARN: string | undefined; + + /** + * A list of key-value pairs that you can associate with a managed Contributor Insights
+ * rule. You can associate as many as 50 tags with a rule. Tags can help you organize and
+ * categorize your resources. You also can use them to scope user permissions by granting a
+ * user permission to access or change only the resources that have certain tag values. To
+ * associate tags with a rule, you must have the cloudwatch:TagResource
+ * permission in addition to the cloudwatch:PutInsightRule permission. If you
+ * are using this operation to update an existing Contributor Insights rule, any tags that
+ * you specify in this parameter are ignored. To change the tags of an existing rule, use
+ * TagResource.
A list of ManagedRules to enable.
An array that lists the rules that could not be enabled.
+ * @public + */ + Failures?: PartialFailure[] | undefined; +} + +/** + * @public + */ +export interface PutMetricAlarmInput { + /** + *The name for the alarm. This name must be unique within the Region.
+ *The name must contain only UTF-8 characters, and can't contain ASCII control + * characters
+ * @public + */ + AlarmName: string | undefined; + + /** + *The description for the alarm.
+ * @public + */ + AlarmDescription?: string | undefined; + + /** + *Indicates whether actions should be executed during any changes to the alarm state.
+ * The default is TRUE.
The actions to execute when this alarm transitions to an OK state from
+ * any other state. Each action is specified as an Amazon Resource Name (ARN). Valid
+ * values:
+ * EC2 actions: + *
+ *
+ * arn:aws:automate:region:ec2:stop
+ *
+ * arn:aws:automate:region:ec2:terminate
+ *
+ * arn:aws:automate:region:ec2:reboot
+ *
+ * arn:aws:automate:region:ec2:recover
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
+ *
+ * Autoscaling action: + *
+ *
+ * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
+ *
+ *
+ * Lambda actions: + *
+ *Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ *
+ *
Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ *
+ *
Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ *
+ *
+ * SNS notification action: + *
+ *
+ * arn:aws:sns:region:account-id:sns-topic-name
+ *
+ *
+ * SSM integration actions: + *
+ *
+ * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
+ *
+ *
+ * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
+ *
+ *
The actions to execute when this alarm transitions to the ALARM state
+ * from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid
+ * values:
+ * EC2 actions: + *
+ *
+ * arn:aws:automate:region:ec2:stop
+ *
+ * arn:aws:automate:region:ec2:terminate
+ *
+ * arn:aws:automate:region:ec2:reboot
+ *
+ * arn:aws:automate:region:ec2:recover
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
+ *
+ * Autoscaling action: + *
+ *
+ * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
+ *
+ *
+ * Lambda actions: + *
+ *Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ *
+ *
Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ *
+ *
Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ *
+ *
+ * SNS notification action: + *
+ *
+ * arn:aws:sns:region:account-id:sns-topic-name
+ *
+ *
+ * SSM integration actions: + *
+ *
+ * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
+ *
+ *
+ * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
+ *
+ *
The actions to execute when this alarm transitions to the
+ * INSUFFICIENT_DATA state from any other state. Each action is specified
+ * as an Amazon Resource Name (ARN). Valid values:
+ * EC2 actions: + *
+ *
+ * arn:aws:automate:region:ec2:stop
+ *
+ * arn:aws:automate:region:ec2:terminate
+ *
+ * arn:aws:automate:region:ec2:reboot
+ *
+ * arn:aws:automate:region:ec2:recover
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
+ *
+ * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
+ *
+ * Autoscaling action: + *
+ *
+ * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
+ *
+ *
+ * Lambda actions: + *
+ *Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ *
+ *
Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ *
+ *
Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ *
+ *
+ * SNS notification action: + *
+ *
+ * arn:aws:sns:region:account-id:sns-topic-name
+ *
+ *
+ * SSM integration actions: + *
+ *
+ * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
+ *
+ *
+ * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
+ *
+ *
The name for the metric associated with the alarm. For each
+ * PutMetricAlarm operation, you must specify either
+ * MetricName or a Metrics array.
If you are creating an alarm based on a math expression, you cannot specify this
+ * parameter, or any of the Namespace, Dimensions,
+ * Period, Unit, Statistic, or
+ * ExtendedStatistic parameters. Instead, you specify all this information
+ * in the Metrics array.
The namespace for the metric associated specified in
+ * MetricName.
The statistic for the metric specified in MetricName, other than
+ * percentile. For percentile statistics, use ExtendedStatistic. When you call
+ * PutMetricAlarm and specify a MetricName, you must specify
+ * either Statistic or ExtendedStatistic, but not both.
The extended statistic for the metric specified in MetricName. When
+ * you call PutMetricAlarm and specify a MetricName, you must
+ * specify either Statistic or ExtendedStatistic but not
+ * both.
If you specify ExtendedStatistic, the following are valid values:
+ * p90
+ *
+ * tm90
+ *
+ * tc90
+ *
+ * ts90
+ *
+ * wm90
+ *
+ * IQM
+ *
+ * PR(n:m) where n and m
+ * are values of the metric
+ * TC(X%:X%) where X is
+ * between 10 and 90 inclusive.
+ * TM(X%:X%) where X is
+ * between 10 and 90 inclusive.
+ * TS(X%:X%) where X is
+ * between 10 and 90 inclusive.
+ * WM(X%:X%) where X is
+ * between 10 and 90 inclusive.
For more information about these extended statistics, see CloudWatch statistics definitions.
+ * @public + */ + ExtendedStatistic?: string | undefined; + + /** + *The dimensions for the metric specified in MetricName.
The length, in seconds, used each time the metric specified in
+ * MetricName is evaluated. Valid values are 10, 30, and any multiple of
+ * 60.
+ * Period is required for alarms based on static thresholds. If you are
+ * creating an alarm based on a metric math expression, you specify the period for each
+ * metric within the objects in the Metrics array.
Be sure to specify 10 or 30 only for metrics that are stored by a
+ * PutMetricData call with a StorageResolution of 1. If you
+ * specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the
+ * alarm still attempts to gather data at the period rate that you specify. In this case,
+ * it does not receive data for the attempts that do not correspond to a one-minute data
+ * resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10
+ * or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than
+ * other alarms. For more information about pricing, see Amazon CloudWatch
+ * Pricing.
An alarm's total current evaluation period can be no longer than one day, so
+ * Period multiplied by EvaluationPeriods cannot be more than
+ * 86,400 seconds.
The unit of measure for the statistic. For example, the units for the Amazon EC2
+ * NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance
+ * receives on all network interfaces. You can also specify a unit when you create a custom
+ * metric. Units help provide conceptual meaning to your data. Metric data points that
+ * specify a unit of measure, such as Percent, are aggregated separately. If you are
+ * creating an alarm based on a metric math expression, you can specify the unit for each
+ * metric (if needed) within the objects in the Metrics array.
If you don't specify Unit, CloudWatch retrieves all unit types that
+ * have been published for the metric and attempts to evaluate the alarm. Usually, metrics
+ * are published with only one unit, so the alarm works as intended.
However, if the metric is published with multiple types of units and you don't + * specify a unit, the alarm's behavior is not defined and it behaves + * unpredictably.
+ *We recommend omitting Unit so that you don't inadvertently specify an
+ * incorrect unit that is not published for this metric. Doing so causes the alarm to be
+ * stuck in the INSUFFICIENT DATA state.
The number of periods over which data is compared to the specified threshold. If + * you are setting an alarm that requires that a number of consecutive data points be + * breaching to trigger the alarm, this value specifies that number. If you are setting an + * "M out of N" alarm, this value is the N.
+ *An alarm's total current evaluation period can be no longer than one day, so this
+ * number multiplied by Period cannot be more than 86,400 seconds.
The number of data points that must be breaching to trigger the alarm. This is used + * only if you are setting an "M out of N" alarm. In that case, this value is the M. For + * more information, see Evaluating an Alarm in the Amazon CloudWatch User + * Guide.
+ * @public + */ + DatapointsToAlarm?: number | undefined; + + /** + *The value against which the specified statistic is compared.
+ *This parameter is required for alarms based on static thresholds, but should not be + * used for alarms based on anomaly detection models.
+ * @public + */ + Threshold?: number | undefined; + + /** + *The arithmetic operation to use when comparing the specified statistic and + * threshold. The specified statistic value is used as the first operand.
+ *The values LessThanLowerOrGreaterThanUpperThreshold,
+ * LessThanLowerThreshold, and GreaterThanUpperThreshold are
+ * used only for alarms based on anomaly detection models.
Sets how this alarm is to handle missing data points. If
+ * TreatMissingData is omitted, the default behavior of
+ * missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.
Valid Values: breaching | notBreaching | ignore | missing
+ *
Alarms that evaluate metrics in the AWS/DynamoDB namespace always
+ * ignore missing data even if you choose a different option for
+ * TreatMissingData. When an AWS/DynamoDB metric has
+ * missing data, alarms that evaluate that metric remain in their current state.
Used only for alarms based on percentiles. If you specify ignore, the
+ * alarm state does not change during periods with too few data points to be statistically
+ * significant. If you specify evaluate or omit this parameter, the alarm is
+ * always evaluated and possibly changes state no matter how many data points are
+ * available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.
Valid Values: evaluate | ignore
+ *
An array of MetricDataQuery structures that enable you to create an alarm
+ * based on the result of a metric math expression. For each PutMetricAlarm
+ * operation, you must specify either MetricName or a Metrics
+ * array.
Each item in the Metrics array either retrieves a metric or performs a
+ * math expression.
One item in the Metrics array is the expression that the alarm watches.
+ * You designate this expression by setting ReturnData to true for this object
+ * in the array. For more information, see MetricDataQuery.
If you use the Metrics parameter, you cannot include the
+ * Namespace, MetricName, Dimensions,
+ * Period, Unit, Statistic, or
+ * ExtendedStatistic parameters of PutMetricAlarm in the same
+ * operation. Instead, you retrieve the metrics you are using in your math expression as
+ * part of the Metrics array.
A list of key-value pairs to associate with the alarm. You can associate as many as
+ * 50 tags with an alarm. To be able to associate tags with the alarm when you create the
+ * alarm, you must have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to + * scope user permissions by granting a user permission to access or change only resources + * with certain tag values.
+ *If you are using this operation to update an existing alarm, any tags you specify in + * this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
+ *To use this field to set tags for an alarm when you create it, you must be signed on
+ * with both the cloudwatch:PutMetricAlarm and
+ * cloudwatch:TagResource permissions.
If this is an alarm based on an anomaly detection model, make this value match the ID
+ * of the ANOMALY_DETECTION_BAND function.
For an example of how to use this parameter, see the Anomaly + * Detection Model Alarm example on this page.
+ *If your alarm uses this parameter, it cannot have Auto Scaling actions.
+ * @public + */ + ThresholdMetricId?: string | undefined; +} + +/** + * @public + */ +export interface PutMetricDataInput { + /** + *The namespace for the metric data. You can use ASCII characters for the namespace, + * except for control characters which are not supported.
+ *To avoid conflicts with Amazon Web Services service namespaces, you should not
+ * specify a namespace that begins with AWS/
+ *
The data for the metrics. Use this parameter if your metrics do not contain + * associated entities. The array can include no more than 1000 metrics per call.
+ *The limit of metrics allowed, 1000, is the sum of both EntityMetricData
+ * and MetricData metrics.
Data for metrics that contain associated entity information. You can include up to
+ * two EntityMetricData objects, each of which can contain a single
+ * Entity and associated metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData
+ * and MetricData metrics.
Whether to accept valid metric data when an invalid entity is sent.
+ *When set to true: Any validation error (for entity or metric
+ * data) will fail the entire request, and no data will be ingested. The failed
+ * operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not
+ * associate the metric with the entity, but the metric data will still be
+ * accepted and ingested. Validation errors in the metric data will fail the
+ * entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a
+ * 200 status, but an additional response header will contain
+ * information about the validation errors. The new header,
+ * X-Amzn-Failure-Message is an enumeration of the following
+ * values:
+ * InvalidEntity - The provided entity is invalid.
+ * InvalidKeyAttributes - The provided
+ * KeyAttributes of an entity is invalid.
+ * InvalidAttributes - The provided Attributes
+ * of an entity is invalid.
+ * InvalidTypeValue - The provided Type in the
+ * KeyAttributes of an entity is invalid.
+ * EntitySizeTooLarge - The number of
+ * EntityMetricData objects allowed is 2.
+ * MissingRequiredFields - There are missing required
+ * fields in the KeyAttributes for the provided
+ * Type.
For details of the requirements for specifying an entity, see + * How + * to add related information to telemetry in the + * CloudWatch User Guide.
+ *This parameter is required when EntityMetricData is
+ * included.
If you are creating a new metric stream, this is the name for the new stream. The name + * must be different than the names of other metric streams in this account and + * Region.
+ *If you are updating a metric stream, specify the name of that stream here.
+ *Valid characters are A-Z, a-z, 0-9, "-" and "_".
+ * @public + */ + Name: string | undefined; + + /** + *If you specify this parameter, the stream sends only the metrics from the metric + * namespaces that you specify here.
+ *You cannot include IncludeFilters and ExcludeFilters in the
+ * same operation.
If you specify this parameter, the stream sends metrics from all metric namespaces + * except for the namespaces that you specify here.
+ *You cannot include ExcludeFilters and IncludeFilters in the
+ * same operation.
The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric + * stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be + * in the same account as the metric stream.
+ * @public + */ + FirehoseArn: string | undefined; + + /** + *The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data + * Firehose resources. This IAM role must already exist and must be in the same account as + * the metric stream. This IAM role must include the following permissions:
+ *firehose:PutRecord
+ *firehose:PutRecordBatch
+ *The output format for the stream. Valid values are json,
+ * opentelemetry1.0, and opentelemetry0.7. For more
+ * information about metric stream output formats, see
+ * Metric streams output formats.
A list of key-value pairs to associate with the metric stream. You can associate as + * many as 50 tags with a metric stream.
+ *Tags can help you organize and categorize your resources. You can also use them to + * scope user permissions by granting a user permission to access or change only resources + * with certain tag values.
+ *You can use this parameter only when you are creating a new metric stream. If you are + * using this operation to update an existing metric stream, any tags you specify in this + * parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.
+ * @public + */ + Tags?: Tag[] | undefined; + + /** + *By default, a metric stream always sends the MAX, MIN,
+ * SUM, and SAMPLECOUNT statistics for each metric that is
+ * streamed. You can use this parameter to have the metric stream also send additional
+ * statistics in the stream. This array can have up to 100 members.
For each entry in this array, you specify one or more metrics and the list of
+ * additional statistics to stream for those metrics. The additional statistics that you
+ * can stream depend on the stream's OutputFormat. If the
+ * OutputFormat is json, you can stream any additional
+ * statistic that is supported by CloudWatch, listed in
+ * CloudWatch statistics definitions. If the OutputFormat
+ * is opentelemetry1.0 or opentelemetry0.7, you can stream
+ * percentile statistics such as p95, p99.9, and so on.
If you are creating a metric stream in a monitoring account, specify true
+ * to include metrics from source accounts in the metric stream.
The ARN of the metric stream.
+ * @public + */ + Arn?: string | undefined; +} + +/** + *Data was not syntactically valid JSON.
+ * @public + */ +export class InvalidFormatFault extends __BaseException { + readonly name: "InvalidFormatFault" = "InvalidFormatFault"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe name of the alarm.
+ * @public + */ + AlarmName: string | undefined; + + /** + *The value of the state.
+ * @public + */ + StateValue: StateValue | undefined; + + /** + *The reason that this alarm is set to this specific state, in text format.
+ * @public + */ + StateReason: string | undefined; + + /** + *The reason that this alarm is set to this specific state, in JSON format.
+ *For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling + * or application Auto Scaling alarm actions, the Auto Scaling policy uses the information + * in this field to take the correct action.
+ * @public + */ + StateReasonData?: string | undefined; +} + +/** + * @public + */ +export interface StartMetricStreamsInput { + /** + *The array of the names of metric streams to start streaming.
+ *This is an "all or nothing" operation. If you do not have permission to access all of + * the metric streams that you list here, then none of the streams that you list in the + * operation will start streaming.
+ * @public + */ + Names: string[] | undefined; +} + +/** + * @public + */ +export interface StartMetricStreamsOutput {} + +/** + * @public + */ +export interface StopMetricStreamsInput { + /** + *The array of the names of metric streams to stop streaming.
+ *This is an "all or nothing" operation. If you do not have permission to access all of + * the metric streams that you list here, then none of the streams that you list in the + * operation will stop streaming.
+ * @public + */ + Names: string[] | undefined; +} + +/** + * @public + */ +export interface StopMetricStreamsOutput {} + +/** + * @public + */ +export interface TagResourceInput { + /** + *The ARN of the CloudWatch resource that you're adding tags to.
+ *The ARN format of an alarm is
+ * arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
+ *
+ *
The ARN format of a Contributor Insights rule is
+ * arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
+ *
+ *
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web + * Services General Reference.
+ * @public + */ + ResourceARN: string | undefined; + + /** + *The list of key-value pairs to associate with the alarm.
+ * @public + */ + Tags: Tag[] | undefined; +} + +/** + * @public + */ +export interface TagResourceOutput {} + +/** + * @public + */ +export interface UntagResourceInput { + /** + *The ARN of the CloudWatch resource that you're removing tags from.
+ *The ARN format of an alarm is
+ * arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
+ *
+ *
The ARN format of a Contributor Insights rule is
+ * arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
+ *
+ *
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web + * Services General Reference.
+ * @public + */ + ResourceARN: string | undefined; + + /** + *The list of tag keys to remove from the resource.
+ * @public + */ + TagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface UntagResourceOutput {} diff --git a/clients/client-cloudwatch-cbor/src/pagination/DescribeAlarmHistoryPaginator.ts b/clients/client-cloudwatch-cbor/src/pagination/DescribeAlarmHistoryPaginator.ts new file mode 100644 index 000000000000..83e36abece83 --- /dev/null +++ b/clients/client-cloudwatch-cbor/src/pagination/DescribeAlarmHistoryPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { CloudWatchClient } from "../CloudWatchClient"; +import { + DescribeAlarmHistoryCommand, + DescribeAlarmHistoryCommandInput, + DescribeAlarmHistoryCommandOutput, +} from "../commands/DescribeAlarmHistoryCommand"; +import { CloudWatchPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateDescribeAlarmHistory: ( + config: CloudWatchPaginationConfiguration, + input: DescribeAlarmHistoryCommandInput, + ...rest: any[] +) => PaginatorAmazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
+This guide provides descriptions of the Secrets Manager API. For more information about using this +service, see the Amazon Web Services Secrets Manager User Guide.
++API Version +
+This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
+For a list of endpoints, see Amazon Web Services Secrets Manager +endpoints.
++Support and Feedback for Amazon Web Services Secrets Manager +
+We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more +information about the Amazon Web Services Discussion Forums, see Forums +Help.
++Logging API Requests +
+Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services +account and delivers log files to an Amazon S3 bucket. By using information that's collected +by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the +request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services +CloudTrail, see Logging +Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. +To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
+ +## Installing + +To install this package, simply type add or install @aws-sdk/client-secrets-manager +using your favorite package manager: + +- `npm install @aws-sdk/client-secrets-manager` +- `yarn add @aws-sdk/client-secrets-manager` +- `pnpm add @aws-sdk/client-secrets-manager` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `SecretsManagerClient` and +the commands you need, for example `ListSecretsCommand`: + +```js +// ES5 example +const { SecretsManagerClient, ListSecretsCommand } = require("@aws-sdk/client-secrets-manager"); +``` + +```ts +// ES6+ example +import { SecretsManagerClient, ListSecretsCommand } from "@aws-sdk/client-secrets-manager"; +``` + +### Usage + +To send a request, you: + +- Initiate client with configuration (e.g. credentials, region). +- Initiate command with input parameters. +- Call `send` operation on client with command object as input. +- If you are using a custom http handler, you may call `destroy()` to close open connections. + +```js +// a client can be shared by different commands. +const client = new SecretsManagerClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new ListSecretsCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // process err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-secrets-manager"; +const client = new AWS.SecretsManager({ region: "REGION" }); + +// async/await. +try { + const data = await client.listSecrets(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .listSecrets(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.listSecrets(params, (err, data) => { + // process err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-secrets-manager` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. + +## Client Commands (Operations List) + +Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
+ *This guide provides descriptions of the Secrets Manager API. For more information about using this + * service, see the Amazon Web Services Secrets Manager User Guide.
+ *+ * API Version + *
+ *This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
+ *For a list of endpoints, see Amazon Web Services Secrets Manager + * endpoints.
+ *+ * Support and Feedback for Amazon Web Services Secrets Manager + *
+ *We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more + * information about the Amazon Web Services Discussion Forums, see Forums + * Help.
+ *+ * Logging API Requests + *
+ *Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services + * account and delivers log files to an Amazon S3 bucket. By using information that's collected + * by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the + * request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services + * CloudTrail, see Logging + * Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. + * To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
+ * @public + */ +export class SecretsManager extends SecretsManagerClient implements SecretsManager {} +createAggregatedClient(commands, SecretsManager); diff --git a/clients/client-secrets-manager-cbor/src/SecretsManagerClient.ts b/clients/client-secrets-manager-cbor/src/SecretsManagerClient.ts new file mode 100644 index 000000000000..bfd510d75554 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/SecretsManagerClient.ts @@ -0,0 +1,419 @@ +// smithy-typescript generated code +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver"; +import { + DefaultIdentityProviderConfig, + getHttpAuthSchemeEndpointRuleSetPlugin, + getHttpSigningPlugin, +} from "@smithy/core"; +import { getContentLengthPlugin } from "@smithy/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint"; +import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"; +import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http"; +import { + Client as __Client, + DefaultsMode as __DefaultsMode, + SmithyConfiguration as __SmithyConfiguration, + SmithyResolvedConfiguration as __SmithyResolvedConfiguration, +} from "@smithy/smithy-client"; +import { + AwsCredentialIdentityProvider, + BodyLengthCalculator as __BodyLengthCalculator, + CheckOptionalClientConfig as __CheckOptionalClientConfig, + ChecksumConstructor as __ChecksumConstructor, + Decoder as __Decoder, + Encoder as __Encoder, + EndpointV2 as __EndpointV2, + HashConstructor as __HashConstructor, + HttpHandlerOptions as __HttpHandlerOptions, + Logger as __Logger, + Provider as __Provider, + Provider, + StreamCollector as __StreamCollector, + UrlParser as __UrlParser, + UserAgent as __UserAgent, +} from "@smithy/types"; + +import { + defaultSecretsManagerHttpAuthSchemeParametersProvider, + HttpAuthSchemeInputConfig, + HttpAuthSchemeResolvedConfig, + resolveHttpAuthSchemeConfig, +} from "./auth/httpAuthSchemeProvider"; +import { + BatchGetSecretValueCommandInput, + BatchGetSecretValueCommandOutput, +} from "./commands/BatchGetSecretValueCommand"; +import { CancelRotateSecretCommandInput, CancelRotateSecretCommandOutput } from "./commands/CancelRotateSecretCommand"; +import { CreateSecretCommandInput, CreateSecretCommandOutput } from "./commands/CreateSecretCommand"; +import { + DeleteResourcePolicyCommandInput, + DeleteResourcePolicyCommandOutput, +} from "./commands/DeleteResourcePolicyCommand"; +import { DeleteSecretCommandInput, DeleteSecretCommandOutput } from "./commands/DeleteSecretCommand"; +import { DescribeSecretCommandInput, DescribeSecretCommandOutput } from "./commands/DescribeSecretCommand"; +import { GetRandomPasswordCommandInput, GetRandomPasswordCommandOutput } from "./commands/GetRandomPasswordCommand"; +import { GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput } from "./commands/GetResourcePolicyCommand"; +import { GetSecretValueCommandInput, GetSecretValueCommandOutput } from "./commands/GetSecretValueCommand"; +import { ListSecretsCommandInput, ListSecretsCommandOutput } from "./commands/ListSecretsCommand"; +import { + ListSecretVersionIdsCommandInput, + ListSecretVersionIdsCommandOutput, +} from "./commands/ListSecretVersionIdsCommand"; +import { PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput } from "./commands/PutResourcePolicyCommand"; +import { PutSecretValueCommandInput, PutSecretValueCommandOutput } from "./commands/PutSecretValueCommand"; +import { + RemoveRegionsFromReplicationCommandInput, + RemoveRegionsFromReplicationCommandOutput, +} from "./commands/RemoveRegionsFromReplicationCommand"; +import { + ReplicateSecretToRegionsCommandInput, + ReplicateSecretToRegionsCommandOutput, +} from "./commands/ReplicateSecretToRegionsCommand"; +import { RestoreSecretCommandInput, RestoreSecretCommandOutput } from "./commands/RestoreSecretCommand"; +import { RotateSecretCommandInput, RotateSecretCommandOutput } from "./commands/RotateSecretCommand"; +import { + StopReplicationToReplicaCommandInput, + StopReplicationToReplicaCommandOutput, +} from "./commands/StopReplicationToReplicaCommand"; +import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; +import { UpdateSecretCommandInput, UpdateSecretCommandOutput } from "./commands/UpdateSecretCommand"; +import { + UpdateSecretVersionStageCommandInput, + UpdateSecretVersionStageCommandOutput, +} from "./commands/UpdateSecretVersionStageCommand"; +import { + ValidateResourcePolicyCommandInput, + ValidateResourcePolicyCommandOutput, +} from "./commands/ValidateResourcePolicyCommand"; +import { + ClientInputEndpointParameters, + ClientResolvedEndpointParameters, + EndpointParameters, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; +import { resolveRuntimeExtensions, RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions"; + +export { __Client }; + +/** + * @public + */ +export type ServiceInputTypes = + | BatchGetSecretValueCommandInput + | CancelRotateSecretCommandInput + | CreateSecretCommandInput + | DeleteResourcePolicyCommandInput + | DeleteSecretCommandInput + | DescribeSecretCommandInput + | GetRandomPasswordCommandInput + | GetResourcePolicyCommandInput + | GetSecretValueCommandInput + | ListSecretVersionIdsCommandInput + | ListSecretsCommandInput + | PutResourcePolicyCommandInput + | PutSecretValueCommandInput + | RemoveRegionsFromReplicationCommandInput + | ReplicateSecretToRegionsCommandInput + | RestoreSecretCommandInput + | RotateSecretCommandInput + | StopReplicationToReplicaCommandInput + | TagResourceCommandInput + | UntagResourceCommandInput + | UpdateSecretCommandInput + | UpdateSecretVersionStageCommandInput + | ValidateResourcePolicyCommandInput; + +/** + * @public + */ +export type ServiceOutputTypes = + | BatchGetSecretValueCommandOutput + | CancelRotateSecretCommandOutput + | CreateSecretCommandOutput + | DeleteResourcePolicyCommandOutput + | DeleteSecretCommandOutput + | DescribeSecretCommandOutput + | GetRandomPasswordCommandOutput + | GetResourcePolicyCommandOutput + | GetSecretValueCommandOutput + | ListSecretVersionIdsCommandOutput + | ListSecretsCommandOutput + | PutResourcePolicyCommandOutput + | PutSecretValueCommandOutput + | RemoveRegionsFromReplicationCommandOutput + | ReplicateSecretToRegionsCommandOutput + | RestoreSecretCommandOutput + | RotateSecretCommandOutput + | StopReplicationToReplicaCommandOutput + | TagResourceCommandOutput + | UntagResourceCommandOutput + | UpdateSecretCommandOutput + | UpdateSecretVersionStageCommandOutput + | ValidateResourcePolicyCommandOutput; + +/** + * @public + */ +export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> { + /** + * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. + */ + requestHandler?: __HttpHandlerUserInput; + + /** + * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface + * that computes the SHA-256 HMAC or checksum of a string or binary buffer. + * @internal + */ + sha256?: __ChecksumConstructor | __HashConstructor; + + /** + * The function that will be used to convert strings into HTTP endpoints. + * @internal + */ + urlParser?: __UrlParser; + + /** + * A function that can calculate the length of a request body. + * @internal + */ + bodyLengthChecker?: __BodyLengthCalculator; + + /** + * A function that converts a stream into an array of bytes. + * @internal + */ + streamCollector?: __StreamCollector; + + /** + * The function that will be used to convert a base64-encoded string to a byte array. + * @internal + */ + base64Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a base64-encoded string. + * @internal + */ + base64Encoder?: __Encoder; + + /** + * The function that will be used to convert a UTF8-encoded string to a byte array. + * @internal + */ + utf8Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a UTF-8 encoded string. + * @internal + */ + utf8Encoder?: __Encoder; + + /** + * The runtime environment. + * @internal + */ + runtime?: string; + + /** + * Disable dynamically changing the endpoint of the client based on the hostPrefix + * trait of an operation. + */ + disableHostPrefix?: boolean; + + /** + * Unique service identifier. + * @internal + */ + serviceId?: string; + + /** + * Enables IPv6/IPv4 dualstack endpoint. + */ + useDualstackEndpoint?: boolean | __ProviderAmazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
+ *This guide provides descriptions of the Secrets Manager API. For more information about using this + * service, see the Amazon Web Services Secrets Manager User Guide.
+ *+ * API Version + *
+ *This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
+ *For a list of endpoints, see Amazon Web Services Secrets Manager + * endpoints.
+ *+ * Support and Feedback for Amazon Web Services Secrets Manager + *
+ *We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more + * information about the Amazon Web Services Discussion Forums, see Forums + * Help.
+ *+ * Logging API Requests + *
+ *Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services + * account and delivers log files to an Amazon S3 bucket. By using information that's collected + * by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the + * request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services + * CloudTrail, see Logging + * Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. + * To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
+ * @public + */ +export class SecretsManagerClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + SecretsManagerClientResolvedConfig +> { + /** + * The resolved configuration of SecretsManagerClient class. This is resolved and normalized from the {@link SecretsManagerClientConfig | constructor configuration interface}. + */ + readonly config: SecretsManagerClientResolvedConfig; + + constructor(...[configuration]: __CheckOptionalClientConfigRetrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue.
To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as AccessDeniedException while attempting to retrieve any of the secrets, you can see the errors in Errors in the response.
Secrets Manager generates CloudTrail GetSecretValue log entries for each secret you request when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ * Required permissions:
+ * secretsmanager:BatchGetSecretValue, and you must have secretsmanager:GetSecretValue for each secret. If you use filters, you must also have secretsmanager:ListSecrets. If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed key
+ * aws/secretsmanager, then you also need kms:Decrypt permissions for the keys.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
Secrets Manager can't decrypt the protected secret text using the provided KMS key.
+ * + * @throws {@link InternalServiceError} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link InvalidNextTokenException} (client fault) + *The NextToken value is invalid.
The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To retrieve the secret values for a group of secrets listed by name + * ```javascript + * // The following example gets the values for three secrets. + * const input = { + * "SecretIdList": [ + * "MySecret1", + * "MySecret2", + * "MySecret3" + * ] + * }; + * const command = new BatchGetSecretValueCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "Errors": [], + * "SecretValues": [ + * { + * "ARN": "®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret1-a1b2c3", + * "CreatedDate": 1700591229.801, + * "Name": "MySecret1", + * "SecretString": "{\"username\":\"diego_ramirez\",\"password\":\"EXAMPLE-PASSWORD\",\"engine\":\"mysql\",\"host\":\"secretsmanagertutorial.cluster.us-west-2.rds.amazonaws.com\",\"port\":3306,\"dbClusterIdentifier\":\"secretsmanagertutorial\"}", + * "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", + * "VersionStages": [ + * "AWSCURRENT" + * ] + * }, + * { + * "ARN": "®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret2-a1b2c3", + * "CreatedDate": 1699911394.105, + * "Name": "MySecret2", + * "SecretString": "{\"username\":\"akua_mansa\",\"password\":\"EXAMPLE-PASSWORD\"", + * "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", + * "VersionStages": [ + * "AWSCURRENT" + * ] + * }, + * { + * "ARN": "®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret3-a1b2c3", + * "CreatedDate": 1699911394.105, + * "Name": "MySecret3", + * "SecretString": "{\"username\":\"jie_liu\",\"password\":\"EXAMPLE-PASSWORD\"", + * "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEccccc", + * "VersionStages": [ + * "AWSCURRENT" + * ] + * } + * ] + * } + * *\/ + * // example id: to-retrieve-the-secret-values-for-a-group-of-secrets-listed-by-name-1704846593341 + * ``` + * + */ +export class BatchGetSecretValueCommand extends $Command + .classBuilder< + BatchGetSecretValueCommandInput, + BatchGetSecretValueCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "BatchGetSecretValue", {}) + .n("SecretsManagerClient", "BatchGetSecretValueCommand") + .f(void 0, BatchGetSecretValueResponseFilterSensitiveLog) + .ser(se_BatchGetSecretValueCommand) + .de(de_BatchGetSecretValueCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: BatchGetSecretValueRequest; + output: BatchGetSecretValueResponse; + }; + sdk: { + input: BatchGetSecretValueCommandInput; + output: BatchGetSecretValueCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/CancelRotateSecretCommand.ts b/clients/client-secrets-manager-cbor/src/commands/CancelRotateSecretCommand.ts new file mode 100644 index 000000000000..5540a4120daf --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/CancelRotateSecretCommand.ts @@ -0,0 +1,156 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CancelRotateSecretRequest, CancelRotateSecretResponse } from "../models/models_0"; +import { de_CancelRotateSecretCommand, se_CancelRotateSecretCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CancelRotateSecretCommand}. + */ +export interface CancelRotateSecretCommandInput extends CancelRotateSecretRequest {} +/** + * @public + * + * The output of {@link CancelRotateSecretCommand}. + */ +export interface CancelRotateSecretCommandOutput extends CancelRotateSecretResponse, __MetadataBearer {} + +/** + *Turns off automatic rotation, and if a rotation is currently in + * progress, cancels the rotation.
+ *If you cancel a rotation in progress, it can leave the VersionStage
+ * labels in an unexpected state. You might
+ * need to remove the staging label AWSPENDING from the partially created version.
+ * You also need to determine whether to roll back to the previous version of the secret
+ * by moving the staging label AWSCURRENT to the version that has AWSPENDING.
+ * To determine
+ * which version has a specific staging label, call ListSecretVersionIds. Then use
+ * UpdateSecretVersionStage to change staging labels.
+ * For more information, see How rotation works.
To turn on automatic rotation again, call RotateSecret.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:CancelRotateSecret.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To cancel scheduled rotation for a secret + * ```javascript + * // The following example shows how to cancel rotation for a secret. The operation sets the RotationEnabled field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the rotate-secret operation. + * const input = { + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new CancelRotateSecretCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "Name" + * } + * *\/ + * // example id: to-cancel-scheduled-rotation-for-a-secret-1523996016032 + * ``` + * + */ +export class CancelRotateSecretCommand extends $Command + .classBuilder< + CancelRotateSecretCommandInput, + CancelRotateSecretCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "CancelRotateSecret", {}) + .n("SecretsManagerClient", "CancelRotateSecretCommand") + .f(void 0, void 0) + .ser(se_CancelRotateSecretCommand) + .de(de_CancelRotateSecretCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CancelRotateSecretRequest; + output: CancelRotateSecretResponse; + }; + sdk: { + input: CancelRotateSecretCommandInput; + output: CancelRotateSecretCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/CreateSecretCommand.ts b/clients/client-secrets-manager-cbor/src/commands/CreateSecretCommand.ts new file mode 100644 index 000000000000..bb77b91ff385 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/CreateSecretCommand.ts @@ -0,0 +1,227 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateSecretRequest, CreateSecretRequestFilterSensitiveLog, CreateSecretResponse } from "../models/models_0"; +import { de_CreateSecretCommand, se_CreateSecretCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateSecretCommand}. + */ +export interface CreateSecretCommandInput extends CreateSecretRequest {} +/** + * @public + * + * The output of {@link CreateSecretCommand}. + */ +export interface CreateSecretCommandOutput extends CreateSecretResponse, __MetadataBearer {} + +/** + *Creates a new secret. A secret can be a password, a set of + * credentials such as a user name and password, an OAuth token, or other secret information + * that you store in an encrypted form in Secrets Manager. The secret also + * includes the connection information to access a database or other service, which Secrets Manager + * doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the + * important information needed to manage the secret.
+ *For secrets that use managed rotation, you need to create the secret through the managing service. For more information, see Secrets Manager secrets managed by other Amazon Web Services services. + * + *
+ *For information about creating a secret in the console, see Create a secret.
+ *To create a secret, you can provide the secret value to be encrypted in either the
+ * SecretString parameter or the SecretBinary parameter, but not both.
+ * If you include SecretString or SecretBinary
+ * then Secrets Manager creates an initial secret version and automatically attaches the staging
+ * label AWSCURRENT to it.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret,
+ * you must make sure the JSON you store in the SecretString matches the JSON structure of
+ * a database secret.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
+ * aws/secretsmanager. If this key
+ * doesn't already exist in your account, then Secrets Manager creates it for you automatically. All
+ * users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager.
+ * Creating aws/secretsmanager can result in a one-time significant delay in returning the
+ * result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then
+ * you can't use aws/secretsmanager to encrypt the secret, and you must create
+ * and use a customer managed KMS key.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ * Required permissions:
+ * secretsmanager:CreateSecret. If you
+ * include tags in the secret, you also need secretsmanager:TagResource. To add replica Regions, you must also have secretsmanager:ReplicateSecretToRegions.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
+ *Secrets Manager can't decrypt the protected secret text using the provided KMS key.
+ * + * @throws {@link EncryptionFailure} (client fault) + *Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the + * KMS key is available, enabled, and not in an invalid state. For more + * information, see Key state: Effect on your KMS key.
+ * + * @throws {@link InternalServiceError} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *The request failed because it would exceed one of the Secrets Manager quotas.
+ * + * @throws {@link MalformedPolicyDocumentException} (client fault) + *The resource policy has syntax errors.
+ * + * @throws {@link PreconditionNotMetException} (client fault) + *The request failed because you did not complete all the prerequisite steps.
+ * + * @throws {@link ResourceExistsException} (client fault) + *A resource with the ID you requested already exists.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To create a basic secret + * ```javascript + * // The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named mycreds.json. + * const input = { + * "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + * "Description": "My test database secret created with the CLI", + * "Name": "MyTestDatabaseSecret", + * "SecretString": "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}" + * }; + * const command = new CreateSecretCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret", + * "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1" + * } + * *\/ + * // example id: to-create-a-basic-secret-1523996473658 + * ``` + * + */ +export class CreateSecretCommand extends $Command + .classBuilder< + CreateSecretCommandInput, + CreateSecretCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "CreateSecret", {}) + .n("SecretsManagerClient", "CreateSecretCommand") + .f(CreateSecretRequestFilterSensitiveLog, void 0) + .ser(se_CreateSecretCommand) + .de(de_CreateSecretCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateSecretRequest; + output: CreateSecretResponse; + }; + sdk: { + input: CreateSecretCommandInput; + output: CreateSecretCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/DeleteResourcePolicyCommand.ts b/clients/client-secrets-manager-cbor/src/commands/DeleteResourcePolicyCommand.ts new file mode 100644 index 000000000000..8fef589d0c3c --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/DeleteResourcePolicyCommand.ts @@ -0,0 +1,145 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteResourcePolicyRequest, DeleteResourcePolicyResponse } from "../models/models_0"; +import { de_DeleteResourcePolicyCommand, se_DeleteResourcePolicyCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteResourcePolicyCommand}. + */ +export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyRequest {} +/** + * @public + * + * The output of {@link DeleteResourcePolicyCommand}. + */ +export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyResponse, __MetadataBearer {} + +/** + *Deletes the resource-based permission policy attached to the secret. To attach a policy to + * a secret, use PutResourcePolicy.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:DeleteResourcePolicy.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To delete the resource-based policy attached to a secret + * ```javascript + * // The following example shows how to delete the resource-based policy that is attached to a secret. + * const input = { + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new DeleteResourcePolicyCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret" + * } + * *\/ + * // example id: to-delete-the-resource-based-policy-attached-to-a-secret-1530209419204 + * ``` + * + */ +export class DeleteResourcePolicyCommand extends $Command + .classBuilder< + DeleteResourcePolicyCommandInput, + DeleteResourcePolicyCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "DeleteResourcePolicy", {}) + .n("SecretsManagerClient", "DeleteResourcePolicyCommand") + .f(void 0, void 0) + .ser(se_DeleteResourcePolicyCommand) + .de(de_DeleteResourcePolicyCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteResourcePolicyRequest; + output: DeleteResourcePolicyResponse; + }; + sdk: { + input: DeleteResourcePolicyCommandInput; + output: DeleteResourcePolicyCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/DeleteSecretCommand.ts b/clients/client-secrets-manager-cbor/src/commands/DeleteSecretCommand.ts new file mode 100644 index 000000000000..d48afaae2ee0 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/DeleteSecretCommand.ts @@ -0,0 +1,170 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteSecretRequest, DeleteSecretResponse } from "../models/models_0"; +import { de_DeleteSecretCommand, se_DeleteSecretCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteSecretCommand}. + */ +export interface DeleteSecretCommandInput extends DeleteSecretRequest {} +/** + * @public + * + * The output of {@link DeleteSecretCommand}. + */ +export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __MetadataBearer {} + +/** + *Deletes a secret and all of its versions. You can specify a recovery
+ * window during which you can restore the secret. The minimum recovery window is 7 days.
+ * The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to
+ * the secret that specifies the end of the recovery window. At the end of the recovery window,
+ * Secrets Manager deletes the secret permanently.
You can't delete a primary secret that is replicated to other Regions. You must first delete the + * replicas using RemoveRegionsFromReplication, and then delete the primary secret. + * When you delete a replica, it is deleted immediately.
+ *You can't directly delete a version of a secret. Instead, you remove all staging labels + * from the version using UpdateSecretVersionStage. This marks the version as deprecated, + * and then Secrets Manager can automatically delete the version in the background.
+ *To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm + * to alert you to any attempts to access a secret during the recovery window. For more information, + * see + * Monitor secrets scheduled for deletion.
+ *Secrets Manager performs the permanent secret deletion at the end of the waiting period as a + * background task with low priority. There is no guarantee of a specific time after the + * recovery window for the permanent delete to occur.
+ *At any time before recovery window ends, you can use RestoreSecret to
+ * remove the DeletionDate and cancel the deletion of the secret.
When a secret is scheduled for deletion, you cannot retrieve the secret value. + * You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:DeleteSecret.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To delete a secret + * ```javascript + * // The following example shows how to delete a secret. The secret stays in your account in a deprecated and inaccessible state until the recovery window ends. After the date and time in the DeletionDate response field has passed, you can no longer recover this secret with restore-secret. + * const input = { + * "RecoveryWindowInDays": 7, + * "SecretId": "MyTestDatabaseSecret1" + * }; + * const command = new DeleteSecretCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "DeletionDate": "1524085349.095", + * "Name": "MyTestDatabaseSecret" + * } + * *\/ + * // example id: to-delete-a-secret-1523996905092 + * ``` + * + */ +export class DeleteSecretCommand extends $Command + .classBuilder< + DeleteSecretCommandInput, + DeleteSecretCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "DeleteSecret", {}) + .n("SecretsManagerClient", "DeleteSecretCommand") + .f(void 0, void 0) + .ser(se_DeleteSecretCommand) + .de(de_DeleteSecretCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteSecretRequest; + output: DeleteSecretResponse; + }; + sdk: { + input: DeleteSecretCommandInput; + output: DeleteSecretCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/DescribeSecretCommand.ts b/clients/client-secrets-manager-cbor/src/commands/DescribeSecretCommand.ts new file mode 100644 index 000000000000..9d8e33bec4a1 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/DescribeSecretCommand.ts @@ -0,0 +1,195 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeSecretRequest, DescribeSecretResponse } from "../models/models_0"; +import { de_DescribeSecretCommand, se_DescribeSecretCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeSecretCommand}. + */ +export interface DescribeSecretCommandInput extends DescribeSecretRequest {} +/** + * @public + * + * The output of {@link DescribeSecretCommand}. + */ +export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __MetadataBearer {} + +/** + *Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager + * only returns fields that have a value in the response.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:DescribeSecret.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To retrieve the details of a secret + * ```javascript + * // The following example shows how to get the details about a secret. + * const input = { + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new DescribeSecretCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Description": "My test database secret", + * "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE1-90ab-cdef-fedc-ba987KMSKEY1", + * "LastAccessedDate": "1523923200", + * "LastChangedDate": 1523477145.729, + * "LastRotatedDate": 1525747253.72, + * "Name": "MyTestDatabaseSecret", + * "NextRotationDate": "1665165599", + * "RotationEnabled": true, + * "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda", + * "RotationRules": { + * "AutomaticallyAfterDays": 14, + * "Duration": "2h", + * "ScheduleExpression": "cron(0 16 1,15 * ? *)" + * }, + * "Tags": [ + * { + * "Key": "SecondTag", + * "Value": "AnotherValue" + * }, + * { + * "Key": "FirstTag", + * "Value": "SomeValue" + * } + * ], + * "VersionIdsToStages": { + * "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ + * "AWSPREVIOUS" + * ], + * "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ + * "AWSCURRENT" + * ] + * } + * } + * *\/ + * // example id: to-retrieve-the-details-of-a-secret-1524000138629 + * ``` + * + */ +export class DescribeSecretCommand extends $Command + .classBuilder< + DescribeSecretCommandInput, + DescribeSecretCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "DescribeSecret", {}) + .n("SecretsManagerClient", "DescribeSecretCommand") + .f(void 0, void 0) + .ser(se_DescribeSecretCommand) + .de(de_DescribeSecretCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeSecretRequest; + output: DescribeSecretResponse; + }; + sdk: { + input: DescribeSecretCommandInput; + output: DescribeSecretCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/GetRandomPasswordCommand.ts b/clients/client-secrets-manager-cbor/src/commands/GetRandomPasswordCommand.ts new file mode 100644 index 000000000000..fb3503a667ff --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/GetRandomPasswordCommand.ts @@ -0,0 +1,155 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { + GetRandomPasswordRequest, + GetRandomPasswordResponse, + GetRandomPasswordResponseFilterSensitiveLog, +} from "../models/models_0"; +import { de_GetRandomPasswordCommand, se_GetRandomPasswordCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetRandomPasswordCommand}. + */ +export interface GetRandomPasswordCommandInput extends GetRandomPasswordRequest {} +/** + * @public + * + * The output of {@link GetRandomPasswordCommand}. + */ +export interface GetRandomPasswordCommandOutput extends GetRandomPasswordResponse, __MetadataBearer {} + +/** + *Generates a random password. We recommend that you specify the
+ * maximum length and include every character type that the system you are generating a password
+ * for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: !\"#$%&'()*+,-./:;<=>?@[\\]^_`\{|\}~
+ *
Secrets Manager generates a CloudTrail log entry when you call this action.
+ *
+ * Required permissions:
+ * secretsmanager:GetRandomPassword.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To generate a random password + * ```javascript + * // The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters. + * const input = { + * "IncludeSpace": true, + * "PasswordLength": 20, + * "RequireEachIncludedType": true + * }; + * const command = new GetRandomPasswordCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "RandomPassword": "EXAMPLE-PASSWORD" + * } + * *\/ + * // example id: to-generate-a-random-password-1524000546092 + * ``` + * + */ +export class GetRandomPasswordCommand extends $Command + .classBuilder< + GetRandomPasswordCommandInput, + GetRandomPasswordCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "GetRandomPassword", {}) + .n("SecretsManagerClient", "GetRandomPasswordCommand") + .f(void 0, GetRandomPasswordResponseFilterSensitiveLog) + .ser(se_GetRandomPasswordCommand) + .de(de_GetRandomPasswordCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetRandomPasswordRequest; + output: GetRandomPasswordResponse; + }; + sdk: { + input: GetRandomPasswordCommandInput; + output: GetRandomPasswordCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/GetResourcePolicyCommand.ts b/clients/client-secrets-manager-cbor/src/commands/GetResourcePolicyCommand.ts new file mode 100644 index 000000000000..536c411c759f --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/GetResourcePolicyCommand.ts @@ -0,0 +1,149 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetResourcePolicyRequest, GetResourcePolicyResponse } from "../models/models_0"; +import { de_GetResourcePolicyCommand, se_GetResourcePolicyCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetResourcePolicyCommand}. + */ +export interface GetResourcePolicyCommandInput extends GetResourcePolicyRequest {} +/** + * @public + * + * The output of {@link GetResourcePolicyCommand}. + */ +export interface GetResourcePolicyCommandOutput extends GetResourcePolicyResponse, __MetadataBearer {} + +/** + *Retrieves the JSON text of the resource-based policy document attached to the + * secret. For more information about permissions policies attached to a secret, see + * Permissions + * policies attached to a secret.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:GetResourcePolicy.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To retrieve the resource-based policy attached to a secret + * ```javascript + * // The following example shows how to retrieve the resource-based policy that is attached to a secret. + * const input = { + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new GetResourcePolicyCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret", + * "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}" + * } + * *\/ + * // example id: to-retrieve-the-resource-based-policy-attached-to-a-secret-1530209677536 + * ``` + * + */ +export class GetResourcePolicyCommand extends $Command + .classBuilder< + GetResourcePolicyCommandInput, + GetResourcePolicyCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "GetResourcePolicy", {}) + .n("SecretsManagerClient", "GetResourcePolicyCommand") + .f(void 0, void 0) + .ser(se_GetResourcePolicyCommand) + .de(de_GetResourcePolicyCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetResourcePolicyRequest; + output: GetResourcePolicyResponse; + }; + sdk: { + input: GetResourcePolicyCommandInput; + output: GetResourcePolicyCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/GetSecretValueCommand.ts b/clients/client-secrets-manager-cbor/src/commands/GetSecretValueCommand.ts new file mode 100644 index 000000000000..fb57aedce46f --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/GetSecretValueCommand.ts @@ -0,0 +1,176 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { + GetSecretValueRequest, + GetSecretValueResponse, + GetSecretValueResponseFilterSensitiveLog, +} from "../models/models_0"; +import { de_GetSecretValueCommand, se_GetSecretValueCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetSecretValueCommand}. + */ +export interface GetSecretValueCommandInput extends GetSecretValueRequest {} +/** + * @public + * + * The output of {@link GetSecretValueCommand}. + */ +export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __MetadataBearer {} + +/** + *Retrieves the contents of the encrypted fields SecretString or
+ * SecretBinary from the specified version of a secret, whichever contains
+ * content.
To retrieve the values for a group of secrets, call BatchGetSecretValue.
+ *We recommend that you cache your secret values by using client-side caching. + * Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for + * your applications.
+ *To retrieve the previous version of a secret, use VersionStage and specify
+ * AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:GetSecretValue.
+ * If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key
+ * aws/secretsmanager, then you also need kms:Decrypt permissions for that key.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
Secrets Manager can't decrypt the protected secret text using the provided KMS key.
+ * + * @throws {@link InternalServiceError} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To retrieve the encrypted secret value of a secret + * ```javascript + * // The following example shows how to retrieve a secret string value. + * const input = { + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new GetSecretValueCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "CreatedDate": 1523477145.713, + * "Name": "MyTestDatabaseSecret", + * "SecretString": "{\n \"username\":\"david\",\n \"password\":\"EXAMPLE-PASSWORD\"\n}\n", + * "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + * "VersionStages": [ + * "AWSPREVIOUS" + * ] + * } + * *\/ + * // example id: to-retrieve-the-encrypted-secret-value-of-a-secret-1524000702484 + * ``` + * + */ +export class GetSecretValueCommand extends $Command + .classBuilder< + GetSecretValueCommandInput, + GetSecretValueCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "GetSecretValue", {}) + .n("SecretsManagerClient", "GetSecretValueCommand") + .f(void 0, GetSecretValueResponseFilterSensitiveLog) + .ser(se_GetSecretValueCommand) + .de(de_GetSecretValueCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetSecretValueRequest; + output: GetSecretValueResponse; + }; + sdk: { + input: GetSecretValueCommandInput; + output: GetSecretValueCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/ListSecretVersionIdsCommand.ts b/clients/client-secrets-manager-cbor/src/commands/ListSecretVersionIdsCommand.ts new file mode 100644 index 000000000000..3e72a723b9c9 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/ListSecretVersionIdsCommand.ts @@ -0,0 +1,170 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListSecretVersionIdsRequest, ListSecretVersionIdsResponse } from "../models/models_0"; +import { de_ListSecretVersionIdsCommand, se_ListSecretVersionIdsCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListSecretVersionIdsCommand}. + */ +export interface ListSecretVersionIdsCommandInput extends ListSecretVersionIdsRequest {} +/** + * @public + * + * The output of {@link ListSecretVersionIdsCommand}. + */ +export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsResponse, __MetadataBearer {} + +/** + *Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions + * of a secret. For more information, see + * Secrets Manager concepts: Versions.
+ *To list the secrets in the account, use ListSecrets.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:ListSecretVersionIds.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidNextTokenException} (client fault) + *The NextToken value is invalid.
The parameter name or value is invalid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To list all of the secret versions associated with a secret + * ```javascript + * // The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels. + * const input = { + * "IncludeDeprecated": true, + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new ListSecretVersionIdsCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret", + * "Versions": [ + * { + * "CreatedDate": 1523477145.713, + * "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", + * "VersionStages": [ + * "AWSPREVIOUS" + * ] + * }, + * { + * "CreatedDate": 1523486221.391, + * "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + * "VersionStages": [ + * "AWSCURRENT" + * ] + * }, + * { + * "CreatedDate": 1511974462.36, + * "VersionId": "EXAMPLE3-90ab-cdef-fedc-ba987EXAMPLE;" + * } + * ] + * } + * *\/ + * // example id: to-list-all-of-the-secret-versions-associated-with-a-secret-1524000999164 + * ``` + * + */ +export class ListSecretVersionIdsCommand extends $Command + .classBuilder< + ListSecretVersionIdsCommandInput, + ListSecretVersionIdsCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "ListSecretVersionIds", {}) + .n("SecretsManagerClient", "ListSecretVersionIdsCommand") + .f(void 0, void 0) + .ser(se_ListSecretVersionIdsCommand) + .de(de_ListSecretVersionIdsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListSecretVersionIdsRequest; + output: ListSecretVersionIdsResponse; + }; + sdk: { + input: ListSecretVersionIdsCommandInput; + output: ListSecretVersionIdsCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/ListSecretsCommand.ts b/clients/client-secrets-manager-cbor/src/commands/ListSecretsCommand.ts new file mode 100644 index 000000000000..42d0451dc9ff --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/ListSecretsCommand.ts @@ -0,0 +1,213 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListSecretsRequest, ListSecretsResponse } from "../models/models_0"; +import { de_ListSecretsCommand, se_ListSecretsCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListSecretsCommand}. + */ +export interface ListSecretsCommandInput extends ListSecretsRequest {} +/** + * @public + * + * The output of {@link ListSecretsCommand}. + */ +export interface ListSecretsCommandOutput extends ListSecretsResponse, __MetadataBearer {} + +/** + *Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets + * that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
+ *All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret.
+ *To list the versions of a secret, use ListSecretVersionIds.
+ *To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.
+ *For information about finding secrets in the console, see Find secrets in Secrets Manager.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:ListSecrets.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidNextTokenException} (client fault) + *The NextToken value is invalid.
The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To list the secrets in your account + * ```javascript + * // The following example shows how to list all of the secrets in your account. + * const input = {}; + * const command = new ListSecretsCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "SecretList": [ + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Description": "My test database secret", + * "LastChangedDate": 1523477145.729, + * "Name": "MyTestDatabaseSecret", + * "SecretVersionsToStages": { + * "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ + * "AWSCURRENT" + * ] + * } + * }, + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret1-d4e5f6", + * "Description": "Another secret created for a different database", + * "LastChangedDate": 1523482025.685, + * "Name": "MyTestDatabaseSecret1", + * "SecretVersionsToStages": { + * "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ + * "AWSCURRENT" + * ] + * } + * } + * ] + * } + * *\/ + * // example id: to-list-the-secrets-in-your-account-1524001246087 + * ``` + * + */ +export class ListSecretsCommand extends $Command + .classBuilder< + ListSecretsCommandInput, + ListSecretsCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "ListSecrets", {}) + .n("SecretsManagerClient", "ListSecretsCommand") + .f(void 0, void 0) + .ser(se_ListSecretsCommand) + .de(de_ListSecretsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListSecretsRequest; + output: ListSecretsResponse; + }; + sdk: { + input: ListSecretsCommandInput; + output: ListSecretsCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/PutResourcePolicyCommand.ts b/clients/client-secrets-manager-cbor/src/commands/PutResourcePolicyCommand.ts new file mode 100644 index 000000000000..6911390889f3 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/PutResourcePolicyCommand.ts @@ -0,0 +1,157 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutResourcePolicyRequest, PutResourcePolicyResponse } from "../models/models_0"; +import { de_PutResourcePolicyCommand, se_PutResourcePolicyCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutResourcePolicyCommand}. + */ +export interface PutResourcePolicyCommandInput extends PutResourcePolicyRequest {} +/** + * @public + * + * The output of {@link PutResourcePolicyCommand}. + */ +export interface PutResourcePolicyCommandOutput extends PutResourcePolicyResponse, __MetadataBearer {} + +/** + *Attaches a resource-based permission policy to a secret. A resource-based policy is + * optional. For more information, see Authentication and access control for Secrets Manager + *
+ *For information about attaching a policy in the console, see Attach a + * permissions policy to a secret.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:PutResourcePolicy.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *The resource policy has syntax errors.
+ * + * @throws {@link PublicPolicyException} (client fault) + *The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.
Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To add a resource-based policy to a secret + * ```javascript + * // The following example shows how to add a resource-based policy to a secret. + * const input = { + * "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}", + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new PutResourcePolicyCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret" + * } + * *\/ + * // example id: to-add-a-resource-based-policy-to-a-secret-1530209881839 + * ``` + * + */ +export class PutResourcePolicyCommand extends $Command + .classBuilder< + PutResourcePolicyCommandInput, + PutResourcePolicyCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "PutResourcePolicy", {}) + .n("SecretsManagerClient", "PutResourcePolicyCommand") + .f(void 0, void 0) + .ser(se_PutResourcePolicyCommand) + .de(de_PutResourcePolicyCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutResourcePolicyRequest; + output: PutResourcePolicyResponse; + }; + sdk: { + input: PutResourcePolicyCommandInput; + output: PutResourcePolicyCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/PutSecretValueCommand.ts b/clients/client-secrets-manager-cbor/src/commands/PutSecretValueCommand.ts new file mode 100644 index 000000000000..b9b543f8ceaa --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/PutSecretValueCommand.ts @@ -0,0 +1,202 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { + PutSecretValueRequest, + PutSecretValueRequestFilterSensitiveLog, + PutSecretValueResponse, +} from "../models/models_0"; +import { de_PutSecretValueCommand, se_PutSecretValueCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutSecretValueCommand}. + */ +export interface PutSecretValueCommandInput extends PutSecretValueRequest {} +/** + * @public + * + * The output of {@link PutSecretValueCommand}. + */ +export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __MetadataBearer {} + +/** + *Creates a new version with a new encrypted secret value and attaches it to the secret. The
+ * version can contain a new SecretString value or a new SecretBinary value.
We recommend you avoid calling PutSecretValue at a sustained rate of more than
+ * once every 10 minutes. When you update the secret value, Secrets Manager creates a new version
+ * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
+ * remove versions created less than 24 hours ago. If you call PutSecretValue more
+ * than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
+ * the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages.
+ * If you don't include VersionStages, then Secrets Manager automatically
+ * moves the staging label AWSCURRENT to this version. If this operation creates
+ * the first version for the secret, then Secrets Manager
+ * automatically attaches the staging label AWSCURRENT to it.
+ * If this operation moves the staging label AWSCURRENT from another version to this
+ * version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to
+ * the version that AWSCURRENT was removed from.
This operation is idempotent. If you call this operation with a ClientRequestToken
+ * that matches an existing version's VersionId, and you specify the
+ * same secret data, the operation succeeds but does nothing. However, if the secret data is
+ * different, then the operation fails because you can't modify an existing version; you can
+ * only create new ones.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary, SecretString, or RotationToken because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ * Required permissions:
+ * secretsmanager:PutSecretValue.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
+ *Secrets Manager can't decrypt the protected secret text using the provided KMS key.
+ * + * @throws {@link EncryptionFailure} (client fault) + *Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the + * KMS key is available, enabled, and not in an invalid state. For more + * information, see Key state: Effect on your KMS key.
+ * + * @throws {@link InternalServiceError} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *The request failed because it would exceed one of the Secrets Manager quotas.
+ * + * @throws {@link ResourceExistsException} (client fault) + *A resource with the ID you requested already exists.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To store a secret value in a new version of a secret + * ```javascript + * // The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command. + * const input = { + * "ClientRequestToken": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + * "SecretId": "MyTestDatabaseSecret", + * "SecretString": "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}" + * }; + * const command = new PutSecretValueCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret", + * "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + * "VersionStages": [ + * "AWSCURRENT" + * ] + * } + * *\/ + * // example id: to-store-a-secret-value-in-a-new-version-of-a-secret-1524001393971 + * ``` + * + */ +export class PutSecretValueCommand extends $Command + .classBuilder< + PutSecretValueCommandInput, + PutSecretValueCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "PutSecretValue", {}) + .n("SecretsManagerClient", "PutSecretValueCommand") + .f(PutSecretValueRequestFilterSensitiveLog, void 0) + .ser(se_PutSecretValueCommand) + .de(de_PutSecretValueCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutSecretValueRequest; + output: PutSecretValueResponse; + }; + sdk: { + input: PutSecretValueCommandInput; + output: PutSecretValueCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/RemoveRegionsFromReplicationCommand.ts b/clients/client-secrets-manager-cbor/src/commands/RemoveRegionsFromReplicationCommand.ts new file mode 100644 index 000000000000..d4c7345a884f --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/RemoveRegionsFromReplicationCommand.ts @@ -0,0 +1,140 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { RemoveRegionsFromReplicationRequest, RemoveRegionsFromReplicationResponse } from "../models/models_0"; +import { de_RemoveRegionsFromReplicationCommand, se_RemoveRegionsFromReplicationCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link RemoveRegionsFromReplicationCommand}. + */ +export interface RemoveRegionsFromReplicationCommandInput extends RemoveRegionsFromReplicationRequest {} +/** + * @public + * + * The output of {@link RemoveRegionsFromReplicationCommand}. + */ +export interface RemoveRegionsFromReplicationCommandOutput + extends RemoveRegionsFromReplicationResponse, + __MetadataBearer {} + +/** + *For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:RemoveRegionsFromReplication.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + */ +export class RemoveRegionsFromReplicationCommand extends $Command + .classBuilder< + RemoveRegionsFromReplicationCommandInput, + RemoveRegionsFromReplicationCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "RemoveRegionsFromReplication", {}) + .n("SecretsManagerClient", "RemoveRegionsFromReplicationCommand") + .f(void 0, void 0) + .ser(se_RemoveRegionsFromReplicationCommand) + .de(de_RemoveRegionsFromReplicationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: RemoveRegionsFromReplicationRequest; + output: RemoveRegionsFromReplicationResponse; + }; + sdk: { + input: RemoveRegionsFromReplicationCommandInput; + output: RemoveRegionsFromReplicationCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/ReplicateSecretToRegionsCommand.ts b/clients/client-secrets-manager-cbor/src/commands/ReplicateSecretToRegionsCommand.ts new file mode 100644 index 000000000000..26c6850d2209 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/ReplicateSecretToRegionsCommand.ts @@ -0,0 +1,171 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ReplicateSecretToRegionsRequest, ReplicateSecretToRegionsResponse } from "../models/models_0"; +import { de_ReplicateSecretToRegionsCommand, se_ReplicateSecretToRegionsCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ReplicateSecretToRegionsCommand}. + */ +export interface ReplicateSecretToRegionsCommandInput extends ReplicateSecretToRegionsRequest {} +/** + * @public + * + * The output of {@link ReplicateSecretToRegionsCommand}. + */ +export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretToRegionsResponse, __MetadataBearer {} + +/** + *Replicates the secret to a new Regions. See Multi-Region secrets.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:ReplicateSecretToRegions.
+ * If the primary secret is encrypted with a KMS key other than aws/secretsmanager, you also need kms:Decrypt permission to the key. To encrypt the replicated secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Encrypt to the key. For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example Example + * ```javascript + * // The following example replicates a secret to eu-west-3. The replica is encrypted with the AWS managed key aws/secretsmanager. + * const input = { + * "AddReplicaRegions": [ + * { + * "Region": "eu-west-3" + * } + * ], + * "ForceOverwriteReplicaSecret": true, + * "SecretId": "MyTestSecret" + * }; + * const command = new ReplicateSecretToRegionsCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-1a2b3c", + * "ReplicationStatus": [ + * { + * "KmsKeyId": "alias/aws/secretsmanager", + * "Region": "eu-west-3", + * "Status": "InProgress" + * } + * ] + * } + * *\/ + * // example id: example-1679591984774 + * ``` + * + */ +export class ReplicateSecretToRegionsCommand extends $Command + .classBuilder< + ReplicateSecretToRegionsCommandInput, + ReplicateSecretToRegionsCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "ReplicateSecretToRegions", {}) + .n("SecretsManagerClient", "ReplicateSecretToRegionsCommand") + .f(void 0, void 0) + .ser(se_ReplicateSecretToRegionsCommand) + .de(de_ReplicateSecretToRegionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ReplicateSecretToRegionsRequest; + output: ReplicateSecretToRegionsResponse; + }; + sdk: { + input: ReplicateSecretToRegionsCommandInput; + output: ReplicateSecretToRegionsCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/RestoreSecretCommand.ts b/clients/client-secrets-manager-cbor/src/commands/RestoreSecretCommand.ts new file mode 100644 index 000000000000..e84631206508 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/RestoreSecretCommand.ts @@ -0,0 +1,145 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { RestoreSecretRequest, RestoreSecretResponse } from "../models/models_0"; +import { de_RestoreSecretCommand, se_RestoreSecretCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link RestoreSecretCommand}. + */ +export interface RestoreSecretCommandInput extends RestoreSecretRequest {} +/** + * @public + * + * The output of {@link RestoreSecretCommand}. + */ +export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __MetadataBearer {} + +/** + *Cancels the scheduled deletion of a secret by removing the DeletedDate time
+ * stamp. You can access a secret again after it has been restored.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:RestoreSecret.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To restore a previously deleted secret + * ```javascript + * // The following example shows how to restore a secret that you previously scheduled for deletion. + * const input = { + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new RestoreSecretCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret" + * } + * *\/ + * // example id: to-restore-a-previously-deleted-secret-1524001513930 + * ``` + * + */ +export class RestoreSecretCommand extends $Command + .classBuilder< + RestoreSecretCommandInput, + RestoreSecretCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "RestoreSecret", {}) + .n("SecretsManagerClient", "RestoreSecretCommand") + .f(void 0, void 0) + .ser(se_RestoreSecretCommand) + .de(de_RestoreSecretCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: RestoreSecretRequest; + output: RestoreSecretResponse; + }; + sdk: { + input: RestoreSecretCommandInput; + output: RestoreSecretCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/RotateSecretCommand.ts b/clients/client-secrets-manager-cbor/src/commands/RotateSecretCommand.ts new file mode 100644 index 000000000000..2e0fa3c237d4 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/RotateSecretCommand.ts @@ -0,0 +1,185 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { RotateSecretRequest, RotateSecretResponse } from "../models/models_0"; +import { de_RotateSecretCommand, se_RotateSecretCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link RotateSecretCommand}. + */ +export interface RotateSecretCommandInput extends RotateSecretRequest {} +/** + * @public + * + * The output of {@link RotateSecretCommand}. + */ +export interface RotateSecretCommandOutput extends RotateSecretResponse, __MetadataBearer {} + +/** + *Configures and starts the asynchronous process of rotating the secret. For information about rotation, + * see Rotate secrets in the Secrets Manager User Guide. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret.
+ *When rotation is successful, the AWSPENDING staging label might be attached
+ * to the same version as the AWSCURRENT version, or it might not be attached to any
+ * version. If the AWSPENDING staging label is present but not attached to the same
+ * version as AWSCURRENT, then any later invocation of RotateSecret
+ * assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the AWSPENDING staging label might be attached to an empty secret version. For more information, see Troubleshoot rotation in the Secrets Manager User Guide.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:RotateSecret.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function.
+ * For more information, see
+ * Permissions for rotation.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To configure rotation for a secret + * ```javascript + * // The following example configures rotation for a secret using a cron expression. The first rotation happens immediately after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation window begins at 4:00 PM UTC and ends at 6:00 PM. + * const input = { + * "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda", + * "RotationRules": { + * "Duration": "2h", + * "ScheduleExpression": "cron(0 16 1,15 * ? *)" + * }, + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new RotateSecretCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret", + * "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2" + * } + * *\/ + * // example id: to-configure-rotation-for-a-secret-1524001629475 + * ``` + * + * @example To request an immediate rotation for a secret + * ```javascript + * // The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background. + * const input = { + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new RotateSecretCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret", + * "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2" + * } + * *\/ + * // example id: to-request-an-immediate-rotation-for-a-secret-1524001949004 + * ``` + * + */ +export class RotateSecretCommand extends $Command + .classBuilder< + RotateSecretCommandInput, + RotateSecretCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "RotateSecret", {}) + .n("SecretsManagerClient", "RotateSecretCommand") + .f(void 0, void 0) + .ser(se_RotateSecretCommand) + .de(de_RotateSecretCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: RotateSecretRequest; + output: RotateSecretResponse; + }; + sdk: { + input: RotateSecretCommandInput; + output: RotateSecretCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/StopReplicationToReplicaCommand.ts b/clients/client-secrets-manager-cbor/src/commands/StopReplicationToReplicaCommand.ts new file mode 100644 index 000000000000..25044a21c7b1 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/StopReplicationToReplicaCommand.ts @@ -0,0 +1,127 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { StopReplicationToReplicaRequest, StopReplicationToReplicaResponse } from "../models/models_0"; +import { de_StopReplicationToReplicaCommand, se_StopReplicationToReplicaCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link StopReplicationToReplicaCommand}. + */ +export interface StopReplicationToReplicaCommandInput extends StopReplicationToReplicaRequest {} +/** + * @public + * + * The output of {@link StopReplicationToReplicaCommand}. + */ +export interface StopReplicationToReplicaCommandOutput extends StopReplicationToReplicaResponse, __MetadataBearer {} + +/** + *Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
+ *You must call this operation from the Region in which you want to promote the replica to a primary secret.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:StopReplicationToReplica.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + */ +export class StopReplicationToReplicaCommand extends $Command + .classBuilder< + StopReplicationToReplicaCommandInput, + StopReplicationToReplicaCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "StopReplicationToReplica", {}) + .n("SecretsManagerClient", "StopReplicationToReplicaCommand") + .f(void 0, void 0) + .ser(se_StopReplicationToReplicaCommand) + .de(de_StopReplicationToReplicaCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: StopReplicationToReplicaRequest; + output: StopReplicationToReplicaResponse; + }; + sdk: { + input: StopReplicationToReplicaCommandInput; + output: StopReplicationToReplicaCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/TagResourceCommand.ts b/clients/client-secrets-manager-cbor/src/commands/TagResourceCommand.ts new file mode 100644 index 000000000000..70b2bff7ccd5 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/TagResourceCommand.ts @@ -0,0 +1,160 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { TagResourceRequest } from "../models/models_0"; +import { de_TagResourceCommand, se_TagResourceCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link TagResourceCommand}. + */ +export interface TagResourceCommandInput extends TagResourceRequest {} +/** + * @public + * + * The output of {@link TagResourceCommand}. + */ +export interface TagResourceCommandOutput extends __MetadataBearer {} + +/** + *Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the + * secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.
+ *For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General + * Reference guide.
+ *If you use tags as part of your security strategy, then adding or removing a tag can + * change permissions. If successfully completing this operation would result in you losing + * your permissions for this secret, then the operation is blocked and returns an Access Denied + * error.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:TagResource.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To add tags to a secret + * ```javascript + * // The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation. + * const input = { + * "SecretId": "MyExampleSecret", + * "Tags": [ + * { + * "Key": "FirstTag", + * "Value": "SomeValue" + * }, + * { + * "Key": "SecondTag", + * "Value": "AnotherValue" + * } + * ] + * }; + * const command = new TagResourceCommand(input); + * await client.send(command); + * // example id: to-add-tags-to-a-secret-1524002106718 + * ``` + * + */ +export class TagResourceCommand extends $Command + .classBuilder< + TagResourceCommandInput, + TagResourceCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "TagResource", {}) + .n("SecretsManagerClient", "TagResourceCommand") + .f(void 0, void 0) + .ser(se_TagResourceCommand) + .de(de_TagResourceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: TagResourceRequest; + output: {}; + }; + sdk: { + input: TagResourceCommandInput; + output: TagResourceCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/UntagResourceCommand.ts b/clients/client-secrets-manager-cbor/src/commands/UntagResourceCommand.ts new file mode 100644 index 000000000000..e02894fb0e90 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/UntagResourceCommand.ts @@ -0,0 +1,150 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UntagResourceRequest } from "../models/models_0"; +import { de_UntagResourceCommand, se_UntagResourceCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandInput extends UntagResourceRequest {} +/** + * @public + * + * The output of {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandOutput extends __MetadataBearer {} + +/** + *Removes specific tags from a secret.
+ *This operation is idempotent. If a requested tag is not attached to the secret, no error + * is returned and the secret metadata is unchanged.
+ *If you use tags as part of your security strategy, then removing a tag can change + * permissions. If successfully completing this operation would result in you losing your + * permissions for this secret, then the operation is blocked and returns an Access Denied + * error.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:UntagResource.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To remove tags from a secret + * ```javascript + * // The following example shows how to remove two tags from a secret's metadata. For each, both the tag and the associated value are removed. There is no output from this API. To see the result, use the DescribeSecret operation. + * const input = { + * "SecretId": "MyTestDatabaseSecret", + * "TagKeys": [ + * "FirstTag", + * "SecondTag" + * ] + * }; + * const command = new UntagResourceCommand(input); + * await client.send(command); + * // example id: to-remove-tags-from-a-secret-1524002239065 + * ``` + * + */ +export class UntagResourceCommand extends $Command + .classBuilder< + UntagResourceCommandInput, + UntagResourceCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "UntagResource", {}) + .n("SecretsManagerClient", "UntagResourceCommand") + .f(void 0, void 0) + .ser(se_UntagResourceCommand) + .de(de_UntagResourceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UntagResourceRequest; + output: {}; + }; + sdk: { + input: UntagResourceCommandInput; + output: UntagResourceCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/UpdateSecretCommand.ts b/clients/client-secrets-manager-cbor/src/commands/UpdateSecretCommand.ts new file mode 100644 index 000000000000..d6610bb57a99 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/UpdateSecretCommand.ts @@ -0,0 +1,231 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateSecretRequest, UpdateSecretRequestFilterSensitiveLog, UpdateSecretResponse } from "../models/models_0"; +import { de_UpdateSecretCommand, se_UpdateSecretCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateSecretCommand}. + */ +export interface UpdateSecretCommandInput extends UpdateSecretRequest {} +/** + * @public + * + * The output of {@link UpdateSecretCommand}. + */ +export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __MetadataBearer {} + +/** + *Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
+ *To change the rotation configuration of a secret, use RotateSecret instead.
+ *To change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services.
+ *We recommend you avoid calling UpdateSecret at a sustained rate of more than
+ * once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version
+ * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
+ * remove versions created less than 24 hours ago. If you update the secret value more
+ * than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
+ * the quota for secret versions.
If you include SecretString or SecretBinary to create a new
+ * secret version, Secrets Manager automatically moves the staging label AWSCURRENT to the new
+ * version. Then it attaches the label AWSPREVIOUS
+ * to the version that AWSCURRENT was removed from.
If you call this operation with a ClientRequestToken that matches an existing version's
+ * VersionId, the operation results in an error. You can't modify an existing
+ * version, you can only create a new version. To remove a version, remove all staging labels from it. See
+ * UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ * Required permissions:
+ * secretsmanager:UpdateSecret.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
+ * If you use a customer managed key, you must also have kms:GenerateDataKey, kms:Encrypt, and
+ * kms:Decrypt permissions on the key. If you change the KMS key and you don't have kms:Encrypt permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more information, see
+ * Secret encryption and decryption.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
+ *Secrets Manager can't decrypt the protected secret text using the provided KMS key.
+ * + * @throws {@link EncryptionFailure} (client fault) + *Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the + * KMS key is available, enabled, and not in an invalid state. For more + * information, see Key state: Effect on your KMS key.
+ * + * @throws {@link InternalServiceError} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *The request failed because it would exceed one of the Secrets Manager quotas.
+ * + * @throws {@link MalformedPolicyDocumentException} (client fault) + *The resource policy has syntax errors.
+ * + * @throws {@link PreconditionNotMetException} (client fault) + *The request failed because you did not complete all the prerequisite steps.
+ * + * @throws {@link ResourceExistsException} (client fault) + *A resource with the ID you requested already exists.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To update the description of a secret + * ```javascript + * // The following example shows how to modify the description of a secret. + * const input = { + * "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", + * "Description": "This is a new description for the secret.", + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new UpdateSecretCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret" + * } + * *\/ + * // example id: to-update-the-description-of-a-secret-1524002349094 + * ``` + * + * @example To update the KMS key associated with a secret + * ```javascript + * // This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret. + * const input = { + * "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new UpdateSecretCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret" + * } + * *\/ + * // example id: to-update-the-kms-key-associated-with-a-secret-1524002421563 + * ``` + * + * @example To create a new version of the encrypted secret value + * ```javascript + * // The following example shows how to create a new version of the secret by updating the SecretString field. Alternatively, you can use the put-secret-value operation. + * const input = { + * "SecretId": "MyTestDatabaseSecret", + * "SecretString": "{JSON STRING WITH CREDENTIALS}" + * }; + * const command = new UpdateSecretCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret", + * "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" + * } + * *\/ + * // example id: to-create-a-new-version-of-the-encrypted-secret-value-1524004651836 + * ``` + * + */ +export class UpdateSecretCommand extends $Command + .classBuilder< + UpdateSecretCommandInput, + UpdateSecretCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "UpdateSecret", {}) + .n("SecretsManagerClient", "UpdateSecretCommand") + .f(UpdateSecretRequestFilterSensitiveLog, void 0) + .ser(se_UpdateSecretCommand) + .de(de_UpdateSecretCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateSecretRequest; + output: UpdateSecretResponse; + }; + sdk: { + input: UpdateSecretCommandInput; + output: UpdateSecretCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/UpdateSecretVersionStageCommand.ts b/clients/client-secrets-manager-cbor/src/commands/UpdateSecretVersionStageCommand.ts new file mode 100644 index 000000000000..95f0c981bab7 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/UpdateSecretVersionStageCommand.ts @@ -0,0 +1,205 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateSecretVersionStageRequest, UpdateSecretVersionStageResponse } from "../models/models_0"; +import { de_UpdateSecretVersionStageCommand, se_UpdateSecretVersionStageCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateSecretVersionStageCommand}. + */ +export interface UpdateSecretVersionStageCommandInput extends UpdateSecretVersionStageRequest {} +/** + * @public + * + * The output of {@link UpdateSecretVersionStageCommand}. + */ +export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersionStageResponse, __MetadataBearer {} + +/** + *Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to + * track a version as it progresses through the secret rotation process. Each staging label can be + * attached to only one version at a time. To add a staging label to a version when it is already + * attached to another version, Secrets Manager first removes it from the other version first and + * then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
+ *The staging labels that you specify in the VersionStage parameter are added
+ * to the existing list of staging labels for the version.
You can move the AWSCURRENT staging label to this version by including it in this
+ * call.
Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS
+ * to the version that AWSCURRENT was removed from.
If this action results in the last label being removed from a version, then the version is + * considered to be 'deprecated' and can be deleted by Secrets Manager.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:UpdateSecretVersionStage.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *The request failed because it would exceed one of the Secrets Manager quotas.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To add a staging label attached to a version of a secret + * ```javascript + * // The following example shows you how to add a staging label to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version. + * const input = { + * "MoveToVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + * "SecretId": "MyTestDatabaseSecret", + * "VersionStage": "STAGINGLABEL1" + * }; + * const command = new UpdateSecretVersionStageCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret" + * } + * *\/ + * // example id: to-add-a-staging-label-attached-to-a-version-of-a-secret-1524004783841 + * ``` + * + * @example To delete a staging label attached to a version of a secret + * ```javascript + * // The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version. + * const input = { + * "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + * "SecretId": "MyTestDatabaseSecret", + * "VersionStage": "STAGINGLABEL1" + * }; + * const command = new UpdateSecretVersionStageCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret" + * } + * *\/ + * // example id: to-delete-a-staging-label-attached-to-a-version-of-a-secret-1524004862181 + * ``` + * + * @example To move a staging label from one version of a secret to another + * ```javascript + * // The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version. + * const input = { + * "MoveToVersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2", + * "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + * "SecretId": "MyTestDatabaseSecret", + * "VersionStage": "AWSCURRENT" + * }; + * const command = new UpdateSecretVersionStageCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + * "Name": "MyTestDatabaseSecret" + * } + * *\/ + * // example id: to-move-a-staging-label-from-one-version-of-a-secret-to-another-1524004963841 + * ``` + * + */ +export class UpdateSecretVersionStageCommand extends $Command + .classBuilder< + UpdateSecretVersionStageCommandInput, + UpdateSecretVersionStageCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "UpdateSecretVersionStage", {}) + .n("SecretsManagerClient", "UpdateSecretVersionStageCommand") + .f(void 0, void 0) + .ser(se_UpdateSecretVersionStageCommand) + .de(de_UpdateSecretVersionStageCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateSecretVersionStageRequest; + output: UpdateSecretVersionStageResponse; + }; + sdk: { + input: UpdateSecretVersionStageCommandInput; + output: UpdateSecretVersionStageCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/ValidateResourcePolicyCommand.ts b/clients/client-secrets-manager-cbor/src/commands/ValidateResourcePolicyCommand.ts new file mode 100644 index 000000000000..88c15cd0390c --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/ValidateResourcePolicyCommand.ts @@ -0,0 +1,168 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ValidateResourcePolicyRequest, ValidateResourcePolicyResponse } from "../models/models_0"; +import { de_ValidateResourcePolicyCommand, se_ValidateResourcePolicyCommand } from "../protocols/Rpcv2cbor"; +import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ValidateResourcePolicyCommand}. + */ +export interface ValidateResourcePolicyCommandInput extends ValidateResourcePolicyRequest {} +/** + * @public + * + * The output of {@link ValidateResourcePolicyCommand}. + */ +export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePolicyResponse, __MetadataBearer {} + +/** + *Validates that a resource policy does not grant a wide range of principals access to + * your secret. A resource-based policy is optional for secrets.
+ *The API performs three checks when validating the policy:
+ *Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not + * allow broad access to your secret, for example policies that use a wildcard for the principal.
+ *Checks for correct syntax in a policy.
+ *Verifies the policy does not lock out a caller.
+ *Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
+ *
+ * Required permissions:
+ * secretsmanager:ValidateResourcePolicy and secretsmanager:PutResourcePolicy.
+ * For more information, see
+ * IAM policy actions for Secrets Manager and Authentication
+ * and access control in Secrets Manager.
An error occurred on the server side.
+ * + * @throws {@link InvalidParameterException} (client fault) + *The parameter name or value is invalid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *A parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *The resource policy has syntax errors.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Secrets Manager can't find the resource that you asked for.
+ * + * @throws {@link SecretsManagerServiceException} + *Base exception class for all service exceptions from SecretsManager service.
+ * + * @public + * @example To validate a resource-based policy to a secret + * ```javascript + * // The following example shows how to validate a resource-based policy to a secret. + * const input = { + * "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}", + * "SecretId": "MyTestDatabaseSecret" + * }; + * const command = new ValidateResourcePolicyCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "PolicyValidationPassed": true, + * "ValidationErrors": [] + * } + * *\/ + * // example id: to-validate-the-resource-policy-of-a-secret-1524000138629 + * ``` + * + */ +export class ValidateResourcePolicyCommand extends $Command + .classBuilder< + ValidateResourcePolicyCommandInput, + ValidateResourcePolicyCommandOutput, + SecretsManagerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SecretsManagerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("secretsmanager", "ValidateResourcePolicy", {}) + .n("SecretsManagerClient", "ValidateResourcePolicyCommand") + .f(void 0, void 0) + .ser(se_ValidateResourcePolicyCommand) + .de(de_ValidateResourcePolicyCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ValidateResourcePolicyRequest; + output: ValidateResourcePolicyResponse; + }; + sdk: { + input: ValidateResourcePolicyCommandInput; + output: ValidateResourcePolicyCommandOutput; + }; + }; +} diff --git a/clients/client-secrets-manager-cbor/src/commands/index.ts b/clients/client-secrets-manager-cbor/src/commands/index.ts new file mode 100644 index 000000000000..2b1413e768cc --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/commands/index.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +export * from "./BatchGetSecretValueCommand"; +export * from "./CancelRotateSecretCommand"; +export * from "./CreateSecretCommand"; +export * from "./DeleteResourcePolicyCommand"; +export * from "./DeleteSecretCommand"; +export * from "./DescribeSecretCommand"; +export * from "./GetRandomPasswordCommand"; +export * from "./GetResourcePolicyCommand"; +export * from "./GetSecretValueCommand"; +export * from "./ListSecretVersionIdsCommand"; +export * from "./ListSecretsCommand"; +export * from "./PutResourcePolicyCommand"; +export * from "./PutSecretValueCommand"; +export * from "./RemoveRegionsFromReplicationCommand"; +export * from "./ReplicateSecretToRegionsCommand"; +export * from "./RestoreSecretCommand"; +export * from "./RotateSecretCommand"; +export * from "./StopReplicationToReplicaCommand"; +export * from "./TagResourceCommand"; +export * from "./UntagResourceCommand"; +export * from "./UpdateSecretCommand"; +export * from "./UpdateSecretVersionStageCommand"; +export * from "./ValidateResourcePolicyCommand"; diff --git a/clients/client-secrets-manager-cbor/src/endpoint/EndpointParameters.ts b/clients/client-secrets-manager-cbor/src/endpoint/EndpointParameters.ts new file mode 100644 index 000000000000..5889d9bc071f --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/endpoint/EndpointParameters.ts @@ -0,0 +1,41 @@ +// smithy-typescript generated code +import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types"; + +/** + * @public + */ +export interface ClientInputEndpointParameters { + region?: string | ProviderAmazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
+ *This guide provides descriptions of the Secrets Manager API. For more information about using this + * service, see the Amazon Web Services Secrets Manager User Guide.
+ *+ * API Version + *
+ *This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
+ *For a list of endpoints, see Amazon Web Services Secrets Manager + * endpoints.
+ *+ * Support and Feedback for Amazon Web Services Secrets Manager + *
+ *We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more + * information about the Amazon Web Services Discussion Forums, see Forums + * Help.
+ *+ * Logging API Requests + *
+ *Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services + * account and delivers log files to an Amazon S3 bucket. By using information that's collected + * by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the + * request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services + * CloudTrail, see Logging + * Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. + * To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
+ * + * @packageDocumentation + */ +export * from "./SecretsManagerClient"; +export * from "./SecretsManager"; +export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters"; +export type { RuntimeExtension } from "./runtimeExtensions"; +export type { SecretsManagerExtensionConfiguration } from "./extensionConfiguration"; +export * from "./commands"; +export * from "./pagination"; +export * from "./models"; + +export { SecretsManagerServiceException } from "./models/SecretsManagerServiceException"; diff --git a/clients/client-secrets-manager-cbor/src/models/SecretsManagerServiceException.ts b/clients/client-secrets-manager-cbor/src/models/SecretsManagerServiceException.ts new file mode 100644 index 000000000000..663a921b2a0f --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/models/SecretsManagerServiceException.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { + ServiceException as __ServiceException, + ServiceExceptionOptions as __ServiceExceptionOptions, +} from "@smithy/smithy-client"; + +export type { __ServiceExceptionOptions }; + +export { __ServiceException }; + +/** + * @public + * + * Base exception class for all service exceptions from SecretsManager service. + */ +export class SecretsManagerServiceException extends __ServiceException { + /** + * @internal + */ + constructor(options: __ServiceExceptionOptions) { + super(options); + Object.setPrototypeOf(this, SecretsManagerServiceException.prototype); + } +} diff --git a/clients/client-secrets-manager-cbor/src/models/index.ts b/clients/client-secrets-manager-cbor/src/models/index.ts new file mode 100644 index 000000000000..9eaceb12865f --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/models/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./models_0"; diff --git a/clients/client-secrets-manager-cbor/src/models/models_0.ts b/clients/client-secrets-manager-cbor/src/models/models_0.ts new file mode 100644 index 000000000000..81dee493817f --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/models/models_0.ts @@ -0,0 +1,2334 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; + +import { SecretsManagerServiceException as __BaseException } from "./SecretsManagerServiceException"; + +/** + *A custom type that specifies a Region and the KmsKeyId for a replica secret.
A Region code. For a list of Region codes, see Name and code of Regions.
+ * @public + */ + Region?: string | undefined; + + /** + *The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.
The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue.
+ * @public + */ +export interface APIErrorType { + /** + *The ARN or name of the secret.
+ * @public + */ + SecretId?: string | undefined; + + /** + *The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue, for example ResourceNotFoundException,InvalidParameterException, InvalidRequestException, DecryptionFailure, or AccessDeniedException.
A message describing the error.
+ * @public + */ + Message?: string | undefined; +} + +/** + * @public + * @enum + */ +export const FilterNameStringType = { + all: "all", + description: "description", + name: "name", + owning_service: "owning-service", + primary_region: "primary-region", + tag_key: "tag-key", + tag_value: "tag-value", +} as const; + +/** + * @public + */ +export type FilterNameStringType = (typeof FilterNameStringType)[keyof typeof FilterNameStringType]; + +/** + *Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager.
+ * @public + */ +export interface Filter { + /** + *The following are keys you can use:
+ *+ * description: Prefix match, not case-sensitive.
+ *+ * name: Prefix match, case-sensitive.
+ *+ * tag-key: Prefix match, case-sensitive.
+ *+ * tag-value: Prefix match, case-sensitive.
+ *+ * primary-region: Prefix match, case-sensitive.
+ *+ * owning-service: Prefix match, case-sensitive.
+ *+ * all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
+ *The keyword to filter for.
+ *You can prefix your search value with an exclamation mark (!) in order to perform negation filters.
The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.
The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.
The number of results to include in the response.
+ *If there are more results available, in the response, Secrets Manager includes NextToken.
+ * To get the next results, call BatchGetSecretValue again with the value from
+ * NextToken. To use this parameter, you must also use the Filters parameter.
A token that indicates where the output should continue from, if a
+ * previous call did not show all results. To get the next results, call BatchGetSecretValue again
+ * with this value.
A structure that contains the secret value and other details for a secret.
+ * @public + */ +export interface SecretValueEntry { + /** + *The Amazon Resource Name (ARN) of the secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The friendly name of the secret.
+ * @public + */ + Name?: string | undefined; + + /** + *The unique version identifier of this version of the secret.
+ * @public + */ + VersionId?: string | undefined; + + /** + *The decrypted secret value, if the secret value was originally provided as + * binary data in the form of a byte array. The parameter represents the binary data as + * a base64-encoded + * string.
+ * @public + */ + SecretBinary?: Uint8Array | undefined; + + /** + *The decrypted secret value, if the secret value was originally provided as a string or + * through the Secrets Manager console.
+ * @public + */ + SecretString?: string | undefined; + + /** + *A list of all of the staging labels currently attached to this version of the + * secret.
+ * @public + */ + VersionStages?: string[] | undefined; + + /** + *The date the secret was created.
+ * @public + */ + CreatedDate?: Date | undefined; +} + +/** + * @public + */ +export interface BatchGetSecretValueResponse { + /** + *A list of secret values.
+ * @public + */ + SecretValues?: SecretValueEntry[] | undefined; + + /** + *Secrets Manager includes this value if
+ * there's more output available than what is included in the current response. This can
+ * occur even when the response includes no values at all, such as when you ask for a filtered view
+ * of a long list. To get the next results, call BatchGetSecretValue again
+ * with this value.
A list of errors Secrets Manager encountered while attempting to retrieve individual secrets.
+ * @public + */ + Errors?: APIErrorType[] | undefined; +} + +/** + *Secrets Manager can't decrypt the protected secret text using the provided KMS key.
+ * @public + */ +export class DecryptionFailure extends __BaseException { + readonly name: "DecryptionFailure" = "DecryptionFailure"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeAn error occurred on the server side.
+ * @public + */ +export class InternalServiceError extends __BaseException { + readonly name: "InternalServiceError" = "InternalServiceError"; + readonly $fault: "server" = "server"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe NextToken value is invalid.
The parameter name or value is invalid.
+ * @public + */ +export class InvalidParameterException extends __BaseException { + readonly name: "InvalidParameterException" = "InvalidParameterException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeA parameter value is not valid for the current state of the + * resource.
+ *Possible causes:
+ *The secret is scheduled for deletion.
+ *You tried to enable rotation on a secret that doesn't already have a Lambda function + * ARN configured and you didn't include such an ARN as a parameter in this call.
+ *The secret is managed by another service, and you must use that service to update it. + * For more information, see Secrets managed by other Amazon Web Services services.
+ *Secrets Manager can't find the resource that you asked for.
+ * @public + */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe ARN or name of the secret.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; +} + +/** + * @public + */ +export interface CancelRotateSecretResponse { + /** + *The ARN of the secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret.
+ * @public + */ + Name?: string | undefined; + + /** + *The unique identifier of the version of the secret created during the rotation. This
+ * version might not be complete, and should be evaluated for possible deletion. We recommend
+ * that you remove the VersionStage value AWSPENDING from this version so that
+ * Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from
+ * starting future rotations.
A structure that contains information about a tag.
+ * @public + */ +export interface Tag { + /** + *The key identifier, or name, of the tag.
+ * @public + */ + Key?: string | undefined; + + /** + *The string value associated with the key of the tag.
+ * @public + */ + Value?: string | undefined; +} + +/** + * @public + */ +export interface CreateSecretRequest { + /** + *The name of the new secret.
+ *The secret name can contain ASCII letters, numbers, and the following characters: + * /_+=.@-
+ *Do not end your secret name with a hyphen followed by six characters. If you do so, you + * risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager + * automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
+ * @public + */ + Name: string | undefined; + + /** + *If you include SecretString or SecretBinary, then
+ * Secrets Manager creates an initial version for the secret, and this parameter specifies the unique
+ * identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
+ *If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
+ *If the ClientRequestToken value isn't already associated with a version
+ * of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
+ * and SecretBinary values are the same as those in the request, then the
+ * request is ignored.
If a version with this value already exists and that version's
+ * SecretString and SecretBinary values are different from those
+ * in the request, then the request fails because you cannot modify an existing version.
+ * Instead, use PutSecretValue to create a new version.
This value becomes the VersionId of the new version.
The description of the secret.
+ * @public + */ + Description?: string | undefined; + + /** + *The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
+ * encrypt the secret value in the secret. An alias is always prefixed by alias/,
+ * for example alias/aws/secretsmanager. For more information, see About aliases.
To use a KMS key in a different account, use the key ARN or the alias ARN.
+ *If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager.
+ * If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it
+ * encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then
+ * you can't use aws/secretsmanager to encrypt the secret, and you must create
+ * and use a customer managed KMS key.
The binary data to encrypt and store in the new version of + * the secret. We recommend that you store your binary data in a file and then pass the + * contents of the file as a parameter.
+ *Either SecretString or SecretBinary must have a value, but not
+ * both.
This parameter is not available in the Secrets Manager console.
+ *Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
+ * @public + */ + SecretBinary?: Uint8Array | undefined; + + /** + *The text data to encrypt and store in this new version of + * the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
+ *Either SecretString or SecretBinary must have a value, but not
+ * both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected
+ * secret text in only the SecretString parameter. The Secrets Manager console stores the
+ * information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
+ * @public + */ + SecretString?: string | undefined; + + /** + *A list of tags to attach to the secret. Each tag + * is a key and value pair of strings in a JSON text string, for example:
+ *
+ * [\{"Key":"CostCenter","Value":"12345"\},\{"Key":"environment","Value":"production"\}]
+ *
Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag + * from one with key "abc".
+ *If you check tags in permissions policies as part of your
+ * security strategy, then adding or removing a tag can change permissions. If the
+ * completion of this operation would result in you losing your permissions for
+ * this secret, then Secrets Manager blocks the operation and returns an Access Denied
+ * error. For more information, see Control
+ * access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a + * JSON parameter for the various command line tool environments, see Using JSON for + * Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should + * use single quotes to avoid confusion with the double quotes required in the JSON text.
+ *For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General + * Reference guide.
+ * @public + */ + Tags?: Tag[] | undefined; + + /** + *A list of Regions and KMS keys to replicate secrets.
+ * @public + */ + AddReplicaRegions?: ReplicaRegionType[] | undefined; + + /** + *Specifies whether to overwrite a secret with the same name in the + * destination Region. By default, secrets aren't overwritten.
+ * @public + */ + ForceOverwriteReplicaSecret?: boolean | undefined; +} + +/** + * @public + * @enum + */ +export const StatusType = { + Failed: "Failed", + InProgress: "InProgress", + InSync: "InSync", +} as const; + +/** + * @public + */ +export type StatusType = (typeof StatusType)[keyof typeof StatusType]; + +/** + *A replication object consisting of a RegionReplicationStatus object and includes a Region, KMSKeyId, status, and status message.
The Region where replication occurs.
+ * @public + */ + Region?: string | undefined; + + /** + *Can be an ARN, Key ID, or Alias.
The status can be InProgress, Failed, or InSync.
Status message such as "Secret with this name already exists in this + * region".
+ * @public + */ + StatusMessage?: string | undefined; + + /** + *The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
+ * @public + */ + LastAccessedDate?: Date | undefined; +} + +/** + * @public + */ +export interface CreateSecretResponse { + /** + *The ARN of the new secret. The ARN includes the name of the secret followed by six random + * characters. This ensures that if you create a new secret with the same name as a deleted secret, + * then users with access to the old secret don't get access to the new secret because the ARNs + * are different.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the new secret.
+ * @public + */ + Name?: string | undefined; + + /** + *The unique identifier associated with the version of the new secret.
+ * @public + */ + VersionId?: string | undefined; + + /** + *A list of the replicas of this secret and their status:
+ *
+ * Failed, which indicates that the replica was not created.
+ * InProgress, which indicates that Secrets Manager is in the process of creating the replica.
+ * InSync, which indicates that the replica was created.
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the + * KMS key is available, enabled, and not in an invalid state. For more + * information, see Key state: Effect on your KMS key.
+ * @public + */ +export class EncryptionFailure extends __BaseException { + readonly name: "EncryptionFailure" = "EncryptionFailure"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request failed because it would exceed one of the Secrets Manager quotas.
+ * @public + */ +export class LimitExceededException extends __BaseException { + readonly name: "LimitExceededException" = "LimitExceededException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe resource policy has syntax errors.
+ * @public + */ +export class MalformedPolicyDocumentException extends __BaseException { + readonly name: "MalformedPolicyDocumentException" = "MalformedPolicyDocumentException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request failed because you did not complete all the prerequisite steps.
+ * @public + */ +export class PreconditionNotMetException extends __BaseException { + readonly name: "PreconditionNotMetException" = "PreconditionNotMetException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeA resource with the ID you requested already exists.
+ * @public + */ +export class ResourceExistsException extends __BaseException { + readonly name: "ResourceExistsException" = "ResourceExistsException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe ARN or name of the secret to delete the attached resource-based policy for.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; +} + +/** + * @public + */ +export interface DeleteResourcePolicyResponse { + /** + *The ARN of the secret that the resource-based policy was deleted for.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret that the resource-based policy was deleted for.
+ * @public + */ + Name?: string | undefined; +} + +/** + * @public + */ +export interface DeleteSecretRequest { + /** + *The ARN or name of the secret to delete.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; + + /** + *The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the
+ * secret. You can't use both this parameter and ForceDeleteWithoutRecovery
+ * in the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.
Specifies whether to delete the secret without any recovery window. You
+ * can't use both this parameter and RecoveryWindowInDays in the same
+ * call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might + * be a short delay before the secret is permanently deleted. If you delete a secret and then + * immediately create a secret with the same name, use appropriate back off and retry logic.
+ *If you forcibly delete an already deleted or nonexistent secret, the operation does not return ResourceNotFoundException.
Use this parameter with caution. This parameter causes the operation to skip the normal
+ * recovery window before the permanent deletion that Secrets Manager would normally impose with the
+ * RecoveryWindowInDays parameter. If you delete a secret with the
+ * ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover
+ * the secret. You lose the secret permanently.
The ARN of the secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret.
+ * @public + */ + Name?: string | undefined; + + /** + *The date and time after which this secret Secrets Manager can permanently delete this secret,
+ * and it can no longer be restored. This value is the date and time of the delete request
+ * plus the number of days in RecoveryWindowInDays.
The ARN or name of the secret.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; +} + +/** + *A structure that defines the rotation configuration for the secret.
+ * @public + */ +export interface RotationRulesType { + /** + *The number of days between rotations of the secret. You can use this
+ * value to check that your secret meets your compliance guidelines for how often secrets must
+ * be rotated. If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation
+ * date based on the previous rotation. Manually updating the secret value by calling
+ * PutSecretValue or UpdateSecret is considered a valid rotation.
In DescribeSecret and ListSecrets, this value is calculated from
+ * the rotation schedule after every successful rotation. In RotateSecret, you can
+ * set the rotation schedule in RotationRules with AutomaticallyAfterDays
+ * or ScheduleExpression, but not both. To set a rotation schedule in hours, use
+ * ScheduleExpression.
The length of the rotation window in hours, for example 3h for a three
+ * hour window. Secrets Manager rotates your secret at any time during this window. The window must not
+ * extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration,
+ * for a ScheduleExpression in hours, the window automatically closes after one
+ * hour. For a ScheduleExpression in days, the window automatically closes at the
+ * end of the UTC day. For
+ * more information, including examples, see Schedule expressions
+ * in Secrets Manager rotation in the Secrets Manager Users Guide.
A cron() or rate() expression that defines the schedule for
+ * rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.
Secrets Manager rate() expressions represent the interval in hours or days that you
+ * want to rotate your secret, for example rate(12 hours) or
+ * rate(10 days). You can rotate a secret as often as every four hours. If you
+ * use a rate() expression, the rotation
+ * window starts at midnight. For a rate in hours, the default rotation window closes after one
+ * hour. For a rate in days, the default rotation window closes at the end of the day. You can
+ * set the Duration to change the rotation window. The rotation window must not
+ * extend into the next UTC day or into the next rotation window.
You can use a cron() expression to create a rotation schedule that is
+ * more detailed than a rotation interval. For more information, including examples, see
+ * Schedule expressions in
+ * Secrets Manager rotation in the Secrets Manager Users Guide. For a cron expression
+ * that represents a schedule in hours, the default rotation window closes after one hour. For
+ * a cron expression that represents a schedule in days, the default rotation window closes at
+ * the end of the day. You can set the Duration to change the rotation window. The
+ * rotation window must not extend into the next UTC day or into the next rotation window.
The ARN of the secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret.
+ * @public + */ + Name?: string | undefined; + + /** + *The description of the secret.
+ * @public + */ + Description?: string | undefined; + + /** + *The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
+ * If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager,
+ * this field is omitted. Secrets created using the console use an KMS key ID.
Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.
+ *To turn on rotation, use RotateSecret. To turn off + * rotation, use CancelRotateSecret.
+ * @public + */ + RotationEnabled?: boolean | undefined; + + /** + *The ARN of the Lambda function that Secrets Manager invokes to rotate the + * secret.
+ * @public + */ + RotationLambdaARN?: string | undefined; + + /** + *The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but + * it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had + * rotation turned on, this field is omitted.
+ * @public + */ + RotationRules?: RotationRulesType | undefined; + + /** + *The last date and time that Secrets Manager rotated the secret. + * If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
+ * @public + */ + LastRotatedDate?: Date | undefined; + + /** + *The last date and time that this secret was modified in any way.
+ * @public + */ + LastChangedDate?: Date | undefined; + + /** + *The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
+ * @public + */ + LastAccessedDate?: Date | undefined; + + /** + *The date the secret is scheduled for deletion. If it is not scheduled for deletion, this + * field is omitted. When you delete a secret, Secrets Manager requires a + * recovery window of at least 7 days before deleting the secret. Some time after the deleted date, + * Secrets Manager deletes the secret, including all of its versions.
+ *If a secret is scheduled for deletion, then its details, including the encrypted secret + * value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
+ * @public + */ + DeletedDate?: Date | undefined; + + /** + *The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.
+ *This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.
+ * @public + */ + NextRotationDate?: Date | undefined; + + /** + *The list of tags attached to the secret. To add tags to a + * secret, use TagResource. To remove tags, use UntagResource.
+ * @public + */ + Tags?: Tag[] | undefined; + + /** + *A list of the versions of the secret that have staging labels attached. + * Versions that don't have staging labels are considered deprecated and Secrets Manager + * can delete them.
+ *Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three + * staging labels for rotation are:
+ *
+ * AWSCURRENT, which indicates the current version of the secret.
+ * AWSPENDING, which indicates the version of the secret that contains new
+ * secret information that will become the next current version when rotation finishes.
During
+ * rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version.
+ * To check if a secret version exists, call GetSecretValue.
+ * AWSPREVIOUS, which indicates the previous current version of the secret.
+ * You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
+ * @public + */ + VersionIdsToStages?: RecordThe ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.
+ * @public + */ + OwningService?: string | undefined; + + /** + *The date the secret was created.
+ * @public + */ + CreatedDate?: Date | undefined; + + /** + *The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
A list of the replicas of this secret and their status:
+ *
+ * Failed, which indicates that the replica was not created.
+ * InProgress, which indicates that Secrets Manager is in the process of creating the replica.
+ * InSync, which indicates that the replica was created.
The length of the password. If you don't include this parameter, the + * default length is 32 characters.
+ * @public + */ + PasswordLength?: number | undefined; + + /** + *A string of the characters that you don't want in the password.
+ * @public + */ + ExcludeCharacters?: string | undefined; + + /** + *Specifies whether to exclude numbers from the password. If you don't + * include this switch, the password can contain numbers.
+ * @public + */ + ExcludeNumbers?: boolean | undefined; + + /** + *Specifies whether to exclude the following punctuation characters from the password:
+ * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` \{ | \} ~.
+ * If you don't include this switch, the password can contain punctuation.
Specifies whether to exclude uppercase letters from the password. If you + * don't include this switch, the password can contain uppercase letters.
+ * @public + */ + ExcludeUppercase?: boolean | undefined; + + /** + *Specifies whether to exclude lowercase letters from the password. If + * you don't include this switch, the password can contain lowercase letters.
+ * @public + */ + ExcludeLowercase?: boolean | undefined; + + /** + *Specifies whether to include the space character. If you + * include this switch, the password can contain space characters.
+ * @public + */ + IncludeSpace?: boolean | undefined; + + /** + *Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. + * If you don't include this switch, the password contains at least one of every character type.
+ * @public + */ + RequireEachIncludedType?: boolean | undefined; +} + +/** + * @public + */ +export interface GetRandomPasswordResponse { + /** + *A string with the password.
+ * @public + */ + RandomPassword?: string | undefined; +} + +/** + * @public + */ +export interface GetResourcePolicyRequest { + /** + *The ARN or name of the secret to retrieve the attached resource-based policy for.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; +} + +/** + * @public + */ +export interface GetResourcePolicyResponse { + /** + *The ARN of the secret that the resource-based policy was retrieved for.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret that the resource-based policy was retrieved for.
+ * @public + */ + Name?: string | undefined; + + /** + *A JSON-formatted string that contains the permissions policy + * attached to the secret. For more information about permissions policies, see Authentication and access control for + * Secrets Manager.
+ * @public + */ + ResourcePolicy?: string | undefined; +} + +/** + * @public + */ +export interface GetSecretValueRequest { + /** + *The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; + + /** + *The unique identifier of the version of the secret to retrieve. If
+ * you include both this parameter and VersionStage, the two parameters must refer
+ * to the same secret version. If you don't specify either a VersionStage or
+ * VersionId, then Secrets Manager returns the AWSCURRENT version.
This value is typically a UUID-type value with + * 32 hexadecimal digits.
+ * @public + */ + VersionId?: string | undefined; + + /** + *The staging label of the version of the secret to retrieve.
+ *Secrets Manager uses staging labels to keep track of different versions during the rotation process.
+ * If you include both this parameter and VersionId, the two parameters must refer
+ * to the same secret version. If you don't specify either a VersionStage or
+ * VersionId, Secrets Manager returns the AWSCURRENT version.
The ARN of the secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The friendly name of the secret.
+ * @public + */ + Name?: string | undefined; + + /** + *The unique identifier of this version of the secret.
+ * @public + */ + VersionId?: string | undefined; + + /** + *The decrypted secret value, if the secret value was originally provided as
+ * binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.
If the secret was created by using the Secrets Manager console, or if the secret value was
+ * originally provided as a string, then this field is omitted. The secret value appears in
+ * SecretString instead.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
+ * @public + */ + SecretBinary?: Uint8Array | undefined; + + /** + *The decrypted secret value, if the secret value was originally provided as a string or + * through the Secrets Manager console.
+ *If this secret was created by using the console, then Secrets Manager stores the information as a + * JSON structure of key/value pairs.
+ *Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
+ * @public + */ + SecretString?: string | undefined; + + /** + *A list of all of the staging labels currently attached to this version of the + * secret.
+ * @public + */ + VersionStages?: string[] | undefined; + + /** + *The date and time that this version of the secret was created. If you don't specify
+ * which version in VersionId or VersionStage, then Secrets Manager uses the
+ * AWSCURRENT version.
Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.
+ * @public + */ + IncludePlannedDeletion?: boolean | undefined; + + /** + *The number of results to include in the response.
+ *If there are more results available, in the response, Secrets Manager includes NextToken.
+ * To get the next results, call ListSecrets again with the value from
+ * NextToken.
A token that indicates where the output should continue from, if a
+ * previous call did not show all results. To get the next results, call ListSecrets again
+ * with this value.
The filters to apply to the list of secrets.
+ * @public + */ + Filters?: Filter[] | undefined; + + /** + *Secrets are listed by CreatedDate.
A structure that contains the details about a secret. It does not include the encrypted
+ * SecretString and SecretBinary values. To get those values, use
+ * GetSecretValue
+ * .
The Amazon Resource Name (ARN) of the secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The friendly name of the secret.
+ * @public + */ + Name?: string | undefined; + + /** + *The user-provided description of the secret.
+ * @public + */ + Description?: string | undefined; + + /** + *The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with
+ * the Amazon Web Services managed key aws/secretsmanager, this field is omitted.
Indicates whether automatic, scheduled rotation is enabled for this secret.
+ * @public + */ + RotationEnabled?: boolean | undefined; + + /** + *The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the
+ * secret either automatically per the schedule or manually by a call to
+ * RotateSecret
+ * .
A structure that defines the rotation configuration for the secret.
+ * @public + */ + RotationRules?: RotationRulesType | undefined; + + /** + *The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.
+ * @public + */ + LastRotatedDate?: Date | undefined; + + /** + *The last date and time that this secret was modified in any way.
+ * @public + */ + LastChangedDate?: Date | undefined; + + /** + *The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
+ * @public + */ + LastAccessedDate?: Date | undefined; + + /** + *The date and time the deletion of the secret occurred. Not present on active secrets. The
+ * secret can be recovered until the number of days in the recovery window has passed, as
+ * specified in the RecoveryWindowInDays parameter of the
+ * DeleteSecret
+ * operation.
The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
+ * @public + */ + NextRotationDate?: Date | undefined; + + /** + *The list of user-defined tags associated with the secret. To add tags to a
+ * secret, use
+ * TagResource
+ * .
+ * To remove tags, use
+ * UntagResource
+ * .
A list of all of the currently assigned SecretVersionStage staging labels and
+ * the SecretVersionId attached to each one. Staging labels are used to keep
+ * track of the different versions during the rotation process.
A version that does not have any SecretVersionStage is considered
+ * deprecated and subject to deletion. Such versions are not included in this list.
Returns the name of the service that created the secret.
+ * @public + */ + OwningService?: string | undefined; + + /** + *The date and time when a secret was created.
+ * @public + */ + CreatedDate?: Date | undefined; + + /** + *The Region where Secrets Manager originated the secret.
+ * @public + */ + PrimaryRegion?: string | undefined; +} + +/** + * @public + */ +export interface ListSecretsResponse { + /** + *A list of the secrets in the account.
+ * @public + */ + SecretList?: SecretListEntry[] | undefined; + + /** + *Secrets Manager includes this value if
+ * there's more output available than what is included in the current response. This can
+ * occur even when the response includes no values at all, such as when you ask for a filtered view
+ * of a long list. To get the next results, call ListSecrets again
+ * with this value.
The ARN or name of the secret whose versions you want to list.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; + + /** + *The number of results to include in the response.
+ *If there are more results available, in the response, Secrets Manager includes NextToken.
+ * To get the next results, call ListSecretVersionIds again with the value from NextToken.
A token that indicates where the output should continue from, if a previous call
+ * did not show all results. To get the next results, call ListSecretVersionIds again with
+ * this value.
Specifies whether to include versions of secrets that don't have any + * staging labels attached to them. Versions without staging labels are considered deprecated and are subject to + * deletion by Secrets Manager. By default, versions without staging labels aren't included.
+ * @public + */ + IncludeDeprecated?: boolean | undefined; +} + +/** + *A structure that contains information about one version of a secret.
+ * @public + */ +export interface SecretVersionsListEntry { + /** + *The unique version identifier of this version of the secret.
+ * @public + */ + VersionId?: string | undefined; + + /** + *An array of staging labels that are currently associated with this version of the + * secret.
+ * @public + */ + VersionStages?: string[] | undefined; + + /** + *The date that this version of the secret was last accessed. Note that the resolution of + * this field is at the date level and does not include the time.
+ * @public + */ + LastAccessedDate?: Date | undefined; + + /** + *The date and time this version of the secret was created.
+ * @public + */ + CreatedDate?: Date | undefined; + + /** + *The KMS keys used to encrypt the secret version.
+ * @public + */ + KmsKeyIds?: string[] | undefined; +} + +/** + * @public + */ +export interface ListSecretVersionIdsResponse { + /** + *A list of the versions of the secret.
+ * @public + */ + Versions?: SecretVersionsListEntry[] | undefined; + + /** + *Secrets Manager includes this value if there's more output available than what is included
+ * in the current response. This can occur even when the response includes no values at all,
+ * such as when you ask for a filtered view of a long list. To get the next results,
+ * call ListSecretVersionIds again with this value.
The ARN of the secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret.
+ * @public + */ + Name?: string | undefined; +} + +/** + *The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.
The ARN or name of the secret to attach the resource-based policy.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; + + /** + *A JSON-formatted string for an Amazon Web Services + * resource-based policy. For example policies, see Permissions + * policy examples.
+ * @public + */ + ResourcePolicy: string | undefined; + + /** + *Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren't blocked.
+ *Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:
+ *Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)
+ *Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)
+ *To review permissions to your secrets, see Determine who has permissions to your secrets.
+ *The ARN of the secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret.
+ * @public + */ + Name?: string | undefined; +} + +/** + * @public + */ +export interface PutSecretValueRequest { + /** + *The ARN or name of the secret to add a new version to.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ *If the secret doesn't already exist, use CreateSecret instead.
A unique identifier for the new version of the secret.
+ *If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
+ *If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
+ *If the ClientRequestToken value isn't already associated with a version
+ * of the secret then a new version of the secret is created.
If a version with this value already exists and that version's
+ * SecretString or SecretBinary values are the same as those in
+ * the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the
+ * SecretString and SecretBinary values are different from those
+ * in the request, then the request fails because you can't modify a secret
+ * version. You can only create new versions to store new secret values.
This value becomes the VersionId of the new version.
The binary data to encrypt and store in the new version of + * the secret. To use this parameter in the command-line tools, we recommend that you store your + * binary data in a file and then pass the + * contents of the file as a parameter.
+ *You must include SecretBinary or SecretString, but not both.
You can't access this value from the Secrets Manager console.
+ *Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
+ * @public + */ + SecretBinary?: Uint8Array | undefined; + + /** + *The text to encrypt and store in the new version of the secret.
+ *You must include SecretBinary or SecretString, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
+ *Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
+ * @public + */ + SecretString?: string | undefined; + + /** + *A list of staging labels to attach to this version of the + * secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
+ *If you specify a staging
+ * label that's already associated with a different version of the same secret, then Secrets Manager
+ * removes the label from the other version and attaches it to this version.
+ * If you specify
+ * AWSCURRENT, and it is already attached to another version, then Secrets Manager also
+ * moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If you don't include VersionStages, then Secrets Manager automatically
+ * moves the staging label AWSCURRENT to this version.
A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see How rotation works.
+ *Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
+ * @public + */ + RotationToken?: string | undefined; +} + +/** + * @public + */ +export interface PutSecretValueResponse { + /** + *The ARN of the secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret.
+ * @public + */ + Name?: string | undefined; + + /** + *The unique identifier of the version of the secret.
+ * @public + */ + VersionId?: string | undefined; + + /** + *The list of staging labels that are currently attached to this version of the secret. + * Secrets Manager uses staging labels to track a version as it progresses through the secret rotation + * process.
+ * @public + */ + VersionStages?: string[] | undefined; +} + +/** + * @public + */ +export interface RemoveRegionsFromReplicationRequest { + /** + *The ARN or name of the secret.
+ * @public + */ + SecretId: string | undefined; + + /** + *The Regions of the replicas to remove.
+ * @public + */ + RemoveReplicaRegions: string[] | undefined; +} + +/** + * @public + */ +export interface RemoveRegionsFromReplicationResponse { + /** + *The ARN of the primary secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The status of replicas for this secret after you remove Regions.
+ * @public + */ + ReplicationStatus?: ReplicationStatusType[] | undefined; +} + +/** + * @public + */ +export interface ReplicateSecretToRegionsRequest { + /** + *The ARN or name of the secret to replicate.
+ * @public + */ + SecretId: string | undefined; + + /** + *A list of Regions in which to replicate the secret.
+ * @public + */ + AddReplicaRegions: ReplicaRegionType[] | undefined; + + /** + *Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.
+ * @public + */ + ForceOverwriteReplicaSecret?: boolean | undefined; +} + +/** + * @public + */ +export interface ReplicateSecretToRegionsResponse { + /** + *The ARN of the primary secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The status of replication.
+ * @public + */ + ReplicationStatus?: ReplicationStatusType[] | undefined; +} + +/** + * @public + */ +export interface RestoreSecretRequest { + /** + *The ARN or name of the secret to restore.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; +} + +/** + * @public + */ +export interface RestoreSecretResponse { + /** + *The ARN of the secret that was restored.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret that was restored.
+ * @public + */ + Name?: string | undefined; +} + +/** + * @public + */ +export interface RotateSecretRequest { + /** + *The ARN or name of the secret to rotate.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; + + /** + *A unique identifier for the new version of the secret. You only need to specify this value if you implement your own retry logic and you want to + * ensure that Secrets Manager doesn't attempt to create a secret version twice.
+ *If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
+ *If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
+ * @public + */ + ClientRequestToken?: string | undefined; + + /** + *For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function.
+ *For secrets that use managed rotation, omit this field. For more information, see Managed rotation in the Secrets Manager User Guide.
+ * @public + */ + RotationLambdaARN?: string | undefined; + + /** + *A structure that defines the rotation configuration for this secret.
+ * @public + */ + RotationRules?: RotationRulesType | undefined; + + /** + *Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. + * The rotation schedule is defined in RotateSecretRequest$RotationRules.
+ *For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the
+ *
+ * testSecret
+ * step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.
By default, Secrets Manager rotates the secret immediately.
+ * @public + */ + RotateImmediately?: boolean | undefined; +} + +/** + * @public + */ +export interface RotateSecretResponse { + /** + *The ARN of the secret.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret.
+ * @public + */ + Name?: string | undefined; + + /** + *The ID of the new version of the secret.
+ * @public + */ + VersionId?: string | undefined; +} + +/** + * @public + */ +export interface StopReplicationToReplicaRequest { + /** + *The ARN of the primary secret.
+ * @public + */ + SecretId: string | undefined; +} + +/** + * @public + */ +export interface StopReplicationToReplicaResponse { + /** + *The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
+ * @public + */ + ARN?: string | undefined; +} + +/** + * @public + */ +export interface TagResourceRequest { + /** + *The identifier for the secret to attach tags to. You can specify either the + * Amazon Resource Name (ARN) or the friendly name of the secret.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; + + /** + *The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
+ * and a Value.
For storing multiple values, we recommend that you use a JSON text + * string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI + * in the Amazon Web Services CLI User Guide.
+ * @public + */ + Tags: Tag[] | undefined; +} + +/** + * @public + */ +export interface UntagResourceRequest { + /** + *The ARN or name of the secret.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; + + /** + *A list of tag key names to remove from the secret. You don't specify the value. Both the + * key and its associated value are removed.
+ *This parameter requires a JSON text string argument.
+ *For storing multiple values, we recommend that you use a JSON text + * string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI + * in the Amazon Web Services CLI User Guide.
+ * @public + */ + TagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface UpdateSecretRequest { + /** + *The ARN or name of the secret.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; + + /** + *If you include SecretString or SecretBinary, then Secrets Manager creates
+ * a new version for the secret, and this parameter specifies the unique identifier for the new
+ * version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
+ *If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
+ * @public + */ + ClientRequestToken?: string | undefined; + + /** + *The description of the secret.
+ * @public + */ + Description?: string | undefined; + + /** + *The ARN, key ID, or alias of the KMS key that Secrets Manager
+ * uses to encrypt new secret versions as well as any existing versions with the staging labels
+ * AWSCURRENT, AWSPENDING, or AWSPREVIOUS. If you don't have kms:Encrypt permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more information about versions and staging labels, see Concepts: Version.
A key alias is always prefixed by alias/, for example alias/aws/secretsmanager.
+ * For more information, see About aliases.
If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key
+ * aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager
+ * creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access
+ * to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time
+ * significant delay in returning the result.
You can only use the Amazon Web Services managed key aws/secretsmanager if you call this
+ * operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in
+ * a different account, then you must use a customer managed key and provide the ARN of that KMS key in
+ * this field. The user making the call must have permissions to both the secret and the KMS key in
+ * their respective accounts.
The binary data to encrypt and store in the new + * version of the secret. We recommend that you + * store your binary data in a file and then pass + * the contents of the file as a parameter.
+ *Either SecretBinary or
+ * SecretString must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
+ *Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
+ * @public + */ + SecretBinary?: Uint8Array | undefined; + + /** + *The text data to encrypt and store in the new + * version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
+ *Either SecretBinary or SecretString must have
+ * a value, but not both.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
+ * @public + */ + SecretString?: string | undefined; +} + +/** + * @public + */ +export interface UpdateSecretResponse { + /** + *The ARN of the secret that was updated.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret that was updated.
+ * @public + */ + Name?: string | undefined; + + /** + *If Secrets Manager created a new version of the secret during this operation, then VersionId
+ * contains the unique identifier of the new version.
The ARN or the name of the secret with the version and staging labelsto modify.
+ *For an ARN, we recommend that you specify a complete ARN rather + * than a partial ARN. See Finding a secret from a partial ARN.
+ * @public + */ + SecretId: string | undefined; + + /** + *The staging label to add to this version.
+ * @public + */ + VersionStage: string | undefined; + + /** + *The ID of the version that the staging label is to be removed + * from. If the staging label you are trying to attach to one version is already attached to a + * different version, then you must include this parameter and specify the version that the label + * is to be removed from. If the label is attached and you either do not specify this parameter, + * or the version ID does not match, then the operation fails.
+ * @public + */ + RemoveFromVersionId?: string | undefined; + + /** + *The ID of the version to add the staging label to. To + * remove a label from a version, then do not specify this parameter.
+ *If the staging label is already attached to a different version of the secret, then you
+ * must also specify the RemoveFromVersionId parameter.
The ARN of the secret that was updated.
+ * @public + */ + ARN?: string | undefined; + + /** + *The name of the secret that was updated.
+ * @public + */ + Name?: string | undefined; +} + +/** + * @public + */ +export interface ValidateResourcePolicyRequest { + /** + *The ARN or name of the secret with the resource-based policy you want to validate.
+ * @public + */ + SecretId?: string | undefined; + + /** + *A JSON-formatted string that contains an Amazon Web Services + * resource-based policy. The policy in the string identifies who can access or manage this + * secret and its versions. For example policies, see Permissions policy examples.
+ * @public + */ + ResourcePolicy: string | undefined; +} + +/** + *Displays errors that occurred during validation of the resource policy.
+ * @public + */ +export interface ValidationErrorsEntry { + /** + *Checks the name of the policy.
+ * @public + */ + CheckName?: string | undefined; + + /** + *Displays error messages if validation encounters problems during validation of the resource policy.
+ * @public + */ + ErrorMessage?: string | undefined; +} + +/** + * @public + */ +export interface ValidateResourcePolicyResponse { + /** + *True if your policy passes validation, otherwise false.
+ * @public + */ + PolicyValidationPassed?: boolean | undefined; + + /** + *Validation errors if your policy didn't pass validation.
+ * @public + */ + ValidationErrors?: ValidationErrorsEntry[] | undefined; +} + +/** + * @internal + */ +export const SecretValueEntryFilterSensitiveLog = (obj: SecretValueEntry): any => ({ + ...obj, + ...(obj.SecretBinary && { SecretBinary: SENSITIVE_STRING }), + ...(obj.SecretString && { SecretString: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const BatchGetSecretValueResponseFilterSensitiveLog = (obj: BatchGetSecretValueResponse): any => ({ + ...obj, + ...(obj.SecretValues && { SecretValues: obj.SecretValues.map((item) => SecretValueEntryFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const CreateSecretRequestFilterSensitiveLog = (obj: CreateSecretRequest): any => ({ + ...obj, + ...(obj.SecretBinary && { SecretBinary: SENSITIVE_STRING }), + ...(obj.SecretString && { SecretString: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetRandomPasswordResponseFilterSensitiveLog = (obj: GetRandomPasswordResponse): any => ({ + ...obj, + ...(obj.RandomPassword && { RandomPassword: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetSecretValueResponseFilterSensitiveLog = (obj: GetSecretValueResponse): any => ({ + ...obj, + ...(obj.SecretBinary && { SecretBinary: SENSITIVE_STRING }), + ...(obj.SecretString && { SecretString: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const PutSecretValueRequestFilterSensitiveLog = (obj: PutSecretValueRequest): any => ({ + ...obj, + ...(obj.SecretBinary && { SecretBinary: SENSITIVE_STRING }), + ...(obj.SecretString && { SecretString: SENSITIVE_STRING }), + ...(obj.RotationToken && { RotationToken: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const UpdateSecretRequestFilterSensitiveLog = (obj: UpdateSecretRequest): any => ({ + ...obj, + ...(obj.SecretBinary && { SecretBinary: SENSITIVE_STRING }), + ...(obj.SecretString && { SecretString: SENSITIVE_STRING }), +}); diff --git a/clients/client-secrets-manager-cbor/src/pagination/BatchGetSecretValuePaginator.ts b/clients/client-secrets-manager-cbor/src/pagination/BatchGetSecretValuePaginator.ts new file mode 100644 index 000000000000..0c9cd82bcbd1 --- /dev/null +++ b/clients/client-secrets-manager-cbor/src/pagination/BatchGetSecretValuePaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + BatchGetSecretValueCommand, + BatchGetSecretValueCommandInput, + BatchGetSecretValueCommandOutput, +} from "../commands/BatchGetSecretValueCommand"; +import { SecretsManagerClient } from "../SecretsManagerClient"; +import { SecretsManagerPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateBatchGetSecretValue: ( + config: SecretsManagerPaginationConfiguration, + input: BatchGetSecretValueCommandInput, + ...rest: any[] +) => Paginator