ListOrganizationRecommendationAccounts
Lists the accounts that own the resources for an organization aggregate recommendation. This API only supports prioritized recommendations.
Request Syntax
GET /v1/organization-recommendations/organizationRecommendationIdentifier
/accounts?affectedAccountId=affectedAccountId
&maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- affectedAccountId
-
An account affected by this organization recommendation
Length Constraints: Fixed length of 12.
Pattern:
^\d+$
- maxResults
-
The maximum number of results to return per page.
Valid Range: Minimum value of 1. Maximum value of 200.
- nextToken
-
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.
Length Constraints: Minimum length of 4. Maximum length of 10000.
- organizationRecommendationIdentifier
-
The Recommendation identifier
Length Constraints: Minimum length of 20. Maximum length of 200.
Pattern:
^arn:[\w-]+:trustedadvisor:::organization-recommendation\/[\w-]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"accountRecommendationLifecycleSummaries": [
{
"accountId": "string",
"accountRecommendationArn": "string",
"lastUpdatedAt": "string",
"lifecycleStage": "string",
"updatedOnBehalfOf": "string",
"updatedOnBehalfOfJobTitle": "string",
"updateReason": "string",
"updateReasonCode": "string"
}
],
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- accountRecommendationLifecycleSummaries
-
The account recommendations lifecycles that are applicable to the Recommendation
Type: Array of AccountRecommendationLifecycleSummary objects
- nextToken
-
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.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Exception that access has been denied due to insufficient access
HTTP Status Code: 403
- InternalServerException
-
Exception to notify that an unexpected internal error occurred during processing of the request
HTTP Status Code: 500
- ResourceNotFoundException
-
Exception that the requested resource has not been found
HTTP Status Code: 404
- ThrottlingException
-
Exception to notify that requests are being throttled
HTTP Status Code: 429
- ValidationException
-
Exception that the request failed to satisfy service constraints
HTTP Status Code: 400
Examples
List Accounts For An Organization Recommendation
List all account recommendation summaries for an organization recommendation by its identifier.
Sample Request
{
"organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5"
}
Sample Response
{
"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": "REDACTED"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: