Amazon Web Services, Inc.

TrustedAdvisor Public API

TrustedAdvisor Public API

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

TrustedAdvisor Public API

Endpoints 12

  • PUTBatch update recommendation resource exclusion/v1/batch-update-recommendation-resource-exclusionUpdate one or more exclusion statuses for a list of recommendation resources. This API supports up to 25 unique recommendation resource ARNs per request. This…
  • GETGet organization recommendation/v1/organization-recommendations/:organizationRecommendationIdentifierGet a specific recommendation within an AWS Organizations organization. This API supports only prioritized recommendations and provides global priority…
  • GETGet recommendation/v1/recommendations/:recommendationIdentifier?language=stringGet a specific Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region.
  • GETList checks/v1/checks?nextToken=string&maxResults=0&pillar=string&awsService=string&source=string&language=stringList a filterable set of Checks. This API provides global recommendations, eliminating the need to call the API in each AWS Region.
  • GETList organization recommendation accounts/v1/organization-recommendations/:organizationRecommendationIdentifier/accounts?nextToken=string&maxResults=0&affectedAccountId=stringLists the accounts that own the resources for an organization aggregate recommendation. This API only supports prioritized recommendations and provides global…
  • GETList organization recommendation resources/v1/organization-recommendations/:organizationRecommendationIdentifier/resources?nextToken=string&maxResults=0&status=string&exclusionStatus=string&regionCode=string&affectedAccountId=stringList Resources of a Recommendation within an Organization. This API only supports prioritized recommendations and provides global priority recommendations,…
  • GETList organization recommendations/v1/organization-recommendations?nextToken=string&maxResults=0&type=string&status=string&pillar=string&awsService=string&source=string&checkIdentifier=string&afterLastUpdatedAt=string&beforeLastUpdatedAt=stringList a filterable set of Recommendations within an Organization. This API only supports prioritized recommendations and provides global priority…
  • GETList recommendation resources/v1/recommendations/:recommendationIdentifier/resources?nextToken=string&maxResults=0&status=string&exclusionStatus=string&regionCode=string&language=stringList Resources of a Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region.
  • GETList recommendations/v1/recommendations?nextToken=string&maxResults=0&type=string&status=string&pillar=string&awsService=string&source=string&checkIdentifier=string&afterLastUpdatedAt=string&beforeLastUpdatedAt=string&language=stringList a filterable set of Recommendations. This API provides global recommendations, eliminating the need to call the API in each AWS Region.
  • GETList recommendations for resource/v1/recommendations-for-resource/:awsResourceArn?nextToken=string&maxResults=0&pillar=string&status=string&checkArn=string&language=stringList all Trusted Advisor recommendations for a given AWS resource ARN.
  • PUTUpdate organization recommendation lifecycle/v1/organization-recommendations/:organizationRecommendationIdentifier/lifecycleUpdate the lifecycle of a Recommendation within an Organization. This API only supports prioritized recommendations and updates global priority…
  • PUTUpdate recommendation lifecycle/v1/recommendations/:recommendationIdentifier/lifecycleUpdate the lifecyle of a Recommendation. This API only supports prioritized recommendations and updates global priority recommendations, eliminating the need…

API details

Base URL
https://trustedadvisor.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
12 operations on 12 pathsGET 9PUT 3
Description format
AWS Smithy model, API version 2022-09-15

How to test the TrustedAdvisor Public API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the TrustedAdvisor Public API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Batch update recommendation resource exclusion” (PUT /v1/batch-update-recommendation-resource-exclusion), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the TrustedAdvisor Public API?

TrustedAdvisor Public API It is listed under Developer tools and has 12 endpoints.

Who publishes the TrustedAdvisor Public API?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the TrustedAdvisor Public API?

Requests go to https://trustedadvisor.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the TrustedAdvisor Public API?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the TrustedAdvisor Public API have?

12 operations on 12 paths (9 GET, 3 PUT).

Is forking the TrustedAdvisor Public API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.