TrustedAdvisor Public API
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-trustedadvisor +using your favorite package manager: + +- `npm install @aws-sdk/client-trustedadvisor` +- `yarn add @aws-sdk/client-trustedadvisor` +- `pnpm add @aws-sdk/client-trustedadvisor` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `TrustedAdvisorClient` and +the commands you need, for example `ListChecksCommand`: + +```js +// ES5 example +const { TrustedAdvisorClient, ListChecksCommand } = require("@aws-sdk/client-trustedadvisor"); +``` + +```ts +// ES6+ example +import { TrustedAdvisorClient, ListChecksCommand } from "@aws-sdk/client-trustedadvisor"; +``` + +### 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 TrustedAdvisorClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new ListChecksCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // process err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-trustedadvisor"; +const client = new AWS.TrustedAdvisor({ region: "REGION" }); + +// async/await. +try { + const data = await client.listChecks(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .listChecks(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.listChecks(params, (err, data) => { + // process err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-trustedadvisor` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. + +## Client Commands (Operations List) + +TrustedAdvisor Public API
+ */ +export class TrustedAdvisor extends TrustedAdvisorClient implements TrustedAdvisor {} +createAggregatedClient(commands, TrustedAdvisor); diff --git a/clients/client-trustedadvisor/src/TrustedAdvisorClient.ts b/clients/client-trustedadvisor/src/TrustedAdvisorClient.ts new file mode 100644 index 000000000000..923ed363caa2 --- /dev/null +++ b/clients/client-trustedadvisor/src/TrustedAdvisorClient.ts @@ -0,0 +1,342 @@ +// smithy-typescript generated code +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { + AwsAuthInputConfig, + AwsAuthResolvedConfig, + getAwsAuthPlugin, + resolveAwsAuthConfig, +} from "@aws-sdk/middleware-signing"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { Credentials as __Credentials } from "@aws-sdk/types"; +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver"; +import { getContentLengthPlugin } from "@smithy/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint"; +import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"; +import { HttpHandler as __HttpHandler } from "@smithy/protocol-http"; +import { + Client as __Client, + DefaultsMode as __DefaultsMode, + SmithyConfiguration as __SmithyConfiguration, + SmithyResolvedConfiguration as __SmithyResolvedConfiguration, +} from "@smithy/smithy-client"; +import { + BodyLengthCalculator as __BodyLengthCalculator, + CheckOptionalClientConfig as __CheckOptionalClientConfig, + Checksum as __Checksum, + ChecksumConstructor as __ChecksumConstructor, + Decoder as __Decoder, + Encoder as __Encoder, + EndpointV2 as __EndpointV2, + Hash as __Hash, + HashConstructor as __HashConstructor, + HttpHandlerOptions as __HttpHandlerOptions, + Logger as __Logger, + Provider as __Provider, + Provider, + StreamCollector as __StreamCollector, + UrlParser as __UrlParser, + UserAgent as __UserAgent, +} from "@smithy/types"; + +import { + GetOrganizationRecommendationCommandInput, + GetOrganizationRecommendationCommandOutput, +} from "./commands/GetOrganizationRecommendationCommand"; +import { GetRecommendationCommandInput, GetRecommendationCommandOutput } from "./commands/GetRecommendationCommand"; +import { ListChecksCommandInput, ListChecksCommandOutput } from "./commands/ListChecksCommand"; +import { + ListOrganizationRecommendationAccountsCommandInput, + ListOrganizationRecommendationAccountsCommandOutput, +} from "./commands/ListOrganizationRecommendationAccountsCommand"; +import { + ListOrganizationRecommendationResourcesCommandInput, + ListOrganizationRecommendationResourcesCommandOutput, +} from "./commands/ListOrganizationRecommendationResourcesCommand"; +import { + ListOrganizationRecommendationsCommandInput, + ListOrganizationRecommendationsCommandOutput, +} from "./commands/ListOrganizationRecommendationsCommand"; +import { + ListRecommendationResourcesCommandInput, + ListRecommendationResourcesCommandOutput, +} from "./commands/ListRecommendationResourcesCommand"; +import { + ListRecommendationsCommandInput, + ListRecommendationsCommandOutput, +} from "./commands/ListRecommendationsCommand"; +import { + UpdateOrganizationRecommendationLifecycleCommandInput, + UpdateOrganizationRecommendationLifecycleCommandOutput, +} from "./commands/UpdateOrganizationRecommendationLifecycleCommand"; +import { + UpdateRecommendationLifecycleCommandInput, + UpdateRecommendationLifecycleCommandOutput, +} from "./commands/UpdateRecommendationLifecycleCommand"; +import { + ClientInputEndpointParameters, + ClientResolvedEndpointParameters, + EndpointParameters, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; +import { resolveRuntimeExtensions, RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions"; + +export { __Client }; + +/** + * @public + */ +export type ServiceInputTypes = + | GetOrganizationRecommendationCommandInput + | GetRecommendationCommandInput + | ListChecksCommandInput + | ListOrganizationRecommendationAccountsCommandInput + | ListOrganizationRecommendationResourcesCommandInput + | ListOrganizationRecommendationsCommandInput + | ListRecommendationResourcesCommandInput + | ListRecommendationsCommandInput + | UpdateOrganizationRecommendationLifecycleCommandInput + | UpdateRecommendationLifecycleCommandInput; + +/** + * @public + */ +export type ServiceOutputTypes = + | GetOrganizationRecommendationCommandOutput + | GetRecommendationCommandOutput + | ListChecksCommandOutput + | ListOrganizationRecommendationAccountsCommandOutput + | ListOrganizationRecommendationResourcesCommandOutput + | ListOrganizationRecommendationsCommandOutput + | ListRecommendationResourcesCommandOutput + | ListRecommendationsCommandOutput + | UpdateOrganizationRecommendationLifecycleCommandOutput + | UpdateRecommendationLifecycleCommandOutput; + +/** + * @public + */ +export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> { + /** + * The HTTP handler to use. Fetch in browser and Https in Nodejs. + */ + requestHandler?: __HttpHandler; + + /** + * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface + * that computes the SHA-256 HMAC or checksum of a string or binary buffer. + * @internal + */ + sha256?: __ChecksumConstructor | __HashConstructor; + + /** + * The function that will be used to convert strings into HTTP endpoints. + * @internal + */ + urlParser?: __UrlParser; + + /** + * A function that can calculate the length of a request body. + * @internal + */ + bodyLengthChecker?: __BodyLengthCalculator; + + /** + * A function that converts a stream into an array of bytes. + * @internal + */ + streamCollector?: __StreamCollector; + + /** + * The function that will be used to convert a base64-encoded string to a byte array. + * @internal + */ + base64Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a base64-encoded string. + * @internal + */ + base64Encoder?: __Encoder; + + /** + * The function that will be used to convert a UTF8-encoded string to a byte array. + * @internal + */ + utf8Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a UTF-8 encoded string. + * @internal + */ + utf8Encoder?: __Encoder; + + /** + * The runtime environment. + * @internal + */ + runtime?: string; + + /** + * Disable dynamically changing the endpoint of the client based on the hostPrefix + * trait of an operation. + */ + disableHostPrefix?: boolean; + + /** + * Unique service identifier. + * @internal + */ + serviceId?: string; + + /** + * Enables IPv6/IPv4 dualstack endpoint. + */ + useDualstackEndpoint?: boolean | __ProviderTrustedAdvisor Public API
+ */ +export class TrustedAdvisorClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + TrustedAdvisorClientResolvedConfig +> { + /** + * The resolved configuration of TrustedAdvisorClient class. This is resolved and normalized from the {@link TrustedAdvisorClientConfig | constructor configuration interface}. + */ + readonly config: TrustedAdvisorClientResolvedConfig; + + constructor(...[configuration]: __CheckOptionalClientConfigGet a specific recommendation within an AWS Organizations organization. This API supports only prioritized + * recommendations. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TrustedAdvisorClient, GetOrganizationRecommendationCommand } from "@aws-sdk/client-trustedadvisor"; // ES Modules import + * // const { TrustedAdvisorClient, GetOrganizationRecommendationCommand } = require("@aws-sdk/client-trustedadvisor"); // CommonJS import + * const client = new TrustedAdvisorClient(config); + * const input = { // GetOrganizationRecommendationRequest + * organizationRecommendationIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetOrganizationRecommendationCommand(input); + * const response = await client.send(command); + * // { // GetOrganizationRecommendationResponse + * // organizationRecommendation: { // OrganizationRecommendation + * // id: "STRING_VALUE", // required + * // type: "standard" || "priority", // required + * // checkArn: "STRING_VALUE", + * // status: "ok" || "warning" || "error", // required + * // lifecycleStage: "in_progress" || "pending_response" || "dismissed" || "resolved", + * // pillars: [ // RecommendationPillarList // required + * // "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence", + * // ], + * // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", // required + * // awsServices: [ // RecommendationAwsServiceList + * // "STRING_VALUE", + * // ], + * // name: "STRING_VALUE", // required + * // resourcesAggregates: { // RecommendationResourcesAggregates + * // okCount: Number("long"), // required + * // warningCount: Number("long"), // required + * // errorCount: Number("long"), // required + * // }, + * // pillarSpecificAggregates: { // RecommendationPillarSpecificAggregates + * // costOptimizing: { // RecommendationCostOptimizingAggregates + * // estimatedMonthlySavings: Number("double"), // required + * // estimatedPercentMonthlySavings: Number("double"), // required + * // }, + * // }, + * // createdAt: new Date("TIMESTAMP"), + * // lastUpdatedAt: new Date("TIMESTAMP"), + * // arn: "STRING_VALUE", // required + * // description: "STRING_VALUE", // required + * // createdBy: "STRING_VALUE", + * // updatedOnBehalfOf: "STRING_VALUE", + * // updatedOnBehalfOfJobTitle: "STRING_VALUE", + * // updateReason: "STRING_VALUE", + * // updateReasonCode: "non_critical_account" || "temporary_account" || "valid_business_case" || "other_methods_available" || "low_priority" || "not_applicable" || "other", + * // resolvedAt: new Date("TIMESTAMP"), + * // }, + * // }; + * + * ``` + * + * @param GetOrganizationRecommendationCommandInput - {@link GetOrganizationRecommendationCommandInput} + * @returns {@link GetOrganizationRecommendationCommandOutput} + * @see {@link GetOrganizationRecommendationCommandInput} for command's `input` shape. + * @see {@link GetOrganizationRecommendationCommandOutput} for command's `response` shape. + * @see {@link TrustedAdvisorClientResolvedConfig | config} for TrustedAdvisorClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Exception that access has been denied due to insufficient access
+ * + * @throws {@link InternalServerException} (server fault) + *Exception to notify that an unexpected internal error occurred during processing of the request
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Exception that the requested resource has not been found
+ * + * @throws {@link ThrottlingException} (client fault) + *Exception to notify that requests are being throttled
+ * + * @throws {@link ValidationException} (client fault) + *Exception that the request failed to satisfy service constraints
+ * + * @throws {@link TrustedAdvisorServiceException} + *Base exception class for all service exceptions from TrustedAdvisor service.
+ * + */ +export class GetOrganizationRecommendationCommand extends $Command< + GetOrganizationRecommendationCommandInput, + GetOrganizationRecommendationCommandOutput, + TrustedAdvisorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetOrganizationRecommendationCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGet a specific Recommendation
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TrustedAdvisorClient, GetRecommendationCommand } from "@aws-sdk/client-trustedadvisor"; // ES Modules import + * // const { TrustedAdvisorClient, GetRecommendationCommand } = require("@aws-sdk/client-trustedadvisor"); // CommonJS import + * const client = new TrustedAdvisorClient(config); + * const input = { // GetRecommendationRequest + * recommendationIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetRecommendationCommand(input); + * const response = await client.send(command); + * // { // GetRecommendationResponse + * // recommendation: { // Recommendation + * // id: "STRING_VALUE", // required + * // type: "standard" || "priority", // required + * // checkArn: "STRING_VALUE", + * // status: "ok" || "warning" || "error", // required + * // lifecycleStage: "in_progress" || "pending_response" || "dismissed" || "resolved", + * // pillars: [ // RecommendationPillarList // required + * // "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence", + * // ], + * // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", // required + * // awsServices: [ // RecommendationAwsServiceList + * // "STRING_VALUE", + * // ], + * // name: "STRING_VALUE", // required + * // resourcesAggregates: { // RecommendationResourcesAggregates + * // okCount: Number("long"), // required + * // warningCount: Number("long"), // required + * // errorCount: Number("long"), // required + * // }, + * // pillarSpecificAggregates: { // RecommendationPillarSpecificAggregates + * // costOptimizing: { // RecommendationCostOptimizingAggregates + * // estimatedMonthlySavings: Number("double"), // required + * // estimatedPercentMonthlySavings: Number("double"), // required + * // }, + * // }, + * // createdAt: new Date("TIMESTAMP"), + * // lastUpdatedAt: new Date("TIMESTAMP"), + * // arn: "STRING_VALUE", // required + * // description: "STRING_VALUE", // required + * // createdBy: "STRING_VALUE", + * // updatedOnBehalfOf: "STRING_VALUE", + * // updatedOnBehalfOfJobTitle: "STRING_VALUE", + * // updateReason: "STRING_VALUE", + * // updateReasonCode: "non_critical_account" || "temporary_account" || "valid_business_case" || "other_methods_available" || "low_priority" || "not_applicable" || "other", + * // resolvedAt: new Date("TIMESTAMP"), + * // }, + * // }; + * + * ``` + * + * @param GetRecommendationCommandInput - {@link GetRecommendationCommandInput} + * @returns {@link GetRecommendationCommandOutput} + * @see {@link GetRecommendationCommandInput} for command's `input` shape. + * @see {@link GetRecommendationCommandOutput} for command's `response` shape. + * @see {@link TrustedAdvisorClientResolvedConfig | config} for TrustedAdvisorClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Exception that access has been denied due to insufficient access
+ * + * @throws {@link InternalServerException} (server fault) + *Exception to notify that an unexpected internal error occurred during processing of the request
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Exception that the requested resource has not been found
+ * + * @throws {@link ThrottlingException} (client fault) + *Exception to notify that requests are being throttled
+ * + * @throws {@link ValidationException} (client fault) + *Exception that the request failed to satisfy service constraints
+ * + * @throws {@link TrustedAdvisorServiceException} + *Base exception class for all service exceptions from TrustedAdvisor service.
+ * + */ +export class GetRecommendationCommand extends $Command< + GetRecommendationCommandInput, + GetRecommendationCommandOutput, + TrustedAdvisorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetRecommendationCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackList a filterable set of Checks
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TrustedAdvisorClient, ListChecksCommand } from "@aws-sdk/client-trustedadvisor"; // ES Modules import + * // const { TrustedAdvisorClient, ListChecksCommand } = require("@aws-sdk/client-trustedadvisor"); // CommonJS import + * const client = new TrustedAdvisorClient(config); + * const input = { // ListChecksRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * pillar: "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence", + * awsService: "STRING_VALUE", + * source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", + * language: "en" || "ja" || "zh" || "fr" || "de" || "ko" || "zh_TW" || "it" || "es" || "pt_BR" || "id", + * }; + * const command = new ListChecksCommand(input); + * const response = await client.send(command); + * // { // ListChecksResponse + * // nextToken: "STRING_VALUE", + * // checkSummaries: [ // CheckSummaryList // required + * // { // CheckSummary + * // id: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", // required + * // pillars: [ // RecommendationPillarList // required + * // "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence", + * // ], + * // awsServices: [ // RecommendationAwsServiceList // required + * // "STRING_VALUE", + * // ], + * // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", // required + * // metadata: { // StringMap // required + * // "Exception that access has been denied due to insufficient access
+ * + * @throws {@link InternalServerException} (server fault) + *Exception to notify that an unexpected internal error occurred during processing of the request
+ * + * @throws {@link ThrottlingException} (client fault) + *Exception to notify that requests are being throttled
+ * + * @throws {@link ValidationException} (client fault) + *Exception that the request failed to satisfy service constraints
+ * + * @throws {@link TrustedAdvisorServiceException} + *Base exception class for all service exceptions from TrustedAdvisor service.
+ * + */ +export class ListChecksCommand extends $Command< + ListChecksCommandInput, + ListChecksCommandOutput, + TrustedAdvisorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListChecksCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists the accounts that own the resources for an organization aggregate recommendation. This API only + * supports prioritized recommendations. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TrustedAdvisorClient, ListOrganizationRecommendationAccountsCommand } from "@aws-sdk/client-trustedadvisor"; // ES Modules import + * // const { TrustedAdvisorClient, ListOrganizationRecommendationAccountsCommand } = require("@aws-sdk/client-trustedadvisor"); // CommonJS import + * const client = new TrustedAdvisorClient(config); + * const input = { // ListOrganizationRecommendationAccountsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * organizationRecommendationIdentifier: "STRING_VALUE", // required + * affectedAccountId: "STRING_VALUE", + * }; + * const command = new ListOrganizationRecommendationAccountsCommand(input); + * const response = await client.send(command); + * // { // ListOrganizationRecommendationAccountsResponse + * // nextToken: "STRING_VALUE", + * // accountRecommendationLifecycleSummaries: [ // AccountRecommendationLifecycleSummaryList // required + * // { // AccountRecommendationLifecycleSummary + * // accountId: "STRING_VALUE", + * // accountRecommendationArn: "STRING_VALUE", + * // lifecycleStage: "in_progress" || "pending_response" || "dismissed" || "resolved", + * // updatedOnBehalfOf: "STRING_VALUE", + * // updatedOnBehalfOfJobTitle: "STRING_VALUE", + * // updateReason: "STRING_VALUE", + * // updateReasonCode: "non_critical_account" || "temporary_account" || "valid_business_case" || "other_methods_available" || "low_priority" || "not_applicable" || "other", + * // lastUpdatedAt: new Date("TIMESTAMP"), + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListOrganizationRecommendationAccountsCommandInput - {@link ListOrganizationRecommendationAccountsCommandInput} + * @returns {@link ListOrganizationRecommendationAccountsCommandOutput} + * @see {@link ListOrganizationRecommendationAccountsCommandInput} for command's `input` shape. + * @see {@link ListOrganizationRecommendationAccountsCommandOutput} for command's `response` shape. + * @see {@link TrustedAdvisorClientResolvedConfig | config} for TrustedAdvisorClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Exception that access has been denied due to insufficient access
+ * + * @throws {@link InternalServerException} (server fault) + *Exception to notify that an unexpected internal error occurred during processing of the request
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Exception that the requested resource has not been found
+ * + * @throws {@link ThrottlingException} (client fault) + *Exception to notify that requests are being throttled
+ * + * @throws {@link ValidationException} (client fault) + *Exception that the request failed to satisfy service constraints
+ * + * @throws {@link TrustedAdvisorServiceException} + *Base exception class for all service exceptions from TrustedAdvisor service.
+ * + */ +export class ListOrganizationRecommendationAccountsCommand extends $Command< + ListOrganizationRecommendationAccountsCommandInput, + ListOrganizationRecommendationAccountsCommandOutput, + TrustedAdvisorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListOrganizationRecommendationAccountsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackList Resources of a Recommendation within an Organization. This API only supports prioritized + * recommendations. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TrustedAdvisorClient, ListOrganizationRecommendationResourcesCommand } from "@aws-sdk/client-trustedadvisor"; // ES Modules import + * // const { TrustedAdvisorClient, ListOrganizationRecommendationResourcesCommand } = require("@aws-sdk/client-trustedadvisor"); // CommonJS import + * const client = new TrustedAdvisorClient(config); + * const input = { // ListOrganizationRecommendationResourcesRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * status: "ok" || "warning" || "error", + * regionCode: "STRING_VALUE", + * organizationRecommendationIdentifier: "STRING_VALUE", // required + * affectedAccountId: "STRING_VALUE", + * }; + * const command = new ListOrganizationRecommendationResourcesCommand(input); + * const response = await client.send(command); + * // { // ListOrganizationRecommendationResourcesResponse + * // nextToken: "STRING_VALUE", + * // organizationRecommendationResourceSummaries: [ // OrganizationRecommendationResourceSummaryList // required + * // { // OrganizationRecommendationResourceSummary + * // id: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // awsResourceId: "STRING_VALUE", // required + * // regionCode: "STRING_VALUE", // required + * // status: "ok" || "warning" || "error", // required + * // metadata: { // StringMap // required + * // "Exception that access has been denied due to insufficient access
+ * + * @throws {@link InternalServerException} (server fault) + *Exception to notify that an unexpected internal error occurred during processing of the request
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Exception that the requested resource has not been found
+ * + * @throws {@link ThrottlingException} (client fault) + *Exception to notify that requests are being throttled
+ * + * @throws {@link ValidationException} (client fault) + *Exception that the request failed to satisfy service constraints
+ * + * @throws {@link TrustedAdvisorServiceException} + *Base exception class for all service exceptions from TrustedAdvisor service.
+ * + */ +export class ListOrganizationRecommendationResourcesCommand extends $Command< + ListOrganizationRecommendationResourcesCommandInput, + ListOrganizationRecommendationResourcesCommandOutput, + TrustedAdvisorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListOrganizationRecommendationResourcesCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackList a filterable set of Recommendations within an Organization. This API only supports prioritized + * recommendations. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TrustedAdvisorClient, ListOrganizationRecommendationsCommand } from "@aws-sdk/client-trustedadvisor"; // ES Modules import + * // const { TrustedAdvisorClient, ListOrganizationRecommendationsCommand } = require("@aws-sdk/client-trustedadvisor"); // CommonJS import + * const client = new TrustedAdvisorClient(config); + * const input = { // ListOrganizationRecommendationsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * type: "standard" || "priority", + * status: "ok" || "warning" || "error", + * pillar: "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence", + * awsService: "STRING_VALUE", + * source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", + * checkIdentifier: "STRING_VALUE", + * afterLastUpdatedAt: new Date("TIMESTAMP"), + * beforeLastUpdatedAt: new Date("TIMESTAMP"), + * }; + * const command = new ListOrganizationRecommendationsCommand(input); + * const response = await client.send(command); + * // { // ListOrganizationRecommendationsResponse + * // nextToken: "STRING_VALUE", + * // organizationRecommendationSummaries: [ // OrganizationRecommendationSummaryList // required + * // { // OrganizationRecommendationSummary + * // id: "STRING_VALUE", // required + * // type: "standard" || "priority", // required + * // checkArn: "STRING_VALUE", + * // status: "ok" || "warning" || "error", // required + * // lifecycleStage: "in_progress" || "pending_response" || "dismissed" || "resolved", + * // pillars: [ // RecommendationPillarList // required + * // "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence", + * // ], + * // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", // required + * // awsServices: [ // RecommendationAwsServiceList + * // "STRING_VALUE", + * // ], + * // name: "STRING_VALUE", // required + * // resourcesAggregates: { // RecommendationResourcesAggregates + * // okCount: Number("long"), // required + * // warningCount: Number("long"), // required + * // errorCount: Number("long"), // required + * // }, + * // pillarSpecificAggregates: { // RecommendationPillarSpecificAggregates + * // costOptimizing: { // RecommendationCostOptimizingAggregates + * // estimatedMonthlySavings: Number("double"), // required + * // estimatedPercentMonthlySavings: Number("double"), // required + * // }, + * // }, + * // createdAt: new Date("TIMESTAMP"), + * // lastUpdatedAt: new Date("TIMESTAMP"), + * // arn: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListOrganizationRecommendationsCommandInput - {@link ListOrganizationRecommendationsCommandInput} + * @returns {@link ListOrganizationRecommendationsCommandOutput} + * @see {@link ListOrganizationRecommendationsCommandInput} for command's `input` shape. + * @see {@link ListOrganizationRecommendationsCommandOutput} for command's `response` shape. + * @see {@link TrustedAdvisorClientResolvedConfig | config} for TrustedAdvisorClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Exception that access has been denied due to insufficient access
+ * + * @throws {@link InternalServerException} (server fault) + *Exception to notify that an unexpected internal error occurred during processing of the request
+ * + * @throws {@link ThrottlingException} (client fault) + *Exception to notify that requests are being throttled
+ * + * @throws {@link ValidationException} (client fault) + *Exception that the request failed to satisfy service constraints
+ * + * @throws {@link TrustedAdvisorServiceException} + *Base exception class for all service exceptions from TrustedAdvisor service.
+ * + */ +export class ListOrganizationRecommendationsCommand extends $Command< + ListOrganizationRecommendationsCommandInput, + ListOrganizationRecommendationsCommandOutput, + TrustedAdvisorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListOrganizationRecommendationsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackList Resources of a Recommendation
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TrustedAdvisorClient, ListRecommendationResourcesCommand } from "@aws-sdk/client-trustedadvisor"; // ES Modules import + * // const { TrustedAdvisorClient, ListRecommendationResourcesCommand } = require("@aws-sdk/client-trustedadvisor"); // CommonJS import + * const client = new TrustedAdvisorClient(config); + * const input = { // ListRecommendationResourcesRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * status: "ok" || "warning" || "error", + * regionCode: "STRING_VALUE", + * recommendationIdentifier: "STRING_VALUE", // required + * }; + * const command = new ListRecommendationResourcesCommand(input); + * const response = await client.send(command); + * // { // ListRecommendationResourcesResponse + * // nextToken: "STRING_VALUE", + * // recommendationResourceSummaries: [ // RecommendationResourceSummaryList // required + * // { // RecommendationResourceSummary + * // id: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // awsResourceId: "STRING_VALUE", // required + * // regionCode: "STRING_VALUE", // required + * // status: "ok" || "warning" || "error", // required + * // metadata: { // StringMap // required + * // "Exception that access has been denied due to insufficient access
+ * + * @throws {@link InternalServerException} (server fault) + *Exception to notify that an unexpected internal error occurred during processing of the request
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Exception that the requested resource has not been found
+ * + * @throws {@link ThrottlingException} (client fault) + *Exception to notify that requests are being throttled
+ * + * @throws {@link ValidationException} (client fault) + *Exception that the request failed to satisfy service constraints
+ * + * @throws {@link TrustedAdvisorServiceException} + *Base exception class for all service exceptions from TrustedAdvisor service.
+ * + */ +export class ListRecommendationResourcesCommand extends $Command< + ListRecommendationResourcesCommandInput, + ListRecommendationResourcesCommandOutput, + TrustedAdvisorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListRecommendationResourcesCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackList a filterable set of Recommendations
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TrustedAdvisorClient, ListRecommendationsCommand } from "@aws-sdk/client-trustedadvisor"; // ES Modules import + * // const { TrustedAdvisorClient, ListRecommendationsCommand } = require("@aws-sdk/client-trustedadvisor"); // CommonJS import + * const client = new TrustedAdvisorClient(config); + * const input = { // ListRecommendationsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * type: "standard" || "priority", + * status: "ok" || "warning" || "error", + * pillar: "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence", + * awsService: "STRING_VALUE", + * source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", + * checkIdentifier: "STRING_VALUE", + * afterLastUpdatedAt: new Date("TIMESTAMP"), + * beforeLastUpdatedAt: new Date("TIMESTAMP"), + * }; + * const command = new ListRecommendationsCommand(input); + * const response = await client.send(command); + * // { // ListRecommendationsResponse + * // nextToken: "STRING_VALUE", + * // recommendationSummaries: [ // RecommendationSummaryList // required + * // { // RecommendationSummary + * // id: "STRING_VALUE", // required + * // type: "standard" || "priority", // required + * // checkArn: "STRING_VALUE", + * // status: "ok" || "warning" || "error", // required + * // lifecycleStage: "in_progress" || "pending_response" || "dismissed" || "resolved", + * // pillars: [ // RecommendationPillarList // required + * // "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence", + * // ], + * // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", // required + * // awsServices: [ // RecommendationAwsServiceList + * // "STRING_VALUE", + * // ], + * // name: "STRING_VALUE", // required + * // resourcesAggregates: { // RecommendationResourcesAggregates + * // okCount: Number("long"), // required + * // warningCount: Number("long"), // required + * // errorCount: Number("long"), // required + * // }, + * // pillarSpecificAggregates: { // RecommendationPillarSpecificAggregates + * // costOptimizing: { // RecommendationCostOptimizingAggregates + * // estimatedMonthlySavings: Number("double"), // required + * // estimatedPercentMonthlySavings: Number("double"), // required + * // }, + * // }, + * // createdAt: new Date("TIMESTAMP"), + * // lastUpdatedAt: new Date("TIMESTAMP"), + * // arn: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListRecommendationsCommandInput - {@link ListRecommendationsCommandInput} + * @returns {@link ListRecommendationsCommandOutput} + * @see {@link ListRecommendationsCommandInput} for command's `input` shape. + * @see {@link ListRecommendationsCommandOutput} for command's `response` shape. + * @see {@link TrustedAdvisorClientResolvedConfig | config} for TrustedAdvisorClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Exception that access has been denied due to insufficient access
+ * + * @throws {@link InternalServerException} (server fault) + *Exception to notify that an unexpected internal error occurred during processing of the request
+ * + * @throws {@link ThrottlingException} (client fault) + *Exception to notify that requests are being throttled
+ * + * @throws {@link ValidationException} (client fault) + *Exception that the request failed to satisfy service constraints
+ * + * @throws {@link TrustedAdvisorServiceException} + *Base exception class for all service exceptions from TrustedAdvisor service.
+ * + */ +export class ListRecommendationsCommand extends $Command< + ListRecommendationsCommandInput, + ListRecommendationsCommandOutput, + TrustedAdvisorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListRecommendationsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdate the lifecyle of a Recommendation within an Organization. This API only supports prioritized + * recommendations. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TrustedAdvisorClient, UpdateOrganizationRecommendationLifecycleCommand } from "@aws-sdk/client-trustedadvisor"; // ES Modules import + * // const { TrustedAdvisorClient, UpdateOrganizationRecommendationLifecycleCommand } = require("@aws-sdk/client-trustedadvisor"); // CommonJS import + * const client = new TrustedAdvisorClient(config); + * const input = { // UpdateOrganizationRecommendationLifecycleRequest + * lifecycleStage: "pending_response" || "in_progress" || "dismissed" || "resolved", // required + * updateReason: "STRING_VALUE", + * updateReasonCode: "non_critical_account" || "temporary_account" || "valid_business_case" || "other_methods_available" || "low_priority" || "not_applicable" || "other", + * organizationRecommendationIdentifier: "STRING_VALUE", // required + * }; + * const command = new UpdateOrganizationRecommendationLifecycleCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UpdateOrganizationRecommendationLifecycleCommandInput - {@link UpdateOrganizationRecommendationLifecycleCommandInput} + * @returns {@link UpdateOrganizationRecommendationLifecycleCommandOutput} + * @see {@link UpdateOrganizationRecommendationLifecycleCommandInput} for command's `input` shape. + * @see {@link UpdateOrganizationRecommendationLifecycleCommandOutput} for command's `response` shape. + * @see {@link TrustedAdvisorClientResolvedConfig | config} for TrustedAdvisorClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Exception that access has been denied due to insufficient access
+ * + * @throws {@link ConflictException} (client fault) + *Exception that the request was denied due to conflictions in state
+ * + * @throws {@link InternalServerException} (server fault) + *Exception to notify that an unexpected internal error occurred during processing of the request
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Exception that the requested resource has not been found
+ * + * @throws {@link ThrottlingException} (client fault) + *Exception to notify that requests are being throttled
+ * + * @throws {@link ValidationException} (client fault) + *Exception that the request failed to satisfy service constraints
+ * + * @throws {@link TrustedAdvisorServiceException} + *Base exception class for all service exceptions from TrustedAdvisor service.
+ * + */ +export class UpdateOrganizationRecommendationLifecycleCommand extends $Command< + UpdateOrganizationRecommendationLifecycleCommandInput, + UpdateOrganizationRecommendationLifecycleCommandOutput, + TrustedAdvisorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateOrganizationRecommendationLifecycleCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdate the lifecyle of a Recommendation. This API only supports prioritized recommendations.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TrustedAdvisorClient, UpdateRecommendationLifecycleCommand } from "@aws-sdk/client-trustedadvisor"; // ES Modules import + * // const { TrustedAdvisorClient, UpdateRecommendationLifecycleCommand } = require("@aws-sdk/client-trustedadvisor"); // CommonJS import + * const client = new TrustedAdvisorClient(config); + * const input = { // UpdateRecommendationLifecycleRequest + * lifecycleStage: "pending_response" || "in_progress" || "dismissed" || "resolved", // required + * updateReason: "STRING_VALUE", + * updateReasonCode: "non_critical_account" || "temporary_account" || "valid_business_case" || "other_methods_available" || "low_priority" || "not_applicable" || "other", + * recommendationIdentifier: "STRING_VALUE", // required + * }; + * const command = new UpdateRecommendationLifecycleCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UpdateRecommendationLifecycleCommandInput - {@link UpdateRecommendationLifecycleCommandInput} + * @returns {@link UpdateRecommendationLifecycleCommandOutput} + * @see {@link UpdateRecommendationLifecycleCommandInput} for command's `input` shape. + * @see {@link UpdateRecommendationLifecycleCommandOutput} for command's `response` shape. + * @see {@link TrustedAdvisorClientResolvedConfig | config} for TrustedAdvisorClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Exception that access has been denied due to insufficient access
+ * + * @throws {@link ConflictException} (client fault) + *Exception that the request was denied due to conflictions in state
+ * + * @throws {@link InternalServerException} (server fault) + *Exception to notify that an unexpected internal error occurred during processing of the request
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Exception that the requested resource has not been found
+ * + * @throws {@link ThrottlingException} (client fault) + *Exception to notify that requests are being throttled
+ * + * @throws {@link ValidationException} (client fault) + *Exception that the request failed to satisfy service constraints
+ * + * @throws {@link TrustedAdvisorServiceException} + *Base exception class for all service exceptions from TrustedAdvisor service.
+ * + */ +export class UpdateRecommendationLifecycleCommand extends $Command< + UpdateRecommendationLifecycleCommandInput, + UpdateRecommendationLifecycleCommandOutput, + TrustedAdvisorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateRecommendationLifecycleCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackTrustedAdvisor Public API
+ * + * @packageDocumentation + */ +export * from "./TrustedAdvisorClient"; +export * from "./TrustedAdvisor"; +export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters"; +export { RuntimeExtension } from "./runtimeExtensions"; +export { TrustedAdvisorExtensionConfiguration } from "./extensionConfiguration"; +export * from "./commands"; +export * from "./pagination"; +export * from "./models"; + +import "@aws-sdk/util-endpoints"; + +export { TrustedAdvisorServiceException } from "./models/TrustedAdvisorServiceException"; diff --git a/clients/client-trustedadvisor/src/models/TrustedAdvisorServiceException.ts b/clients/client-trustedadvisor/src/models/TrustedAdvisorServiceException.ts new file mode 100644 index 000000000000..a41db1549dbb --- /dev/null +++ b/clients/client-trustedadvisor/src/models/TrustedAdvisorServiceException.ts @@ -0,0 +1,22 @@ +// smithy-typescript generated code +import { + ServiceException as __ServiceException, + ServiceExceptionOptions as __ServiceExceptionOptions, +} from "@smithy/smithy-client"; + +export { __ServiceException, __ServiceExceptionOptions }; + +/** + * @public + * + * Base exception class for all service exceptions from TrustedAdvisor service. + */ +export class TrustedAdvisorServiceException extends __ServiceException { + /** + * @internal + */ + constructor(options: __ServiceExceptionOptions) { + super(options); + Object.setPrototypeOf(this, TrustedAdvisorServiceException.prototype); + } +} diff --git a/clients/client-trustedadvisor/src/models/index.ts b/clients/client-trustedadvisor/src/models/index.ts new file mode 100644 index 000000000000..9eaceb12865f --- /dev/null +++ b/clients/client-trustedadvisor/src/models/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./models_0"; diff --git a/clients/client-trustedadvisor/src/models/models_0.ts b/clients/client-trustedadvisor/src/models/models_0.ts new file mode 100644 index 000000000000..13a7ccb88b01 --- /dev/null +++ b/clients/client-trustedadvisor/src/models/models_0.ts @@ -0,0 +1,1615 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; + +import { TrustedAdvisorServiceException as __BaseException } from "./TrustedAdvisorServiceException"; + +/** + * @public + *Exception that access has been denied due to insufficient access
+ */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeSummary of an AccountRecommendationLifecycle for an Organization Recommendation
+ */ +export interface AccountRecommendationLifecycleSummary { + /** + * @public + *The AWS account ID
+ */ + accountId?: string; + + /** + * @public + *The Recommendation ARN
+ */ + accountRecommendationArn?: string; + + /** + * @public + *The lifecycle stage from AWS Trusted Advisor Priority
+ */ + lifecycleStage?: RecommendationLifecycleStage; + + /** + * @public + *The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information + * is only available when a Technical Account Manager takes an action on a recommendation managed by AWS + * Trusted Advisor Priority + *
+ */ + updatedOnBehalfOf?: string; + + /** + * @public + *The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. + * This information is only available when a Technical Account Manager takes an action on a recommendation + * managed by AWS Trusted Advisor Priority + *
+ */ + updatedOnBehalfOfJobTitle?: string; + + /** + * @public + *Reason for the lifecycle stage change
+ */ + updateReason?: string; + + /** + * @public + *Reason code for the lifecycle state change
+ */ + updateReasonCode?: UpdateRecommendationLifecycleStageReasonCode; + + /** + * @public + *When the Recommendation was last updated
+ */ + lastUpdatedAt?: Date; +} + +/** + * @public + * @enum + */ +export const RecommendationPillar = { + COST_OPTIMIZING: "cost_optimizing", + FAULT_TOLERANCE: "fault_tolerance", + OPERATIONAL_EXCELLENCE: "operational_excellence", + PERFORMANCE: "performance", + SECURITY: "security", + SERVICE_LIMITS: "service_limits", +} as const; + +/** + * @public + */ +export type RecommendationPillar = (typeof RecommendationPillar)[keyof typeof RecommendationPillar]; + +/** + * @public + * @enum + */ +export const RecommendationSource = { + AWS_CONFIG: "aws_config", + COMPUTE_OPTIMIZER: "compute_optimizer", + COST_EXPLORER: "cost_explorer", + LSE: "lse", + MANUAL: "manual", + PSE: "pse", + RDS: "rds", + RESILIENCE: "resilience", + RESILIENCE_HUB: "resilience_hub", + SECURITY_HUB: "security_hub", + STIR: "stir", + TA_CHECK: "ta_check", + WELL_ARCHITECTED: "well_architected", +} as const; + +/** + * @public + */ +export type RecommendationSource = (typeof RecommendationSource)[keyof typeof RecommendationSource]; + +/** + * @public + *A summary of an AWS Trusted Advisor Check
+ */ +export interface CheckSummary { + /** + * @public + *The unique identifier of the AWS Trusted Advisor Check
+ */ + id: string | undefined; + + /** + * @public + *The ARN of the AWS Trusted Advisor Check
+ */ + arn: string | undefined; + + /** + * @public + *The name of the AWS Trusted Advisor Check
+ */ + name: string | undefined; + + /** + * @public + *A description of what the AWS Trusted Advisor Check is monitoring
+ */ + description: string | undefined; + + /** + * @public + *The Recommendation pillars that the AWS Trusted Advisor Check falls under
+ */ + pillars: RecommendationPillar[] | undefined; + + /** + * @public + *The AWS Services that the Check applies to
+ */ + awsServices: string[] | undefined; + + /** + * @public + *The source of the Recommendation
+ */ + source: RecommendationSource | undefined; + + /** + * @public + *The column headings for the metadata returned in the resource
+ */ + metadata: RecordException that the request was denied due to conflictions in state
+ */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe Recommendation identifier
+ */ + organizationRecommendationIdentifier: string | undefined; +} + +/** + * @public + *Cost optimizing aggregates for a Recommendation
+ */ +export interface RecommendationCostOptimizingAggregates { + /** + * @public + *The estimated monthly savings
+ */ + estimatedMonthlySavings: number | undefined; + + /** + * @public + *The estimated percently monthly savings
+ */ + estimatedPercentMonthlySavings: number | undefined; +} + +/** + * @public + *Recommendation pillar aggregates
+ */ +export interface RecommendationPillarSpecificAggregates { + /** + * @public + *Cost optimizing aggregates
+ */ + costOptimizing?: RecommendationCostOptimizingAggregates; +} + +/** + * @public + *Aggregation of Recommendation Resources
+ */ +export interface RecommendationResourcesAggregates { + /** + * @public + *The number of AWS resources that were flagged to be OK according to the Trusted Advisor check
+ */ + okCount: number | undefined; + + /** + * @public + *The number of AWS resources that were flagged to have warning according to the Trusted Advisor check + *
+ */ + warningCount: number | undefined; + + /** + * @public + *The number of AWS resources that were flagged to have errors according to the Trusted Advisor check
+ */ + errorCount: number | undefined; +} + +/** + * @public + * @enum + */ +export const RecommendationStatus = { + ERROR: "error", + OK: "ok", + WARNING: "warning", +} as const; + +/** + * @public + */ +export type RecommendationStatus = (typeof RecommendationStatus)[keyof typeof RecommendationStatus]; + +/** + * @public + * @enum + */ +export const RecommendationType = { + PRIORITY: "priority", + STANDARD: "standard", +} as const; + +/** + * @public + */ +export type RecommendationType = (typeof RecommendationType)[keyof typeof RecommendationType]; + +/** + * @public + *A Recommendation for accounts within an Organization
+ */ +export interface OrganizationRecommendation { + /** + * @public + *The ID which identifies where the Recommendation was produced
+ */ + id: string | undefined; + + /** + * @public + *Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
+ */ + type: RecommendationType | undefined; + + /** + * @public + *The AWS Trusted Advisor Check ARN that relates to the Recommendation
+ */ + checkArn?: string; + + /** + * @public + *The status of the Recommendation
+ */ + status: RecommendationStatus | undefined; + + /** + * @public + *The lifecycle stage from AWS Trusted Advisor Priority
+ */ + lifecycleStage?: RecommendationLifecycleStage; + + /** + * @public + *The Pillars that the Recommendation is optimizing
+ */ + pillars: RecommendationPillar[] | undefined; + + /** + * @public + *The source of the Recommendation
+ */ + source: RecommendationSource | undefined; + + /** + * @public + *The AWS Services that the Recommendation applies to
+ */ + awsServices?: string[]; + + /** + * @public + *The name of the AWS Trusted Advisor Recommendation
+ */ + name: string | undefined; + + /** + * @public + *An aggregation of all resources
+ */ + resourcesAggregates: RecommendationResourcesAggregates | undefined; + + /** + * @public + *The pillar aggregations for cost savings
+ */ + pillarSpecificAggregates?: RecommendationPillarSpecificAggregates; + + /** + * @public + *When the Recommendation was created, if created by AWS Trusted Advisor Priority
+ */ + createdAt?: Date; + + /** + * @public + *When the Recommendation was last updated
+ */ + lastUpdatedAt?: Date; + + /** + * @public + *The ARN of the Recommendation
+ */ + arn: string | undefined; + + /** + * @public + *A description for AWS Trusted Advisor recommendations
+ */ + description: string | undefined; + + /** + * @public + *The creator, if created by AWS Trusted Advisor Priority
+ */ + createdBy?: string; + + /** + * @public + *The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information + * is only available when a Technical Account Manager takes an action on a recommendation managed by AWS + * Trusted Advisor Priority + *
+ */ + updatedOnBehalfOf?: string; + + /** + * @public + *The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. + * This information is only available when a Technical Account Manager takes an action on a recommendation + * managed by AWS Trusted Advisor Priority + *
+ */ + updatedOnBehalfOfJobTitle?: string; + + /** + * @public + *Reason for the lifecycle stage change
+ */ + updateReason?: string; + + /** + * @public + *Reason code for the lifecycle state change
+ */ + updateReasonCode?: UpdateRecommendationLifecycleStageReasonCode; + + /** + * @public + *When the Recommendation was resolved
+ */ + resolvedAt?: Date; +} + +/** + * @public + */ +export interface GetOrganizationRecommendationResponse { + /** + * @public + *The Recommendation
+ */ + organizationRecommendation?: OrganizationRecommendation; +} + +/** + * @public + *Exception to notify that an unexpected internal error occurred during processing of the request
+ */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + $retryable = {}; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeException that the requested resource has not been found
+ */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeException to notify that requests are being throttled
+ */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + $retryable = { + throttling: true, + }; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeException that the request failed to satisfy service constraints
+ */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe Recommendation identifier
+ */ + recommendationIdentifier: string | undefined; +} + +/** + * @public + *A Recommendation for an Account
+ */ +export interface Recommendation { + /** + * @public + *The ID which identifies where the Recommendation was produced
+ */ + id: string | undefined; + + /** + * @public + *Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
+ */ + type: RecommendationType | undefined; + + /** + * @public + *The AWS Trusted Advisor Check ARN that relates to the Recommendation
+ */ + checkArn?: string; + + /** + * @public + *The status of the Recommendation
+ */ + status: RecommendationStatus | undefined; + + /** + * @public + *The lifecycle stage from AWS Trusted Advisor Priority
+ */ + lifecycleStage?: RecommendationLifecycleStage; + + /** + * @public + *The Pillars that the Recommendation is optimizing
+ */ + pillars: RecommendationPillar[] | undefined; + + /** + * @public + *The source of the Recommendation
+ */ + source: RecommendationSource | undefined; + + /** + * @public + *The AWS Services that the Recommendation applies to
+ */ + awsServices?: string[]; + + /** + * @public + *The name of the AWS Trusted Advisor Recommendation
+ */ + name: string | undefined; + + /** + * @public + *An aggregation of all resources
+ */ + resourcesAggregates: RecommendationResourcesAggregates | undefined; + + /** + * @public + *The pillar aggregations for cost savings
+ */ + pillarSpecificAggregates?: RecommendationPillarSpecificAggregates; + + /** + * @public + *When the Recommendation was created, if created by AWS Trusted Advisor Priority
+ */ + createdAt?: Date; + + /** + * @public + *When the Recommendation was last updated
+ */ + lastUpdatedAt?: Date; + + /** + * @public + *The ARN of the Recommendation
+ */ + arn: string | undefined; + + /** + * @public + *A description for AWS Trusted Advisor recommendations
+ */ + description: string | undefined; + + /** + * @public + *The creator, if created by AWS Trusted Advisor Priority
+ */ + createdBy?: string; + + /** + * @public + *The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information + * is only available when a Technical Account Manager takes an action on a recommendation managed by AWS + * Trusted Advisor Priority + *
+ */ + updatedOnBehalfOf?: string; + + /** + * @public + *The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. + * This information is only available when a Technical Account Manager takes an action on a recommendation + * managed by AWS Trusted Advisor Priority + *
+ */ + updatedOnBehalfOfJobTitle?: string; + + /** + * @public + *Reason for the lifecycle stage change
+ */ + updateReason?: string; + + /** + * @public + *Reason code for the lifecycle state change
+ */ + updateReasonCode?: UpdateRecommendationLifecycleStageReasonCode; + + /** + * @public + *When the Recommendation was resolved
+ */ + resolvedAt?: Date; +} + +/** + * @public + */ +export interface GetRecommendationResponse { + /** + * @public + *The Recommendation
+ */ + recommendation?: Recommendation; +} + +/** + * @public + * @enum + */ +export const RecommendationLanguage = { + BAHASA_INDONESIA: "id", + BRAZILIAN_PORTUGUESE: "pt_BR", + CHINESE: "zh", + ENGLISH: "en", + FRENCH: "fr", + GERMAN: "de", + ITALIAN: "it", + JAPANESE: "ja", + KOREAN: "ko", + SPANISH: "es", + TRADITIONAL_CHINESE: "zh_TW", +} as const; + +/** + * @public + */ +export type RecommendationLanguage = (typeof RecommendationLanguage)[keyof typeof RecommendationLanguage]; + +/** + * @public + */ +export interface ListChecksRequest { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *The maximum number of results to return per page.
+ */ + maxResults?: number; + + /** + * @public + *The pillar of the check
+ */ + pillar?: RecommendationPillar; + + /** + * @public + *The aws service associated with the check
+ */ + awsService?: string; + + /** + * @public + *The source of the check
+ */ + source?: RecommendationSource; + + /** + * @public + *The ISO 639-1 code for the language that you want your checks to appear in.
+ */ + language?: RecommendationLanguage; +} + +/** + * @public + */ +export interface ListChecksResponse { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *The list of Checks
+ */ + checkSummaries: CheckSummary[] | undefined; +} + +/** + * @public + */ +export interface ListOrganizationRecommendationAccountsRequest { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *The maximum number of results to return per page.
+ */ + maxResults?: number; + + /** + * @public + *The Recommendation identifier
+ */ + organizationRecommendationIdentifier: string | undefined; + + /** + * @public + *An account affected by this organization recommendation
+ */ + affectedAccountId?: string; +} + +/** + * @public + */ +export interface ListOrganizationRecommendationAccountsResponse { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *The account recommendations lifecycles that are applicable to the Recommendation
+ */ + accountRecommendationLifecycleSummaries: AccountRecommendationLifecycleSummary[] | undefined; +} + +/** + * @public + * @enum + */ +export const ResourceStatus = { + ERROR: "error", + OK: "ok", + WARNING: "warning", +} as const; + +/** + * @public + */ +export type ResourceStatus = (typeof ResourceStatus)[keyof typeof ResourceStatus]; + +/** + * @public + */ +export interface ListOrganizationRecommendationResourcesRequest { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *The maximum number of results to return per page.
+ */ + maxResults?: number; + + /** + * @public + *The status of the resource
+ */ + status?: ResourceStatus; + + /** + * @public + *The AWS Region code of the resource
+ */ + regionCode?: string; + + /** + * @public + *The AWS Organization organization's Recommendation identifier
+ */ + organizationRecommendationIdentifier: string | undefined; + + /** + * @public + *An account affected by this organization recommendation
+ */ + affectedAccountId?: string; +} + +/** + * @public + *Organization Recommendation Resource Summary
+ */ +export interface OrganizationRecommendationResourceSummary { + /** + * @public + *The ID of the Recommendation Resource
+ */ + id: string | undefined; + + /** + * @public + *The ARN of the Recommendation Resource
+ */ + arn: string | undefined; + + /** + * @public + *The AWS resource identifier
+ */ + awsResourceId: string | undefined; + + /** + * @public + *The AWS Region code that the Recommendation Resource is in
+ */ + regionCode: string | undefined; + + /** + * @public + *The current status of the Recommendation Resource
+ */ + status: ResourceStatus | undefined; + + /** + * @public + *Metadata associated with the Recommendation Resource
+ */ + metadata: RecordWhen the Recommendation Resource was last updated
+ */ + lastUpdatedAt: Date | undefined; + + /** + * @public + *The AWS account ID
+ */ + accountId?: string; + + /** + * @public + *The Recommendation ARN
+ */ + recommendationArn: string | undefined; +} + +/** + * @public + */ +export interface ListOrganizationRecommendationResourcesResponse { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *A list of Recommendation Resources
+ */ + organizationRecommendationResourceSummaries: OrganizationRecommendationResourceSummary[] | undefined; +} + +/** + * @public + */ +export interface ListOrganizationRecommendationsRequest { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *The maximum number of results to return per page.
+ */ + maxResults?: number; + + /** + * @public + *The type of the Recommendation
+ */ + type?: RecommendationType; + + /** + * @public + *The status of the Recommendation
+ */ + status?: RecommendationStatus; + + /** + * @public + *The pillar of the Recommendation
+ */ + pillar?: RecommendationPillar; + + /** + * @public + *The aws service associated with the Recommendation
+ */ + awsService?: string; + + /** + * @public + *The source of the Recommendation
+ */ + source?: RecommendationSource; + + /** + * @public + *The check identifier of the Recommendation
+ */ + checkIdentifier?: string; + + /** + * @public + *After the last update of the Recommendation
+ */ + afterLastUpdatedAt?: Date; + + /** + * @public + *Before the last update of the Recommendation
+ */ + beforeLastUpdatedAt?: Date; +} + +/** + * @public + *Summary of recommendation for accounts within an Organization
+ */ +export interface OrganizationRecommendationSummary { + /** + * @public + *The ID which identifies where the Recommendation was produced
+ */ + id: string | undefined; + + /** + * @public + *Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
+ */ + type: RecommendationType | undefined; + + /** + * @public + *The AWS Trusted Advisor Check ARN that relates to the Recommendation
+ */ + checkArn?: string; + + /** + * @public + *The status of the Recommendation
+ */ + status: RecommendationStatus | undefined; + + /** + * @public + *The lifecycle stage from AWS Trusted Advisor Priority
+ */ + lifecycleStage?: RecommendationLifecycleStage; + + /** + * @public + *The Pillars that the Recommendation is optimizing
+ */ + pillars: RecommendationPillar[] | undefined; + + /** + * @public + *The source of the Recommendation
+ */ + source: RecommendationSource | undefined; + + /** + * @public + *The AWS Services that the Recommendation applies to
+ */ + awsServices?: string[]; + + /** + * @public + *The name of the AWS Trusted Advisor Recommendation
+ */ + name: string | undefined; + + /** + * @public + *An aggregation of all resources
+ */ + resourcesAggregates: RecommendationResourcesAggregates | undefined; + + /** + * @public + *The pillar aggregations for cost savings
+ */ + pillarSpecificAggregates?: RecommendationPillarSpecificAggregates; + + /** + * @public + *When the Recommendation was created, if created by AWS Trusted Advisor Priority
+ */ + createdAt?: Date; + + /** + * @public + *When the Recommendation was last updated
+ */ + lastUpdatedAt?: Date; + + /** + * @public + *The ARN of the Recommendation
+ */ + arn: string | undefined; +} + +/** + * @public + */ +export interface ListOrganizationRecommendationsResponse { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *The list of Recommendations
+ */ + organizationRecommendationSummaries: OrganizationRecommendationSummary[] | undefined; +} + +/** + * @public + */ +export interface ListRecommendationResourcesRequest { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *The maximum number of results to return per page.
+ */ + maxResults?: number; + + /** + * @public + *The status of the resource
+ */ + status?: ResourceStatus; + + /** + * @public + *The AWS Region code of the resource
+ */ + regionCode?: string; + + /** + * @public + *The Recommendation identifier
+ */ + recommendationIdentifier: string | undefined; +} + +/** + * @public + *Summary of a Recommendation Resource
+ */ +export interface RecommendationResourceSummary { + /** + * @public + *The ID of the Recommendation Resource
+ */ + id: string | undefined; + + /** + * @public + *The ARN of the Recommendation Resource
+ */ + arn: string | undefined; + + /** + * @public + *The AWS resource identifier
+ */ + awsResourceId: string | undefined; + + /** + * @public + *The AWS Region code that the Recommendation Resource is in
+ */ + regionCode: string | undefined; + + /** + * @public + *The current status of the Recommendation Resource
+ */ + status: ResourceStatus | undefined; + + /** + * @public + *Metadata associated with the Recommendation Resource
+ */ + metadata: RecordWhen the Recommendation Resource was last updated
+ */ + lastUpdatedAt: Date | undefined; + + /** + * @public + *The Recommendation ARN
+ */ + recommendationArn: string | undefined; +} + +/** + * @public + */ +export interface ListRecommendationResourcesResponse { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *A list of Recommendation Resources
+ */ + recommendationResourceSummaries: RecommendationResourceSummary[] | undefined; +} + +/** + * @public + */ +export interface ListRecommendationsRequest { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *The maximum number of results to return per page.
+ */ + maxResults?: number; + + /** + * @public + *The type of the Recommendation
+ */ + type?: RecommendationType; + + /** + * @public + *The status of the Recommendation
+ */ + status?: RecommendationStatus; + + /** + * @public + *The pillar of the Recommendation
+ */ + pillar?: RecommendationPillar; + + /** + * @public + *The aws service associated with the Recommendation
+ */ + awsService?: string; + + /** + * @public + *The source of the Recommendation
+ */ + source?: RecommendationSource; + + /** + * @public + *The check identifier of the Recommendation
+ */ + checkIdentifier?: string; + + /** + * @public + *After the last update of the Recommendation
+ */ + afterLastUpdatedAt?: Date; + + /** + * @public + *Before the last update of the Recommendation
+ */ + beforeLastUpdatedAt?: Date; +} + +/** + * @public + *Summary of Recommendation for an Account
+ */ +export interface RecommendationSummary { + /** + * @public + *The ID which identifies where the Recommendation was produced
+ */ + id: string | undefined; + + /** + * @public + *Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
+ */ + type: RecommendationType | undefined; + + /** + * @public + *The AWS Trusted Advisor Check ARN that relates to the Recommendation
+ */ + checkArn?: string; + + /** + * @public + *The status of the Recommendation
+ */ + status: RecommendationStatus | undefined; + + /** + * @public + *The lifecycle stage from AWS Trusted Advisor Priority
+ */ + lifecycleStage?: RecommendationLifecycleStage; + + /** + * @public + *The Pillars that the Recommendation is optimizing
+ */ + pillars: RecommendationPillar[] | undefined; + + /** + * @public + *The source of the Recommendation
+ */ + source: RecommendationSource | undefined; + + /** + * @public + *The AWS Services that the Recommendation applies to
+ */ + awsServices?: string[]; + + /** + * @public + *The name of the AWS Trusted Advisor Recommendation
+ */ + name: string | undefined; + + /** + * @public + *An aggregation of all resources
+ */ + resourcesAggregates: RecommendationResourcesAggregates | undefined; + + /** + * @public + *The pillar aggregations for cost savings
+ */ + pillarSpecificAggregates?: RecommendationPillarSpecificAggregates; + + /** + * @public + *When the Recommendation was created, if created by AWS Trusted Advisor Priority
+ */ + createdAt?: Date; + + /** + * @public + *When the Recommendation was last updated
+ */ + lastUpdatedAt?: Date; + + /** + * @public + *The ARN of the Recommendation
+ */ + arn: string | undefined; +} + +/** + * @public + */ +export interface ListRecommendationsResponse { + /** + * @public + *The token for the next set of results. Use the value returned in the previous response in the next request + * to retrieve the next set of results. + *
+ */ + nextToken?: string; + + /** + * @public + *The list of Recommendations
+ */ + recommendationSummaries: RecommendationSummary[] | undefined; +} + +/** + * @public + * @enum + */ +export const UpdateRecommendationLifecycleStage = { + DISMISSED: "dismissed", + IN_PROGRESS: "in_progress", + PENDING_RESPONSE: "pending_response", + RESOLVED: "resolved", +} as const; + +/** + * @public + */ +export type UpdateRecommendationLifecycleStage = + (typeof UpdateRecommendationLifecycleStage)[keyof typeof UpdateRecommendationLifecycleStage]; + +/** + * @public + */ +export interface UpdateOrganizationRecommendationLifecycleRequest { + /** + * @public + *The new lifecycle stage
+ */ + lifecycleStage: UpdateRecommendationLifecycleStage | undefined; + + /** + * @public + *Reason for the lifecycle stage change
+ */ + updateReason?: string; + + /** + * @public + *Reason code for the lifecycle state change
+ */ + updateReasonCode?: UpdateRecommendationLifecycleStageReasonCode; + + /** + * @public + *The Recommendation identifier for AWS Trusted Advisor Priority recommendations
+ */ + organizationRecommendationIdentifier: string | undefined; +} + +/** + * @public + */ +export interface UpdateRecommendationLifecycleRequest { + /** + * @public + *The new lifecycle stage
+ */ + lifecycleStage: UpdateRecommendationLifecycleStage | undefined; + + /** + * @public + *Reason for the lifecycle stage change
+ */ + updateReason?: string; + + /** + * @public + *Reason code for the lifecycle state change
+ */ + updateReasonCode?: UpdateRecommendationLifecycleStageReasonCode; + + /** + * @public + *The Recommendation identifier for AWS Trusted Advisor Priority recommendations
+ */ + recommendationIdentifier: string | undefined; +} + +/** + * @internal + */ +export const AccountRecommendationLifecycleSummaryFilterSensitiveLog = ( + obj: AccountRecommendationLifecycleSummary +): any => ({ + ...obj, + ...(obj.updateReason && { updateReason: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const OrganizationRecommendationFilterSensitiveLog = (obj: OrganizationRecommendation): any => ({ + ...obj, + ...(obj.updateReason && { updateReason: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetOrganizationRecommendationResponseFilterSensitiveLog = ( + obj: GetOrganizationRecommendationResponse +): any => ({ + ...obj, + ...(obj.organizationRecommendation && { + organizationRecommendation: OrganizationRecommendationFilterSensitiveLog(obj.organizationRecommendation), + }), +}); + +/** + * @internal + */ +export const RecommendationFilterSensitiveLog = (obj: Recommendation): any => ({ + ...obj, + ...(obj.updateReason && { updateReason: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetRecommendationResponseFilterSensitiveLog = (obj: GetRecommendationResponse): any => ({ + ...obj, + ...(obj.recommendation && { recommendation: RecommendationFilterSensitiveLog(obj.recommendation) }), +}); + +/** + * @internal + */ +export const ListOrganizationRecommendationAccountsResponseFilterSensitiveLog = ( + obj: ListOrganizationRecommendationAccountsResponse +): any => ({ + ...obj, + ...(obj.accountRecommendationLifecycleSummaries && { + accountRecommendationLifecycleSummaries: obj.accountRecommendationLifecycleSummaries.map((item) => + AccountRecommendationLifecycleSummaryFilterSensitiveLog(item) + ), + }), +}); + +/** + * @internal + */ +export const UpdateOrganizationRecommendationLifecycleRequestFilterSensitiveLog = ( + obj: UpdateOrganizationRecommendationLifecycleRequest +): any => ({ + ...obj, + ...(obj.updateReason && { updateReason: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const UpdateRecommendationLifecycleRequestFilterSensitiveLog = ( + obj: UpdateRecommendationLifecycleRequest +): any => ({ + ...obj, + ...(obj.updateReason && { updateReason: SENSITIVE_STRING }), +}); diff --git a/clients/client-trustedadvisor/src/pagination/Interfaces.ts b/clients/client-trustedadvisor/src/pagination/Interfaces.ts new file mode 100644 index 000000000000..2f86a227ead9 --- /dev/null +++ b/clients/client-trustedadvisor/src/pagination/Interfaces.ts @@ -0,0 +1,11 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@smithy/types"; + +import { TrustedAdvisorClient } from "../TrustedAdvisorClient"; + +/** + * @public + */ +export interface TrustedAdvisorPaginationConfiguration extends PaginationConfiguration { + client: TrustedAdvisorClient; +} diff --git a/clients/client-trustedadvisor/src/pagination/ListChecksPaginator.ts b/clients/client-trustedadvisor/src/pagination/ListChecksPaginator.ts new file mode 100644 index 000000000000..6143ca3e41bd --- /dev/null +++ b/clients/client-trustedadvisor/src/pagination/ListChecksPaginator.ts @@ -0,0 +1,46 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { ListChecksCommand, ListChecksCommandInput, ListChecksCommandOutput } from "../commands/ListChecksCommand"; +import { TrustedAdvisorClient } from "../TrustedAdvisorClient"; +import { TrustedAdvisorPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: TrustedAdvisorClient, + input: ListChecksCommandInput, + ...args: any +): PromiseException that access has been denied due to insufficient access
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.trustedadvisor#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.trustedadvisor#AccountRecommendationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor::\\d{12}:recommendation\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#AccountRecommendationIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 200 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor::\\d{12}:recommendation\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#AccountRecommendationLifecycleSummary": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.trustedadvisor#AccountId", + "traits": { + "smithy.api#documentation": "The AWS account ID
" + } + }, + "accountRecommendationArn": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationArn", + "traits": { + "smithy.api#documentation": "The Recommendation ARN
" + } + }, + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#RecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "The lifecycle stage from AWS Trusted Advisor Priority
" + } + }, + "updatedOnBehalfOf": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information\n is only available when a Technical Account Manager takes an action on a recommendation managed by AWS\n Trusted Advisor Priority\n
" + } + }, + "updatedOnBehalfOfJobTitle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation.\n This information is only available when a Technical Account Manager takes an action on a recommendation\n managed by AWS Trusted Advisor Priority\n
" + } + }, + "updateReason": { + "target": "com.amazonaws.trustedadvisor#RecommendationUpdateReason", + "traits": { + "smithy.api#documentation": "Reason for the lifecycle stage change
" + } + }, + "updateReasonCode": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode", + "traits": { + "smithy.api#documentation": "Reason code for the lifecycle state change
" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation was last updated
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of an AccountRecommendationLifecycle for an Organization Recommendation
" + } + }, + "com.amazonaws.trustedadvisor#AccountRecommendationLifecycleSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationLifecycleSummary" + } + }, + "com.amazonaws.trustedadvisor#CheckArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor:::check\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#CheckIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 64 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor:::check\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#CheckSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the AWS Trusted Advisor Check
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#CheckArn", + "traits": { + "smithy.api#documentation": "The ARN of the AWS Trusted Advisor Check
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the AWS Trusted Advisor Check
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of what the AWS Trusted Advisor Check is monitoring
", + "smithy.api#required": {} + } + }, + "pillars": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarList", + "traits": { + "smithy.api#documentation": "The Recommendation pillars that the AWS Trusted Advisor Check falls under
", + "smithy.api#required": {} + } + }, + "awsServices": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsServiceList", + "traits": { + "smithy.api#documentation": "The AWS Services that the Check applies to
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.trustedadvisor#RecommendationSource", + "traits": { + "smithy.api#documentation": "The source of the Recommendation
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.trustedadvisor#StringMap", + "traits": { + "smithy.api#documentation": "The column headings for the metadata returned in the resource
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of an AWS Trusted Advisor Check
" + } + }, + "com.amazonaws.trustedadvisor#CheckSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#CheckSummary" + } + }, + "com.amazonaws.trustedadvisor#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exception that the request was denied due to conflictions in state
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.trustedadvisor#GetOrganizationRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#GetOrganizationRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#GetOrganizationRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get a specific recommendation within an AWS Organizations organization. This API supports only prioritized\n recommendations.\n
", + "smithy.api#examples": [ + { + "title": "Get an AWS Organization's Recommendation by ARN", + "input": { + "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5" + }, + "output": { + "organizationRecommendation": { + "arn": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "name": "Lambda Runtime Deprecation Warning", + "description": "One or more lambdas are using a deprecated runtime", + "awsServices": ["lambda"], + "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", + "id": "9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "lifecycleStage": "resolved", + "pillars": ["security"], + "resourcesAggregates": { + "errorCount": 150, + "okCount": 500, + "warningCount": 100 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/organization-recommendations/{organizationRecommendationIdentifier}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#GetOrganizationRecommendationRequest": { + "type": "structure", + "members": { + "organizationRecommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "The Recommendation identifier
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#GetOrganizationRecommendationResponse": { + "type": "structure", + "members": { + "organizationRecommendation": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendation", + "traits": { + "smithy.api#documentation": "The Recommendation
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#GetRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#GetRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#GetRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get a specific Recommendation
", + "smithy.api#examples": [ + { + "title": "Get a Recommendation by ARN", + "input": { + "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578" + }, + "output": { + "recommendation": { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "name": "MFA Recommendation", + "description": "Enable multi-factor authentication", + "awsServices": ["iam"], + "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos", + "id": "55fa4d2e-bbb7-491a-833b-5773e9589578", + "lastUpdatedAt": "2023-11-01T15:57:58.673Z", + "pillarSpecificAggregates": { + "costOptimizing": { + "estimatedMonthlySavings": 0.0, + "estimatedPercentMonthlySavings": 0.0 + } + }, + "pillars": ["security"], + "resourcesAggregates": { + "errorCount": 0, + "okCount": 0, + "warningCount": 0 + }, + "source": "ta_check", + "status": "error", + "type": "standard" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/recommendations/{recommendationIdentifier}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#GetRecommendationRequest": { + "type": "structure", + "members": { + "recommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "The Recommendation identifier
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#GetRecommendationResponse": { + "type": "structure", + "members": { + "recommendation": { + "target": "com.amazonaws.trustedadvisor#Recommendation", + "traits": { + "smithy.api#documentation": "The Recommendation
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exception to notify that an unexpected internal error occurred during processing of the request
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.trustedadvisor#ListChecks": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListChecksRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListChecksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List a filterable set of Checks
", + "smithy.api#examples": [ + { + "title": "List all AWS Trusted Advisor Checks", + "input": {}, + "output": { + "checkSummaries": [ + { + "arn": "arn:aws:trustedadvisor:::check/1iG5NDGVre", + "awsServices": ["EC2"], + "description": "Checks security groups for rules that allow unrestricted access to a resource. Unrestricted access increases opportunities for malicious activity (hacking, denial-of-service attacks, loss of data).\nThe token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "pillar": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillar", + "traits": { + "smithy.api#documentation": "The pillar of the check
", + "smithy.api#httpQuery": "pillar" + } + }, + "awsService": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsService", + "traits": { + "smithy.api#documentation": "The aws service associated with the check
", + "smithy.api#httpQuery": "awsService" + } + }, + "source": { + "target": "com.amazonaws.trustedadvisor#RecommendationSource", + "traits": { + "smithy.api#documentation": "The source of the check
", + "smithy.api#httpQuery": "source" + } + }, + "language": { + "target": "com.amazonaws.trustedadvisor#RecommendationLanguage", + "traits": { + "smithy.api#documentation": "The ISO 639-1 code for the language that you want your checks to appear in.
", + "smithy.api#httpQuery": "language" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListChecksResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "checkSummaries": { + "target": "com.amazonaws.trustedadvisor#CheckSummaryList", + "traits": { + "smithy.api#documentation": "The list of Checks
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccountsRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the accounts that own the resources for an organization aggregate recommendation. This API only\n supports prioritized recommendations.\n
", + "smithy.api#examples": [ + { + "title": "List all Accounts for an AWS Organization's Recommendation", + "input": { + "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5" + }, + "output": { + "accountRecommendationLifecycleSummaries": [ + { + "accountId": "000000000000", + "accountRecommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "lifecycleStage": "resolved" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBRXh1QXZLTHlrTTFGcExuNmxVbWcxdEFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTUY2WWU5NVVZZXVBY0ZyOS9BZ0VRZ0RzZmZWdkFNYWU3akxUS0Fmc1dBUmdsTlJadWI3ZDhGWHF5eTNBOTloenpzNUJ3WUZnWjY3MzM1N3B2eGVQcDhQMHl3NGJrSFlHMTNEN0NaQT09KF3n6Ghj-Z9I8pjzwpxNB8fZMSZCS2Eh5pZdfoz5BP87e0KUXIzWLwupY-OGmK_klEh_J6lQMjVZmvR_C1BqTqZs0t3O0UNh29UPNdvfxIC2y2Wkrl4vKf8Zjs60ysx_eP9vVX01kpv1mxacIji9gp6lCRkMEAMmCfqW8a4bUKLZ93umoGVdYCPn_nKZHMHvqDtpHO-zHMeW2hXf8RQNQKR9pfWDsp_NBjWBqkaTuNyjOE3ardMrFnyK7CMvIHjBwn8_8guzGpY0UKVNldWzyUQRbgVXTxF-xkSMzxrOm6rxMXFbrAE=" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/organization-recommendations/{organizationRecommendationIdentifier}/accounts", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "accountRecommendationLifecycleSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccountsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "organizationRecommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "The Recommendation identifier
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "affectedAccountId": { + "target": "com.amazonaws.trustedadvisor#AccountId", + "traits": { + "smithy.api#documentation": "An account affected by this organization recommendation
", + "smithy.api#httpQuery": "affectedAccountId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccountsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "accountRecommendationLifecycleSummaries": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationLifecycleSummaryList", + "traits": { + "smithy.api#documentation": "The account recommendations lifecycles that are applicable to the Recommendation
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResourcesRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List Resources of a Recommendation within an Organization. This API only supports prioritized\n recommendations.\n
", + "smithy.api#examples": [ + { + "title": "List all Resources for an AWS Organization's Recommendation", + "input": { + "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2-ae72-730598fa89d0" + }, + "output": { + "organizationRecommendationResourceSummaries": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/5a694939-2e54-45a2-ae72-730598fa89d0/bb38affc0ce0681d9a6cd13f30238ba03a8f63dfe7a379dc403c619119d86af", + "awsResourceId": "database-1-instance-1", + "id": "bb38affc0ce0681d9a6cd13f302383ba03a8f63dfe7a379dc403c619119d86af", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "208.79999999999998", + "instanceName": "database-1-instance-1", + "instanceType": "db.r5.large", + "multiAZ": "false", + "region": "us-west-2", + "resourceARN": "arn:aws:rds:us-west-2:000000000000:db:database-1-instance-1", + "storageSizeGB": "1" + }, + "recommendationArn": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", + "regionCode": "us-west-2", + "status": "warning" + }, + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/5a694939-2e54-45a2-ae72-730598fa89d0/51fded4d7a3278818df9cfe344ff5762cec46c095a6763d1ba1ba53bd0e1b0e6", + "awsResourceId": "database-1", + "id": "51fded4d7a3278818df9cfe344ff5762cec46c095a6763d1ba1ba53bd0e1b0e6", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "31.679999999999996", + "instanceName": "database-1", + "instanceType": "db.t3.small", + "multiAZ": "false", + "region": "us-west-2", + "resourceARN": "arn:aws:rds:us-west-2:000000000000:db:database-1", + "storageSizeGB": "20" + }, + "recommendationArn": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", + "regionCode": "us-west-2", + "status": "warning" + }, + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/5a694939-2e54-45a2-ae72-730598fa89d0/f4d01bd20f4cd5372062aafc8786c489e48f0ead7cdab121463bf9f89e40a36b", + "awsResourceId": "database-2-instance-1-us-west-2a", + "id": "f4d01bd20f4cd5372062aafc8786c489e48f0ead7cdab121463bf9f89e40a36b", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "187.20000000000002", + "instanceName": "database-2-instance-1-us-west-2a", + "instanceType": "db.r6g.large", + "multiAZ": "true", + "region": "us-west-2", + "resourceARN": "arn:aws:rds:us-west-2:000000000000:db:database-2-instance-1-us-west-2a", + "storageSizeGB": "1" + }, + "recommendationArn": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", + "regionCode": "us-west-2", + "status": "warning" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBRkh6azN0L1pnN1RldmE4L0N2TjRBOUFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTTF2dEdvL0hyYjgrekZxL3FBZ0VRZ0Rzem5HWHZiV2NhOG5TdEE5ZmFoWHpSRm1xU0dUcVAvOFBteW5OWFFkZjNKT3NMUXNDblVsMTlCUnZHS3BKQnFZTlNwbXl2VEllaGFEU1gvUT09W0JMIfQ6puz70ZdK2v6sV1XDCgBIh_e6D-jVUuQQjUaIoy0uLO9QfGrlcSiJ-WvNfhbg8zO0JLcNl6s6bXqZZPZYtnMXiZ_-ygAQhajX_ObCAOedCjpcfikGf6d6KwrjVUplGOaO_NA0Xp6LJExCnViusJCzmKbLOHoBSsdEknb4kY88-iZ1lebblumsWBxsZ8ADcguSLon5IXlejoDf6UukwoM3Z7EjIue3O_OR0gT9DST52shjyNObOzPizO-auI2ZoNKE1y4bzIKtWHzqRfAHHMT4VspFBm58564FqedKqF-D71k=" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/organization-recommendations/{organizationRecommendationIdentifier}/resources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "organizationRecommendationResourceSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResourcesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#ResourceStatus", + "traits": { + "smithy.api#documentation": "The status of the resource
", + "smithy.api#httpQuery": "status" + } + }, + "regionCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The AWS Region code of the resource
", + "smithy.api#httpQuery": "regionCode" + } + }, + "organizationRecommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "The AWS Organization organization's Recommendation identifier
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "affectedAccountId": { + "target": "com.amazonaws.trustedadvisor#AccountId", + "traits": { + "smithy.api#documentation": "An account affected by this organization recommendation
", + "smithy.api#httpQuery": "affectedAccountId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResourcesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "organizationRecommendationResourceSummaries": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationResourceSummaryList", + "traits": { + "smithy.api#documentation": "A list of Recommendation Resources
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List a filterable set of Recommendations within an Organization. This API only supports prioritized\n recommendations.\n
", + "smithy.api#examples": [ + { + "title": "List all of an AWS Organization's Recommendations", + "input": {}, + "output": { + "organizationRecommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "name": "Lambda Runtime Deprecation Warning", + "awsServices": ["lambda"], + "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", + "id": "9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "lifecycleStage": "resolved", + "pillars": ["security"], + "resourcesAggregates": { + "errorCount": 150, + "okCount": 500, + "warningCount": 100 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + }, + { + "arn": "arn:aws:trustedadvisor:::organization-recommendation/4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", + "name": "Lambda Runtime Deprecation Warning", + "awsServices": ["lambda"], + "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", + "id": "4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", + "lifecycleStage": "resolved", + "pillars": ["security"], + "resourcesAggregates": { + "errorCount": 150, + "okCount": 500, + "warningCount": 100 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBCmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBSEwveUo0WGtzUERDZUEweDdjVXNJUkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVA1Q0tvVHlvaVBMMXBheFJBZ0VRZ0R0M3NSQXhJNVNoNVJGdFpXN2tjc3JRenlDSDFqaHRkbXp6VTYxZkw0V2lKbkhWeTFqZllaY2prNERPd1hUM2lZVjdZdnJpblRjRFNIVHExZz09wONgOWmSmHcQa82lL7tfrIIiz5kwiP348ZRHDFnNtRRBmuyjwEy8nWAjw_ldisYaifLWtlT31JCln5EAe7tt9c5D_pn2gh-m6EIakcQKX61DY-wuxYIKfeu1ibferY2wq_dTEbqXY6OVN-0N84GKe2azBRV9N80PLouIpG-bt9VjsqdTviEFs3eQnEDJnxRGQmgXrJQFTZIqSLDSsC2-niOVkY7HNvWtLT3fHvXUfFDfD5XlMeWL3DBbnD9beij553VbvnbuKj50BcoV2zWqgc8_eFM4xM0Gsc16OajX0Xio6ZdmwOM=" + } + }, + { + "title": "Filter and return a max of one AWS Organization Recommendation that is a part of the \"security\" pillar", + "input": { + "pillar": "security", + "maxResults": 1 + }, + "output": { + "organizationRecommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "name": "Lambda Runtime Deprecation Warning", + "awsServices": ["lambda"], + "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", + "id": "9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "lifecycleStage": "resolved", + "pillars": ["security"], + "resourcesAggregates": { + "errorCount": 150, + "okCount": 500, + "warningCount": 100 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBSG15cmpVYXd3bUtUM0J2dzhleUsyakFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTUFadFFiRTl2VmlCZWN4WHNBZ0VRZ0RzdWRPMTFVWDNjUW9MNStEeTU0QktWQlNMeDBSa3RoeG9UZVJONjRFQzJBUDdvMTdvRTMxTWlJL1FvdE9neGtYWk1aZmx1dFpybHBwRjRTUT093orMKsmELla57p7di2_DnzTGQJxzgjD9HBZApR3831zITqaZo5aTHJ8q59gon_DhD0s2sm3dY8f3SmZxI7IevqI6Vz1UTY0C3IIsyA6XrQiXwfNo36mumo_W7eSf9xNk1CD_to2qwxq-b6m1-88SfNzfvzoA4x52DBczJZNYERmdQRkh-CRs3CSnTdFdXvb8fuyONmJnJuSB5x06IIBpMhLIQqNYLkofnsWRxDUAppOE0aRNfzC4iajmWq9JiYytfc9yGsbU4bqplPYerEtSIRau0QfBrnfifJL7VilfaIwrEs_j_ekqLQ==" + } + }, + { + "title": "Use the \"nextToken\" returned from a previous request to fetch the next page of filtered AWS Organization Recommendations that are a part of the \"security\" pillar", + "input": { + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBSG15cmpVYXd3bUtUM0J2dzhleUsyakFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTUFadFFiRTl2VmlCZWN4WHNBZ0VRZ0RzdWRPMTFVWDNjUW9MNStEeTU0QktWQlNMeDBSa3RoeG9UZVJONjRFQzJBUDdvMTdvRTMxTWlJL1FvdE9neGtYWk1aZmx1dFpybHBwRjRTUT093orMKsmELla57p7di2_DnzTGQJxzgjD9HBZApR3831zITqaZo5aTHJ8q59gon_DhD0s2sm3dY8f3SmZxI7IevqI6Vz1UTY0C3IIsyA6XrQiXwfNo36mumo_W7eSf9xNk1CD_to2qwxq-b6m1-88SfNzfvzoA4x52DBczJZNYERmdQRkh-CRs3CSnTdFdXvb8fuyONmJnJuSB5x06IIBpMhLIQqNYLkofnsWRxDUAppOE0aRNfzC4iajmWq9JiYytfc9yGsbU4bqplPYerEtSIRau0QfBrnfifJL7VilfaIwrEs_j_ekqLQ==", + "pillar": "security", + "maxResults": 1 + }, + "output": { + "organizationRecommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor:::organization-recommendation/4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", + "name": "Lambda Runtime Deprecation Warning", + "awsServices": ["lambda"], + "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", + "id": "4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", + "lifecycleStage": "resolved", + "pillars": ["security"], + "resourcesAggregates": { + "errorCount": 150, + "okCount": 500, + "warningCount": 100 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/organization-recommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "organizationRecommendationSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "The type of the Recommendation
", + "smithy.api#httpQuery": "type" + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#RecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the Recommendation
", + "smithy.api#httpQuery": "status" + } + }, + "pillar": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillar", + "traits": { + "smithy.api#documentation": "The pillar of the Recommendation
", + "smithy.api#httpQuery": "pillar" + } + }, + "awsService": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsService", + "traits": { + "smithy.api#documentation": "The aws service associated with the Recommendation
", + "smithy.api#httpQuery": "awsService" + } + }, + "source": { + "target": "com.amazonaws.trustedadvisor#RecommendationSource", + "traits": { + "smithy.api#documentation": "The source of the Recommendation
", + "smithy.api#httpQuery": "source" + } + }, + "checkIdentifier": { + "target": "com.amazonaws.trustedadvisor#CheckIdentifier", + "traits": { + "smithy.api#documentation": "The check identifier of the Recommendation
", + "smithy.api#httpQuery": "checkIdentifier" + } + }, + "afterLastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "After the last update of the Recommendation
", + "smithy.api#httpQuery": "afterLastUpdatedAt" + } + }, + "beforeLastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Before the last update of the Recommendation
", + "smithy.api#httpQuery": "beforeLastUpdatedAt" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "organizationRecommendationSummaries": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationSummaryList", + "traits": { + "smithy.api#documentation": "The list of Recommendations
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#ListRecommendationResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListRecommendationResourcesRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListRecommendationResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List Resources of a Recommendation
", + "smithy.api#examples": [ + { + "title": "List all Resources for a Recommendation", + "input": { + "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578" + }, + "output": { + "recommendationResourceSummaries": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/55fa4d2e-bbb7-491a-833b-5773e9589578/18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", + "id": "18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", + "awsResourceId": "webcms-dev-01", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "123.12000000000002", + "instanceName": "webcms-dev-01", + "instanceType": "db.m6i.large", + "multiAZ": "false", + "region": "us-east-1", + "resourceARN": "arn:aws:rds:us-east-1:000000000000:db:webcms-dev-01", + "storageSizeGB": "20" + }, + "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "regionCode": "us-east-1", + "status": "warning" + }, + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/55fa4d2e-bbb7-491a-833b-5773e9589578/e6367ff500ac90db8e4adeb4892e39ee9c36bbf812dcbce4b9e4fefcec9eb63e", + "id": "e6367ff500ac90db8e4adeb4892e39ee9c36bbf812dcbce4b9e4fefcec9eb63e", + "awsResourceId": "aws-dev-db-stack-instance-1", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "29.52", + "instanceName": "aws-dev-db-stack-instance-1", + "instanceType": "db.t2.small", + "multiAZ": "false", + "region": "us-east-1", + "resourceARN": "arn:aws:rds:us-east-1:000000000000:db:aws-dev-db-stack-instance-1", + "storageSizeGB": "1" + }, + "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "regionCode": "us-east-1", + "status": "warning" + }, + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/55fa4d2e-bbb7-491a-833b-5773e9589578/31aa78ba050a5015d2d38cca7f5f1ce88f70857c4e1c3ad03f8f9fd95dad7459", + "id": "31aa78ba050a5015d2d38cca7f5f1ce88f70857c4e1c3ad03f8f9fd95dad7459", + "awsResourceId": "aws-awesome-apps-stack-db", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "114.48000000000002", + "instanceName": "aws-awesome-apps-stack-db", + "instanceType": "db.m6g.large", + "multiAZ": "false", + "region": "us-east-1", + "resourceARN": "arn:aws:rds:us-east-1:000000000000:db:aws-awesome-apps-stack-db", + "storageSizeGB": "100" + }, + "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "regionCode": "us-east-1", + "status": "warning" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmJTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBRmZpZ2taY09rdSt5VXhocEdLR0k3TUFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTWZoU3BQNUxtMkt3THpCTG5BZ0VRZ0R2WjBHdzljc3RsV2ZiSkg0QkcvUkJQZDhIc0dGTHNLOXhLc1p5bU8vVlBtYy90dThSYmVKVUhxM3RTS1JwUDB4bWp2dU1jSGQxV3BOTU40UT09pyOzpADaUjX5i75XDGEpw6TEkHoxZsepcoWjQtXjvAYrKILVkdI0lpSZqghK4mPnFGgecInr0_-BJ4ud9TPCZmnNxr7MuYTYJVFWArAaddEw3oJFOY8YLQHjJ37LsY_dEpMN6oDwdAdcdyEZBUBeK71f6XPQa0S1sw5Si_NYuJEvQ3bPZiS8V07IUkUUhe_gE1_xjGK2mA3eTW0wiylW0l8jfz3u8lC6md_5GmvVrtphEkWoc4A9DIfR9CsX_bmvOa4P3NI9rZ9-gezuhkd3k3nXqH52hZPI1fl5iyd4vSFXlvaeawI=" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/recommendations/{recommendationIdentifier}/resources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "recommendationResourceSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#ListRecommendationResourcesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#ResourceStatus", + "traits": { + "smithy.api#documentation": "The status of the resource
", + "smithy.api#httpQuery": "status" + } + }, + "regionCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The AWS Region code of the resource
", + "smithy.api#httpQuery": "regionCode" + } + }, + "recommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "The Recommendation identifier
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListRecommendationResourcesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "recommendationResourceSummaries": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceSummaryList", + "traits": { + "smithy.api#documentation": "A list of Recommendation Resources
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#ListRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List a filterable set of Recommendations
", + "smithy.api#examples": [ + { + "title": "List all Recommendations", + "input": {}, + "output": { + "recommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "name": "MFA Recommendation", + "awsServices": ["iam"], + "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos", + "id": "55fa4d2e-bbb7-491a-833b-5773e9589578", + "lastUpdatedAt": "2023-11-01T15:57:58.673Z", + "pillarSpecificAggregates": { + "costOptimizing": { + "estimatedMonthlySavings": 0.0, + "estimatedPercentMonthlySavings": 0.0 + } + }, + "pillars": ["security"], + "resourcesAggregates": { + "errorCount": 0, + "okCount": 0, + "warningCount": 0 + }, + "source": "ta_check", + "status": "error", + "type": "standard" + }, + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation/8b602b6f-452d-4cb2-8a9e-c7650955d9cd", + "name": "RDS clusters quota warning", + "awsServices": ["rds"], + "checkArn": "arn:aws:trustedadvisor:::check/gjqMBn6pjz", + "id": "8b602b6f-452d-4cb2-8a9e-c7650955d9cd", + "lastUpdatedAt": "2023-11-01T15:58:17.397Z", + "pillarSpecificAggregates": { + "costOptimizing": { + "estimatedMonthlySavings": 0.0, + "estimatedPercentMonthlySavings": 0.0 + } + }, + "pillars": ["service_limits"], + "resourcesAggregates": { + "errorCount": 0, + "okCount": 0, + "warningCount": 0 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBR3RUWW1ma3MwY0plS0llWENTZHV0SkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTUVSUDNkclhLblpkd3h4MW5BZ0VRZ0RzTFBpOTlzZmppYXJxMjJoMHlRWDV6bkFuRGZna3FOZEpKaWtuUGloUWpFRzFrSnR6eWV2UGVjWFZudEw1RHQ0dkdvQ1RXL2hGeERFNG44QT09NZONpU850LXJxneOHiAMVmAkpDmCUH5-ob34VBXNqkq9y3s54mW4se3VGv6Ds85WwEaW9uEAM3HpLWMLJjw6u3rLFdwzvNsmicgmGvBd_kZVXJ_bo3Oqgo9koXDg5ltCZt8nxhp-6FnU8dyBDdSENAlQ3ldIb6QIyyRCH5185coh7UYIjbtd7Ne-TMgHk2HsLongKnbz1Lq6dfOm3mqHyJHAmrU8Qnbm10X2Ph9ZsolloEw4HiGMdEKL5-DnGRgXp3gZLuOTrAuukHwqpd1-cRZYHxmjaIUFiSuVuSC4QlWDeeiqlPo=" + } + }, + { + "title": "Filter and return a max of one Recommendation that is a part of AWS IAM", + "input": { + "awsService": "iam", + "maxResults": 1 + }, + "output": { + "recommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "name": "MFA Recommendation", + "awsServices": ["iam"], + "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos", + "id": "55fa4d2e-bbb7-491a-833b-5773e9589578", + "lastUpdatedAt": "2023-11-01T15:57:58.673Z", + "pillarSpecificAggregates": { + "costOptimizing": { + "estimatedMonthlySavings": 0.0, + "estimatedPercentMonthlySavings": 0.0 + } + }, + "pillars": ["security"], + "resourcesAggregates": { + "errorCount": 0, + "okCount": 0, + "warningCount": 0 + }, + "source": "ta_check", + "status": "error", + "type": "standard" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBR01zYktEMDlmSm5nSkM1TGYzaWtTNkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVlwVDdDRk01cTdzV0JnRmhBZ0VRZ0R1dVg4dkVOYjZYTHJ6WVhvUlBWQVg1YU5KZkkraElsNk5lTjh3TXpzWkhHUEVzWXNkbXI2bTZzNTl1TEhKWUN2dGpqOENpTzVzM0FDT3BqZz09S35zPCUsSxxYFtdXw7z8BaSuDmz9P1Toit_MFrXsfpnPmDd6Q1f1NaJhi3O8NoZvzinXknKoKxTeqSumUaHe7W3n6Xa3661LF979aPdhifpKw3-MQpb5oGdXGgU7UMlXHzwISkND7sLlh_s0V-jkRvWPZjLHwLg4dUCQnIqMEwo5G3IG6Ffn-SKHhqPimTnzgOrxK2i9LA0EEj6msvH00h4YXuG9M3hFP9X52T19ZGZfdDPhVKCtSshXtQ8zcCUB8ykgw8ROJvAwzQk8I1PMIS4dirHySKOgoowu4Um3bZE6hHex-zXsjA==" + } + }, + { + "title": "Use the \"nextToken\" returned from a previous request to fetch the next page of filtered Recommendations that are a part of AWS IAM", + "input": { + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBR01zYktEMDlmSm5nSkM1TGYzaWtTNkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVlwVDdDRk01cTdzV0JnRmhBZ0VRZ0R1dVg4dkVOYjZYTHJ6WVhvUlBWQVg1YU5KZkkraElsNk5lTjh3TXpzWkhHUEVzWXNkbXI2bTZzNTl1TEhKWUN2dGpqOENpTzVzM0FDT3BqZz09S35zPCUsSxxYFtdXw7z8BaSuDmz9P1Toit_MFrXsfpnPmDd6Q1f1NaJhi3O8NoZvzinXknKoKxTeqSumUaHe7W3n6Xa3661LF979aPdhifpKw3-MQpb5oGdXGgU7UMlXHzwISkND7sLlh_s0V-jkRvWPZjLHwLg4dUCQnIqMEwo5G3IG6Ffn-SKHhqPimTnzgOrxK2i9LA0EEj6msvH00h4YXuG9M3hFP9X52T19ZGZfdDPhVKCtSshXtQ8zcCUB8ykgw8ROJvAwzQk8I1PMIS4dirHySKOgoowu4Um3bZE6hHex-zXsjA==", + "awsService": "iam", + "maxResults": 1 + }, + "output": { + "recommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation/8b602b6f-452d-4cb2-8a9e-c7650955d9cd", + "name": "RDS clusters quota warning", + "awsServices": ["rds"], + "checkArn": "arn:aws:trustedadvisor:::check/gjqMBn6pjz", + "id": "8b602b6f-452d-4cb2-8a9e-c7650955d9cd", + "lastUpdatedAt": "2023-11-01T15:58:17.397Z", + "pillarSpecificAggregates": { + "costOptimizing": { + "estimatedMonthlySavings": 0.0, + "estimatedPercentMonthlySavings": 0.0 + } + }, + "pillars": ["service_limits"], + "resourcesAggregates": { + "errorCount": 0, + "okCount": 0, + "warningCount": 0 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/recommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "recommendationSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#ListRecommendationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "The type of the Recommendation
", + "smithy.api#httpQuery": "type" + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#RecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the Recommendation
", + "smithy.api#httpQuery": "status" + } + }, + "pillar": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillar", + "traits": { + "smithy.api#documentation": "The pillar of the Recommendation
", + "smithy.api#httpQuery": "pillar" + } + }, + "awsService": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsService", + "traits": { + "smithy.api#documentation": "The aws service associated with the Recommendation
", + "smithy.api#httpQuery": "awsService" + } + }, + "source": { + "target": "com.amazonaws.trustedadvisor#RecommendationSource", + "traits": { + "smithy.api#documentation": "The source of the Recommendation
", + "smithy.api#httpQuery": "source" + } + }, + "checkIdentifier": { + "target": "com.amazonaws.trustedadvisor#CheckIdentifier", + "traits": { + "smithy.api#documentation": "The check identifier of the Recommendation
", + "smithy.api#httpQuery": "checkIdentifier" + } + }, + "afterLastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "After the last update of the Recommendation
", + "smithy.api#httpQuery": "afterLastUpdatedAt" + } + }, + "beforeLastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Before the last update of the Recommendation
", + "smithy.api#httpQuery": "beforeLastUpdatedAt" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListRecommendationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n
", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "recommendationSummaries": { + "target": "com.amazonaws.trustedadvisor#RecommendationSummaryList", + "traits": { + "smithy.api#documentation": "The list of Recommendations
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendation": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID which identifies where the Recommendation was produced
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
", + "smithy.api#required": {} + } + }, + "checkArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The AWS Trusted Advisor Check ARN that relates to the Recommendation
" + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#RecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the Recommendation
", + "smithy.api#required": {} + } + }, + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#RecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "The lifecycle stage from AWS Trusted Advisor Priority
" + } + }, + "pillars": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarList", + "traits": { + "smithy.api#documentation": "The Pillars that the Recommendation is optimizing
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.trustedadvisor#RecommendationSource", + "traits": { + "smithy.api#documentation": "The source of the Recommendation
", + "smithy.api#required": {} + } + }, + "awsServices": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsServiceList", + "traits": { + "smithy.api#documentation": "The AWS Services that the Recommendation applies to
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the AWS Trusted Advisor Recommendation
", + "smithy.api#required": {} + } + }, + "resourcesAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourcesAggregates", + "traits": { + "smithy.api#documentation": "An aggregation of all resources
", + "smithy.api#required": {} + } + }, + "pillarSpecificAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarSpecificAggregates", + "traits": { + "smithy.api#documentation": "The pillar aggregations for cost savings
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation was created, if created by AWS Trusted Advisor Priority
", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation was last updated
", + "smithy.api#timestampFormat": "date-time" + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationArn", + "traits": { + "smithy.api#documentation": "The ARN of the Recommendation
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description for AWS Trusted Advisor recommendations
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The creator, if created by AWS Trusted Advisor Priority
" + } + }, + "updatedOnBehalfOf": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information\n is only available when a Technical Account Manager takes an action on a recommendation managed by AWS\n Trusted Advisor Priority\n
" + } + }, + "updatedOnBehalfOfJobTitle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation.\n This information is only available when a Technical Account Manager takes an action on a recommendation\n managed by AWS Trusted Advisor Priority\n
" + } + }, + "updateReason": { + "target": "com.amazonaws.trustedadvisor#RecommendationUpdateReason", + "traits": { + "smithy.api#documentation": "Reason for the lifecycle stage change
" + } + }, + "updateReasonCode": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode", + "traits": { + "smithy.api#documentation": "Reason code for the lifecycle state change
" + } + }, + "resolvedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation was resolved
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "A Recommendation for accounts within an Organization
" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor:::organization-recommendation\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 200 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor:::organization-recommendation\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationResourceSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the Recommendation Resource
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the Recommendation Resource
", + "smithy.api#required": {} + } + }, + "awsResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The AWS resource identifier
", + "smithy.api#required": {} + } + }, + "regionCode": { + "target": "com.amazonaws.trustedadvisor#RecommendationRegionCode", + "traits": { + "smithy.api#documentation": "The AWS Region code that the Recommendation Resource is in
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#ResourceStatus", + "traits": { + "smithy.api#documentation": "The current status of the Recommendation Resource
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.trustedadvisor#StringMap", + "traits": { + "smithy.api#documentation": "Metadata associated with the Recommendation Resource
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation Resource was last updated
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "accountId": { + "target": "com.amazonaws.trustedadvisor#AccountId", + "traits": { + "smithy.api#documentation": "The AWS account ID
" + } + }, + "recommendationArn": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationArn", + "traits": { + "smithy.api#documentation": "The Recommendation ARN
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Organization Recommendation Resource Summary
" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationResourceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationResourceSummary" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID which identifies where the Recommendation was produced
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
", + "smithy.api#required": {} + } + }, + "checkArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The AWS Trusted Advisor Check ARN that relates to the Recommendation
" + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#RecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the Recommendation
", + "smithy.api#required": {} + } + }, + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#RecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "The lifecycle stage from AWS Trusted Advisor Priority
" + } + }, + "pillars": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarList", + "traits": { + "smithy.api#documentation": "The Pillars that the Recommendation is optimizing
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.trustedadvisor#RecommendationSource", + "traits": { + "smithy.api#documentation": "The source of the Recommendation
", + "smithy.api#required": {} + } + }, + "awsServices": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsServiceList", + "traits": { + "smithy.api#documentation": "The AWS Services that the Recommendation applies to
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the AWS Trusted Advisor Recommendation
", + "smithy.api#required": {} + } + }, + "resourcesAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourcesAggregates", + "traits": { + "smithy.api#documentation": "An aggregation of all resources
", + "smithy.api#required": {} + } + }, + "pillarSpecificAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarSpecificAggregates", + "traits": { + "smithy.api#documentation": "The pillar aggregations for cost savings
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation was created, if created by AWS Trusted Advisor Priority
", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation was last updated
", + "smithy.api#timestampFormat": "date-time" + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationArn", + "traits": { + "smithy.api#documentation": "The ARN of the Recommendation
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of recommendation for accounts within an Organization
" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationSummary" + } + }, + "com.amazonaws.trustedadvisor#Recommendation": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID which identifies where the Recommendation was produced
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
", + "smithy.api#required": {} + } + }, + "checkArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The AWS Trusted Advisor Check ARN that relates to the Recommendation
" + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#RecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the Recommendation
", + "smithy.api#required": {} + } + }, + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#RecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "The lifecycle stage from AWS Trusted Advisor Priority
" + } + }, + "pillars": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarList", + "traits": { + "smithy.api#documentation": "The Pillars that the Recommendation is optimizing
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.trustedadvisor#RecommendationSource", + "traits": { + "smithy.api#documentation": "The source of the Recommendation
", + "smithy.api#required": {} + } + }, + "awsServices": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsServiceList", + "traits": { + "smithy.api#documentation": "The AWS Services that the Recommendation applies to
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the AWS Trusted Advisor Recommendation
", + "smithy.api#required": {} + } + }, + "resourcesAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourcesAggregates", + "traits": { + "smithy.api#documentation": "An aggregation of all resources
", + "smithy.api#required": {} + } + }, + "pillarSpecificAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarSpecificAggregates", + "traits": { + "smithy.api#documentation": "The pillar aggregations for cost savings
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation was created, if created by AWS Trusted Advisor Priority
", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation was last updated
", + "smithy.api#timestampFormat": "date-time" + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationArn", + "traits": { + "smithy.api#documentation": "The ARN of the Recommendation
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description for AWS Trusted Advisor recommendations
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The creator, if created by AWS Trusted Advisor Priority
" + } + }, + "updatedOnBehalfOf": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information\n is only available when a Technical Account Manager takes an action on a recommendation managed by AWS\n Trusted Advisor Priority\n
" + } + }, + "updatedOnBehalfOfJobTitle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation.\n This information is only available when a Technical Account Manager takes an action on a recommendation\n managed by AWS Trusted Advisor Priority\n
" + } + }, + "updateReason": { + "target": "com.amazonaws.trustedadvisor#RecommendationUpdateReason", + "traits": { + "smithy.api#documentation": "Reason for the lifecycle stage change
" + } + }, + "updateReasonCode": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode", + "traits": { + "smithy.api#documentation": "Reason code for the lifecycle state change
" + } + }, + "resolvedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation was resolved
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "A Recommendation for an Account
" + } + }, + "com.amazonaws.trustedadvisor#RecommendationAwsService": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 30 + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationAwsServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsService" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.trustedadvisor#RecommendationCostOptimizingAggregates": { + "type": "structure", + "members": { + "estimatedMonthlySavings": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The estimated monthly savings
", + "smithy.api#required": {} + } + }, + "estimatedPercentMonthlySavings": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The estimated percently monthly savings
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Cost optimizing aggregates for a Recommendation
" + } + }, + "com.amazonaws.trustedadvisor#RecommendationLanguage": { + "type": "enum", + "members": { + "ENGLISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en" + } + }, + "JAPANESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ja" + } + }, + "CHINESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh" + } + }, + "FRENCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr" + } + }, + "GERMAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de" + } + }, + "KOREAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ko" + } + }, + "TRADITIONAL_CHINESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh_TW" + } + }, + "ITALIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it" + } + }, + "SPANISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es" + } + }, + "BRAZILIAN_PORTUGUESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt_BR" + } + }, + "BAHASA_INDONESIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "id" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationLifecycleStage": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in_progress" + } + }, + "PENDING_RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_response" + } + }, + "DISMISSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dismissed" + } + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resolved" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationPillar": { + "type": "enum", + "members": { + "COST_OPTIMIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cost_optimizing" + } + }, + "PERFORMANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "performance" + } + }, + "SECURITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "security" + } + }, + "SERVICE_LIMITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "service_limits" + } + }, + "FAULT_TOLERANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fault_tolerance" + } + }, + "OPERATIONAL_EXCELLENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "operational_excellence" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationPillarList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillar" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.trustedadvisor#RecommendationPillarSpecificAggregates": { + "type": "structure", + "members": { + "costOptimizing": { + "target": "com.amazonaws.trustedadvisor#RecommendationCostOptimizingAggregates", + "traits": { + "smithy.api#documentation": "Cost optimizing aggregates
" + } + } + }, + "traits": { + "smithy.api#documentation": "Recommendation pillar aggregates
" + } + }, + "com.amazonaws.trustedadvisor#RecommendationRegionCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 20 + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor::\\d{12}:recommendation-resource\\/[\\w-]+\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#RecommendationResourceSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the Recommendation Resource
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the Recommendation Resource
", + "smithy.api#required": {} + } + }, + "awsResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The AWS resource identifier
", + "smithy.api#required": {} + } + }, + "regionCode": { + "target": "com.amazonaws.trustedadvisor#RecommendationRegionCode", + "traits": { + "smithy.api#documentation": "The AWS Region code that the Recommendation Resource is in
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#ResourceStatus", + "traits": { + "smithy.api#documentation": "The current status of the Recommendation Resource
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.trustedadvisor#StringMap", + "traits": { + "smithy.api#documentation": "Metadata associated with the Recommendation Resource
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation Resource was last updated
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "recommendationArn": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationArn", + "traits": { + "smithy.api#documentation": "The Recommendation ARN
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of a Recommendation Resource
" + } + }, + "com.amazonaws.trustedadvisor#RecommendationResourceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceSummary" + } + }, + "com.amazonaws.trustedadvisor#RecommendationResourcesAggregates": { + "type": "structure", + "members": { + "okCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of AWS resources that were flagged to be OK according to the Trusted Advisor check
", + "smithy.api#required": {} + } + }, + "warningCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of AWS resources that were flagged to have warning according to the Trusted Advisor check\n
", + "smithy.api#required": {} + } + }, + "errorCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of AWS resources that were flagged to have errors according to the Trusted Advisor check
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Aggregation of Recommendation Resources
" + } + }, + "com.amazonaws.trustedadvisor#RecommendationSource": { + "type": "enum", + "members": { + "AWS_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws_config" + } + }, + "COMPUTE_OPTIMIZER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "compute_optimizer" + } + }, + "COST_EXPLORER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cost_explorer" + } + }, + "LSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lse" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "manual" + } + }, + "PSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pse" + } + }, + "RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rds" + } + }, + "RESILIENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resilience" + } + }, + "RESILIENCE_HUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resilience_hub" + } + }, + "SECURITY_HUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "security_hub" + } + }, + "STIR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stir" + } + }, + "TA_CHECK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ta_check" + } + }, + "WELL_ARCHITECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "well_architected" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationStatus": { + "type": "enum", + "members": { + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ok" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "warning" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID which identifies where the Recommendation was produced
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
", + "smithy.api#required": {} + } + }, + "checkArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The AWS Trusted Advisor Check ARN that relates to the Recommendation
" + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#RecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the Recommendation
", + "smithy.api#required": {} + } + }, + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#RecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "The lifecycle stage from AWS Trusted Advisor Priority
" + } + }, + "pillars": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarList", + "traits": { + "smithy.api#documentation": "The Pillars that the Recommendation is optimizing
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.trustedadvisor#RecommendationSource", + "traits": { + "smithy.api#documentation": "The source of the Recommendation
", + "smithy.api#required": {} + } + }, + "awsServices": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsServiceList", + "traits": { + "smithy.api#documentation": "The AWS Services that the Recommendation applies to
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the AWS Trusted Advisor Recommendation
", + "smithy.api#required": {} + } + }, + "resourcesAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourcesAggregates", + "traits": { + "smithy.api#documentation": "An aggregation of all resources
", + "smithy.api#required": {} + } + }, + "pillarSpecificAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarSpecificAggregates", + "traits": { + "smithy.api#documentation": "The pillar aggregations for cost savings
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation was created, if created by AWS Trusted Advisor Priority
", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the Recommendation was last updated
", + "smithy.api#timestampFormat": "date-time" + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationArn", + "traits": { + "smithy.api#documentation": "The ARN of the Recommendation
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of Recommendation for an Account
" + } + }, + "com.amazonaws.trustedadvisor#RecommendationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#RecommendationSummary" + } + }, + "com.amazonaws.trustedadvisor#RecommendationType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "PRIORITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "priority" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationUpdateReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.trustedadvisor#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exception that the requested resource has not been found
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.trustedadvisor#ResourceStatus": { + "type": "enum", + "members": { + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ok" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "warning" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.trustedadvisor#StringMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.trustedadvisor#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exception to notify that requests are being throttled
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.trustedadvisor#TrustedAdvisor": { + "type": "service", + "version": "2022-09-15", + "operations": [ + { + "target": "com.amazonaws.trustedadvisor#GetOrganizationRecommendation" + }, + { + "target": "com.amazonaws.trustedadvisor#GetRecommendation" + }, + { + "target": "com.amazonaws.trustedadvisor#ListChecks" + }, + { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccounts" + }, + { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResources" + }, + { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendations" + }, + { + "target": "com.amazonaws.trustedadvisor#ListRecommendationResources" + }, + { + "target": "com.amazonaws.trustedadvisor#ListRecommendations" + }, + { + "target": "com.amazonaws.trustedadvisor#UpdateOrganizationRecommendationLifecycle" + }, + { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycle" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "TrustedAdvisor", + "arnNamespace": "trustedadvisor", + "cloudTrailEventSource": "trustedadvisor.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "trustedadvisor" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "amz-sdk-invocation-id", + "amz-sdk-request", + "authorization", + "content-length", + "content-type", + "date", + "retry-after", + "x-amz-apigw-id", + "x-amz-cf-id", + "x-amz-content-sha256", + "x-amz-date", + "x-amz-security-token", + "x-amz-target", + "x-amz-user-agent", + "x-amzn-errormessage", + "x-amzn-errortype", + "x-amzn-platform-id", + "x-amzn-requestid", + "x-amzn-trace-id", + "x-amzn-waf-action", + "x-api-key" + ], + "additionalExposedHeaders": [ + "date", + "retry-after", + "x-amz-apigw-id", + "x-amz-cf-id", + "x-amzn-errormessage", + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id", + "x-amzn-waf-action" + ] + }, + "smithy.api#documentation": "TrustedAdvisor Public API
", + "smithy.api#title": "TrustedAdvisor Public API", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://trustedadvisor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://trustedadvisor-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://trustedadvisor.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://trustedadvisor.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://trustedadvisor.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.trustedadvisor#UpdateOrganizationRecommendationLifecycle": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#UpdateOrganizationRecommendationLifecycleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#ConflictException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update the lifecyle of a Recommendation within an Organization. This API only supports prioritized\n recommendations.\n
", + "smithy.api#examples": [ + { + "title": "Update the lifecycle stage of an AWS Organization's Recommendation that is managed by AWS Trusted Advisor Priority", + "input": { + "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/96b5e5ca-7930-444c-90c6-06d386128100", + "lifecycleStage": "dismissed", + "updateReasonCode": "not_applicable", + "updateReason": "Does not apply to this resource" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/organization-recommendations/{organizationRecommendationIdentifier}/lifecycle", + "code": 200 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#UpdateOrganizationRecommendationLifecycleRequest": { + "type": "structure", + "members": { + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "The new lifecycle stage
", + "smithy.api#required": {} + } + }, + "updateReason": { + "target": "com.amazonaws.trustedadvisor#RecommendationUpdateReason", + "traits": { + "smithy.api#documentation": "Reason for the lifecycle stage change
" + } + }, + "updateReasonCode": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode", + "traits": { + "smithy.api#documentation": "Reason code for the lifecycle state change
" + } + }, + "organizationRecommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "The Recommendation identifier for AWS Trusted Advisor Priority recommendations
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycle": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#ConflictException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update the lifecyle of a Recommendation. This API only supports prioritized recommendations.
", + "smithy.api#examples": [ + { + "title": "Update the lifecycle stage of a Recommendation managed by AWS Trusted Advisor Priority", + "input": { + "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/861c9c6e-f169-405a-8b59-537a8caccd7a", + "lifecycleStage": "resolved", + "updateReasonCode": "valid_business_case", + "updateReason": "Resolved the recommendation" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/recommendations/{recommendationIdentifier}/lifecycle", + "code": 200 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleRequest": { + "type": "structure", + "members": { + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "The new lifecycle stage
", + "smithy.api#required": {} + } + }, + "updateReason": { + "target": "com.amazonaws.trustedadvisor#RecommendationUpdateReason", + "traits": { + "smithy.api#documentation": "Reason for the lifecycle stage change
" + } + }, + "updateReasonCode": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode", + "traits": { + "smithy.api#documentation": "Reason code for the lifecycle state change
" + } + }, + "recommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "The Recommendation identifier for AWS Trusted Advisor Priority recommendations
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStage": { + "type": "enum", + "members": { + "PENDING_RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_response" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in_progress" + } + }, + "DISMISSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dismissed" + } + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resolved" + } + } + } + }, + "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode": { + "type": "enum", + "members": { + "NON_CRITICAL_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "non_critical_account" + } + }, + "TEMPORARY_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "temporary_account" + } + }, + "VALID_BUSINESS_CASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "valid_business_case" + } + }, + "OTHER_METHODS_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other_methods_available" + } + }, + "LOW_PRIORITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "low_priority" + } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not_applicable" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + }, + "com.amazonaws.trustedadvisor#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exception that the request failed to satisfy service constraints
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +}