{ "smithy": "2.0", "shapes": { "com.amazonaws.trustedadvisor#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Exception 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 is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

" } }, "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. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

" } }, "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#AwsResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws(-\\w+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$" } }, "com.amazonaws.trustedadvisor#BatchUpdateRecommendationResourceExclusion": { "type": "operation", "input": { "target": "com.amazonaws.trustedadvisor#BatchUpdateRecommendationResourceExclusionRequest" }, "output": { "target": "com.amazonaws.trustedadvisor#BatchUpdateRecommendationResourceExclusionResponse" }, "errors": [ { "target": "com.amazonaws.trustedadvisor#AccessDeniedException" }, { "target": "com.amazonaws.trustedadvisor#ConflictException" }, { "target": "com.amazonaws.trustedadvisor#InternalServerException" }, { "target": "com.amazonaws.trustedadvisor#ThrottlingException" }, { "target": "com.amazonaws.trustedadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update one or more exclusion statuses for a list of recommendation resources. This API supports up to 25 unique recommendation resource ARNs per request. This API currently doesn't support prioritized recommendation resources. This API updates global recommendations, eliminating the need to call the API in each AWS Region. After submitting an exclusion update, note that it might take a few minutes for the changes to be reflected in the system.

", "smithy.api#examples": [ { "title": "Batch updates the exclusion status for a list of recommendation resources", "input": { "recommendationResourceExclusions": [ { "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/55fa4d2e-bbb7-491a-833b-5773e9589578/18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", "isExcluded": true } ] }, "output": { "batchUpdateRecommendationResourceExclusionErrors": [ { "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/55fa4d2e-bbb7-491a-833b-5773e9589578/18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", "errorCode": "404", "errorMessage": "Exception that the requested resource has not been found" } ] } } ], "smithy.api#http": { "method": "PUT", "uri": "/v1/batch-update-recommendation-resource-exclusion", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "not_aws-cn_prod", "not_aws-us-gov_prod" ] } }, "com.amazonaws.trustedadvisor#BatchUpdateRecommendationResourceExclusionRequest": { "type": "structure", "members": { "recommendationResourceExclusions": { "target": "com.amazonaws.trustedadvisor#RecommendationResourceExclusionList", "traits": { "smithy.api#documentation": "

A list of recommendation resource ARNs and exclusion status to update

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.trustedadvisor#BatchUpdateRecommendationResourceExclusionResponse": { "type": "structure", "members": { "batchUpdateRecommendationResourceExclusionErrors": { "target": "com.amazonaws.trustedadvisor#UpdateRecommendationResourceExclusionErrorList", "traits": { "smithy.api#documentation": "

A list of recommendation resource ARNs whose exclusion status failed to update, if any

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "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": {} } }, "resourceArnQueryable": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether this check is supported by the ListRecommendationsForResource API.

" } }, "awsResourceTypes": { "target": "com.amazonaws.trustedadvisor#StringList", "traits": { "smithy.api#default": [], "smithy.api#documentation": "

The AWS resource types that this check evaluates (for example, AWS::EC2::Instance).

" } }, "checkGranularity": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The granularity level at which the check operates: resource, account, or account_region.

" } }, "recommendationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The recommendation identifier associated with the check.

" } } }, "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#ExclusionStatus": { "type": "enum", "members": { "EXCLUDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "excluded" } }, "INCLUDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "included" } } } }, "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 recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region.

", "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": 0, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "warning", "type": "priority" } } } ], "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. This API provides global recommendations, eliminating the need to call the API in each AWS Region.

", "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": 1, "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": {} } }, "language": { "target": "com.amazonaws.trustedadvisor#RecommendationLanguage", "traits": { "smithy.api#documentation": "

The ISO 639-1 code for the language that you want your recommendations to appear in.

", "smithy.api#httpQuery": "language" } } }, "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. This API provides global recommendations, eliminating the need to call the API in each AWS Region.

", "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).\n
\n
Note: This check only evaluates security groups that you create and their inbound rules for IPv4 addresses. Security groups created by AWS Directory Services are flagged as red or yellow, but they don\u2019t pose a security risk and can be safely ignored or excluded. For more information, see the Trusted Advisor FAQ.\n
\n
\n

Alert Criteria

\n
\nRed: A security group rule has a source IP address with a /0 suffix for ports other than 25, 80, or 443.\n
\n
\n

Recommended Action

\n
\nRestrict access to only those IP addresses that require it. To restrict access to a specific IP address, set the suffix to /32 (for example, 192.0.2.10/32). Be sure to delete overly permissive rules after creating rules that are more restrictive.\n
\n
\n

Additional Resources

\n
Amazon EC2 Security Groups
\nClassless Inter-Domain Routing (Wikipedia)", "id": "1iG5NDGVre", "metadata": { "0": "Region", "1": "Security Group Name", "2": "Security Group ID", "3": "Protocol", "4": "Port", "5": "Status", "6": "IP Range" }, "name": "Security Groups - Unrestricted Access", "pillars": [ "security" ], "source": "ta_check", "resourceArnQueryable": true, "awsResourceTypes": [ "AWS::EC2::SecurityGroup" ], "checkGranularity": "resource", "recommendationId": "9534ec9b-bf3a-44e8-8213-2ed68b39d9d5" }, { "arn": "arn:aws:trustedadvisor:::check/1qazXsw23e", "awsServices": [ "RDS" ], "description": "Checks your usage of RDS and provides recommendations on purchase of Reserved Instances to help reduce costs incurred from using RDS On-Demand. AWS generates these recommendations by analyzing your On-Demand usage for the past 30 days. We then simulate every combination of reservations in the generated category of usage in order to identify the best number of each type of Reserved Instance to purchase to maximize your savings. This check covers recommendations based on partial upfront payment option with 1-year or 3-year commitment. This check is not available to accounts linked in Consolidated Billing. Recommendations are only available for the Paying Account.

\r\n

Alert Criteria


\nYellow: Optimizing the purchase of RDS Reserved Instances can help reduce costs.

\r\n

Recommended Action


\r\nSee the Cost Explorer page for more detailed recommendations, customization options (e.g. look-back period, payment option, etc.) and to purchase RDS Reserved Instances.\n
\n
\n

Additional Resources


\nInformation on RDS Reserved Instances and how they can save you money can be found here.
\nFor more information on this recommendation, see Reserved Instance Optimization Check Questions in the Trusted Advisor FAQs.
\nFor more detailed description of fields, see Cost Explorer documentation", "id": "1qazXsw23e", "metadata": { "0": "Region", "1": "Family", "10": "Upfront Cost of Reserved Instances", "11": "Estimated cost of Reserved Instances (monthly)", "12": "Estimated On-Demand Cost Post Recommended Reserved Instance Purchase (monthly)", "13": "Estimated Break Even (months)", "14": "Lookback Period (days)", "15": "Term (years)", "2": "Instance Type", "3": "License Model", "4": "Database Edition", "5": "Database Engine", "6": "Deployment Option", "7": "Recommended number of Reserved Instances to purchase", "8": "Expected Average Reserved Instance Utilization", "9": "Estimated Savings with Recommendation (monthly)" }, "name": "Amazon Relational Database Service (RDS) Reserved Instance Optimization", "pillars": [ "cost_optimizing" ], "source": "ta_check", "resourceArnQueryable": false, "awsResourceTypes": [], "checkGranularity": "account", "recommendationId": "8b602b6f-452d-4cb2-8a9e-c7650955d9cd" }, { "arn": "arn:aws:trustedadvisor:::check/1qw23er45t", "awsServices": [ "Redshift" ], "description": "Checks your usage of Redshift and provides recommendations on purchase of Reserved Nodes to help reduce costs incurred from using Redshift On-Demand. AWS generates these recommendations by analyzing your On-Demand usage for the past 30 days. We then simulate every combination of reservations in the generated category of usage in order to identify the best number of each type of Reserved Nodes to purchase to maximize your savings. This check covers recommendations based on partial upfront payment option with 1-year or 3-year commitment. This check is not available to accounts linked in Consolidated Billing. Recommendations are only available for the Paying Account.

\n

Alert Criteria


Yellow: Optimizing the purchase of Redshift Reserved Nodes can help reduce costs.

\n

Recommended Action


See the Cost Explorer page for more detailed recommendations, customization options (e.g. look-back period, payment option, etc.) and to purchase Redshift Reserved Nodes.

\n

Additional Resources


Information on Redshift Reserved Nodes and how they can save you money can be found here.
\nFor more information on this recommendation, see Reserved Instance Optimization Check Questions in the Trusted Advisor FAQs.
\nFor more detailed description of fields, see Cost Explorer documentation", "id": "1qw23er45t", "metadata": { "0": "Region", "1": "Family", "10": "Lookback Period (days)", "11": "Term (years)", "2": "Node Type", "3": "Recommended number of Reserved Nodes to purchase", "4": "Expected Average Reserved Node Utilization", "5": "Estimated Savings with Recommendation (monthly)", "6": "Upfront Cost of Reserved Nodes", "7": "Estimated cost of Reserved Nodes (monthly)", "8": "Estimated On-Demand Cost Post Recommended Reserved Nodes Purchase (monthly)", "9": "Estimated Break Even (months)" }, "name": "Amazon Redshift Reserved Node Optimization", "pillars": [ "cost_optimizing" ], "source": "ta_check", "resourceArnQueryable": false, "awsResourceTypes": [], "checkGranularity": "account", "recommendationId": "4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6" } ], "nextToken": "" } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/checks", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "checkSummaries" }, "smithy.api#readonly": {}, "smithy.api#tags": [] } }, "com.amazonaws.trustedadvisor#ListChecksRequest": { "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 to retrieve the next set of results.

", "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 to retrieve the next set of results.

", "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 supports prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region.

", "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", "updateReason": "Resolved issue", "updateReasonCode": "valid_business_case", "lastUpdatedAt": "2023-01-17T18:25:44.552Z" } ], "nextToken": "" } } ], "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 to retrieve the next set of results.

", "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 to retrieve the next set of results.

", "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 recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region.

", "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": { "0": "14", "1": "208.79999999999998", "2": "database-1-instance-1", "3": "db.r5.large", "4": "false", "5": "us-west-2", "6": "arn:aws:rds:us-west-2:000000000000:db:database-1-instance-1", "7": "1" }, "recommendationArn": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", "regionCode": "us-west-2", "status": "warning", "exclusionStatus": "excluded" }, { "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": { "0": "14", "1": "31.679999999999996", "2": "database-1", "3": "db.t3.small", "4": "false", "5": "us-west-2", "6": "arn:aws:rds:us-west-2:000000000000:db:database-1", "7": "20" }, "recommendationArn": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", "regionCode": "us-west-2", "status": "warning", "exclusionStatus": "excluded" }, { "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": { "0": "14", "1": "187.20000000000002", "2": "database-2-instance-1-us-west-2a", "3": "db.r6g.large", "4": "true", "5": "us-west-2", "6": "arn:aws:rds:us-west-2:000000000000:db:database-2-instance-1-us-west-2a", "7": "1" }, "recommendationArn": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", "regionCode": "us-west-2", "status": "warning", "exclusionStatus": "included" } ], "nextToken": "" } } ], "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 to retrieve the next set of results.

", "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" } }, "exclusionStatus": { "target": "com.amazonaws.trustedadvisor#ExclusionStatus", "traits": { "smithy.api#documentation": "

The exclusion status of the resource

", "smithy.api#httpQuery": "exclusionStatus" } }, "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 to retrieve the next set of results.

", "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 recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region.

", "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": 0, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "warning", "type": "priority" }, { "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": 0, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "warning", "type": "priority" } ], "nextToken": "" } }, { "title": "Filter and return a max of one AWS Organization Recommendation that is a part of the \"security\" pillar", "input": { "pillar": "security", "maxResults": 100 }, "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": 0, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "warning", "type": "priority" } ], "nextToken": "" } }, { "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": "", "pillar": "security", "maxResults": 100 }, "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": 0, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "warning", "type": "priority" } ] } } ], "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 to retrieve the next set of results.

", "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 to retrieve the next set of results.

", "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. This API provides global recommendations, eliminating the need to call the API in each AWS Region.

", "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": { "0": "14", "1": "123.12000000000002", "2": "webcms-dev-01", "3": "db.m6i.large", "4": "false", "5": "us-east-1", "6": "arn:aws:rds:us-east-1:000000000000:db:webcms-dev-01", "7": "20" }, "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", "regionCode": "us-east-1", "status": "warning", "exclusionStatus": "excluded" }, { "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": { "0": "14", "1": "29.52", "2": "aws-dev-db-stack-instance-1", "3": "db.t2.small", "4": "false", "5": "us-east-1", "6": "arn:aws:rds:us-east-1:000000000000:db:aws-dev-db-stack-instance-1", "7": "1" }, "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", "regionCode": "us-east-1", "status": "warning", "exclusionStatus": "included" }, { "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": { "0": "14", "1": "114.48000000000002", "2": "aws-awesome-apps-stack-db", "3": "db.m6g.large", "4": "false", "5": "us-east-1", "6": "arn:aws:rds:us-east-1:000000000000:db:aws-awesome-apps-stack-db", "7": "100" }, "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", "regionCode": "us-east-1", "status": "warning", "exclusionStatus": "excluded" } ], "nextToken": "" } } ], "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 to retrieve the next set of results.

", "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": 5000 } } }, "status": { "target": "com.amazonaws.trustedadvisor#ResourceStatus", "traits": { "smithy.api#documentation": "

The status of the resource

", "smithy.api#httpQuery": "status" } }, "exclusionStatus": { "target": "com.amazonaws.trustedadvisor#ExclusionStatus", "traits": { "smithy.api#documentation": "

The exclusion status of the resource

", "smithy.api#httpQuery": "exclusionStatus" } }, "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": {} } }, "language": { "target": "com.amazonaws.trustedadvisor#RecommendationLanguage", "traits": { "smithy.api#documentation": "

The ISO 639-1 code for the language that you want your recommendations to appear in.

", "smithy.api#httpQuery": "language" } } }, "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 to retrieve the next set of results.

", "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. This API provides global recommendations, eliminating the need to call the API in each AWS Region.

", "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": 1, "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": 3, "warningCount": 6 }, "source": "ta_check", "status": "warning", "type": "standard" } ], "nextToken": "" } }, { "title": "Filter and return a max of one Recommendation that is a part of AWS IAM", "input": { "awsService": "iam", "maxResults": 100 }, "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": 1, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "error", "type": "standard" } ], "nextToken": "" } }, { "title": "Use the \"nextToken\" returned from a previous request to fetch the next page of filtered Recommendations", "input": { "nextToken": "", "awsService": "rds", "maxResults": 100 }, "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": 3, "warningCount": 6 }, "source": "ta_check", "status": "warning", "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#ListRecommendationsForResource": { "type": "operation", "input": { "target": "com.amazonaws.trustedadvisor#ListRecommendationsForResourceRequest" }, "output": { "target": "com.amazonaws.trustedadvisor#ListRecommendationsForResourceResponse" }, "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 all Trusted Advisor recommendations for a given AWS resource ARN.

", "smithy.api#examples": [ { "title": "List all Trusted Advisor Recommendations for an AWS Resource", "input": { "awsResourceArn": "arn:aws:ec2:us-east-1:000000000000:instance/i-0abcd1234efgh5678" }, "output": { "recommendationForResourceSummaries": [ { "checkArn": "arn:aws:trustedadvisor:::check/Qch7DwouX1", "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", "awsResourceArn": "arn:aws:ec2:us-east-1:000000000000:instance/i-0abcd1234efgh5678", "status": "warning", "lastUpdatedAt": "2026-05-21T15:09:51.891Z", "exclusionStatus": "included", "metadata": { "Region": "us-east-1", "Resource": "i-0abcd1234efgh5678", "Status": "Yellow" }, "pillars": [ "cost_optimizing" ] } ], "nextToken": "" } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/recommendations-for-resource/{awsResourceArn}", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "recommendationForResourceSummaries" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "not_aws-iso-f", "not_aws-iso-e" ] } }, "com.amazonaws.trustedadvisor#ListRecommendationsForResourceRequest": { "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 to retrieve the next set of results.

", "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": 600 } } }, "awsResourceArn": { "target": "com.amazonaws.trustedadvisor#AwsResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the AWS resource to query recommendations for

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "pillar": { "target": "com.amazonaws.trustedadvisor#RecommendationPillar", "traits": { "smithy.api#documentation": "

The pillar that the recommendation belongs to

", "smithy.api#httpQuery": "pillar" } }, "status": { "target": "com.amazonaws.trustedadvisor#ResourceStatus", "traits": { "smithy.api#documentation": "

The current status of the Recommendation Resource

", "smithy.api#httpQuery": "status" } }, "checkArn": { "target": "com.amazonaws.trustedadvisor#CheckArn", "traits": { "smithy.api#documentation": "

The AWS Trusted Advisor Check ARN that relates to the Recommendation

", "smithy.api#httpQuery": "checkArn" } }, "language": { "target": "com.amazonaws.trustedadvisor#RecommendationLanguage", "traits": { "smithy.api#documentation": "

The ISO 639-1 code for the language that you want your recommendations to appear in.

", "smithy.api#httpQuery": "language" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.trustedadvisor#ListRecommendationsForResourceResponse": { "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 to retrieve the next set of results.

", "smithy.api#length": { "min": 4, "max": 10000 } } }, "recommendationForResourceSummaries": { "target": "com.amazonaws.trustedadvisor#RecommendationForResourceSummaryList", "traits": { "smithy.api#documentation": "

List of Trusted Advisor recommendations associated with the given AWS resource

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "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 to retrieve the next set of results.

", "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" } }, "language": { "target": "com.amazonaws.trustedadvisor#RecommendationLanguage", "traits": { "smithy.api#documentation": "

The ISO 639-1 code for the language that you want your recommendations to appear in.

", "smithy.api#httpQuery": "language" } } }, "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 to retrieve the next set of results.

", "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 is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

" } }, "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. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

" } }, "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. There are certain checks that generate recommendation resources without an awsResourceId.

", "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" } }, "exclusionStatus": { "target": "com.amazonaws.trustedadvisor#ExclusionStatus", "traits": { "smithy.api#default": "included", "smithy.api#documentation": "

The exclusion status of the Recommendation Resource

" } }, "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": {} } }, "statusReason": { "target": "com.amazonaws.trustedadvisor#StatusReason", "traits": { "smithy.api#documentation": "

This attribute provides additional details about potential discrepancies in check status determination.

" } }, "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 is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

" } }, "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. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

" } }, "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#RecommendationForResourceSummary": { "type": "structure", "members": { "checkArn": { "target": "com.amazonaws.trustedadvisor#CheckArn", "traits": { "smithy.api#documentation": "

The Check ARN

", "smithy.api#required": {} } }, "recommendationArn": { "target": "com.amazonaws.trustedadvisor#AccountRecommendationArn", "traits": { "smithy.api#documentation": "

The Recommendation ARN

", "smithy.api#required": {} } }, "awsResourceArn": { "target": "com.amazonaws.trustedadvisor#AwsResourceArn", "traits": { "smithy.api#documentation": "

The AWS Resource ARN

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.trustedadvisor#ResourceStatus", "traits": { "smithy.api#documentation": "

The current status of the recommendation

", "smithy.api#required": {} } }, "lastUpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

When the recommendation was last updated

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "exclusionStatus": { "target": "com.amazonaws.trustedadvisor#ExclusionStatus", "traits": { "smithy.api#documentation": "

The exclusion status of the recommendation

", "smithy.api#required": {} } }, "metadata": { "target": "com.amazonaws.trustedadvisor#StringMap", "traits": { "smithy.api#documentation": "

Metadata associated with the recommendation

", "smithy.api#required": {} } }, "pillars": { "target": "com.amazonaws.trustedadvisor#RecommendationPillarList", "traits": { "smithy.api#documentation": "

The Pillars that the Recommendation is optimizing

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Summary of a Recommendation for a specific AWS Resource

" } }, "com.amazonaws.trustedadvisor#RecommendationForResourceSummaryList": { "type": "list", "member": { "target": "com.amazonaws.trustedadvisor#RecommendationForResourceSummary" } }, "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#length": { "min": 1, "max": 50 }, "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#RecommendationResourceExclusion": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.trustedadvisor#RecommendationResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the Recommendation Resource

", "smithy.api#required": {} } }, "isExcluded": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

The exclusion status

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN and corresponding exclusion status

" } }, "com.amazonaws.trustedadvisor#RecommendationResourceExclusionList": { "type": "list", "member": { "target": "com.amazonaws.trustedadvisor#RecommendationResourceExclusion" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 }, "smithy.api#uniqueItems": {} } }, "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. There are certain checks that generate recommendation resources without an awsResourceId.

", "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" } }, "exclusionStatus": { "target": "com.amazonaws.trustedadvisor#ExclusionStatus", "traits": { "smithy.api#default": "included", "smithy.api#documentation": "

The exclusion status of the Recommendation Resource

" } }, "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

", "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": {} } }, "excludedCount": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The number of AWS resources belonging to this Trusted Advisor check that were excluded by the customer

" } } }, "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" } }, "COST_OPTIMIZATION_HUB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cost_optimization_hub" } } } }, "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": {} } }, "statusReason": { "target": "com.amazonaws.trustedadvisor#StatusReason", "traits": { "smithy.api#documentation": "

This attribute provides additional details about potential discrepancies in check status determination.

" } } }, "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#StatusReason": { "type": "enum", "members": { "NO_DATA_OK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "no_data_ok" } } } }, "com.amazonaws.trustedadvisor#StringList": { "type": "list", "member": { "target": "smithy.api#String" } }, "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#BatchUpdateRecommendationResourceExclusion" }, { "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#ListRecommendationsForResource" }, { "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#endpointBdd": { "version": "1.1", "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" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://trustedadvisor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://trustedadvisor-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://trustedadvisor.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://trustedadvisor.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "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 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 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 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 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 lifecycle of a Recommendation within an Organization. This API only supports prioritized recommendations and updates global priority recommendations, eliminating the need to call the API in each AWS Region.

", "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 and updates global priority recommendations, eliminating the need to call the API in each AWS Region.

", "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#UpdateRecommendationResourceExclusionError": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.trustedadvisor#RecommendationResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the Recommendation Resource

" } }, "errorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The error code

" } }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The error message

" } } }, "traits": { "smithy.api#documentation": "

The error entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN, error code and error message

" } }, "com.amazonaws.trustedadvisor#UpdateRecommendationResourceExclusionErrorList": { "type": "list", "member": { "target": "com.amazonaws.trustedadvisor#UpdateRecommendationResourceExclusionError" } }, "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 } } } }