aws/secretsmanager. If you specify an empty
+ * string for the KMS key ID, the access preview uses the Amazon Web Services managed key of the Amazon Web Services
+ * account. For more information about secret policy limits, see Quotas for
* Secrets Manager..
*/
export interface SecretsManagerSecretConfiguration {
/**
- * The proposed ARN, key ID, or alias of the KMS customer master key (CMK).
+ *The proposed ARN, key ID, or alias of the KMS key.
*/ kmsKeyId?: string; @@ -3273,6 +3273,13 @@ export enum PolicyType { SERVICE_CONTROL_POLICY = "SERVICE_CONTROL_POLICY", } +export enum ValidatePolicyResourceType { + S3_ACCESS_POINT = "AWS::S3::AccessPoint", + S3_BUCKET = "AWS::S3::Bucket", + S3_MULTI_REGION_ACCESS_POINT = "AWS::S3::MultiRegionAccessPoint", + S3_OBJECT_LAMBDA_ACCESS_POINT = "AWS::S3ObjectLambda::AccessPoint", +} + export interface ValidatePolicyRequest { /** *The locale to use for localizing the findings.
@@ -3305,6 +3312,18 @@ export interface ValidatePolicyRequest { * or Amazon S3 bucket policy. */ policyType: PolicyType | string | undefined; + + /** + *The type of resource to attach to your resource policy. Specify a value for the policy
+ * validation resource type only if the policy type is RESOURCE_POLICY. For
+ * example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose
+ * AWS::S3::Bucket for the policy validation resource type.
For resource types not supported as valid values, IAM Access Analyzer runs policy checks that + * apply to all resource policies. For example, to validate a resource policy to attach to a + * KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer + * will run policy checks that apply to all resource policies.
+ */ + validatePolicyResourceType?: ValidatePolicyResourceType | string; } export namespace ValidatePolicyRequest { diff --git a/clients/client-accessanalyzer/src/protocols/Aws_restJson1.ts b/clients/client-accessanalyzer/src/protocols/Aws_restJson1.ts index 95ef184b40fc..5b05abeb388d 100644 --- a/clients/client-accessanalyzer/src/protocols/Aws_restJson1.ts +++ b/clients/client-accessanalyzer/src/protocols/Aws_restJson1.ts @@ -1002,6 +1002,8 @@ export const serializeAws_restJson1ValidatePolicyCommand = async ( ...(input.policyDocument !== undefined && input.policyDocument !== null && { policyDocument: input.policyDocument }), ...(input.policyType !== undefined && input.policyType !== null && { policyType: input.policyType }), + ...(input.validatePolicyResourceType !== undefined && + input.validatePolicyResourceType !== null && { validatePolicyResourceType: input.validatePolicyResourceType }), }); return new __HttpRequest({ protocol, diff --git a/clients/client-backup-gateway/.gitignore b/clients/client-backup-gateway/.gitignore new file mode 100644 index 000000000000..54f14c9aef25 --- /dev/null +++ b/clients/client-backup-gateway/.gitignore @@ -0,0 +1,9 @@ +/node_modules/ +/build/ +/coverage/ +/docs/ +/dist-* +*.tsbuildinfo +*.tgz +*.log +package-lock.json diff --git a/clients/client-backup-gateway/LICENSE b/clients/client-backup-gateway/LICENSE new file mode 100644 index 000000000000..f9e0c8672bca --- /dev/null +++ b/clients/client-backup-gateway/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/clients/client-backup-gateway/README.md b/clients/client-backup-gateway/README.md new file mode 100644 index 000000000000..c7d0267e482f --- /dev/null +++ b/clients/client-backup-gateway/README.md @@ -0,0 +1,212 @@ +# @aws-sdk/client-backup-gateway + +[](https://www.npmjs.com/package/@aws-sdk/client-backup-gateway) +[](https://www.npmjs.com/package/@aws-sdk/client-backup-gateway) + +## Description + +AWS SDK for JavaScript BackupGateway Client for Node.js, Browser and React Native. + +Backup gateway connects Backup to your hypervisor, so you can +create, store, and restore backups of your virtual machines (VMs) anywhere, whether +on-premises or in the VMware Cloud (VMC) on Amazon Web Services.
+Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.
+Use Backup to assign virtual or on-premises resources to a backup plan, or run +on-demand backups. Once you have backed up your resources, you can view them and restore them +like any resource supported by Backup.
+To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-backup-gateway +using your favorite package manager: + +- `npm install @aws-sdk/client-backup-gateway` +- `yarn add @aws-sdk/client-backup-gateway` +- `pnpm add @aws-sdk/client-backup-gateway` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `BackupGatewayClient` and +the commands you need, for example `AssociateGatewayToServerCommand`: + +```js +// ES5 example +const { BackupGatewayClient, AssociateGatewayToServerCommand } = require("@aws-sdk/client-backup-gateway"); +``` + +```ts +// ES6+ example +import { BackupGatewayClient, AssociateGatewayToServerCommand } from "@aws-sdk/client-backup-gateway"; +``` + +### 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 BackupGatewayClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new AssociateGatewayToServerCommand(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) => { + // proccess 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-backup-gateway"; +const client = new AWS.BackupGateway({ region: "REGION" }); + +// async/await. +try { + const data = await client.associateGatewayToServer(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .associateGatewayToServer(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.associateGatewayToServer(params, (err, data) => { + // proccess 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-backup-gateway` 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. diff --git a/clients/client-backup-gateway/jest.config.js b/clients/client-backup-gateway/jest.config.js new file mode 100644 index 000000000000..02eed352c6a8 --- /dev/null +++ b/clients/client-backup-gateway/jest.config.js @@ -0,0 +1,4 @@ +module.exports = { + preset: "ts-jest", + testMatch: ["**/*.spec.ts", "!**/*.browser.spec.ts", "!**/*.integ.spec.ts"], +}; diff --git a/clients/client-backup-gateway/package.json b/clients/client-backup-gateway/package.json new file mode 100644 index 000000000000..724c72a8f746 --- /dev/null +++ b/clients/client-backup-gateway/package.json @@ -0,0 +1,94 @@ +{ + "name": "@aws-sdk/client-backup-gateway", + "description": "AWS SDK for JavaScript Backup Gateway Client for Node.js, Browser and React Native", + "version": "3.0.0", + "scripts": { + "build": "yarn build:cjs && yarn build:es && yarn build:types", + "build:cjs": "tsc -p tsconfig.json", + "build:docs": "yarn clean:docs && typedoc ./", + "build:es": "tsc -p tsconfig.es.json", + "build:types": "tsc -p tsconfig.types.json", + "clean": "yarn clean:dist && yarn clean:docs", + "clean:dist": "rimraf ./dist-*", + "clean:docs": "rimraf ./docs", + "downlevel-dts": "downlevel-dts dist-types dist-types/ts3.4", + "test": "jest --coverage --passWithNoTests" + }, + "main": "./dist-cjs/index.js", + "types": "./dist-types/index.d.ts", + "module": "./dist-es/index.js", + "sideEffects": false, + "dependencies": { + "@aws-crypto/sha256-browser": "2.0.0", + "@aws-crypto/sha256-js": "2.0.0", + "@aws-sdk/client-sts": "3.43.0", + "@aws-sdk/config-resolver": "3.40.0", + "@aws-sdk/credential-provider-node": "3.41.0", + "@aws-sdk/fetch-http-handler": "3.40.0", + "@aws-sdk/hash-node": "3.40.0", + "@aws-sdk/invalid-dependency": "3.40.0", + "@aws-sdk/middleware-content-length": "3.40.0", + "@aws-sdk/middleware-host-header": "3.40.0", + "@aws-sdk/middleware-logger": "3.40.0", + "@aws-sdk/middleware-retry": "3.40.0", + "@aws-sdk/middleware-serde": "3.40.0", + "@aws-sdk/middleware-signing": "3.40.0", + "@aws-sdk/middleware-stack": "3.40.0", + "@aws-sdk/middleware-user-agent": "3.40.0", + "@aws-sdk/node-config-provider": "3.40.0", + "@aws-sdk/node-http-handler": "3.40.0", + "@aws-sdk/protocol-http": "3.40.0", + "@aws-sdk/smithy-client": "3.41.0", + "@aws-sdk/types": "3.40.0", + "@aws-sdk/url-parser": "3.40.0", + "@aws-sdk/util-base64-browser": "3.37.0", + "@aws-sdk/util-base64-node": "3.37.0", + "@aws-sdk/util-body-length-browser": "3.37.0", + "@aws-sdk/util-body-length-node": "3.37.0", + "@aws-sdk/util-user-agent-browser": "3.40.0", + "@aws-sdk/util-user-agent-node": "3.40.0", + "@aws-sdk/util-utf8-browser": "3.37.0", + "@aws-sdk/util-utf8-node": "3.37.0", + "tslib": "^2.3.0" + }, + "devDependencies": { + "@aws-sdk/service-client-documentation-generator": "3.38.0", + "@types/node": "^12.7.5", + "downlevel-dts": "0.7.0", + "jest": "^26.1.0", + "rimraf": "^3.0.0", + "ts-jest": "^26.4.1", + "typedoc": "^0.19.2", + "typescript": "~4.3.5" + }, + "engines": { + "node": ">=10.0.0" + }, + "typesVersions": { + "<4.0": { + "dist-types/*": [ + "dist-types/ts3.4/*" + ] + } + }, + "files": [ + "dist-*" + ], + "author": { + "name": "AWS SDK for JavaScript Team", + "url": "https://aws.amazon.com/javascript/" + }, + "license": "Apache-2.0", + "browser": { + "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.browser" + }, + "react-native": { + "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native" + }, + "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-backup-gateway", + "repository": { + "type": "git", + "url": "https://github.com/aws/aws-sdk-js-v3.git", + "directory": "clients/client-backup-gateway" + } +} diff --git a/clients/client-backup-gateway/src/BackupGateway.ts b/clients/client-backup-gateway/src/BackupGateway.ts new file mode 100644 index 000000000000..4a5451528e44 --- /dev/null +++ b/clients/client-backup-gateway/src/BackupGateway.ts @@ -0,0 +1,603 @@ +import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; + +import { BackupGatewayClient } from "./BackupGatewayClient"; +import { + AssociateGatewayToServerCommand, + AssociateGatewayToServerCommandInput, + AssociateGatewayToServerCommandOutput, +} from "./commands/AssociateGatewayToServerCommand"; +import { + CreateGatewayCommand, + CreateGatewayCommandInput, + CreateGatewayCommandOutput, +} from "./commands/CreateGatewayCommand"; +import { + DeleteGatewayCommand, + DeleteGatewayCommandInput, + DeleteGatewayCommandOutput, +} from "./commands/DeleteGatewayCommand"; +import { + DeleteHypervisorCommand, + DeleteHypervisorCommandInput, + DeleteHypervisorCommandOutput, +} from "./commands/DeleteHypervisorCommand"; +import { + DisassociateGatewayFromServerCommand, + DisassociateGatewayFromServerCommandInput, + DisassociateGatewayFromServerCommandOutput, +} from "./commands/DisassociateGatewayFromServerCommand"; +import { + ImportHypervisorConfigurationCommand, + ImportHypervisorConfigurationCommandInput, + ImportHypervisorConfigurationCommandOutput, +} from "./commands/ImportHypervisorConfigurationCommand"; +import { + ListGatewaysCommand, + ListGatewaysCommandInput, + ListGatewaysCommandOutput, +} from "./commands/ListGatewaysCommand"; +import { + ListHypervisorsCommand, + ListHypervisorsCommandInput, + ListHypervisorsCommandOutput, +} from "./commands/ListHypervisorsCommand"; +import { + ListTagsForResourceCommand, + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "./commands/ListTagsForResourceCommand"; +import { + ListVirtualMachinesCommand, + ListVirtualMachinesCommandInput, + ListVirtualMachinesCommandOutput, +} from "./commands/ListVirtualMachinesCommand"; +import { + PutMaintenanceStartTimeCommand, + PutMaintenanceStartTimeCommandInput, + PutMaintenanceStartTimeCommandOutput, +} from "./commands/PutMaintenanceStartTimeCommand"; +import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { + TestHypervisorConfigurationCommand, + TestHypervisorConfigurationCommandInput, + TestHypervisorConfigurationCommandOutput, +} from "./commands/TestHypervisorConfigurationCommand"; +import { + UntagResourceCommand, + UntagResourceCommandInput, + UntagResourceCommandOutput, +} from "./commands/UntagResourceCommand"; +import { + UpdateGatewayInformationCommand, + UpdateGatewayInformationCommandInput, + UpdateGatewayInformationCommandOutput, +} from "./commands/UpdateGatewayInformationCommand"; +import { + UpdateHypervisorCommand, + UpdateHypervisorCommandInput, + UpdateHypervisorCommandOutput, +} from "./commands/UpdateHypervisorCommand"; + +/** + *Backup gateway connects Backup to your hypervisor, so you can + * create, store, and restore backups of your virtual machines (VMs) anywhere, whether + * on-premises or in the VMware Cloud (VMC) on Amazon Web Services.
+ *Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.
+ *Use Backup to assign virtual or on-premises resources to a backup plan, or run + * on-demand backups. Once you have backed up your resources, you can view them and restore them + * like any resource supported by Backup.
+ *To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.
+ */ +export class BackupGateway extends BackupGatewayClient { + /** + *Associates a backup gateway with your server. After you complete the association process, + * you can back up and restore your VMs through the gateway.
+ */ + public associateGatewayToServer( + args: AssociateGatewayToServerCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates a backup gateway. After you create a gateway, you can associate it with a server
+ * using the AssociateGatewayToServer operation.
Deletes a backup gateway.
+ */ + public deleteGateway( + args: DeleteGatewayCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes a hypervisor.
+ */ + public deleteHypervisor( + args: DeleteHypervisorCommandInput, + options?: __HttpHandlerOptions + ): PromiseDisassociates a backup gateway from the specified server. After the disassociation process + * finishes, the gateway can no longer access the virtual machines on the server.
+ */ + public disassociateGatewayFromServer( + args: DisassociateGatewayFromServerCommandInput, + options?: __HttpHandlerOptions + ): PromiseConnect to a hypervisor by importing its configuration.
+ */ + public importHypervisorConfiguration( + args: ImportHypervisorConfigurationCommandInput, + options?: __HttpHandlerOptions + ): PromiseLists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
+ */ + public listGateways( + args: ListGatewaysCommandInput, + options?: __HttpHandlerOptions + ): PromiseLists your hypervisors.
+ */ + public listHypervisors( + args: ListHypervisorsCommandInput, + options?: __HttpHandlerOptions + ): PromiseLists the tags applied to the resource identified by its Amazon Resource Name + * (ARN).
+ */ + public listTagsForResource( + args: ListTagsForResourceCommandInput, + options?: __HttpHandlerOptions + ): PromiseLists your virtual machines.
+ */ + public listVirtualMachines( + args: ListVirtualMachinesCommandInput, + options?: __HttpHandlerOptions + ): PromiseSet the maintenance start time for a gateway.
+ */ + public putMaintenanceStartTime( + args: PutMaintenanceStartTimeCommandInput, + options?: __HttpHandlerOptions + ): PromiseTag the resource.
+ */ + public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): PromiseTests your hypervisor configuration to validate that backup gateway can connect with the + * hypervisor and its resources.
+ */ + public testHypervisorConfiguration( + args: TestHypervisorConfigurationCommandInput, + options?: __HttpHandlerOptions + ): PromiseRemoves tags from the resource.
+ */ + public untagResource( + args: UntagResourceCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates a gateway's name. Specify which gateway to update using the Amazon Resource Name + * (ARN) of the gateway in your request.
+ */ + public updateGatewayInformation( + args: UpdateGatewayInformationCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates a hypervisor metadata, including its host, username, and password. Specify which + * hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your + * request.
+ */ + public updateHypervisor( + args: UpdateHypervisorCommandInput, + options?: __HttpHandlerOptions + ): PromiseBackup gateway connects Backup to your hypervisor, so you can + * create, store, and restore backups of your virtual machines (VMs) anywhere, whether + * on-premises or in the VMware Cloud (VMC) on Amazon Web Services.
+ *Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.
+ *Use Backup to assign virtual or on-premises resources to a backup plan, or run + * on-demand backups. Once you have backed up your resources, you can view them and restore them + * like any resource supported by Backup.
+ *To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.
+ */ +export class BackupGatewayClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + BackupGatewayClientResolvedConfig +> { + /** + * The resolved configuration of BackupGatewayClient class. This is resolved and normalized from the {@link BackupGatewayClientConfig | constructor configuration interface}. + */ + readonly config: BackupGatewayClientResolvedConfig; + + constructor(configuration: BackupGatewayClientConfig) { + const _config_0 = __getRuntimeConfig(configuration); + const _config_1 = resolveRegionConfig(_config_0); + const _config_2 = resolveEndpointsConfig(_config_1); + const _config_3 = resolveRetryConfig(_config_2); + const _config_4 = resolveHostHeaderConfig(_config_3); + const _config_5 = resolveAwsAuthConfig(_config_4); + const _config_6 = resolveUserAgentConfig(_config_5); + super(_config_6); + this.config = _config_6; + this.middlewareStack.use(getRetryPlugin(this.config)); + this.middlewareStack.use(getContentLengthPlugin(this.config)); + this.middlewareStack.use(getHostHeaderPlugin(this.config)); + this.middlewareStack.use(getLoggerPlugin(this.config)); + this.middlewareStack.use(getAwsAuthPlugin(this.config)); + this.middlewareStack.use(getUserAgentPlugin(this.config)); + } + + /** + * Destroy underlying resources, like sockets. It's usually not necessary to do this. + * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. + * Otherwise, sockets might stay open for quite a long time before the server terminates them. + */ + destroy(): void { + super.destroy(); + } +} diff --git a/clients/client-backup-gateway/src/commands/AssociateGatewayToServerCommand.ts b/clients/client-backup-gateway/src/commands/AssociateGatewayToServerCommand.ts new file mode 100644 index 000000000000..4f6edb34f33d --- /dev/null +++ b/clients/client-backup-gateway/src/commands/AssociateGatewayToServerCommand.ts @@ -0,0 +1,96 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient"; +import { AssociateGatewayToServerInput, AssociateGatewayToServerOutput } from "../models/models_0"; +import { + deserializeAws_json1_0AssociateGatewayToServerCommand, + serializeAws_json1_0AssociateGatewayToServerCommand, +} from "../protocols/Aws_json1_0"; + +export interface AssociateGatewayToServerCommandInput extends AssociateGatewayToServerInput {} +export interface AssociateGatewayToServerCommandOutput extends AssociateGatewayToServerOutput, __MetadataBearer {} + +/** + *Associates a backup gateway with your server. After you complete the association process, + * you can back up and restore your VMs through the gateway.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, AssociateGatewayToServerCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, AssociateGatewayToServerCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new AssociateGatewayToServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateGatewayToServerCommandInput} for command's `input` shape. + * @see {@link AssociateGatewayToServerCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class AssociateGatewayToServerCommand extends $Command< + AssociateGatewayToServerCommandInput, + AssociateGatewayToServerCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: AssociateGatewayToServerCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a backup gateway. After you create a gateway, you can associate it with a server
+ * using the AssociateGatewayToServer operation.
Deletes a backup gateway.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, DeleteGatewayCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, DeleteGatewayCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new DeleteGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteGatewayCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class DeleteGatewayCommand extends $Command< + DeleteGatewayCommandInput, + DeleteGatewayCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteGatewayCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a hypervisor.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, DeleteHypervisorCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, DeleteHypervisorCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new DeleteHypervisorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHypervisorCommandInput} for command's `input` shape. + * @see {@link DeleteHypervisorCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class DeleteHypervisorCommand extends $Command< + DeleteHypervisorCommandInput, + DeleteHypervisorCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteHypervisorCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDisassociates a backup gateway from the specified server. After the disassociation process + * finishes, the gateway can no longer access the virtual machines on the server.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, DisassociateGatewayFromServerCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, DisassociateGatewayFromServerCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new DisassociateGatewayFromServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateGatewayFromServerCommandInput} for command's `input` shape. + * @see {@link DisassociateGatewayFromServerCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class DisassociateGatewayFromServerCommand extends $Command< + DisassociateGatewayFromServerCommandInput, + DisassociateGatewayFromServerCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DisassociateGatewayFromServerCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackConnect to a hypervisor by importing its configuration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, ImportHypervisorConfigurationCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, ImportHypervisorConfigurationCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new ImportHypervisorConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportHypervisorConfigurationCommandInput} for command's `input` shape. + * @see {@link ImportHypervisorConfigurationCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class ImportHypervisorConfigurationCommand extends $Command< + ImportHypervisorConfigurationCommandInput, + ImportHypervisorConfigurationCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ImportHypervisorConfigurationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, ListGatewaysCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, ListGatewaysCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new ListGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGatewaysCommandInput} for command's `input` shape. + * @see {@link ListGatewaysCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class ListGatewaysCommand extends $Command< + ListGatewaysCommandInput, + ListGatewaysCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListGatewaysCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists your hypervisors.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, ListHypervisorsCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, ListHypervisorsCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new ListHypervisorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHypervisorsCommandInput} for command's `input` shape. + * @see {@link ListHypervisorsCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class ListHypervisorsCommand extends $Command< + ListHypervisorsCommandInput, + ListHypervisorsCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListHypervisorsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists the tags applied to the resource identified by its Amazon Resource Name + * (ARN).
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, ListTagsForResourceCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, ListTagsForResourceCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class ListTagsForResourceCommand extends $Command< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListTagsForResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists your virtual machines.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, ListVirtualMachinesCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, ListVirtualMachinesCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new ListVirtualMachinesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVirtualMachinesCommandInput} for command's `input` shape. + * @see {@link ListVirtualMachinesCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class ListVirtualMachinesCommand extends $Command< + ListVirtualMachinesCommandInput, + ListVirtualMachinesCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListVirtualMachinesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackSet the maintenance start time for a gateway.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, PutMaintenanceStartTimeCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, PutMaintenanceStartTimeCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new PutMaintenanceStartTimeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutMaintenanceStartTimeCommandInput} for command's `input` shape. + * @see {@link PutMaintenanceStartTimeCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class PutMaintenanceStartTimeCommand extends $Command< + PutMaintenanceStartTimeCommandInput, + PutMaintenanceStartTimeCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: PutMaintenanceStartTimeCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackTag the resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, TagResourceCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, TagResourceCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class TagResourceCommand extends $Command< + TagResourceCommandInput, + TagResourceCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: TagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackTests your hypervisor configuration to validate that backup gateway can connect with the + * hypervisor and its resources.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, TestHypervisorConfigurationCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, TestHypervisorConfigurationCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new TestHypervisorConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestHypervisorConfigurationCommandInput} for command's `input` shape. + * @see {@link TestHypervisorConfigurationCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class TestHypervisorConfigurationCommand extends $Command< + TestHypervisorConfigurationCommandInput, + TestHypervisorConfigurationCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: TestHypervisorConfigurationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRemoves tags from the resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, UntagResourceCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, UntagResourceCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class UntagResourceCommand extends $Command< + UntagResourceCommandInput, + UntagResourceCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UntagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates a gateway's name. Specify which gateway to update using the Amazon Resource Name + * (ARN) of the gateway in your request.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, UpdateGatewayInformationCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, UpdateGatewayInformationCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new UpdateGatewayInformationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGatewayInformationCommandInput} for command's `input` shape. + * @see {@link UpdateGatewayInformationCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class UpdateGatewayInformationCommand extends $Command< + UpdateGatewayInformationCommandInput, + UpdateGatewayInformationCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UpdateGatewayInformationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates a hypervisor metadata, including its host, username, and password. Specify which + * hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your + * request.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupGatewayClient, UpdateHypervisorCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import + * // const { BackupGatewayClient, UpdateHypervisorCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import + * const client = new BackupGatewayClient(config); + * const command = new UpdateHypervisorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateHypervisorCommandInput} for command's `input` shape. + * @see {@link UpdateHypervisorCommandOutput} for command's `response` shape. + * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape. + * + */ +export class UpdateHypervisorCommand extends $Command< + UpdateHypervisorCommandInput, + UpdateHypervisorCommandOutput, + BackupGatewayClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UpdateHypervisorCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe operation cannot proceed because you have insufficient permissions.
+ */ +export interface AccessDeniedException extends __SmithyException, $MetadataBearer { + name: "AccessDeniedException"; + $fault: "client"; + /** + *A description of why you have insufficient permissions.
+ */ + ErrorCode: string | undefined; + + Message?: string; +} + +export namespace AccessDeniedException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ + ...obj, + }); +} + +export interface AssociateGatewayToServerInput { + /** + *The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
+ * to return a list of gateways for your account and Amazon Web Services Region.
The Amazon Resource Name (ARN) of the server that hosts your virtual machines.
+ */ + ServerArn: string | undefined; +} + +export namespace AssociateGatewayToServerInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AssociateGatewayToServerInput): any => ({ + ...obj, + }); +} + +export interface AssociateGatewayToServerOutput { + /** + *The Amazon Resource Name (ARN) of a gateway.
+ */ + GatewayArn?: string; +} + +export namespace AssociateGatewayToServerOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AssociateGatewayToServerOutput): any => ({ + ...obj, + }); +} + +/** + *The operation cannot proceed because it is not supported.
+ */ +export interface ConflictException extends __SmithyException, $MetadataBearer { + name: "ConflictException"; + $fault: "client"; + /** + *A description of why the operation is not supported.
+ */ + ErrorCode: string | undefined; + + Message?: string; +} + +export namespace ConflictException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ConflictException): any => ({ + ...obj, + }); +} + +/** + *The operation did not succeed because an internal error occurred. Try again later.
+ */ +export interface InternalServerException extends __SmithyException, $MetadataBearer { + name: "InternalServerException"; + $fault: "server"; + /** + *A description of which internal error occured.
+ */ + ErrorCode?: string; + + Message?: string; +} + +export namespace InternalServerException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InternalServerException): any => ({ + ...obj, + }); +} + +/** + *The operation did not succeed because a validation error occurred.
+ */ +export interface ValidationException extends __SmithyException, $MetadataBearer { + name: "ValidationException"; + $fault: "client"; + /** + *A description of what caused the validation error.
+ */ + ErrorCode?: string; + + Message?: string; +} + +export namespace ValidationException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ValidationException): any => ({ + ...obj, + }); +} + +export enum GatewayType { + BACKUP_VM = "BACKUP_VM", +} + +/** + *A key-value pair you can use to manage, filter, and search for your resources. Allowed + * characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : + * /.
+ */ +export interface Tag { + /** + *The key part of a tag's key-value pair. The key can't start with aws:.
The key part of a value's key-value pair.
+ */ + Value: string | undefined; +} + +export namespace Tag { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Tag): any => ({ + ...obj, + }); +} + +export interface CreateGatewayInput { + /** + *The activation key of the created gateway.
+ */ + ActivationKey: string | undefined; + + /** + *The display name of the created gateway.
+ */ + GatewayDisplayName: string | undefined; + + /** + *The type of created gateway.
+ */ + GatewayType: GatewayType | string | undefined; + + /** + *A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.
+ */ + Tags?: Tag[]; +} + +export namespace CreateGatewayInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateGatewayInput): any => ({ + ...obj, + }); +} + +export interface CreateGatewayOutput { + /** + *The Amazon Resource Name (ARN) of the gateway you create.
+ */ + GatewayArn?: string; +} + +export namespace CreateGatewayOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateGatewayOutput): any => ({ + ...obj, + }); +} + +export interface DeleteGatewayInput { + /** + *The Amazon Resource Name (ARN) of the gateway to delete.
+ */ + GatewayArn: string | undefined; +} + +export namespace DeleteGatewayInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteGatewayInput): any => ({ + ...obj, + }); +} + +export interface DeleteGatewayOutput { + /** + *The Amazon Resource Name (ARN) of the gateway you deleted.
+ */ + GatewayArn?: string; +} + +export namespace DeleteGatewayOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteGatewayOutput): any => ({ + ...obj, + }); +} + +/** + *A resource that is required for the action wasn't found.
+ */ +export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer { + name: "ResourceNotFoundException"; + $fault: "client"; + /** + *A description of which resource wasn't found.
+ */ + ErrorCode?: string; + + Message?: string; +} + +export namespace ResourceNotFoundException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ + ...obj, + }); +} + +export interface DisassociateGatewayFromServerInput { + /** + *The Amazon Resource Name (ARN) of the gateway to disassociate.
+ */ + GatewayArn: string | undefined; +} + +export namespace DisassociateGatewayFromServerInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DisassociateGatewayFromServerInput): any => ({ + ...obj, + }); +} + +export interface DisassociateGatewayFromServerOutput { + /** + *The Amazon Resource Name (ARN) of the gateway you disassociated.
+ */ + GatewayArn?: string; +} + +export namespace DisassociateGatewayFromServerOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DisassociateGatewayFromServerOutput): any => ({ + ...obj, + }); +} + +export interface ListGatewaysInput { + /** + *The maximum number of gateways to list.
+ */ + MaxResults?: number; + + /** + *The next item following a partial list of returned resources. For example, if a request is
+ * made to return MaxResults number of resources, NextToken allows you
+ * to return more items in your list starting at the location pointed to by the next
+ * token.
A gateway is an Backup Gateway appliance that runs on the customer's network + * to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.
+ */ +export interface Gateway { + /** + *The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
+ * to return a list of gateways for your account and Amazon Web Services Region.
The display name of the gateway.
+ */ + GatewayDisplayName?: string; + + /** + *The type of the gateway.
+ */ + GatewayType?: GatewayType | string; + + /** + *The hypervisor ID of the gateway.
+ */ + HypervisorId?: string; + + /** + *The last time Backup gateway communicated with the gateway, in Unix format and + * UTC time.
+ */ + LastSeenTime?: Date; +} + +export namespace Gateway { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Gateway): any => ({ + ...obj, + }); +} + +export interface ListGatewaysOutput { + /** + *A list of your gateways.
+ */ + Gateways?: Gateway[]; + + /** + *The next item following a partial list of returned resources. For example, if a request is
+ * made to return maxResults number of resources, NextToken allows you
+ * to return more items in your list starting at the location pointed to by the next
+ * token.
The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start + * time.
+ */ + GatewayArn: string | undefined; + + /** + *The hour of the day to start maintenance on a gateway.
+ */ + HourOfDay: number | undefined; + + /** + *The minute of the hour to start maintenance on a gateway.
+ */ + MinuteOfHour: number | undefined; + + /** + *The day of the week to start maintenance on a gateway.
+ */ + DayOfWeek?: number; + + /** + *The day of the month start maintenance on a gateway.
+ *Valid values range from Sunday to Saturday.
The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start + * time.
+ */ + GatewayArn?: string; +} + +export namespace PutMaintenanceStartTimeOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PutMaintenanceStartTimeOutput): any => ({ + ...obj, + }); +} + +export interface TestHypervisorConfigurationInput { + /** + *The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
+ */ + GatewayArn: string | undefined; + + /** + *The server host of the hypervisor. This can be either an IP address or a fully-qualified + * domain name (FQDN).
+ */ + Host: string | undefined; + + /** + *The username for the hypervisor.
+ */ + Username?: string; + + /** + *The password for the hypervisor.
+ */ + Password?: string; +} + +export namespace TestHypervisorConfigurationInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TestHypervisorConfigurationInput): any => ({ + ...obj, + ...(obj.Username && { Username: SENSITIVE_STRING }), + ...(obj.Password && { Password: SENSITIVE_STRING }), + }); +} + +export interface TestHypervisorConfigurationOutput {} + +export namespace TestHypervisorConfigurationOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TestHypervisorConfigurationOutput): any => ({ + ...obj, + }); +} + +export interface UpdateGatewayInformationInput { + /** + *The Amazon Resource Name (ARN) of the gateway to update.
+ */ + GatewayArn: string | undefined; + + /** + *The updated display name of the gateway.
+ */ + GatewayDisplayName?: string; +} + +export namespace UpdateGatewayInformationInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateGatewayInformationInput): any => ({ + ...obj, + }); +} + +export interface UpdateGatewayInformationOutput { + /** + *The Amazon Resource Name (ARN) of the gateway you updated.
+ */ + GatewayArn?: string; +} + +export namespace UpdateGatewayInformationOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateGatewayInformationOutput): any => ({ + ...obj, + }); +} + +export interface DeleteHypervisorInput { + /** + *The Amazon Resource Name (ARN) of the hypervisor to delete.
+ */ + HypervisorArn: string | undefined; +} + +export namespace DeleteHypervisorInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteHypervisorInput): any => ({ + ...obj, + }); +} + +export interface DeleteHypervisorOutput { + /** + *The Amazon Resource Name (ARN) of the hypervisor you deleted.
+ */ + HypervisorArn?: string; +} + +export namespace DeleteHypervisorOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteHypervisorOutput): any => ({ + ...obj, + }); +} + +export interface ImportHypervisorConfigurationInput { + /** + *The name of the hypervisor.
+ */ + Name: string | undefined; + + /** + *The server host of the hypervisor. This can be either an IP address or a fully-qualified + * domain name (FQDN).
+ */ + Host: string | undefined; + + /** + *The username for the hypervisor.
+ */ + Username?: string; + + /** + *The password for the hypervisor.
+ */ + Password?: string; + + /** + *The Key Management Service for the hypervisor.
+ */ + KmsKeyArn?: string; + + /** + *The tags of the hypervisor configuration to import.
+ */ + Tags?: Tag[]; +} + +export namespace ImportHypervisorConfigurationInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ImportHypervisorConfigurationInput): any => ({ + ...obj, + ...(obj.Username && { Username: SENSITIVE_STRING }), + ...(obj.Password && { Password: SENSITIVE_STRING }), + }); +} + +export interface ImportHypervisorConfigurationOutput { + /** + *The Amazon Resource Name (ARN) of the hypervisor you disassociated.
+ */ + HypervisorArn?: string; +} + +export namespace ImportHypervisorConfigurationOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ImportHypervisorConfigurationOutput): any => ({ + ...obj, + }); +} + +export interface ListHypervisorsInput { + /** + *The maximum number of hypervisors to list.
+ */ + MaxResults?: number; + + /** + *The next item following a partial list of returned resources. For example, if a request is
+ * made to return maxResults number of resources, NextToken allows you
+ * to return more items in your list starting at the location pointed to by the next
+ * token.
Represents the hypervisor's permissions to which the gateway will connect.
+ *A hypervisor is hardware, software, or firmware that creates and manages virtual machines, + * and allocates resources to them.
+ */ +export interface Hypervisor { + /** + *The server host of the hypervisor. This can be either an IP address or a fully-qualified + * domain name (FQDN).
+ */ + Host?: string; + + /** + *The Amazon Resource Name (ARN) of the hypervisor.
+ */ + HypervisorArn?: string; + + /** + *The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the + * hypervisor.
+ */ + KmsKeyArn?: string; + + /** + *The name of the hypervisor.
+ */ + Name?: string; + + /** + *The state of the hypervisor.
+ */ + State?: HypervisorState | string; +} + +export namespace Hypervisor { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Hypervisor): any => ({ + ...obj, + }); +} + +export interface ListHypervisorsOutput { + /** + *A list of your Hypervisor objects, ordered by their Amazon Resource Names
+ * (ARNs).
The next item following a partial list of returned resources. For example, if a request is
+ * made to return maxResults number of resources, NextToken allows you
+ * to return more items in your list starting at the location pointed to by the next
+ * token.
The Amazon Resource Name (ARN) of the hypervisor to update.
+ */ + HypervisorArn: string | undefined; + + /** + *The updated host of the hypervisor. This can be either an IP address or a fully-qualified + * domain name (FQDN).
+ */ + Host?: string; + + /** + *The updated username for the hypervisor.
+ */ + Username?: string; + + /** + *The updated password for the hypervisor.
+ */ + Password?: string; +} + +export namespace UpdateHypervisorInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateHypervisorInput): any => ({ + ...obj, + ...(obj.Username && { Username: SENSITIVE_STRING }), + ...(obj.Password && { Password: SENSITIVE_STRING }), + }); +} + +export interface UpdateHypervisorOutput { + /** + *The Amazon Resource Name (ARN) of the hypervisor you updated.
+ */ + HypervisorArn?: string; +} + +export namespace UpdateHypervisorOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateHypervisorOutput): any => ({ + ...obj, + }); +} + +export interface ListTagsForResourceInput { + /** + *The Amazon Resource Name (ARN) of the resource's tags to list.
+ */ + ResourceArn: string | undefined; +} + +export namespace ListTagsForResourceInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ + ...obj, + }); +} + +export interface ListTagsForResourceOutput { + /** + *The Amazon Resource Name (ARN) of the resource's tags that you listed.
+ */ + ResourceArn?: string; + + /** + *A list of the resource's tags.
+ */ + Tags?: Tag[]; +} + +export namespace ListTagsForResourceOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ + ...obj, + }); +} + +export interface ListVirtualMachinesInput { + /** + *The maximum number of virtual machines to list.
+ */ + MaxResults?: number; + + /** + *The next item following a partial list of returned resources. For example, if a request is
+ * made to return maxResults number of resources, NextToken allows you
+ * to return more items in your list starting at the location pointed to by the next
+ * token.
A virtual machine that is on a hypervisor.
+ */ +export interface VirtualMachine { + /** + *The host name of the virtual machine.
+ */ + HostName?: string; + + /** + *The ID of the virtual machine's hypervisor.
+ */ + HypervisorId?: string; + + /** + *The name of the virtual machine.
+ */ + Name?: string; + + /** + *The path of the virtual machine.
+ */ + Path?: string; + + /** + *The Amazon Resource Name (ARN) of the virtual machine.
+ */ + ResourceArn?: string; + + /** + *The most recent date a virtual machine was backed up, in Unix format and UTC time.
+ */ + LastBackupDate?: Date; +} + +export namespace VirtualMachine { + /** + * @internal + */ + export const filterSensitiveLog = (obj: VirtualMachine): any => ({ + ...obj, + }); +} + +export interface ListVirtualMachinesOutput { + /** + *A list of your VirtualMachine objects, ordered by their Amazon Resource Names
+ * (ARNs).
The next item following a partial list of returned resources. For example, if a request is
+ * made to return maxResults number of resources, NextToken allows you
+ * to return more items in your list starting at the location pointed to by the next
+ * token.
The Amazon Resource Name (ARN) of the resource to tag.
+ */ + ResourceARN: string | undefined; + + /** + *A list of tags to assign to the resource.
+ */ + Tags: Tag[] | undefined; +} + +export namespace TagResourceInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TagResourceInput): any => ({ + ...obj, + }); +} + +export interface TagResourceOutput { + /** + *The Amazon Resource Name (ARN) of the resource you tagged.
+ */ + ResourceARN?: string; +} + +export namespace TagResourceOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ + ...obj, + }); +} + +export interface UntagResourceInput { + /** + *The Amazon Resource Name (ARN) of the resource from which to remove tags.
+ */ + ResourceARN: string | undefined; + + /** + *The list of tag keys specifying which tags to remove.
+ */ + TagKeys: string[] | undefined; +} + +export namespace UntagResourceInput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ + ...obj, + }); +} + +export interface UntagResourceOutput { + /** + *The Amazon Resource Name (ARN) of the resource from which you removed tags.
+ */ + ResourceARN?: string; +} + +export namespace UntagResourceOutput { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ + ...obj, + }); +} diff --git a/clients/client-backup-gateway/src/pagination/Interfaces.ts b/clients/client-backup-gateway/src/pagination/Interfaces.ts new file mode 100644 index 000000000000..b4153dbc5620 --- /dev/null +++ b/clients/client-backup-gateway/src/pagination/Interfaces.ts @@ -0,0 +1,8 @@ +import { PaginationConfiguration } from "@aws-sdk/types"; + +import { BackupGateway } from "../BackupGateway"; +import { BackupGatewayClient } from "../BackupGatewayClient"; + +export interface BackupGatewayPaginationConfiguration extends PaginationConfiguration { + client: BackupGateway | BackupGatewayClient; +} diff --git a/clients/client-backup-gateway/src/pagination/ListGatewaysPaginator.ts b/clients/client-backup-gateway/src/pagination/ListGatewaysPaginator.ts new file mode 100644 index 000000000000..b5d931c9a8ef --- /dev/null +++ b/clients/client-backup-gateway/src/pagination/ListGatewaysPaginator.ts @@ -0,0 +1,59 @@ +import { Paginator } from "@aws-sdk/types"; + +import { BackupGateway } from "../BackupGateway"; +import { BackupGatewayClient } from "../BackupGatewayClient"; +import { + ListGatewaysCommand, + ListGatewaysCommandInput, + ListGatewaysCommandOutput, +} from "../commands/ListGatewaysCommand"; +import { BackupGatewayPaginationConfiguration } from "./Interfaces"; + +/** + * @private + */ +const makePagedClientRequest = async ( + client: BackupGatewayClient, + input: ListGatewaysCommandInput, + ...args: any +): PromiseDeletes a recommendation preference, such as enhanced infrastructure metrics.
+ *For more information, see Activating + * enhanced infrastructure metrics in the Compute Optimizer User + * Guide.
+ */ + public deleteRecommendationPreferences( + args: DeleteRecommendationPreferencesCommandInput, + options?: __HttpHandlerOptions + ): PromiseDescribes recommendation export jobs created in the last seven days.
- * *Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your * recommendations. Then use the DescribeRecommendationExportJobs action * to view your export jobs.
@@ -124,12 +178,10 @@ export class ComputeOptimizer extends ComputeOptimizerClient { /** *Exports optimization recommendations for Auto Scaling groups.
- * *Recommendations are exported in a comma-separated values (.csv) file, and its metadata * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting * Recommendations in the Compute Optimizer User * Guide.
- * *You can have only one Auto Scaling group export job in progress per Amazon Web Services Region.
*/ public exportAutoScalingGroupRecommendations( @@ -165,13 +217,10 @@ export class ComputeOptimizer extends ComputeOptimizerClient { /** *Exports optimization recommendations for Amazon EBS volumes.
- * *Recommendations are exported in a comma-separated values (.csv) file, and its metadata - * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see - * Exporting + * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting * Recommendations in the Compute Optimizer User * Guide.
- * *You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.
*/ public exportEBSVolumeRecommendations( @@ -205,13 +254,10 @@ export class ComputeOptimizer extends ComputeOptimizerClient { /** *Exports optimization recommendations for Amazon EC2 instances.
- * *Recommendations are exported in a comma-separated values (.csv) file, and its metadata - * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see - * Exporting + * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting * Recommendations in the Compute Optimizer User * Guide.
- * *You can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region.
*/ public exportEC2InstanceRecommendations( @@ -245,13 +291,10 @@ export class ComputeOptimizer extends ComputeOptimizerClient { /** *Exports optimization recommendations for Lambda functions.
- * *Recommendations are exported in a comma-separated values (.csv) file, and its metadata - * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see - * Exporting + * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting * Recommendations in the Compute Optimizer User * Guide.
- * *You can have only one Lambda function export job in progress per Amazon Web Services Region.
*/ public exportLambdaFunctionRecommendations( @@ -285,7 +328,6 @@ export class ComputeOptimizer extends ComputeOptimizerClient { /** *Returns Auto Scaling group recommendations.
- * *Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that * meet a specific set of requirements. For more information, see the Supported * resources and requirements in the Compute Optimizer User @@ -322,7 +364,6 @@ export class ComputeOptimizer extends ComputeOptimizerClient { /** *
Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
- * *Compute Optimizer generates recommendations for Amazon EBS volumes that * meet a specific set of requirements. For more information, see the Supported * resources and requirements in the Compute Optimizer User @@ -359,7 +400,6 @@ export class ComputeOptimizer extends ComputeOptimizerClient { /** *
Returns Amazon EC2 instance recommendations.
- * *Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more * information, see the Supported resources and * requirements in the Compute Optimizer User @@ -397,7 +437,6 @@ export class ComputeOptimizer extends ComputeOptimizerClient { /** *
Returns the projected utilization metrics of Amazon EC2 instance * recommendations.
- * *The Cpu and Memory metrics are the only projected
* utilization metrics returned when you run this action. Additionally, the
@@ -434,10 +473,48 @@ export class ComputeOptimizer extends ComputeOptimizerClient {
}
}
+ /**
+ *
Returns the recommendation preferences that are in effect for a given resource, such + * as enhanced infrastructure metrics. Considers all applicable preferences that you might + * have set at the resource, account, and organization level.
+ *When you create a recommendation preference, you can set its status to
+ * Active or Inactive. Use this action to view the
+ * recommendation preferences that are in effect, or Active.
Returns the enrollment (opt in) status of an account to the Compute Optimizer * service.
- * *If the account is the management account of an organization, this action also confirms * the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information * about the enrollment status of member accounts of an organization.
@@ -474,7 +551,6 @@ export class ComputeOptimizer extends ComputeOptimizerClient { /** *Returns the Compute Optimizer enrollment (opt-in) status of organization member * accounts, if your account is an organization management account.
- * *To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.
*/ public getEnrollmentStatusesForOrganization( @@ -508,7 +584,6 @@ export class ComputeOptimizer extends ComputeOptimizerClient { /** *Returns Lambda function recommendations.
- * *Compute Optimizer generates recommendations for functions that meet a specific set * of requirements. For more information, see the Supported resources and * requirements in the Compute Optimizer User @@ -543,11 +618,48 @@ export class ComputeOptimizer extends ComputeOptimizerClient { } } + /** + *
Returns existing recommendation preferences, such as enhanced infrastructure + * metrics.
+ *Use the scope parameter to specify which preferences to return. You can
+ * specify to return preferences for an organization, a specific account ID, or a specific
+ * EC2 instance or Auto Scaling group Amazon Resource Name (ARN).
For more information, see Activating + * enhanced infrastructure metrics in the Compute Optimizer User + * Guide.
+ */ + public getRecommendationPreferences( + args: GetRecommendationPreferencesCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns the optimization findings for an account.
- * *It returns the number of:
- * *Amazon EC2 instances in an account that are @@ -597,15 +709,48 @@ export class ComputeOptimizer extends ComputeOptimizerClient { } } + /** + *
Creates a new recommendation preference or updates an existing recommendation + * preference, such as enhanced infrastructure metrics.
+ *For more information, see Activating + * enhanced infrastructure metrics in the Compute Optimizer User + * Guide.
+ */ + public putRecommendationPreferences( + args: PutRecommendationPreferencesCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
- * *If the account is a management account of an organization, this action can also be * used to enroll member accounts of the organization.
- * *You must have the appropriate permissions to opt in to Compute Optimizer, to view its * recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.
- * *When you opt in, Compute Optimizer automatically creates a service-linked role in your * account to access its data. For more information, see Using * Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.
diff --git a/clients/client-compute-optimizer/src/ComputeOptimizerClient.ts b/clients/client-compute-optimizer/src/ComputeOptimizerClient.ts index ec7e99f2fd86..cc00d09e69d7 100644 --- a/clients/client-compute-optimizer/src/ComputeOptimizerClient.ts +++ b/clients/client-compute-optimizer/src/ComputeOptimizerClient.ts @@ -49,6 +49,10 @@ import { UserAgent as __UserAgent, } from "@aws-sdk/types"; +import { + DeleteRecommendationPreferencesCommandInput, + DeleteRecommendationPreferencesCommandOutput, +} from "./commands/DeleteRecommendationPreferencesCommand"; import { DescribeRecommendationExportJobsCommandInput, DescribeRecommendationExportJobsCommandOutput, @@ -85,6 +89,10 @@ import { GetEC2RecommendationProjectedMetricsCommandInput, GetEC2RecommendationProjectedMetricsCommandOutput, } from "./commands/GetEC2RecommendationProjectedMetricsCommand"; +import { + GetEffectiveRecommendationPreferencesCommandInput, + GetEffectiveRecommendationPreferencesCommandOutput, +} from "./commands/GetEffectiveRecommendationPreferencesCommand"; import { GetEnrollmentStatusCommandInput, GetEnrollmentStatusCommandOutput, @@ -97,10 +105,18 @@ import { GetLambdaFunctionRecommendationsCommandInput, GetLambdaFunctionRecommendationsCommandOutput, } from "./commands/GetLambdaFunctionRecommendationsCommand"; +import { + GetRecommendationPreferencesCommandInput, + GetRecommendationPreferencesCommandOutput, +} from "./commands/GetRecommendationPreferencesCommand"; import { GetRecommendationSummariesCommandInput, GetRecommendationSummariesCommandOutput, } from "./commands/GetRecommendationSummariesCommand"; +import { + PutRecommendationPreferencesCommandInput, + PutRecommendationPreferencesCommandOutput, +} from "./commands/PutRecommendationPreferencesCommand"; import { UpdateEnrollmentStatusCommandInput, UpdateEnrollmentStatusCommandOutput, @@ -108,6 +124,7 @@ import { import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; export type ServiceInputTypes = + | DeleteRecommendationPreferencesCommandInput | DescribeRecommendationExportJobsCommandInput | ExportAutoScalingGroupRecommendationsCommandInput | ExportEBSVolumeRecommendationsCommandInput @@ -117,13 +134,17 @@ export type ServiceInputTypes = | GetEBSVolumeRecommendationsCommandInput | GetEC2InstanceRecommendationsCommandInput | GetEC2RecommendationProjectedMetricsCommandInput + | GetEffectiveRecommendationPreferencesCommandInput | GetEnrollmentStatusCommandInput | GetEnrollmentStatusesForOrganizationCommandInput | GetLambdaFunctionRecommendationsCommandInput + | GetRecommendationPreferencesCommandInput | GetRecommendationSummariesCommandInput + | PutRecommendationPreferencesCommandInput | UpdateEnrollmentStatusCommandInput; export type ServiceOutputTypes = + | DeleteRecommendationPreferencesCommandOutput | DescribeRecommendationExportJobsCommandOutput | ExportAutoScalingGroupRecommendationsCommandOutput | ExportEBSVolumeRecommendationsCommandOutput @@ -133,10 +154,13 @@ export type ServiceOutputTypes = | GetEBSVolumeRecommendationsCommandOutput | GetEC2InstanceRecommendationsCommandOutput | GetEC2RecommendationProjectedMetricsCommandOutput + | GetEffectiveRecommendationPreferencesCommandOutput | GetEnrollmentStatusCommandOutput | GetEnrollmentStatusesForOrganizationCommandOutput | GetLambdaFunctionRecommendationsCommandOutput + | GetRecommendationPreferencesCommandOutput | GetRecommendationSummariesCommandOutput + | PutRecommendationPreferencesCommandOutput | UpdateEnrollmentStatusCommandOutput; export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> { diff --git a/clients/client-compute-optimizer/src/commands/DeleteRecommendationPreferencesCommand.ts b/clients/client-compute-optimizer/src/commands/DeleteRecommendationPreferencesCommand.ts new file mode 100644 index 000000000000..245fb4c174e1 --- /dev/null +++ b/clients/client-compute-optimizer/src/commands/DeleteRecommendationPreferencesCommand.ts @@ -0,0 +1,106 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { ComputeOptimizerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComputeOptimizerClient"; +import { DeleteRecommendationPreferencesRequest, DeleteRecommendationPreferencesResponse } from "../models/models_0"; +import { + deserializeAws_json1_0DeleteRecommendationPreferencesCommand, + serializeAws_json1_0DeleteRecommendationPreferencesCommand, +} from "../protocols/Aws_json1_0"; + +export interface DeleteRecommendationPreferencesCommandInput extends DeleteRecommendationPreferencesRequest {} +export interface DeleteRecommendationPreferencesCommandOutput + extends DeleteRecommendationPreferencesResponse, + __MetadataBearer {} + +/** + *Deletes a recommendation preference, such as enhanced infrastructure metrics.
+ *For more information, see Activating + * enhanced infrastructure metrics in the Compute Optimizer User + * Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, DeleteRecommendationPreferencesCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, DeleteRecommendationPreferencesCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new DeleteRecommendationPreferencesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRecommendationPreferencesCommandInput} for command's `input` shape. + * @see {@link DeleteRecommendationPreferencesCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for ComputeOptimizerClient's `config` shape. + * + */ +export class DeleteRecommendationPreferencesCommand extends $Command< + DeleteRecommendationPreferencesCommandInput, + DeleteRecommendationPreferencesCommandOutput, + ComputeOptimizerClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteRecommendationPreferencesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDescribes recommendation export jobs created in the last seven days.
- * *Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your * recommendations. Then use the DescribeRecommendationExportJobs action * to view your export jobs.
diff --git a/clients/client-compute-optimizer/src/commands/ExportAutoScalingGroupRecommendationsCommand.ts b/clients/client-compute-optimizer/src/commands/ExportAutoScalingGroupRecommendationsCommand.ts index afd3f81313a1..8097d1f66d13 100644 --- a/clients/client-compute-optimizer/src/commands/ExportAutoScalingGroupRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/src/commands/ExportAutoScalingGroupRecommendationsCommand.ts @@ -29,12 +29,10 @@ export interface ExportAutoScalingGroupRecommendationsCommandOutput /** *Exports optimization recommendations for Auto Scaling groups.
- * *Recommendations are exported in a comma-separated values (.csv) file, and its metadata * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting * Recommendations in the Compute Optimizer User * Guide.
- * *You can have only one Auto Scaling group export job in progress per Amazon Web Services Region.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-compute-optimizer/src/commands/ExportEBSVolumeRecommendationsCommand.ts b/clients/client-compute-optimizer/src/commands/ExportEBSVolumeRecommendationsCommand.ts index 3cc99fcbae3d..a11970160cbe 100644 --- a/clients/client-compute-optimizer/src/commands/ExportEBSVolumeRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/src/commands/ExportEBSVolumeRecommendationsCommand.ts @@ -25,13 +25,10 @@ export interface ExportEBSVolumeRecommendationsCommandOutput /** *Exports optimization recommendations for Amazon EBS volumes.
- * *Recommendations are exported in a comma-separated values (.csv) file, and its metadata - * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see - * Exporting + * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting * Recommendations in the Compute Optimizer User * Guide.
- * *You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-compute-optimizer/src/commands/ExportEC2InstanceRecommendationsCommand.ts b/clients/client-compute-optimizer/src/commands/ExportEC2InstanceRecommendationsCommand.ts index 59fd7ab7739c..99ad64527b0e 100644 --- a/clients/client-compute-optimizer/src/commands/ExportEC2InstanceRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/src/commands/ExportEC2InstanceRecommendationsCommand.ts @@ -25,13 +25,10 @@ export interface ExportEC2InstanceRecommendationsCommandOutput /** *Exports optimization recommendations for Amazon EC2 instances.
- * *Recommendations are exported in a comma-separated values (.csv) file, and its metadata - * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see - * Exporting + * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting * Recommendations in the Compute Optimizer User * Guide.
- * *You can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-compute-optimizer/src/commands/ExportLambdaFunctionRecommendationsCommand.ts b/clients/client-compute-optimizer/src/commands/ExportLambdaFunctionRecommendationsCommand.ts index ef5760b02f2b..ec905e965d22 100644 --- a/clients/client-compute-optimizer/src/commands/ExportLambdaFunctionRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/src/commands/ExportLambdaFunctionRecommendationsCommand.ts @@ -28,13 +28,10 @@ export interface ExportLambdaFunctionRecommendationsCommandOutput /** *Exports optimization recommendations for Lambda functions.
- * *Recommendations are exported in a comma-separated values (.csv) file, and its metadata - * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see - * Exporting + * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting * Recommendations in the Compute Optimizer User * Guide.
- * *You can have only one Lambda function export job in progress per Amazon Web Services Region.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-compute-optimizer/src/commands/GetAutoScalingGroupRecommendationsCommand.ts b/clients/client-compute-optimizer/src/commands/GetAutoScalingGroupRecommendationsCommand.ts index 1ee7f342ab24..840a942a54c3 100644 --- a/clients/client-compute-optimizer/src/commands/GetAutoScalingGroupRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/src/commands/GetAutoScalingGroupRecommendationsCommand.ts @@ -28,7 +28,6 @@ export interface GetAutoScalingGroupRecommendationsCommandOutput /** *Returns Auto Scaling group recommendations.
- * *Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that * meet a specific set of requirements. For more information, see the Supported * resources and requirements in the Compute Optimizer User diff --git a/clients/client-compute-optimizer/src/commands/GetEBSVolumeRecommendationsCommand.ts b/clients/client-compute-optimizer/src/commands/GetEBSVolumeRecommendationsCommand.ts index 9e3b6ee02abd..dce6dd6ad9a2 100644 --- a/clients/client-compute-optimizer/src/commands/GetEBSVolumeRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/src/commands/GetEBSVolumeRecommendationsCommand.ts @@ -25,7 +25,6 @@ export interface GetEBSVolumeRecommendationsCommandOutput /** *
Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
- * *Compute Optimizer generates recommendations for Amazon EBS volumes that * meet a specific set of requirements. For more information, see the Supported * resources and requirements in the Compute Optimizer User diff --git a/clients/client-compute-optimizer/src/commands/GetEC2InstanceRecommendationsCommand.ts b/clients/client-compute-optimizer/src/commands/GetEC2InstanceRecommendationsCommand.ts index e935f7060260..0dcbe8901ee4 100644 --- a/clients/client-compute-optimizer/src/commands/GetEC2InstanceRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/src/commands/GetEC2InstanceRecommendationsCommand.ts @@ -25,7 +25,6 @@ export interface GetEC2InstanceRecommendationsCommandOutput /** *
Returns Amazon EC2 instance recommendations.
- * *Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more * information, see the Supported resources and * requirements in the Compute Optimizer User diff --git a/clients/client-compute-optimizer/src/commands/GetEC2RecommendationProjectedMetricsCommand.ts b/clients/client-compute-optimizer/src/commands/GetEC2RecommendationProjectedMetricsCommand.ts index 47e36918172c..e0dfc36103c8 100644 --- a/clients/client-compute-optimizer/src/commands/GetEC2RecommendationProjectedMetricsCommand.ts +++ b/clients/client-compute-optimizer/src/commands/GetEC2RecommendationProjectedMetricsCommand.ts @@ -29,7 +29,6 @@ export interface GetEC2RecommendationProjectedMetricsCommandOutput /** *
Returns the projected utilization metrics of Amazon EC2 instance * recommendations.
- * *The Cpu and Memory metrics are the only projected
* utilization metrics returned when you run this action. Additionally, the
diff --git a/clients/client-compute-optimizer/src/commands/GetEffectiveRecommendationPreferencesCommand.ts b/clients/client-compute-optimizer/src/commands/GetEffectiveRecommendationPreferencesCommand.ts
new file mode 100644
index 000000000000..ccd3c09ce05d
--- /dev/null
+++ b/clients/client-compute-optimizer/src/commands/GetEffectiveRecommendationPreferencesCommand.ts
@@ -0,0 +1,112 @@
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+ FinalizeHandlerArguments,
+ Handler,
+ HandlerExecutionContext,
+ HttpHandlerOptions as __HttpHandlerOptions,
+ MetadataBearer as __MetadataBearer,
+ MiddlewareStack,
+ SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import { ComputeOptimizerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComputeOptimizerClient";
+import {
+ GetEffectiveRecommendationPreferencesRequest,
+ GetEffectiveRecommendationPreferencesResponse,
+} from "../models/models_0";
+import {
+ deserializeAws_json1_0GetEffectiveRecommendationPreferencesCommand,
+ serializeAws_json1_0GetEffectiveRecommendationPreferencesCommand,
+} from "../protocols/Aws_json1_0";
+
+export interface GetEffectiveRecommendationPreferencesCommandInput
+ extends GetEffectiveRecommendationPreferencesRequest {}
+export interface GetEffectiveRecommendationPreferencesCommandOutput
+ extends GetEffectiveRecommendationPreferencesResponse,
+ __MetadataBearer {}
+
+/**
+ *
Returns the recommendation preferences that are in effect for a given resource, such + * as enhanced infrastructure metrics. Considers all applicable preferences that you might + * have set at the resource, account, and organization level.
+ *When you create a recommendation preference, you can set its status to
+ * Active or Inactive. Use this action to view the
+ * recommendation preferences that are in effect, or Active.
Returns the enrollment (opt in) status of an account to the Compute Optimizer * service.
- * *If the account is the management account of an organization, this action also confirms * the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information * about the enrollment status of member accounts of an organization.
diff --git a/clients/client-compute-optimizer/src/commands/GetEnrollmentStatusesForOrganizationCommand.ts b/clients/client-compute-optimizer/src/commands/GetEnrollmentStatusesForOrganizationCommand.ts index b39350b3b9fe..b7ee1d5947db 100644 --- a/clients/client-compute-optimizer/src/commands/GetEnrollmentStatusesForOrganizationCommand.ts +++ b/clients/client-compute-optimizer/src/commands/GetEnrollmentStatusesForOrganizationCommand.ts @@ -29,7 +29,6 @@ export interface GetEnrollmentStatusesForOrganizationCommandOutput /** *Returns the Compute Optimizer enrollment (opt-in) status of organization member * accounts, if your account is an organization management account.
- * *To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-compute-optimizer/src/commands/GetLambdaFunctionRecommendationsCommand.ts b/clients/client-compute-optimizer/src/commands/GetLambdaFunctionRecommendationsCommand.ts index b8ed0920ca3c..b797ff47b45a 100644 --- a/clients/client-compute-optimizer/src/commands/GetLambdaFunctionRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/src/commands/GetLambdaFunctionRecommendationsCommand.ts @@ -25,7 +25,6 @@ export interface GetLambdaFunctionRecommendationsCommandOutput /** *Returns Lambda function recommendations.
- * *Compute Optimizer generates recommendations for functions that meet a specific set * of requirements. For more information, see the Supported resources and * requirements in the Compute Optimizer User diff --git a/clients/client-compute-optimizer/src/commands/GetRecommendationPreferencesCommand.ts b/clients/client-compute-optimizer/src/commands/GetRecommendationPreferencesCommand.ts new file mode 100644 index 000000000000..9785d2d4647f --- /dev/null +++ b/clients/client-compute-optimizer/src/commands/GetRecommendationPreferencesCommand.ts @@ -0,0 +1,107 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { ComputeOptimizerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComputeOptimizerClient"; +import { GetRecommendationPreferencesRequest, GetRecommendationPreferencesResponse } from "../models/models_0"; +import { + deserializeAws_json1_0GetRecommendationPreferencesCommand, + serializeAws_json1_0GetRecommendationPreferencesCommand, +} from "../protocols/Aws_json1_0"; + +export interface GetRecommendationPreferencesCommandInput extends GetRecommendationPreferencesRequest {} +export interface GetRecommendationPreferencesCommandOutput + extends GetRecommendationPreferencesResponse, + __MetadataBearer {} + +/** + *
Returns existing recommendation preferences, such as enhanced infrastructure + * metrics.
+ *Use the scope parameter to specify which preferences to return. You can
+ * specify to return preferences for an organization, a specific account ID, or a specific
+ * EC2 instance or Auto Scaling group Amazon Resource Name (ARN).
For more information, see Activating + * enhanced infrastructure metrics in the Compute Optimizer User + * Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, GetRecommendationPreferencesCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, GetRecommendationPreferencesCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new GetRecommendationPreferencesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRecommendationPreferencesCommandInput} for command's `input` shape. + * @see {@link GetRecommendationPreferencesCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for ComputeOptimizerClient's `config` shape. + * + */ +export class GetRecommendationPreferencesCommand extends $Command< + GetRecommendationPreferencesCommandInput, + GetRecommendationPreferencesCommandOutput, + ComputeOptimizerClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetRecommendationPreferencesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns the optimization findings for an account.
- * *It returns the number of:
- * *Amazon EC2 instances in an account that are diff --git a/clients/client-compute-optimizer/src/commands/PutRecommendationPreferencesCommand.ts b/clients/client-compute-optimizer/src/commands/PutRecommendationPreferencesCommand.ts new file mode 100644 index 000000000000..7afdd3e26709 --- /dev/null +++ b/clients/client-compute-optimizer/src/commands/PutRecommendationPreferencesCommand.ts @@ -0,0 +1,104 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { ComputeOptimizerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComputeOptimizerClient"; +import { PutRecommendationPreferencesRequest, PutRecommendationPreferencesResponse } from "../models/models_0"; +import { + deserializeAws_json1_0PutRecommendationPreferencesCommand, + serializeAws_json1_0PutRecommendationPreferencesCommand, +} from "../protocols/Aws_json1_0"; + +export interface PutRecommendationPreferencesCommandInput extends PutRecommendationPreferencesRequest {} +export interface PutRecommendationPreferencesCommandOutput + extends PutRecommendationPreferencesResponse, + __MetadataBearer {} + +/** + *
Creates a new recommendation preference or updates an existing recommendation + * preference, such as enhanced infrastructure metrics.
+ *For more information, see Activating + * enhanced infrastructure metrics in the Compute Optimizer User + * Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, PutRecommendationPreferencesCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, PutRecommendationPreferencesCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new PutRecommendationPreferencesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRecommendationPreferencesCommandInput} for command's `input` shape. + * @see {@link PutRecommendationPreferencesCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for ComputeOptimizerClient's `config` shape. + * + */ +export class PutRecommendationPreferencesCommand extends $Command< + PutRecommendationPreferencesCommandInput, + PutRecommendationPreferencesCommandOutput, + ComputeOptimizerClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: PutRecommendationPreferencesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
- * *If the account is a management account of an organization, this action can also be * used to enroll member accounts of the organization.
- * *You must have the appropriate permissions to opt in to Compute Optimizer, to view its * recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.
- * *When you opt in, Compute Optimizer automatically creates a service-linked role in your * account to access its data. For more information, see Using * Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.
diff --git a/clients/client-compute-optimizer/src/commands/index.ts b/clients/client-compute-optimizer/src/commands/index.ts index a1755ad5d529..e53efc4da422 100644 --- a/clients/client-compute-optimizer/src/commands/index.ts +++ b/clients/client-compute-optimizer/src/commands/index.ts @@ -1,3 +1,4 @@ +export * from "./DeleteRecommendationPreferencesCommand"; export * from "./DescribeRecommendationExportJobsCommand"; export * from "./ExportAutoScalingGroupRecommendationsCommand"; export * from "./ExportEBSVolumeRecommendationsCommand"; @@ -7,8 +8,11 @@ export * from "./GetAutoScalingGroupRecommendationsCommand"; export * from "./GetEBSVolumeRecommendationsCommand"; export * from "./GetEC2InstanceRecommendationsCommand"; export * from "./GetEC2RecommendationProjectedMetricsCommand"; +export * from "./GetEffectiveRecommendationPreferencesCommand"; export * from "./GetEnrollmentStatusCommand"; export * from "./GetEnrollmentStatusesForOrganizationCommand"; export * from "./GetLambdaFunctionRecommendationsCommand"; +export * from "./GetRecommendationPreferencesCommand"; export * from "./GetRecommendationSummariesCommand"; +export * from "./PutRecommendationPreferencesCommand"; export * from "./UpdateEnrollmentStatusCommand"; diff --git a/clients/client-compute-optimizer/src/models/models_0.ts b/clients/client-compute-optimizer/src/models/models_0.ts index 211c72c52804..b5858a376cd5 100644 --- a/clients/client-compute-optimizer/src/models/models_0.ts +++ b/clients/client-compute-optimizer/src/models/models_0.ts @@ -41,7 +41,6 @@ export interface AccountEnrollmentStatus { /** *The reason for the account enrollment status.
- * *For example, an account might show a status of Pending because member
* accounts of an organization require more time to be enrolled in the service.
Describes the effective recommendation preferences for a resource.
+ */ +export interface EffectiveRecommendationPreferences { + /** + *Describes the CPU vendor and architecture for an instance or Auto Scaling group + * recommendations.
+ *For example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer + * returns recommendations that consist of Graviton2 instance types only.
+ *A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type + * recommendations only.
+ *A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer + * exports recommendations that consist of Graviton2 instance types only.
+ *Describes the activation status of the enhanced infrastructure metrics + * preference.
+ *A status of Active confirms that the preference is applied in the latest
+ * recommendation refresh, and a status of Inactive confirms that it's not yet
+ * applied.
Describes a utilization metric of a resource, such as an Amazon EC2 * instance.
- * *Compare the utilization metric data of your resource against its projected utilization * metric data to determine the performance difference between your current resource and * the recommended option.
@@ -139,7 +198,6 @@ export enum MetricStatistic { export interface UtilizationMetric { /** *The name of the utilization metric.
- * *The following utilization metrics are available:
*The statistic of the utilization metric.
- * *The Compute Optimizer API, Command Line Interface (CLI), and SDKs
* return utilization metrics using only the Maximum statistic, which is the
* highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the
* Average statistic, which is the value of Sum /
* SampleCount during the specified period. For more information, see
@@ -285,6 +340,79 @@ export namespace UtilizationMetric {
});
}
+export enum Currency {
+ CNY = "CNY",
+ USD = "USD",
+}
+
+/**
+ *
Describes the estimated monthly savings amount possible for a given resource based on + * On-Demand instance pricing
+ *For more information, see Estimated monthly savings and savings opportunities in the + * Compute Optimizer User Guide.
+ */ +export interface EstimatedMonthlySavings { + /** + *The currency of the estimated monthly + * savings.
+ */ + currency?: Currency | string; + + /** + *The value of the estimated monthly savings.
+ */ + value?: number; +} + +export namespace EstimatedMonthlySavings { + /** + * @internal + */ + export const filterSensitiveLog = (obj: EstimatedMonthlySavings): any => ({ + ...obj, + }); +} + +/** + *Describes the savings opportunity for recommendations of a given resource type or for + * the recommendation option of an individual resource.
+ *Savings opportunity represents the estimated monthly savings you can achieve by + * implementing a given Compute Optimizer recommendation.
+ *Savings opportunity data requires that you opt in to Cost Explorer, as well as + * activate Receive Amazon EC2 resource + * recommendations in the Cost Explorer preferences page. That + * creates a connection between Cost Explorer and Compute Optimizer. With this + * connection, Cost Explorer generates savings estimates considering the price of + * existing resources, the price of recommended resources, and historical usage data. + * Estimated monthly savings reflects the projected dollar savings associated with each + * of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost + * with Rightsizing Recommendations in the Cost Management User + * Guide.
+ *The estimated monthly savings possible as a percentage of monthly cost.
+ */ + savingsOpportunityPercentage?: number; + + /** + *An object that describes the estimated monthly savings amount possible based on + * On-Demand instance pricing.
+ */ + estimatedMonthlySavings?: EstimatedMonthlySavings; +} + +export namespace SavingsOpportunity { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SavingsOpportunity): any => ({ + ...obj, + }); +} + /** *Describes a recommendation option for an Auto Scaling group.
*/ @@ -296,7 +424,6 @@ export interface AutoScalingGroupRecommendationOption { /** *An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.
- * *The Cpu and Memory metrics are the only projected
* utilization metrics returned. Additionally, the Memory metric is
@@ -310,7 +437,6 @@ export interface AutoScalingGroupRecommendationOption {
/**
*
The performance risk of the Auto Scaling group configuration * recommendation.
- * *Performance risk indicates the likelihood of the recommended instance type not meeting * the resource needs of your workload. Compute Optimizer calculates an individual * performance risk score for each specification of the recommended instance, including @@ -319,7 +445,6 @@ export interface AutoScalingGroupRecommendationOption { * The performance * risk of the recommended instance is calculated as the maximum performance risk score * across the analyzed resource specifications.
- * *The value ranges from 0 - 4, with 0 meaning
* that the recommended resource is predicted to always provide enough hardware capability.
* The higher the performance risk is, the more likely you should validate whether the
@@ -330,10 +455,16 @@ export interface AutoScalingGroupRecommendationOption {
/**
*
The rank of the Auto Scaling group recommendation option.
- * *The top recommendation option is ranked as 1.
An object that describes the savings opportunity for the Auto Scaling group + * recommendation option. Savings opportunity includes the estimated monthly savings amount + * and percentage.
+ */ + savingsOpportunity?: SavingsOpportunity; } export namespace AutoScalingGroupRecommendationOption { @@ -366,9 +497,7 @@ export interface AutoScalingGroupRecommendation { /** *The finding classification of the Auto Scaling group.
- * *Findings for Auto Scaling groups include:
- * *@@ -415,10 +544,22 @@ export interface AutoScalingGroupRecommendation { recommendationOptions?: AutoScalingGroupRecommendationOption[]; /** - *
The timestamp of when the Auto Scaling group recommendation was last - * refreshed.
+ *The timestamp of when the Auto Scaling group recommendation was last + * generated.
*/ lastRefreshTimestamp?: Date; + + /** + *The risk of the current Auto Scaling group not meeting the performance needs of + * its workloads. The higher the risk, the more likely the current Auto Scaling group + * configuration has insufficient capacity and cannot meet workload requirements.
+ */ + currentPerformanceRisk?: CurrentPerformanceRisk | string; + + /** + *An object that describes the effective recommendation preferences for the Auto Scaling group.
+ */ + effectiveRecommendationPreferences?: EffectiveRecommendationPreferences; } export namespace AutoScalingGroupRecommendation { @@ -430,6 +571,273 @@ export namespace AutoScalingGroupRecommendation { }); } +export enum RecommendationPreferenceName { + ENHANCED_INFRASTRUCTURE_METRICS = "EnhancedInfrastructureMetrics", +} + +export enum ResourceType { + AUTO_SCALING_GROUP = "AutoScalingGroup", + EBS_VOLUME = "EbsVolume", + EC2_INSTANCE = "Ec2Instance", + LAMBDA_FUNCTION = "LambdaFunction", +} + +export enum ScopeName { + ACCOUNT_ID = "AccountId", + ORGANIZATION = "Organization", + RESOURCE_ARN = "ResourceArn", +} + +/** + *Describes the scope of a recommendation preference.
+ *Recommendation preferences can be created at the organization level (for management + * accounts of an organization only), account level, and resource level. For more + * information, see Activating + * enhanced infrastructure metrics in the Compute Optimizer User + * Guide.
+ *You cannot create recommendation preferences for Auto Scaling groups at the
+ * organization and account levels. You can create recommendation preferences for
+ * Auto Scaling groups only at the resource level by specifying a scope name
+ * of ResourceArn and a scope value of the Auto Scaling group Amazon
+ * Resource Name (ARN). This will configure the preference for all instances that are
+ * part of the specified the Auto Scaling group.
The name of the scope.
+ *The following scopes are possible:
+ *
+ * Organization - Specifies that the recommendation preference
+ * applies at the organization level, for all member accounts of an
+ * organization.
+ * AccountId - Specifies that the recommendation preference applies
+ * at the account level, for all resources of a given resource type in an
+ * account.
+ * ResourceArn - Specifies that the recommendation preference
+ * applies at the individual resource level.
The value of the scope.
+ *If you specified the name of the scope as:
+ * Organization - The value must be
+ * ALL_ACCOUNTS.
+ * AccountId - The value must be a 12-digit Amazon Web Services account ID.
+ * ResourceArn - The value must be the Amazon Resource
+ * Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
+ */ + value?: string; +} + +export namespace Scope { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Scope): any => ({ + ...obj, + }); +} + +export interface DeleteRecommendationPreferencesRequest { + /** + *The target resource type of the recommendation preference to delete.
+ *The Ec2Instance option encompasses standalone instances and instances
+ * that are part of Auto Scaling groups. The AutoScalingGroup option
+ * encompasses only instances that are part of an Auto Scaling group.
An object that describes the scope of the recommendation preference to delete.
+ *You can delete recommendation preferences that are created at the organization level + * (for management accounts of an organization only), account level, and resource level. + * For more information, see Activating + * enhanced infrastructure metrics in the Compute Optimizer User + * Guide.
+ */ + scope?: Scope; + + /** + *The name of the recommendation preference to delete.
+ *Enhanced infrastructure metrics (EnhancedInfrastructureMetrics) is the
+ * only feature that can be activated through preferences. Therefore, it is also the only
+ * recommendation preference that can be deleted.
An internal error has occurred. Try your call again.
+ */ +export interface InternalServerException extends __SmithyException, $MetadataBearer { + name: "InternalServerException"; + $fault: "server"; + message?: string; +} + +export namespace InternalServerException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InternalServerException): any => ({ + ...obj, + }); +} + +/** + *The value supplied for the input parameter is out of range or not valid.
+ */ +export interface InvalidParameterValueException extends __SmithyException, $MetadataBearer { + name: "InvalidParameterValueException"; + $fault: "client"; + message?: string; +} + +export namespace InvalidParameterValueException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ + ...obj, + }); +} + +/** + *The request must contain either a valid (registered) Amazon Web Services access key ID + * or X.509 certificate.
+ */ +export interface MissingAuthenticationToken extends __SmithyException, $MetadataBearer { + name: "MissingAuthenticationToken"; + $fault: "client"; + message?: string; +} + +export namespace MissingAuthenticationToken { + /** + * @internal + */ + export const filterSensitiveLog = (obj: MissingAuthenticationToken): any => ({ + ...obj, + }); +} + +/** + *The account is not opted in to Compute Optimizer.
+ */ +export interface OptInRequiredException extends __SmithyException, $MetadataBearer { + name: "OptInRequiredException"; + $fault: "client"; + message?: string; +} + +export namespace OptInRequiredException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: OptInRequiredException): any => ({ + ...obj, + }); +} + +/** + *A resource that is required for the action doesn't exist.
+ */ +export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer { + name: "ResourceNotFoundException"; + $fault: "client"; + message?: string; +} + +export namespace ResourceNotFoundException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ + ...obj, + }); +} + +/** + *The request has failed due to a temporary failure of the server.
+ */ +export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer { + name: "ServiceUnavailableException"; + $fault: "server"; + message?: string; +} + +export namespace ServiceUnavailableException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ + ...obj, + }); +} + +/** + *The request was denied due to request throttling.
+ */ +export interface ThrottlingException extends __SmithyException, $MetadataBearer { + name: "ThrottlingException"; + $fault: "client"; + message: string | undefined; +} + +export namespace ThrottlingException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ThrottlingException): any => ({ + ...obj, + }); +} + export enum JobFilterName { JOB_STATUS = "JobStatus", RESOURCE_TYPE = "ResourceType", @@ -439,7 +847,6 @@ export enum JobFilterName { *Describes a filter that returns a more specific list of recommendation export jobs. * Use this filter with the DescribeRecommendationExportJobs * action.
- * *You can use EBSFilter with the GetEBSVolumeRecommendations action,
* LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and Filter with
* the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
The name of the filter.
- * *Specify ResourceType to return export jobs of a specific resource type
* (for example, Ec2Instance).
Specify JobStatus to return export jobs with a specific status (e.g,
* Complete).
The value of the filter.
- * *The valid values for this parameter are as follows, depending on what you specify for
* the name parameter:
Specify Ec2Instance or AutoScalingGroup if you
@@ -491,9 +894,7 @@ export namespace JobFilter {
export interface DescribeRecommendationExportJobsRequest {
/**
*
The identification numbers of the export jobs to return.
- * *An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.
- * *All export jobs created in the last seven days are returned if this parameter is * omitted.
*/ @@ -512,7 +913,6 @@ export interface DescribeRecommendationExportJobsRequest { /** *The maximum number of export jobs to return with a single request.
- * *To retrieve the remaining results, make another request with the returned
* nextToken value.
The Amazon S3 bucket key of an export file.
- * *The key uniquely identifies the object, or export file, in the S3 bucket.
*/ key?: string; /** *The Amazon S3 bucket key of a metadata file.
- * *The key uniquely identifies the object, or metadata file, in the S3 bucket.
*/ metadataKey?: string; @@ -584,13 +982,6 @@ export namespace ExportDestination { }); } -export enum ResourceType { - AUTO_SCALING_GROUP = "AutoScalingGroup", - EBS_VOLUME = "EbsVolume", - EC2_INSTANCE = "Ec2Instance", - LAMBDA_FUNCTION = "LambdaFunction", -} - export enum JobStatus { COMPLETE = "Complete", FAILED = "Failed", @@ -600,12 +991,8 @@ export enum JobStatus { /** *Describes a recommendation export job.
- * - * *Use the DescribeRecommendationExportJobs action to view your * recommendation export jobs.
- * - * *Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your * recommendations.
*/ @@ -663,7 +1050,6 @@ export interface DescribeRecommendationExportJobsResponse { /** *The token to use to advance to the next page of export jobs.
- * *This value is null when there are no more pages of export jobs to return.
*/ nextToken?: string; @@ -678,133 +1064,6 @@ export namespace DescribeRecommendationExportJobsResponse { }); } -/** - *An internal error has occurred. Try your call again.
- */ -export interface InternalServerException extends __SmithyException, $MetadataBearer { - name: "InternalServerException"; - $fault: "server"; - message?: string; -} - -export namespace InternalServerException { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InternalServerException): any => ({ - ...obj, - }); -} - -/** - *The value supplied for the input parameter is out of range or not valid.
- */ -export interface InvalidParameterValueException extends __SmithyException, $MetadataBearer { - name: "InvalidParameterValueException"; - $fault: "client"; - message?: string; -} - -export namespace InvalidParameterValueException { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ - ...obj, - }); -} - -/** - *The request must contain either a valid (registered) Amazon Web Services access key ID - * or X.509 certificate.
- */ -export interface MissingAuthenticationToken extends __SmithyException, $MetadataBearer { - name: "MissingAuthenticationToken"; - $fault: "client"; - message?: string; -} - -export namespace MissingAuthenticationToken { - /** - * @internal - */ - export const filterSensitiveLog = (obj: MissingAuthenticationToken): any => ({ - ...obj, - }); -} - -/** - *The account is not opted in to Compute Optimizer.
- */ -export interface OptInRequiredException extends __SmithyException, $MetadataBearer { - name: "OptInRequiredException"; - $fault: "client"; - message?: string; -} - -export namespace OptInRequiredException { - /** - * @internal - */ - export const filterSensitiveLog = (obj: OptInRequiredException): any => ({ - ...obj, - }); -} - -/** - *A resource that is required for the action doesn't exist.
- */ -export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer { - name: "ResourceNotFoundException"; - $fault: "client"; - message?: string; -} - -export namespace ResourceNotFoundException { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ - ...obj, - }); -} - -/** - *The request has failed due to a temporary failure of the server.
- */ -export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer { - name: "ServiceUnavailableException"; - $fault: "server"; - message?: string; -} - -export namespace ServiceUnavailableException { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ - ...obj, - }); -} - -/** - *The request was denied due to request throttling.
- */ -export interface ThrottlingException extends __SmithyException, $MetadataBearer { - name: "ThrottlingException"; - $fault: "client"; - message: string | undefined; -} - -export namespace ThrottlingException { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ThrottlingException): any => ({ - ...obj, - }); -} - export enum ExportableAutoScalingGroupField { ACCOUNT_ID = "AccountId", AUTO_SCALING_GROUP_ARN = "AutoScalingGroupArn", @@ -816,10 +1075,13 @@ export enum ExportableAutoScalingGroupField { CURRENT_MEMORY = "CurrentMemory", CURRENT_NETWORK = "CurrentNetwork", CURRENT_ON_DEMAND_PRICE = "CurrentOnDemandPrice", + CURRENT_PERFORMANCE_RISK = "CurrentPerformanceRisk", CURRENT_STANDARD_ONE_YEAR_NO_UPFRONT_RESERVED_PRICE = "CurrentStandardOneYearNoUpfrontReservedPrice", CURRENT_STANDARD_THREE_YEAR_NO_UPFRONT_RESERVED_PRICE = "CurrentStandardThreeYearNoUpfrontReservedPrice", CURRENT_STORAGE = "CurrentStorage", CURRENT_VCPUS = "CurrentVCpus", + EFFECTIVE_RECOMMENDATION_PREFERENCES_CPU_VENDOR_ARCHITECTURES = "EffectiveRecommendationPreferencesCpuVendorArchitectures", + EFFECTIVE_RECOMMENDATION_PREFERENCES_ENHANCED_INFRASTRUCTURE_METRICS = "EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics", FINDING = "Finding", LAST_REFRESH_TIMESTAMP = "LastRefreshTimestamp", LOOKBACK_PERIOD_IN_DAYS = "LookbackPeriodInDays", @@ -827,12 +1089,15 @@ export enum ExportableAutoScalingGroupField { RECOMMENDATION_OPTIONS_CONFIGURATION_INSTANCE_TYPE = "RecommendationOptionsConfigurationInstanceType", RECOMMENDATION_OPTIONS_CONFIGURATION_MAX_SIZE = "RecommendationOptionsConfigurationMaxSize", RECOMMENDATION_OPTIONS_CONFIGURATION_MIN_SIZE = "RecommendationOptionsConfigurationMinSize", + RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY = "RecommendationOptionsEstimatedMonthlySavingsCurrency", + RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE = "RecommendationOptionsEstimatedMonthlySavingsValue", RECOMMENDATION_OPTIONS_MEMORY = "RecommendationOptionsMemory", RECOMMENDATION_OPTIONS_NETWORK = "RecommendationOptionsNetwork", RECOMMENDATION_OPTIONS_ON_DEMAND_PRICE = "RecommendationOptionsOnDemandPrice", RECOMMENDATION_OPTIONS_PERFORMANCE_RISK = "RecommendationOptionsPerformanceRisk", RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_CPU_MAXIMUM = "RecommendationOptionsProjectedUtilizationMetricsCpuMaximum", RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_MEMORY_MAXIMUM = "RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum", + RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE = "RecommendationOptionsSavingsOpportunityPercentage", RECOMMENDATION_OPTIONS_STANDARD_ONE_YEAR_NO_UPFRONT_RESERVED_PRICE = "RecommendationOptionsStandardOneYearNoUpfrontReservedPrice", RECOMMENDATION_OPTIONS_STANDARD_THREE_YEAR_NO_UPFRONT_RESERVED_PRICE = "RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice", RECOMMENDATION_OPTIONS_STORAGE = "RecommendationOptionsStorage", @@ -866,7 +1131,6 @@ export enum FilterName { /** *Describes a filter that returns a more specific list of recommendations. Use this * filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
- * *You can use EBSFilter with the GetEBSVolumeRecommendations action,
* LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and JobFilter with
* the DescribeRecommendationExportJobs action.
The name of the filter.
- * *Specify Finding to return recommendations with a specific finding
* classification (for example, Underprovisioned).
Specify RecommendationSourceType to return recommendations of a specific
* resource type (for example, Ec2Instance).
Specify FindingReasonCodes to return recommendations with a specific
* finding reason code (for example, CPUUnderprovisioned).
The value of the filter.
- * *The valid values for this parameter are as follows, depending on what you specify for
* the name parameter and the resource type that you wish to filter results
* for:
Specify Optimized or NotOptimized if you specify the
@@ -913,7 +1172,6 @@ export interface Filter {
*
Specify one of the following options if you specify the name
* parameter as FindingReasonCodes:
@@ -1069,20 +1327,13 @@ export namespace Filter { }); } -export enum CpuVendorArchitecture { - AWS_ARM64 = "AWS_ARM64", - CURRENT = "CURRENT", -} - /** - *
Describes preferences for recommendations.
+ *Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, and GetEC2RecommendationProjectedMetrics request.
*/ export interface RecommendationPreferences { /** *Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
- * *For example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer @@ -1113,7 +1364,6 @@ export namespace RecommendationPreferences { /** *
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and * key prefix for a recommendations export job.
- * *You must create the destination Amazon S3 bucket for your recommendations * export before you create the export job. Compute Optimizer does not create the S3 bucket * for you. After you create the S3 bucket, ensure that it has the required permission @@ -1148,16 +1398,12 @@ export interface ExportAutoScalingGroupRecommendationsRequest { /** *
The IDs of the Amazon Web Services accounts for which to export Auto Scaling group * recommendations.
- * *If your account is the management account of an organization, use this parameter to * specify the member account for which you want to export recommendations.
- * *This parameter cannot be specified together with the include member accounts * parameter. The parameters are mutually exclusive.
- * *Recommendations for member accounts are not included in the export if this parameter, * or the include member accounts parameter, is omitted.
- * *You can specify multiple account IDs per request.
*/ accountIds?: string[]; @@ -1177,20 +1423,18 @@ export interface ExportAutoScalingGroupRecommendationsRequest { /** *An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket * name and key prefix for the export job.
- * *You must create the destination Amazon S3 bucket for your recommendations * export before you create the export job. Compute Optimizer does not create the S3 bucket * for you. After you create the S3 bucket, ensure that it has the required permissions - * policy to allow Compute Optimizer to write the export file to it. If you plan to - * specify an object prefix when you create the export job, you must include the object - * prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the + * policy to allow Compute Optimizer to write the export file to it. If you plan to specify + * an object prefix when you create the export job, you must include the object prefix in + * the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the * Compute Optimizer User Guide.
*/ s3DestinationConfig: S3DestinationConfig | undefined; /** *The format of the export file.
- * *The only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of * the organization if your account is the management account of an organization.
- * *The member accounts must also be opted in to Compute Optimizer, and trusted access for * Compute Optimizer must be enabled in the organization account. For more information, * see Compute Optimizer and Amazon Web Services Organizations trusted access in the * Compute Optimizer User Guide.
- * *Recommendations for member accounts of the organization are not included in the export * file if this parameter is omitted.
- * *This parameter cannot be specified together with the account IDs parameter. The * parameters are mutually exclusive.
- * *Recommendations for member accounts are not included in the export if this parameter, * or the account IDs parameter, is omitted.
*/ @@ -1234,7 +1474,6 @@ export namespace ExportAutoScalingGroupRecommendationsRequest { export interface ExportAutoScalingGroupRecommendationsResponse { /** *The identification number of the export job.
- * *Use the DescribeRecommendationExportJobs action, and specify the job * ID to view the status of an export job.
*/ @@ -1283,6 +1522,7 @@ export enum ExportableVolumeField { CURRENT_CONFIGURATION_VOLUME_SIZE = "CurrentConfigurationVolumeSize", CURRENT_CONFIGURATION_VOLUME_TYPE = "CurrentConfigurationVolumeType", CURRENT_MONTHLY_PRICE = "CurrentMonthlyPrice", + CURRENT_PERFORMANCE_RISK = "CurrentPerformanceRisk", FINDING = "Finding", LAST_REFRESH_TIMESTAMP = "LastRefreshTimestamp", LOOKBACK_PERIOD_IN_DAYS = "LookbackPeriodInDays", @@ -1292,8 +1532,11 @@ export enum ExportableVolumeField { RECOMMENDATION_OPTIONS_CONFIGURATION_VOLUME_BURST_THROUGHPUT = "RecommendationOptionsConfigurationVolumeBurstThroughput", RECOMMENDATION_OPTIONS_CONFIGURATION_VOLUME_SIZE = "RecommendationOptionsConfigurationVolumeSize", RECOMMENDATION_OPTIONS_CONFIGURATION_VOLUME_TYPE = "RecommendationOptionsConfigurationVolumeType", + RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY = "RecommendationOptionsEstimatedMonthlySavingsCurrency", + RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE = "RecommendationOptionsEstimatedMonthlySavingsValue", RECOMMENDATION_OPTIONS_MONTHLY_PRICE = "RecommendationOptionsMonthlyPrice", RECOMMENDATION_OPTIONS_PERFORMANCE_RISK = "RecommendationOptionsPerformanceRisk", + RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE = "RecommendationOptionsSavingsOpportunityPercentage", UTILIZATION_METRICS_VOLUME_READ_BYTES_PER_SECOND_MAXIMUM = "UtilizationMetricsVolumeReadBytesPerSecondMaximum", UTILIZATION_METRICS_VOLUME_READ_OPS_PER_SECOND_MAXIMUM = "UtilizationMetricsVolumeReadOpsPerSecondMaximum", UTILIZATION_METRICS_VOLUME_WRITE_BYTES_PER_SECOND_MAXIMUM = "UtilizationMetricsVolumeWriteBytesPerSecondMaximum", @@ -1308,7 +1551,6 @@ export enum EBSFilterName { /** *Describes a filter that returns a more specific list of Amazon Elastic Block Store * (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.
- * *You can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with the
* DescribeRecommendationExportJobs action, and Filter
* with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
The name of the filter.
- * *Specify Finding to return recommendations with a specific finding
* classification (for example, NotOptimized).
The value of the filter.
- * *The valid values are Optimized, or NotOptimized.
The IDs of the Amazon Web Services accounts for which to export Amazon EBS * volume recommendations.
- * *If your account is the management account of an organization, use this parameter to * specify the member account for which you want to export recommendations.
- * *This parameter cannot be specified together with the include member accounts * parameter. The parameters are mutually exclusive.
- * *Recommendations for member accounts are not included in the export if this parameter, * or the include member accounts parameter, is omitted.
- * *You can specify multiple account IDs per request.
*/ accountIds?: string[]; @@ -1372,7 +1608,6 @@ export interface ExportEBSVolumeRecommendationsRequest { /** *Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and * key prefix for a recommendations export job.
- * *You must create the destination Amazon S3 bucket for your recommendations * export before you create the export job. Compute Optimizer does not create the S3 bucket * for you. After you create the S3 bucket, ensure that it has the required permission @@ -1385,7 +1620,6 @@ export interface ExportEBSVolumeRecommendationsRequest { /** *
The format of the export file.
- * *The only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of * the organization if your account is the management account of an organization.
- * *The member accounts must also be opted in to Compute Optimizer, and trusted access for * Compute Optimizer must be enabled in the organization account. For more information, * see Compute Optimizer and Amazon Web Services Organizations trusted access in the * Compute Optimizer User Guide.
- * *Recommendations for member accounts of the organization are not included in the export * file if this parameter is omitted.
- * *This parameter cannot be specified together with the account IDs parameter. The * parameters are mutually exclusive.
- * *Recommendations for member accounts are not included in the export if this parameter, * or the account IDs parameter, is omitted.
*/ @@ -1423,7 +1653,6 @@ export namespace ExportEBSVolumeRecommendationsRequest { export interface ExportEBSVolumeRecommendationsResponse { /** *The identification number of the export job.
- * *Use the DescribeRecommendationExportJobs action, and specify the job * ID to view the status of an export job.
*/ @@ -1451,10 +1680,13 @@ export enum ExportableInstanceField { CURRENT_MEMORY = "CurrentMemory", CURRENT_NETWORK = "CurrentNetwork", CURRENT_ON_DEMAND_PRICE = "CurrentOnDemandPrice", + CURRENT_PERFORMANCE_RISK = "CurrentPerformanceRisk", CURRENT_STANDARD_ONE_YEAR_NO_UPFRONT_RESERVED_PRICE = "CurrentStandardOneYearNoUpfrontReservedPrice", CURRENT_STANDARD_THREE_YEAR_NO_UPFRONT_RESERVED_PRICE = "CurrentStandardThreeYearNoUpfrontReservedPrice", CURRENT_STORAGE = "CurrentStorage", CURRENT_VCPUS = "CurrentVCpus", + EFFECTIVE_RECOMMENDATION_PREFERENCES_CPU_VENDOR_ARCHITECTURES = "EffectiveRecommendationPreferencesCpuVendorArchitectures", + EFFECTIVE_RECOMMENDATION_PREFERENCES_ENHANCED_INFRASTRUCTURE_METRICS = "EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics", FINDING = "Finding", Finding_Reason_Codes = "FindingReasonCodes", INSTANCE_ARN = "InstanceArn", @@ -1463,6 +1695,8 @@ export enum ExportableInstanceField { LOOKBACK_PERIOD_IN_DAYS = "LookbackPeriodInDays", RECOMMENDATIONS_SOURCES_RECOMMENDATION_SOURCE_ARN = "RecommendationsSourcesRecommendationSourceArn", RECOMMENDATIONS_SOURCES_RECOMMENDATION_SOURCE_TYPE = "RecommendationsSourcesRecommendationSourceType", + RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY = "RecommendationOptionsEstimatedMonthlySavingsCurrency", + RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE = "RecommendationOptionsEstimatedMonthlySavingsValue", RECOMMENDATION_OPTIONS_INSTANCE_TYPE = "RecommendationOptionsInstanceType", RECOMMENDATION_OPTIONS_MEMORY = "RecommendationOptionsMemory", RECOMMENDATION_OPTIONS_NETWORK = "RecommendationOptionsNetwork", @@ -1471,6 +1705,7 @@ export enum ExportableInstanceField { RECOMMENDATION_OPTIONS_PLATFORM_DIFFERENCES = "RecommendationOptionsPlatformDifferences", RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_CPU_MAXIMUM = "RecommendationOptionsProjectedUtilizationMetricsCpuMaximum", RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_MEMORY_MAXIMUM = "RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum", + RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE = "RecommendationOptionsSavingsOpportunityPercentage", RECOMMENDATION_OPTIONS_STANDARD_ONE_YEAR_NO_UPFRONT_RESERVED_PRICE = "RecommendationOptionsStandardOneYearNoUpfrontReservedPrice", RECOMMENDATION_OPTIONS_STANDARD_THREE_YEAR_NO_UPFRONT_RESERVED_PRICE = "RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice", RECOMMENDATION_OPTIONS_STORAGE = "RecommendationOptionsStorage", @@ -1495,16 +1730,12 @@ export interface ExportEC2InstanceRecommendationsRequest { /** *The IDs of the Amazon Web Services accounts for which to export instance * recommendations.
- * *If your account is the management account of an organization, use this parameter to * specify the member account for which you want to export recommendations.
- * *This parameter cannot be specified together with the include member accounts * parameter. The parameters are mutually exclusive.
- * *Recommendations for member accounts are not included in the export if this parameter, * or the include member accounts parameter, is omitted.
- * *You can specify multiple account IDs per request.
*/ accountIds?: string[]; @@ -1525,20 +1756,19 @@ export interface ExportEC2InstanceRecommendationsRequest { /** *An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket * name and key prefix for the export job.
- * *You must create the destination Amazon S3 bucket for your recommendations * export before you create the export job. Compute Optimizer does not create the S3 bucket * for you. After you create the S3 bucket, ensure that it has the required permissions - * policy policy to allow Compute Optimizer to write the export file to it. If you plan to + * policy to allow Compute Optimizer to write the export file to it. + * If you plan to * specify an object prefix when you create the export job, you must include the object - * prefix in the that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the + * prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the * Compute Optimizer User Guide.
*/ s3DestinationConfig: S3DestinationConfig | undefined; /** *The format of the export file.
- * *The only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of * the organization if your account is the management account of an organization.
- * *The member accounts must also be opted in to Compute Optimizer, and trusted access for * Compute Optimizer must be enabled in the organization account. For more information, * see Compute Optimizer and Amazon Web Services Organizations trusted access in the * Compute Optimizer User Guide.
- * *Recommendations for member accounts of the organization are not included in the export * file if this parameter is omitted.
- * *Recommendations for member accounts are not included in the export if this parameter, * or the account IDs parameter, is omitted.
*/ @@ -1579,7 +1806,6 @@ export namespace ExportEC2InstanceRecommendationsRequest { export interface ExportEC2InstanceRecommendationsResponse { /** *The identification number of the export job.
- * *Use the DescribeRecommendationExportJobs action, and specify the job * ID to view the status of an export job.
*/ @@ -1607,6 +1833,7 @@ export enum ExportableLambdaFunctionField { CURRENT_CONFIGURATION_TIMEOUT = "CurrentConfigurationTimeout", CURRENT_COST_AVERAGE = "CurrentCostAverage", CURRENT_COST_TOTAL = "CurrentCostTotal", + CURRENT_PERFORMANCE_RISK = "CurrentPerformanceRisk", FINDING = "Finding", FINDING_REASON_CODES = "FindingReasonCodes", FUNCTION_ARN = "FunctionArn", @@ -1617,9 +1844,12 @@ export enum ExportableLambdaFunctionField { RECOMMENDATION_OPTIONS_CONFIGURATION_MEMORY_SIZE = "RecommendationOptionsConfigurationMemorySize", RECOMMENDATION_OPTIONS_COST_HIGH = "RecommendationOptionsCostHigh", RECOMMENDATION_OPTIONS_COST_LOW = "RecommendationOptionsCostLow", + RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY = "RecommendationOptionsEstimatedMonthlySavingsCurrency", + RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE = "RecommendationOptionsEstimatedMonthlySavingsValue", RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_DURATION_EXPECTED = "RecommendationOptionsProjectedUtilizationMetricsDurationExpected", RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_DURATION_LOWER_BOUND = "RecommendationOptionsProjectedUtilizationMetricsDurationLowerBound", RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_DURATION_UPPER_BOUND = "RecommendationOptionsProjectedUtilizationMetricsDurationUpperBound", + RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE = "RecommendationOptionsSavingsOpportunityPercentage", UTILIZATION_METRICS_DURATION_AVERAGE = "UtilizationMetricsDurationAverage", UTILIZATION_METRICS_DURATION_MAXIMUM = "UtilizationMetricsDurationMaximum", UTILIZATION_METRICS_MEMORY_AVERAGE = "UtilizationMetricsMemoryAverage", @@ -1634,7 +1864,6 @@ export enum LambdaFunctionRecommendationFilterName { /** *Describes a filter that returns a more specific list of Lambda * function recommendations. Use this filter with the GetLambdaFunctionRecommendations action.
- * *You can use EBSFilter with the GetEBSVolumeRecommendations action, JobFilter with the
* DescribeRecommendationExportJobs action, and Filter
* with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
The name of the filter.
- * *Specify Finding to return recommendations with a specific finding
* classification (for example, NotOptimized).
Specify FindingReasonCode to return recommendations with a specific
* finding reason code (for example, MemoryUnderprovisioned).
The value of the filter.
- * *The valid values for this parameter are as follows, depending on what you specify for
* the name parameter:
Specify Optimized, NotOptimized, or
@@ -1687,16 +1912,12 @@ export interface ExportLambdaFunctionRecommendationsRequest {
/**
*
The IDs of the Amazon Web Services accounts for which to export Lambda * function recommendations.
- * *If your account is the management account of an organization, use this parameter to * specify the member account for which you want to export recommendations.
- * *This parameter cannot be specified together with the include member accounts * parameter. The parameters are mutually exclusive.
- * *Recommendations for member accounts are not included in the export if this parameter, * or the include member accounts parameter, is omitted.
- * *You can specify multiple account IDs per request.
*/ accountIds?: string[]; @@ -1716,7 +1937,6 @@ export interface ExportLambdaFunctionRecommendationsRequest { /** *Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and * key prefix for a recommendations export job.
- * *You must create the destination Amazon S3 bucket for your recommendations * export before you create the export job. Compute Optimizer does not create the S3 bucket * for you. After you create the S3 bucket, ensure that it has the required permission @@ -1729,7 +1949,6 @@ export interface ExportLambdaFunctionRecommendationsRequest { /** *
The format of the export file.
- * *The only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of * the organization if your account is the management account of an organization.
- * *The member accounts must also be opted in to Compute Optimizer, and trusted access for * Compute Optimizer must be enabled in the organization account. For more information, * see Compute Optimizer and Amazon Web Services Organizations trusted access in the * Compute Optimizer User Guide.
- * *Recommendations for member accounts of the organization are not included in the export * file if this parameter is omitted.
- * *This parameter cannot be specified together with the account IDs parameter. The * parameters are mutually exclusive.
- * *Recommendations for member accounts are not included in the export if this parameter, * or the account IDs parameter, is omitted.
*/ @@ -1767,7 +1982,6 @@ export namespace ExportLambdaFunctionRecommendationsRequest { export interface ExportLambdaFunctionRecommendationsResponse { /** *The identification number of the export job.
- * *Use the DescribeRecommendationExportJobs action, and specify the job * ID to view the status of an export job.
*/ @@ -1793,11 +2007,9 @@ export interface GetAutoScalingGroupRecommendationsRequest { /** *The ID of the Amazon Web Services account for which to return Auto Scaling group * recommendations.
- * *If your account is the management account of an organization, use this parameter to * specify the member account for which you want to return Auto Scaling group * recommendations.
- * *Only one account ID can be specified per request.
*/ accountIds?: string[]; @@ -1817,7 +2029,6 @@ export interface GetAutoScalingGroupRecommendationsRequest { /** *The maximum number of Auto Scaling group recommendations to return with a single * request.
- * *To retrieve the remaining results, make another request with the returned
* nextToken value.
Describes an error experienced when getting recommendations.
- * *For example, an error is returned if you request recommendations for an unsupported * Auto Scaling group, or if you request recommendations for an instance of an * unsupported instance family.
@@ -1881,7 +2091,6 @@ export interface GetAutoScalingGroupRecommendationsResponse { /** *The token to use to advance to the next page of Auto Scaling group * recommendations.
- * *This value is null when there are no more pages of Auto Scaling group * recommendations to return.
*/ @@ -1894,7 +2103,6 @@ export interface GetAutoScalingGroupRecommendationsResponse { /** *An array of objects that describe errors of the request.
- * *For example, an error is returned if you request recommendations for an unsupported * Auto Scaling group.
*/ @@ -1924,7 +2132,6 @@ export interface GetEBSVolumeRecommendationsRequest { /** *The maximum number of volume recommendations to return with a single request.
- * *To retrieve the remaining results, make another request with the returned
* nextToken value.
The ID of the Amazon Web Services account for which to return volume * recommendations.
- * *If your account is the management account of an organization, use this parameter to * specify the member account for which you want to return volume recommendations.
- * *Only one account ID can be specified per request.
*/ accountIds?: string[]; @@ -1964,7 +2169,6 @@ export namespace GetEBSVolumeRecommendationsRequest { export interface VolumeConfiguration { /** *The volume type.
- * *This can be gp2 for General Purpose SSD, io1 or
* io2 for Provisioned IOPS SSD, st1 for Throughput Optimized
* HDD, sc1 for Cold HDD, or standard for Magnetic
@@ -2022,7 +2226,6 @@ export enum EBSMetricName {
/**
*
Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS) * volume.
- * *Compare the utilization metric data of your resource against its projected utilization * metric data to determine the performance difference between your current resource and * the recommended option.
@@ -2030,7 +2233,6 @@ export enum EBSMetricName { export interface EBSUtilizationMetric { /** *The name of the utilization metric.
- * *The following utilization metrics are available:
*The statistic of the utilization metric.
- * *The Compute Optimizer API, Command Line Interface (CLI), and SDKs
* return utilization metrics using only the Maximum statistic, which is the
* highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the
* Average statistic, which is the value of Sum /
* SampleCount during the specified period. For more information, see
@@ -2106,10 +2306,8 @@ export interface VolumeRecommendationOption {
/**
*
The performance risk of the volume recommendation option.
- * *Performance risk is the likelihood of the recommended volume type meeting the * performance requirement of your workload.
- * *The value ranges from 0 - 4, with 0 meaning
* that the recommended resource is predicted to always provide enough hardware capability.
* The higher the performance risk is, the more likely you should validate whether the
@@ -2120,10 +2318,16 @@ export interface VolumeRecommendationOption {
/**
*
The rank of the volume recommendation option.
- * *The top recommendation option is ranked as 1.
An object that describes the savings opportunity for the EBS volume recommendation + * option. Savings opportunity includes the estimated monthly savings amount and + * percentage.
+ */ + savingsOpportunity?: SavingsOpportunity; } export namespace VolumeRecommendationOption { @@ -2156,7 +2360,6 @@ export interface VolumeRecommendation { /** *The finding classification of the volume.
- * *Findings for volumes include:
*The timestamp of when the volume recommendation was last refreshed.
+ *The timestamp of when the volume recommendation was last generated.
*/ lastRefreshTimestamp?: Date; + + /** + *The risk of the current EBS volume not meeting the performance needs of its workloads. + * The higher the risk, the more likely the current EBS volume doesn't have sufficient + * capacity.
+ */ + currentPerformanceRisk?: CurrentPerformanceRisk | string; } export namespace VolumeRecommendation { @@ -2216,7 +2426,6 @@ export namespace VolumeRecommendation { export interface GetEBSVolumeRecommendationsResponse { /** *The token to use to advance to the next page of volume recommendations.
- * *This value is null when there are no more pages of volume recommendations to * return.
*/ @@ -2229,7 +2438,6 @@ export interface GetEBSVolumeRecommendationsResponse { /** *An array of objects that describe errors of the request.
- * *For example, an error is returned if you request recommendations for an unsupported * volume.
*/ @@ -2259,7 +2467,6 @@ export interface GetEC2InstanceRecommendationsRequest { /** *The maximum number of instance recommendations to return with a single request.
- * *To retrieve the remaining results, make another request with the returned
* nextToken value.
The ID of the Amazon Web Services account for which to return instance * recommendations.
- * *If your account is the management account of an organization, use this parameter to * specify the member account for which you want to return instance recommendations.
- * *Only one account ID can be specified per request.
*/ accountIds?: string[]; @@ -2338,7 +2543,6 @@ export interface InstanceRecommendationOption { /** *An array of objects that describe the projected utilization metrics of the instance * recommendation option.
- * *The Cpu and Memory metrics are the only projected
* utilization metrics returned. Additionally, the Memory metric is
@@ -2356,9 +2560,7 @@ export interface InstanceRecommendationOption {
* Change the instance type guide for Linux and Change the instance type
* guide for Windows provide general guidance for getting started with an
* instance migration.
Platform differences include:
- * *@@ -2453,7 +2655,6 @@ export interface InstanceRecommendationOption { /** *
The performance risk of the instance recommendation option.
- * *Performance risk indicates the likelihood of the recommended instance type not meeting * the resource needs of your workload. Compute Optimizer calculates an individual * performance risk score for each specification of the recommended instance, including @@ -2462,7 +2663,6 @@ export interface InstanceRecommendationOption { * The performance * risk of the recommended instance is calculated as the maximum performance risk score * across the analyzed resource specifications.
- * *The value ranges from 0 - 4, with 0 meaning
* that the recommended resource is predicted to always provide enough hardware capability.
* The higher the performance risk is, the more likely you should validate whether the
@@ -2473,10 +2673,16 @@ export interface InstanceRecommendationOption {
/**
*
The rank of the instance recommendation option.
- * *The top recommendation option is ranked as 1.
An object that describes the savings opportunity for the instance recommendation + * option. Savings opportunity includes the estimated monthly savings amount and + * percentage.
+ */ + savingsOpportunity?: SavingsOpportunity; } export namespace InstanceRecommendationOption { @@ -2546,9 +2752,7 @@ export interface InstanceRecommendation { /** *The finding classification of the instance.
- * *Findings for instances include:
- * *@@ -2587,9 +2791,7 @@ export interface InstanceRecommendation { /** *
The reason for the finding classification of the instance.
- * *Finding reason codes for instances include:
- * *@@ -2630,7 +2832,6 @@ export interface InstanceRecommendation { * your workload and there is an alternative instance type that provides better * memory performance. This is identified by analyzing the memory utilization * metric of the current instance during the look-back period.
- * *Memory utilization is analyzed only for resources that have the unified * CloudWatch agent installed on them. For more information, see @@ -2776,7 +2977,6 @@ export interface InstanceRecommendation { * current instance during the look-back period.
*For more information about instance metrics, see List the * available CloudWatch metrics for your instances in the @@ -2810,9 +3010,22 @@ export interface InstanceRecommendation { recommendationSources?: RecommendationSource[]; /** - *
The timestamp of when the instance recommendation was last refreshed.
+ *The timestamp of when the instance recommendation was last generated.
*/ lastRefreshTimestamp?: Date; + + /** + *The risk of the current instance not meeting the performance needs of its workloads. + * The higher the risk, the more likely the current Lambda function requires + * more memory.
+ */ + currentPerformanceRisk?: CurrentPerformanceRisk | string; + + /** + *An object that describes the effective recommendation preferences for the + * instance.
+ */ + effectiveRecommendationPreferences?: EffectiveRecommendationPreferences; } export namespace InstanceRecommendation { @@ -2827,7 +3040,6 @@ export namespace InstanceRecommendation { export interface GetEC2InstanceRecommendationsResponse { /** *The token to use to advance to the next page of instance recommendations.
- * *This value is null when there are no more pages of instance recommendations to * return.
*/ @@ -2840,7 +3052,6 @@ export interface GetEC2InstanceRecommendationsResponse { /** *An array of objects that describe errors of the request.
- * *For example, an error is returned if you request recommendations for an instance of an * unsupported instance family.
*/ @@ -2903,11 +3114,9 @@ export namespace GetEC2RecommendationProjectedMetricsRequest { *Describes a projected utilization metric of a recommendation option, such as an * Amazon EC2 instance. This represents the projected utilization of a * recommendation option had you used that resource during the analyzed period.
- * *Compare the utilization metric data of your resource against its projected utilization * metric data to determine the performance difference between your current resource and * the recommended option.
- * *The Cpu and Memory metrics are the only projected
* utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the
@@ -2918,7 +3127,6 @@ export namespace GetEC2RecommendationProjectedMetricsRequest {
export interface ProjectedMetric {
/**
*
The name of the projected utilization metric.
- * *The following projected utilization metrics are returned:
*Describes a projected utilization metric of a recommendation option.
- * *The Cpu and Memory metrics are the only projected
* utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the
@@ -2988,9 +3195,7 @@ export interface RecommendedOptionProjectedMetric {
/**
*
The rank of the recommendation option projected metric.
- * *The top recommendation option is ranked as 1.
The projected metric rank correlates to the recommendation option rank. For example,
* the projected metric ranked as 1 is related to the recommendation option
* that is also ranked as 1 in the same response.
The Amazon Resource Name (ARN) of the resource for which to confirm effective + * recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are + * currently supported.
+ */ + resourceArn: string | undefined; +} + +export namespace GetEffectiveRecommendationPreferencesRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetEffectiveRecommendationPreferencesRequest): any => ({ + ...obj, + }); +} + +export interface GetEffectiveRecommendationPreferencesResponse { + /** + *The status of the enhanced infrastructure metrics recommendation preference. Considers + * all applicable preferences that you might have set at the resource, account, and + * organization level.
+ *A status of Active confirms that the preference is applied in the latest
+ * recommendation refresh, and a status of Inactive confirms that it's not yet
+ * applied.
To validate whether the preference is applied to your last generated set of
+ * recommendations, review the effectiveRecommendationPreferences value in the
+ * response of the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
The reason for the enrollment status of the account.
- * *For example, an account might show a status of Pending because member
* accounts of an organization require more time to be enrolled in the service.
The name of the filter.
- * *Specify Status to return accounts with a specific enrollment status (for
* example, Active).
The value of the filter.
- * *The valid values are Active, Inactive, Pending,
* and Failed.
The maximum number of account enrollment statuses to return with a single request. You * can specify up to 100 statuses to return with each request.
- * *To retrieve the remaining results, make another request with the returned
* nextToken value.
The token to use to advance to the next page of account enrollment statuses.
- * *This value is null when there are no more pages of account enrollment statuses to * return.
*/ @@ -3177,7 +3419,6 @@ export interface GetLambdaFunctionRecommendationsRequest { /** *The Amazon Resource Name (ARN) of the functions for which to return * recommendations.
- * *You can specify a qualified or unqualified ARN. If you specify an unqualified ARN
* without a function version suffix, Compute Optimizer will return recommendations for the
* latest ($LATEST) version of the function. If you specify a qualified ARN
@@ -3191,10 +3432,8 @@ export interface GetLambdaFunctionRecommendationsRequest {
/**
*
The ID of the Amazon Web Services account for which to return function * recommendations.
- * *If your account is the management account of an organization, use this parameter to * specify the member account for which you want to return function recommendations.
- * *Only one account ID can be specified per request.
*/ accountIds?: string[]; @@ -3212,7 +3451,6 @@ export interface GetLambdaFunctionRecommendationsRequest { /** *The maximum number of function recommendations to return with a single request.
- * *To retrieve the remaining results, make another request with the returned
* nextToken value.
The rank of the function recommendation option.
- * *The top recommendation option is ranked as 1.
An object that describes the savings opportunity for the Lambda function + * recommendation option. Savings opportunity includes the estimated monthly savings amount + * and percentage.
+ */ + savingsOpportunity?: SavingsOpportunity; } export namespace LambdaFunctionMemoryRecommendationOption { @@ -3329,7 +3573,6 @@ export enum LambdaFunctionMetricStatistic { export interface LambdaFunctionUtilizationMetric { /** *The name of the utilization metric.
- * *The following utilization metrics are available:
*The statistic of the utilization metric.
- * *The Compute Optimizer API, Command Line Interface (CLI), and SDKs
* return utilization metrics using only the Maximum statistic, which is the
* highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the
* Average statistic, which is the value of Sum /
* SampleCount during the specified period. For more information, see
@@ -3419,13 +3660,12 @@ export interface LambdaFunctionRecommendation {
lookbackPeriodInDays?: number;
/**
- *
The timestamp of when the function recommendation was last refreshed.
+ *The timestamp of when the function recommendation was last generated.
*/ lastRefreshTimestamp?: Date; /** *The finding classification of the function.
- * *Findings for functions include:
*The risk of the current Lambda function not meeting the performance needs + * of its workloads. The higher the risk, the more likely the current Lambda + * function configuration is underperforming in its workload.
+ */ + currentPerformanceRisk?: CurrentPerformanceRisk | string; } export namespace LambdaFunctionRecommendation { @@ -3543,7 +3790,6 @@ export namespace LambdaFunctionRecommendation { export interface GetLambdaFunctionRecommendationsResponse { /** *The token to use to advance to the next page of function recommendations.
- * *This value is null when there are no more pages of function recommendations to * return.
*/ @@ -3564,14 +3810,118 @@ export namespace GetLambdaFunctionRecommendationsResponse { }); } +export interface GetRecommendationPreferencesRequest { + /** + *The target resource type of the recommendation preference for which to return + * preferences.
+ *The Ec2Instance option encompasses standalone instances and instances
+ * that are part of Auto Scaling groups. The AutoScalingGroup option
+ * encompasses only instances that are part of an Auto Scaling group.
An object that describes the scope of the recommendation preference to return.
+ *You can return recommendation preferences that are created at the organization level + * (for management accounts of an organization only), account level, and resource level. + * For more information, see Activating + * enhanced infrastructure metrics in the Compute Optimizer User + * Guide.
+ */ + scope?: Scope; + + /** + *The token to advance to the next page of recommendation preferences.
+ */ + nextToken?: string; + + /** + *The maximum number of recommendation preferences to return with a single + * request.
+ *To retrieve the remaining results, make another request with the returned
+ * nextToken value.
Describes a recommendation preference.
+ */ +export interface RecommendationPreferencesDetail { + /** + *An object that describes the scope of the recommendation preference.
+ *Recommendation preferences can be created at the organization level (for management + * accounts of an organization only), account level, and resource level. For more + * information, see Activating + * enhanced infrastructure metrics in the Compute Optimizer User + * Guide.
+ */ + scope?: Scope; + + /** + *The target resource type of the recommendation preference to create.
+ *The Ec2Instance option encompasses standalone instances and instances
+ * that are part of Auto Scaling groups. The AutoScalingGroup option
+ * encompasses only instances that are part of an Auto Scaling group.
The status of the enhanced infrastructure metrics recommendation preference.
+ *A status of Active confirms that the preference is applied in the latest
+ * recommendation refresh, and a status of Inactive confirms that it's not yet
+ * applied.
The token to use to advance to the next page of recommendation preferences.
+ *This value is null when there are no more pages of recommendation preferences to + * return.
+ */ + nextToken?: string; + + /** + *An array of objects that describe recommendation preferences.
+ */ + recommendationPreferencesDetails?: RecommendationPreferencesDetail[]; +} + +export namespace GetRecommendationPreferencesResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetRecommendationPreferencesResponse): any => ({ + ...obj, + }); +} + export interface GetRecommendationSummariesRequest { /** *The ID of the Amazon Web Services account for which to return recommendation * summaries.
- * *If your account is the management account of an organization, use this parameter to * specify the member account for which you want to return recommendation summaries.
- * *Only one account ID can be specified per request.
*/ accountIds?: string[]; @@ -3583,7 +3933,6 @@ export interface GetRecommendationSummariesRequest { /** *The maximum number of recommendation summaries to return with a single request.
- * *To retrieve the remaining results, make another request with the returned
* nextToken value.
Describes the performance risk ratings for a given resource type.
+ *Resources with a high or medium rating are at risk of not
+ * meeting the performance needs of their workloads, while resources with a
+ * low rating are performing well in their workloads.
A count of the applicable resource types with a high performance risk rating.
+ */ + high?: number; + + /** + *A count of the applicable resource types with a medium performance risk rating.
+ */ + medium?: number; + + /** + *A count of the applicable resource types with a low performance risk rating.
+ */ + low?: number; + + /** + *A count of the applicable resource types with a very low performance risk + * rating.
+ */ + veryLow?: number; +} + +export namespace CurrentPerformanceRiskRatings { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CurrentPerformanceRiskRatings): any => ({ + ...obj, + }); +} + export enum FindingReasonCode { MEMORY_OVER_PROVISIONED = "MemoryOverprovisioned", MEMORY_UNDER_PROVISIONED = "MemoryUnderprovisioned", @@ -3667,7 +4054,7 @@ export interface RecommendationSummary { summaries?: Summary[]; /** - *The resource type of the recommendation.
+ *The resource type that the recommendation summary applies to.
*/ recommendationResourceType?: RecommendationSourceType | string; @@ -3675,6 +4062,18 @@ export interface RecommendationSummary { *The Amazon Web Services account ID of the recommendation summary.
*/ accountId?: string; + + /** + *An object that describes the savings opportunity for a given resource type. Savings + * opportunity includes the estimated monthly savings amount and percentage.
+ */ + savingsOpportunity?: SavingsOpportunity; + + /** + *An object that describes the performance risk ratings for a given resource + * type.
+ */ + currentPerformanceRiskRatings?: CurrentPerformanceRiskRatings; } export namespace RecommendationSummary { @@ -3689,7 +4088,6 @@ export namespace RecommendationSummary { export interface GetRecommendationSummariesResponse { /** *The token to use to advance to the next page of recommendation summaries.
- * *This value is null when there are no more pages of recommendation summaries to * return.
*/ @@ -3710,12 +4108,67 @@ export namespace GetRecommendationSummariesResponse { }); } +export interface PutRecommendationPreferencesRequest { + /** + *The target resource type of the recommendation preference to create.
+ *The Ec2Instance option encompasses standalone instances and instances
+ * that are part of Auto Scaling groups. The AutoScalingGroup option
+ * encompasses only instances that are part of an Auto Scaling group.
An object that describes the scope of the recommendation preference to create.
+ *You can create recommendation preferences at the organization level (for management + * accounts of an organization only), account level, and resource level. For more + * information, see Activating + * enhanced infrastructure metrics in the Compute Optimizer User + * Guide.
+ *You cannot create recommendation preferences for Auto Scaling groups at the
+ * organization and account levels. You can create recommendation preferences for
+ * Auto Scaling groups only at the resource level by specifying a scope name
+ * of ResourceArn and a scope value of the Auto Scaling group Amazon
+ * Resource Name (ARN). This will configure the preference for all instances that are
+ * part of the specified the Auto Scaling group.
The status of the enhanced infrastructure metrics recommendation preference to create + * or update.
+ *A status of Active confirms that the preference is applied in the latest
+ * recommendation refresh, and a status of Inactive confirms that it's not yet
+ * applied.
The new enrollment status of the account.
- * *The following status options are available:
- * *@@ -3731,7 +4184,6 @@ export interface UpdateEnrollmentStatusRequest { * from Compute Optimizer after you opt out.
*The This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API. This operation starts a job. This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API. The API Gateway API that is the asset. The API description of the API asset. The API endpoint of the API asset. The unique identifier of the API asset. The API key of the API asset. The API name of the API asset. The download URL of the API specification of the API asset. The date and time that the upload URL expires, in ISO 8601 format. The protocol type of the API asset. The stage of the API asset. The destination for the asset. The Amazon Redshift datashare that is the asset. Information about the API Gateway API asset. An asset in AWS Data Exchange is a piece of data. The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, or an Amazon Redshift datashare (Preview). When you create an import job for your files, you create an asset in AWS Data Exchange for each of those files. An asset in AWS Data Exchange is a piece of data (S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare (Preview). When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange. The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. The request details. The API description. Markdown supported. The API Gateway API ID. The API Gateway API key. The API name. The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used to ensure the integrity of the file. The data set ID. The protocol type. The revision ID. The API stage. Details of the operation to be performed by the job. Details from an import from Amazon Redshift datashare request. Information about the import asset from API Gateway API request. The response details. The API description. The API ID. The API key. The API name. The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location. The upload URL of the API specification. The date and time that the upload URL expires, in ISO 8601 format. The data set ID. The protocol type. The revision ID. The API stage. The details in the response for an import request, including the signed URL and other information. Details from an import from Amazon Redshift datashare response. The response details. The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. The request body for SendApiAsset. The request body. Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue). Asset ID value for the API request. Data set ID value for the API request. Any header value prefixed with x-amzn-dataexchange-header- will have that stripped before sending the Asset API request. Use this when you want to override a header that AWS Data Exchange uses. Alternatively, you can use the header without a prefix to the HTTP request. HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request. URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/{pathValue} Revision ID value for the API request. The response body from the underlying API tracked by the API asset. The response headers from the underlying API tracked by the API asset. The unique identifier for a job. The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. Describes the storage tier status of one or more Amazon EBS snapshots. Describes the data feed for Spot Instances. For more information, see Pending and Failed options cannot be used to update
* the enrollment status of an account. They are returned in the response of a request
diff --git a/clients/client-compute-optimizer/src/protocols/Aws_json1_0.ts b/clients/client-compute-optimizer/src/protocols/Aws_json1_0.ts
index 61f03a3c98d2..1492eb3c7133 100644
--- a/clients/client-compute-optimizer/src/protocols/Aws_json1_0.ts
+++ b/clients/client-compute-optimizer/src/protocols/Aws_json1_0.ts
@@ -18,6 +18,10 @@ import {
SmithyException as __SmithyException,
} from "@aws-sdk/types";
+import {
+ DeleteRecommendationPreferencesCommandInput,
+ DeleteRecommendationPreferencesCommandOutput,
+} from "../commands/DeleteRecommendationPreferencesCommand";
import {
DescribeRecommendationExportJobsCommandInput,
DescribeRecommendationExportJobsCommandOutput,
@@ -54,6 +58,10 @@ import {
GetEC2RecommendationProjectedMetricsCommandInput,
GetEC2RecommendationProjectedMetricsCommandOutput,
} from "../commands/GetEC2RecommendationProjectedMetricsCommand";
+import {
+ GetEffectiveRecommendationPreferencesCommandInput,
+ GetEffectiveRecommendationPreferencesCommandOutput,
+} from "../commands/GetEffectiveRecommendationPreferencesCommand";
import {
GetEnrollmentStatusCommandInput,
GetEnrollmentStatusCommandOutput,
@@ -66,10 +74,18 @@ import {
GetLambdaFunctionRecommendationsCommandInput,
GetLambdaFunctionRecommendationsCommandOutput,
} from "../commands/GetLambdaFunctionRecommendationsCommand";
+import {
+ GetRecommendationPreferencesCommandInput,
+ GetRecommendationPreferencesCommandOutput,
+} from "../commands/GetRecommendationPreferencesCommand";
import {
GetRecommendationSummariesCommandInput,
GetRecommendationSummariesCommandOutput,
} from "../commands/GetRecommendationSummariesCommand";
+import {
+ PutRecommendationPreferencesCommandInput,
+ PutRecommendationPreferencesCommandOutput,
+} from "../commands/PutRecommendationPreferencesCommand";
import {
UpdateEnrollmentStatusCommandInput,
UpdateEnrollmentStatusCommandOutput,
@@ -81,11 +97,16 @@ import {
AutoScalingGroupRecommendation,
AutoScalingGroupRecommendationOption,
CpuVendorArchitecture,
+ CurrentPerformanceRiskRatings,
+ DeleteRecommendationPreferencesRequest,
+ DeleteRecommendationPreferencesResponse,
DescribeRecommendationExportJobsRequest,
DescribeRecommendationExportJobsResponse,
EBSFilter,
EBSUtilizationMetric,
+ EffectiveRecommendationPreferences,
EnrollmentFilter,
+ EstimatedMonthlySavings,
ExportableAutoScalingGroupField,
ExportableInstanceField,
ExportableLambdaFunctionField,
@@ -108,6 +129,8 @@ import {
GetEC2InstanceRecommendationsResponse,
GetEC2RecommendationProjectedMetricsRequest,
GetEC2RecommendationProjectedMetricsResponse,
+ GetEffectiveRecommendationPreferencesRequest,
+ GetEffectiveRecommendationPreferencesResponse,
GetEnrollmentStatusesForOrganizationRequest,
GetEnrollmentStatusesForOrganizationResponse,
GetEnrollmentStatusRequest,
@@ -115,6 +138,8 @@ import {
GetLambdaFunctionRecommendationsRequest,
GetLambdaFunctionRecommendationsResponse,
GetRecommendationError,
+ GetRecommendationPreferencesRequest,
+ GetRecommendationPreferencesResponse,
GetRecommendationSummariesRequest,
GetRecommendationSummariesResponse,
InstanceRecommendation,
@@ -134,15 +159,21 @@ import {
OptInRequiredException,
PlatformDifference,
ProjectedMetric,
+ PutRecommendationPreferencesRequest,
+ PutRecommendationPreferencesResponse,
ReasonCodeSummary,
RecommendationExportJob,
+ RecommendationPreferenceName,
RecommendationPreferences,
+ RecommendationPreferencesDetail,
RecommendationSource,
RecommendationSummary,
RecommendedOptionProjectedMetric,
ResourceNotFoundException,
S3Destination,
S3DestinationConfig,
+ SavingsOpportunity,
+ Scope,
ServiceUnavailableException,
Summary,
ThrottlingException,
@@ -154,6 +185,19 @@ import {
VolumeRecommendationOption,
} from "../models/models_0";
+export const serializeAws_json1_0DeleteRecommendationPreferencesCommand = async (
+ input: DeleteRecommendationPreferencesCommandInput,
+ context: __SerdeContext
+): Promise<__HttpRequest> => {
+ const headers: __HeaderBag = {
+ "content-type": "application/x-amz-json-1.0",
+ "x-amz-target": "ComputeOptimizerService.DeleteRecommendationPreferences",
+ };
+ let body: any;
+ body = JSON.stringify(serializeAws_json1_0DeleteRecommendationPreferencesRequest(input, context));
+ return buildHttpRpcRequest(context, headers, "/", undefined, body);
+};
+
export const serializeAws_json1_0DescribeRecommendationExportJobsCommand = async (
input: DescribeRecommendationExportJobsCommandInput,
context: __SerdeContext
@@ -271,6 +315,19 @@ export const serializeAws_json1_0GetEC2RecommendationProjectedMetricsCommand = a
return buildHttpRpcRequest(context, headers, "/", undefined, body);
};
+export const serializeAws_json1_0GetEffectiveRecommendationPreferencesCommand = async (
+ input: GetEffectiveRecommendationPreferencesCommandInput,
+ context: __SerdeContext
+): Promise<__HttpRequest> => {
+ const headers: __HeaderBag = {
+ "content-type": "application/x-amz-json-1.0",
+ "x-amz-target": "ComputeOptimizerService.GetEffectiveRecommendationPreferences",
+ };
+ let body: any;
+ body = JSON.stringify(serializeAws_json1_0GetEffectiveRecommendationPreferencesRequest(input, context));
+ return buildHttpRpcRequest(context, headers, "/", undefined, body);
+};
+
export const serializeAws_json1_0GetEnrollmentStatusCommand = async (
input: GetEnrollmentStatusCommandInput,
context: __SerdeContext
@@ -310,6 +367,19 @@ export const serializeAws_json1_0GetLambdaFunctionRecommendationsCommand = async
return buildHttpRpcRequest(context, headers, "/", undefined, body);
};
+export const serializeAws_json1_0GetRecommendationPreferencesCommand = async (
+ input: GetRecommendationPreferencesCommandInput,
+ context: __SerdeContext
+): Promise<__HttpRequest> => {
+ const headers: __HeaderBag = {
+ "content-type": "application/x-amz-json-1.0",
+ "x-amz-target": "ComputeOptimizerService.GetRecommendationPreferences",
+ };
+ let body: any;
+ body = JSON.stringify(serializeAws_json1_0GetRecommendationPreferencesRequest(input, context));
+ return buildHttpRpcRequest(context, headers, "/", undefined, body);
+};
+
export const serializeAws_json1_0GetRecommendationSummariesCommand = async (
input: GetRecommendationSummariesCommandInput,
context: __SerdeContext
@@ -323,6 +393,19 @@ export const serializeAws_json1_0GetRecommendationSummariesCommand = async (
return buildHttpRpcRequest(context, headers, "/", undefined, body);
};
+export const serializeAws_json1_0PutRecommendationPreferencesCommand = async (
+ input: PutRecommendationPreferencesCommandInput,
+ context: __SerdeContext
+): Promise<__HttpRequest> => {
+ const headers: __HeaderBag = {
+ "content-type": "application/x-amz-json-1.0",
+ "x-amz-target": "ComputeOptimizerService.PutRecommendationPreferences",
+ };
+ let body: any;
+ body = JSON.stringify(serializeAws_json1_0PutRecommendationPreferencesRequest(input, context));
+ return buildHttpRpcRequest(context, headers, "/", undefined, body);
+};
+
export const serializeAws_json1_0UpdateEnrollmentStatusCommand = async (
input: UpdateEnrollmentStatusCommandInput,
context: __SerdeContext
@@ -336,6 +419,116 @@ export const serializeAws_json1_0UpdateEnrollmentStatusCommand = async (
return buildHttpRpcRequest(context, headers, "/", undefined, body);
};
+export const deserializeAws_json1_0DeleteRecommendationPreferencesCommand = async (
+ output: __HttpResponse,
+ context: __SerdeContext
+): Promise