AWS SDK for PHP 3.x

Client: Aws\TrustedAdvisor\TrustedAdvisorClient

Service ID: trustedadvisor

Version: 2022-09-15

This page describes the parameters and results for the operations of the TrustedAdvisor Public API (2022-09-15), and shows how to use the Aws\TrustedAdvisor\TrustedAdvisorClient object to call the described operations. This documentation is specific to the 2022-09-15 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

BatchUpdateRecommendationResourceExclusion ( array $params = [] ): Update one or more exclusion status for a list of recommendation resources
GetOrganizationRecommendation ( array $params = [] ): Get a specific recommendation within an AWS Organizations organization.
GetRecommendation ( array $params = [] ): Get a specific Recommendation
ListChecks ( array $params = [] ): List a filterable set of Checks
ListOrganizationRecommendationAccounts ( array $params = [] ): Lists the accounts that own the resources for an organization aggregate recommendation.
ListOrganizationRecommendationResources ( array $params = [] ): List Resources of a Recommendation within an Organization.
ListOrganizationRecommendations ( array $params = [] ): List a filterable set of Recommendations within an Organization.
ListRecommendationResources ( array $params = [] ): List Resources of a Recommendation
ListRecommendations ( array $params = [] ): List a filterable set of Recommendations
UpdateOrganizationRecommendationLifecycle ( array $params = [] ): Update the lifecycle of a Recommendation within an Organization.
UpdateRecommendationLifecycle ( array $params = [] ): Update the lifecyle of a Recommendation.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListChecks
ListOrganizationRecommendationAccounts
ListOrganizationRecommendationResources
ListOrganizationRecommendations
ListRecommendationResources
ListRecommendations

Operations

BatchUpdateRecommendationResourceExclusion

$result = $client->batchUpdateRecommendationResourceExclusion([/* ... */]);
$promise = $client->batchUpdateRecommendationResourceExclusionAsync([/* ... */]);

Update one or more exclusion status for a list of recommendation resources

Parameter Syntax

$result = $client->batchUpdateRecommendationResourceExclusion([
    'recommendationResourceExclusions' => [ // REQUIRED
        [
            'arn' => '<string>', // REQUIRED
            'isExcluded' => true || false, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

recommendationResourceExclusions

: Required: Yes
: Type: Array of RecommendationResourceExclusion structures

A list of recommendation resource ARNs and exclusion status to update

Result Syntax

[
    'batchUpdateRecommendationResourceExclusionErrors' => [
        [
            'arn' => '<string>',
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

batchUpdateRecommendationResourceExclusionErrors

: Required: Yes
: Type: Array of UpdateRecommendationResourceExclusionError structures

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

Errors

AccessDeniedException:: Exception that access has been denied due to insufficient access
ConflictException:: Exception that the request was denied due to conflictions in state
InternalServerException:: Exception to notify that an unexpected internal error occurred during processing of the request
ValidationException:: Exception that the request failed to satisfy service constraints
ThrottlingException:: Exception to notify that requests are being throttled

GetOrganizationRecommendation

$result = $client->getOrganizationRecommendation([/* ... */]);
$promise = $client->getOrganizationRecommendationAsync([/* ... */]);

Get a specific recommendation within an AWS Organizations organization. This API supports only prioritized recommendations.

Parameter Syntax

$result = $client->getOrganizationRecommendation([
    'organizationRecommendationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

organizationRecommendationIdentifier

: Required: Yes
: Type: string

The Recommendation identifier

Result Syntax

[
    'organizationRecommendation' => [
        'arn' => '<string>',
        'awsServices' => ['<string>', ...],
        'checkArn' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'lifecycleStage' => 'in_progress|pending_response|dismissed|resolved',
        'name' => '<string>',
        'pillarSpecificAggregates' => [
            'costOptimizing' => [
                'estimatedMonthlySavings' => <float>,
                'estimatedPercentMonthlySavings' => <float>,
            ],
        ],
        'pillars' => ['<string>', ...],
        'resolvedAt' => <DateTime>,
        'resourcesAggregates' => [
            'errorCount' => <integer>,
            'okCount' => <integer>,
            'warningCount' => <integer>,
        ],
        'source' => 'aws_config|compute_optimizer|cost_explorer|lse|manual|pse|rds|resilience|resilience_hub|security_hub|stir|ta_check|well_architected',
        'status' => 'ok|warning|error',
        'type' => 'standard|priority',
        'updateReason' => '<string>',
        'updateReasonCode' => 'non_critical_account|temporary_account|valid_business_case|other_methods_available|low_priority|not_applicable|other',
        'updatedOnBehalfOf' => '<string>',
        'updatedOnBehalfOfJobTitle' => '<string>',
    ],
]

Result Details

Members

organizationRecommendation

: Type: OrganizationRecommendation structure

The Recommendation

Errors

AccessDeniedException:: Exception that access has been denied due to insufficient access
InternalServerException:: Exception to notify that an unexpected internal error occurred during processing of the request
ValidationException:: Exception that the request failed to satisfy service constraints
ResourceNotFoundException:: Exception that the requested resource has not been found
ThrottlingException:: Exception to notify that requests are being throttled

GetRecommendation

$result = $client->getRecommendation([/* ... */]);
$promise = $client->getRecommendationAsync([/* ... */]);

Get a specific Recommendation

Parameter Syntax

$result = $client->getRecommendation([
    'recommendationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

recommendationIdentifier

: Required: Yes
: Type: string

The Recommendation identifier

Result Syntax

[
    'recommendation' => [
        'arn' => '<string>',
        'awsServices' => ['<string>', ...],
        'checkArn' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'lifecycleStage' => 'in_progress|pending_response|dismissed|resolved',
        'name' => '<string>',
        'pillarSpecificAggregates' => [
            'costOptimizing' => [
                'estimatedMonthlySavings' => <float>,
                'estimatedPercentMonthlySavings' => <float>,
            ],
        ],
        'pillars' => ['<string>', ...],
        'resolvedAt' => <DateTime>,
        'resourcesAggregates' => [
            'errorCount' => <integer>,
            'okCount' => <integer>,
            'warningCount' => <integer>,
        ],
        'source' => 'aws_config|compute_optimizer|cost_explorer|lse|manual|pse|rds|resilience|resilience_hub|security_hub|stir|ta_check|well_architected',
        'status' => 'ok|warning|error',
        'type' => 'standard|priority',
        'updateReason' => '<string>',
        'updateReasonCode' => 'non_critical_account|temporary_account|valid_business_case|other_methods_available|low_priority|not_applicable|other',
        'updatedOnBehalfOf' => '<string>',
        'updatedOnBehalfOfJobTitle' => '<string>',
    ],
]

Result Details

Members

recommendation

: Type: Recommendation structure

The Recommendation

Errors

AccessDeniedException:: Exception that access has been denied due to insufficient access
InternalServerException:: Exception to notify that an unexpected internal error occurred during processing of the request
ValidationException:: Exception that the request failed to satisfy service constraints
ResourceNotFoundException:: Exception that the requested resource has not been found
ThrottlingException:: Exception to notify that requests are being throttled

ListChecks

$result = $client->listChecks([/* ... */]);
$promise = $client->listChecksAsync([/* ... */]);

List a filterable set of Checks

Parameter Syntax

$result = $client->listChecks([
    'awsService' => '<string>',
    'language' => 'en|ja|zh|fr|de|ko|zh_TW|it|es|pt_BR|id',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'pillar' => 'cost_optimizing|performance|security|service_limits|fault_tolerance|operational_excellence',
    'source' => 'aws_config|compute_optimizer|cost_explorer|lse|manual|pse|rds|resilience|resilience_hub|security_hub|stir|ta_check|well_architected',
]);

Parameter Details

Members

awsService

: Type: string

The aws service associated with the check

language

: Type: string

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

maxResults

: Type: int

The maximum number of results to return per page.

nextToken

: Type: string

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.

pillar

: Type: string

The pillar of the check

source

: Type: string

The source of the check

Result Syntax

[
    'checkSummaries' => [
        [
            'arn' => '<string>',
            'awsServices' => ['<string>', ...],
            'description' => '<string>',
            'id' => '<string>',
            'metadata' => ['<string>', ...],
            'name' => '<string>',
            'pillars' => ['<string>', ...],
            'source' => 'aws_config|compute_optimizer|cost_explorer|lse|manual|pse|rds|resilience|resilience_hub|security_hub|stir|ta_check|well_architected',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

checkSummaries

: Required: Yes
: Type: Array of CheckSummary structures

The list of Checks

nextToken

: Type: string

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.

Errors

AccessDeniedException:: Exception that access has been denied due to insufficient access
InternalServerException:: Exception to notify that an unexpected internal error occurred during processing of the request
ValidationException:: Exception that the request failed to satisfy service constraints
ThrottlingException:: Exception to notify that requests are being throttled

ListOrganizationRecommendationAccounts

$result = $client->listOrganizationRecommendationAccounts([/* ... */]);
$promise = $client->listOrganizationRecommendationAccountsAsync([/* ... */]);

Lists the accounts that own the resources for an organization aggregate recommendation. This API only supports prioritized recommendations.

Parameter Syntax

$result = $client->listOrganizationRecommendationAccounts([
    'affectedAccountId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'organizationRecommendationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

affectedAccountId

: Type: string

An account affected by this organization recommendation

maxResults

: Type: int

The maximum number of results to return per page.

nextToken

: Type: string

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.

organizationRecommendationIdentifier

: Required: Yes
: Type: string

The Recommendation identifier

Result Syntax

[
    'accountRecommendationLifecycleSummaries' => [
        [
            'accountId' => '<string>',
            'accountRecommendationArn' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'lifecycleStage' => 'in_progress|pending_response|dismissed|resolved',
            'updateReason' => '<string>',
            'updateReasonCode' => 'non_critical_account|temporary_account|valid_business_case|other_methods_available|low_priority|not_applicable|other',
            'updatedOnBehalfOf' => '<string>',
            'updatedOnBehalfOfJobTitle' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

accountRecommendationLifecycleSummaries

: Required: Yes
: Type: Array of AccountRecommendationLifecycleSummary structures

The account recommendations lifecycles that are applicable to the Recommendation

nextToken

: Type: string

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.

Errors

AccessDeniedException:: Exception that access has been denied due to insufficient access
InternalServerException:: Exception to notify that an unexpected internal error occurred during processing of the request
ValidationException:: Exception that the request failed to satisfy service constraints
ResourceNotFoundException:: Exception that the requested resource has not been found
ThrottlingException:: Exception to notify that requests are being throttled

ListOrganizationRecommendationResources

$result = $client->listOrganizationRecommendationResources([/* ... */]);
$promise = $client->listOrganizationRecommendationResourcesAsync([/* ... */]);

List Resources of a Recommendation within an Organization. This API only supports prioritized recommendations.

Parameter Syntax

$result = $client->listOrganizationRecommendationResources([
    'affectedAccountId' => '<string>',
    'exclusionStatus' => 'excluded|included',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'organizationRecommendationIdentifier' => '<string>', // REQUIRED
    'regionCode' => '<string>',
    'status' => 'ok|warning|error',
]);

Parameter Details

Members

affectedAccountId

: Type: string

An account affected by this organization recommendation

exclusionStatus

: Type: string

The exclusion status of the resource

maxResults

: Type: int

The maximum number of results to return per page.

nextToken

: Type: string

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.

organizationRecommendationIdentifier

: Required: Yes
: Type: string

The AWS Organization organization's Recommendation identifier

regionCode

: Type: string

The AWS Region code of the resource

status

: Type: string

The status of the resource

Result Syntax

[
    'nextToken' => '<string>',
    'organizationRecommendationResourceSummaries' => [
        [
            'accountId' => '<string>',
            'arn' => '<string>',
            'awsResourceId' => '<string>',
            'exclusionStatus' => 'excluded|included',
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'metadata' => ['<string>', ...],
            'recommendationArn' => '<string>',
            'regionCode' => '<string>',
            'status' => 'ok|warning|error',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

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.

organizationRecommendationResourceSummaries

: Required: Yes
: Type: Array of OrganizationRecommendationResourceSummary structures

A list of Recommendation Resources

Errors

AccessDeniedException:: Exception that access has been denied due to insufficient access
InternalServerException:: Exception to notify that an unexpected internal error occurred during processing of the request
ValidationException:: Exception that the request failed to satisfy service constraints
ResourceNotFoundException:: Exception that the requested resource has not been found
ThrottlingException:: Exception to notify that requests are being throttled

ListOrganizationRecommendations

$result = $client->listOrganizationRecommendations([/* ... */]);
$promise = $client->listOrganizationRecommendationsAsync([/* ... */]);

List a filterable set of Recommendations within an Organization. This API only supports prioritized recommendations.

Parameter Syntax

$result = $client->listOrganizationRecommendations([
    'afterLastUpdatedAt' => <integer || string || DateTime>,
    'awsService' => '<string>',
    'beforeLastUpdatedAt' => <integer || string || DateTime>,
    'checkIdentifier' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'pillar' => 'cost_optimizing|performance|security|service_limits|fault_tolerance|operational_excellence',
    'source' => 'aws_config|compute_optimizer|cost_explorer|lse|manual|pse|rds|resilience|resilience_hub|security_hub|stir|ta_check|well_architected',
    'status' => 'ok|warning|error',
    'type' => 'standard|priority',
]);

Parameter Details

Members

afterLastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

After the last update of the Recommendation

awsService

: Type: string

The aws service associated with the Recommendation

beforeLastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Before the last update of the Recommendation

checkIdentifier

: Type: string

The check identifier of the Recommendation

maxResults

: Type: int

The maximum number of results to return per page.

nextToken

: Type: string

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.

pillar

: Type: string

The pillar of the Recommendation

source

: Type: string

The source of the Recommendation

status

: Type: string

The status of the Recommendation

type

: Type: string

The type of the Recommendation

Result Syntax

[
    'nextToken' => '<string>',
    'organizationRecommendationSummaries' => [
        [
            'arn' => '<string>',
            'awsServices' => ['<string>', ...],
            'checkArn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'lifecycleStage' => 'in_progress|pending_response|dismissed|resolved',
            'name' => '<string>',
            'pillarSpecificAggregates' => [
                'costOptimizing' => [
                    'estimatedMonthlySavings' => <float>,
                    'estimatedPercentMonthlySavings' => <float>,
                ],
            ],
            'pillars' => ['<string>', ...],
            'resourcesAggregates' => [
                'errorCount' => <integer>,
                'okCount' => <integer>,
                'warningCount' => <integer>,
            ],
            'source' => 'aws_config|compute_optimizer|cost_explorer|lse|manual|pse|rds|resilience|resilience_hub|security_hub|stir|ta_check|well_architected',
            'status' => 'ok|warning|error',
            'type' => 'standard|priority',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

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.

organizationRecommendationSummaries

: Required: Yes
: Type: Array of OrganizationRecommendationSummary structures

The list of Recommendations

Errors

AccessDeniedException:: Exception that access has been denied due to insufficient access
InternalServerException:: Exception to notify that an unexpected internal error occurred during processing of the request
ValidationException:: Exception that the request failed to satisfy service constraints
ThrottlingException:: Exception to notify that requests are being throttled

ListRecommendationResources

$result = $client->listRecommendationResources([/* ... */]);
$promise = $client->listRecommendationResourcesAsync([/* ... */]);

List Resources of a Recommendation

Parameter Syntax

$result = $client->listRecommendationResources([
    'exclusionStatus' => 'excluded|included',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'recommendationIdentifier' => '<string>', // REQUIRED
    'regionCode' => '<string>',
    'status' => 'ok|warning|error',
]);

Parameter Details

Members

exclusionStatus

: Type: string

The exclusion status of the resource

maxResults

: Type: int

The maximum number of results to return per page.

nextToken

: Type: string

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.

recommendationIdentifier

: Required: Yes
: Type: string

The Recommendation identifier

regionCode

: Type: string

The AWS Region code of the resource

status

: Type: string

The status of the resource

Result Syntax

[
    'nextToken' => '<string>',
    'recommendationResourceSummaries' => [
        [
            'arn' => '<string>',
            'awsResourceId' => '<string>',
            'exclusionStatus' => 'excluded|included',
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'metadata' => ['<string>', ...],
            'recommendationArn' => '<string>',
            'regionCode' => '<string>',
            'status' => 'ok|warning|error',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

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.

recommendationResourceSummaries

: Required: Yes
: Type: Array of RecommendationResourceSummary structures

A list of Recommendation Resources

Errors

AccessDeniedException:: Exception that access has been denied due to insufficient access
InternalServerException:: Exception to notify that an unexpected internal error occurred during processing of the request
ValidationException:: Exception that the request failed to satisfy service constraints
ResourceNotFoundException:: Exception that the requested resource has not been found
ThrottlingException:: Exception to notify that requests are being throttled

ListRecommendations

$result = $client->listRecommendations([/* ... */]);
$promise = $client->listRecommendationsAsync([/* ... */]);

List a filterable set of Recommendations

Parameter Syntax

$result = $client->listRecommendations([
    'afterLastUpdatedAt' => <integer || string || DateTime>,
    'awsService' => '<string>',
    'beforeLastUpdatedAt' => <integer || string || DateTime>,
    'checkIdentifier' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'pillar' => 'cost_optimizing|performance|security|service_limits|fault_tolerance|operational_excellence',
    'source' => 'aws_config|compute_optimizer|cost_explorer|lse|manual|pse|rds|resilience|resilience_hub|security_hub|stir|ta_check|well_architected',
    'status' => 'ok|warning|error',
    'type' => 'standard|priority',
]);

Parameter Details

Members

afterLastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

After the last update of the Recommendation

awsService

: Type: string

The aws service associated with the Recommendation

beforeLastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Before the last update of the Recommendation

checkIdentifier

: Type: string

The check identifier of the Recommendation

maxResults

: Type: int

The maximum number of results to return per page.

nextToken

: Type: string

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.

pillar

: Type: string

The pillar of the Recommendation

source

: Type: string

The source of the Recommendation

status

: Type: string

The status of the Recommendation

type

: Type: string

The type of the Recommendation

Result Syntax

[
    'nextToken' => '<string>',
    'recommendationSummaries' => [
        [
            'arn' => '<string>',
            'awsServices' => ['<string>', ...],
            'checkArn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'lifecycleStage' => 'in_progress|pending_response|dismissed|resolved',
            'name' => '<string>',
            'pillarSpecificAggregates' => [
                'costOptimizing' => [
                    'estimatedMonthlySavings' => <float>,
                    'estimatedPercentMonthlySavings' => <float>,
                ],
            ],
            'pillars' => ['<string>', ...],
            'resourcesAggregates' => [
                'errorCount' => <integer>,
                'okCount' => <integer>,
                'warningCount' => <integer>,
            ],
            'source' => 'aws_config|compute_optimizer|cost_explorer|lse|manual|pse|rds|resilience|resilience_hub|security_hub|stir|ta_check|well_architected',
            'status' => 'ok|warning|error',
            'type' => 'standard|priority',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

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.

recommendationSummaries

: Required: Yes
: Type: Array of RecommendationSummary structures

The list of Recommendations

Errors

AccessDeniedException:: Exception that access has been denied due to insufficient access
InternalServerException:: Exception to notify that an unexpected internal error occurred during processing of the request
ValidationException:: Exception that the request failed to satisfy service constraints
ThrottlingException:: Exception to notify that requests are being throttled

UpdateOrganizationRecommendationLifecycle

$result = $client->updateOrganizationRecommendationLifecycle([/* ... */]);
$promise = $client->updateOrganizationRecommendationLifecycleAsync([/* ... */]);

Update the lifecycle of a Recommendation within an Organization. This API only supports prioritized recommendations.

Parameter Syntax

$result = $client->updateOrganizationRecommendationLifecycle([
    'lifecycleStage' => 'pending_response|in_progress|dismissed|resolved', // REQUIRED
    'organizationRecommendationIdentifier' => '<string>', // REQUIRED
    'updateReason' => '<string>',
    'updateReasonCode' => 'non_critical_account|temporary_account|valid_business_case|other_methods_available|low_priority|not_applicable|other',
]);

Parameter Details

Members

lifecycleStage

: Required: Yes
: Type: string

The new lifecycle stage

organizationRecommendationIdentifier

: Required: Yes
: Type: string

The Recommendation identifier for AWS Trusted Advisor Priority recommendations

updateReason

: Type: string

Reason for the lifecycle stage change

updateReasonCode

: Type: string

Reason code for the lifecycle state change

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:: Exception that access has been denied due to insufficient access
ConflictException:: Exception that the request was denied due to conflictions in state
InternalServerException:: Exception to notify that an unexpected internal error occurred during processing of the request
ValidationException:: Exception that the request failed to satisfy service constraints
ResourceNotFoundException:: Exception that the requested resource has not been found
ThrottlingException:: Exception to notify that requests are being throttled

UpdateRecommendationLifecycle

$result = $client->updateRecommendationLifecycle([/* ... */]);
$promise = $client->updateRecommendationLifecycleAsync([/* ... */]);

Update the lifecyle of a Recommendation. This API only supports prioritized recommendations.

Parameter Syntax

$result = $client->updateRecommendationLifecycle([
    'lifecycleStage' => 'pending_response|in_progress|dismissed|resolved', // REQUIRED
    'recommendationIdentifier' => '<string>', // REQUIRED
    'updateReason' => '<string>',
    'updateReasonCode' => 'non_critical_account|temporary_account|valid_business_case|other_methods_available|low_priority|not_applicable|other',
]);

Parameter Details

Members

lifecycleStage

: Required: Yes
: Type: string

The new lifecycle stage

recommendationIdentifier

: Required: Yes
: Type: string

The Recommendation identifier for AWS Trusted Advisor Priority recommendations

updateReason

: Type: string

Reason for the lifecycle stage change

updateReasonCode

: Type: string

Reason code for the lifecycle state change

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:: Exception that access has been denied due to insufficient access
ConflictException:: Exception that the request was denied due to conflictions in state
InternalServerException:: Exception to notify that an unexpected internal error occurred during processing of the request
ValidationException:: Exception that the request failed to satisfy service constraints
ResourceNotFoundException:: Exception that the requested resource has not been found
ThrottlingException:: Exception to notify that requests are being throttled

Shapes

AccessDeniedException

Description

Exception that access has been denied due to insufficient access

Members

message

: Required: Yes
: Type: string

AccountRecommendationLifecycleSummary

Description

Summary of an AccountRecommendationLifecycle for an Organization Recommendation

Members

accountId

: Type: string

The AWS account ID

accountRecommendationArn

: Type: string

The Recommendation ARN

lastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation was last updated

lifecycleStage

: Type: string

The lifecycle stage from AWS Trusted Advisor Priority

updateReason

: Type: string

Reason for the lifecycle stage change

updateReasonCode

: Type: string

Reason code for the lifecycle state change

updatedOnBehalfOf

: Type: string

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

: Type: string

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

CheckSummary

Description

A summary of an AWS Trusted Advisor Check

Members

arn

: Required: Yes
: Type: string

The ARN of the AWS Trusted Advisor Check

awsServices

: Required: Yes
: Type: Array of strings

The AWS Services that the Check applies to

description

: Required: Yes
: Type: string

A description of what the AWS Trusted Advisor Check is monitoring

id

: Required: Yes
: Type: string

The unique identifier of the AWS Trusted Advisor Check

metadata

: Required: Yes
: Type: Associative array of custom strings keys (String) to strings

The column headings for the metadata returned in the resource

name

: Required: Yes
: Type: string

The name of the AWS Trusted Advisor Check

pillars

: Required: Yes
: Type: Array of strings

The Recommendation pillars that the AWS Trusted Advisor Check falls under

source

: Required: Yes
: Type: string

The source of the Recommendation

ConflictException

Description

Exception that the request was denied due to conflictions in state

Members

message

: Required: Yes
: Type: string

InternalServerException

Description

Exception to notify that an unexpected internal error occurred during processing of the request

Members

message

: Required: Yes
: Type: string

OrganizationRecommendation

Description

A Recommendation for accounts within an Organization

Members

arn

: Required: Yes
: Type: string

The ARN of the Recommendation

awsServices

: Type: Array of strings

The AWS Services that the Recommendation applies to

checkArn

: Type: string

The AWS Trusted Advisor Check ARN that relates to the Recommendation

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation was created, if created by AWS Trusted Advisor Priority

createdBy

: Type: string

The creator, if created by AWS Trusted Advisor Priority

description

: Required: Yes
: Type: string

A description for AWS Trusted Advisor recommendations

id

: Required: Yes
: Type: string

The ID which identifies where the Recommendation was produced

lastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation was last updated

lifecycleStage

: Type: string

The lifecycle stage from AWS Trusted Advisor Priority

name

: Required: Yes
: Type: string

The name of the AWS Trusted Advisor Recommendation

pillarSpecificAggregates

: Type: RecommendationPillarSpecificAggregates structure

The pillar aggregations for cost savings

pillars

: Required: Yes
: Type: Array of strings

The Pillars that the Recommendation is optimizing

resolvedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation was resolved

resourcesAggregates

: Required: Yes
: Type: RecommendationResourcesAggregates structure

An aggregation of all resources

source

: Required: Yes
: Type: string

The source of the Recommendation

status

: Required: Yes
: Type: string

The status of the Recommendation

type

: Required: Yes
: Type: string

Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

updateReason

: Type: string

Reason for the lifecycle stage change

updateReasonCode

: Type: string

Reason code for the lifecycle state change

updatedOnBehalfOf

: Type: string

updatedOnBehalfOfJobTitle

: Type: string

OrganizationRecommendationResourceSummary

Description

Organization Recommendation Resource Summary

Members

accountId

: Type: string

The AWS account ID

arn

: Required: Yes
: Type: string

The ARN of the Recommendation Resource

awsResourceId

: Required: Yes
: Type: string

The AWS resource identifier

exclusionStatus

: Type: string

The exclusion status of the Recommendation Resource

id

: Required: Yes
: Type: string

The ID of the Recommendation Resource

lastUpdatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation Resource was last updated

metadata

: Required: Yes
: Type: Associative array of custom strings keys (String) to strings

Metadata associated with the Recommendation Resource

recommendationArn

: Required: Yes
: Type: string

The Recommendation ARN

regionCode

: Required: Yes
: Type: string

The AWS Region code that the Recommendation Resource is in

status

: Required: Yes
: Type: string

The current status of the Recommendation Resource

OrganizationRecommendationSummary

Description

Summary of recommendation for accounts within an Organization

Members

arn

: Required: Yes
: Type: string

The ARN of the Recommendation

awsServices

: Type: Array of strings

The AWS Services that the Recommendation applies to

checkArn

: Type: string

The AWS Trusted Advisor Check ARN that relates to the Recommendation

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation was created, if created by AWS Trusted Advisor Priority

id

: Required: Yes
: Type: string

The ID which identifies where the Recommendation was produced

lastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation was last updated

lifecycleStage

: Type: string

The lifecycle stage from AWS Trusted Advisor Priority

name

: Required: Yes
: Type: string

The name of the AWS Trusted Advisor Recommendation

pillarSpecificAggregates

: Type: RecommendationPillarSpecificAggregates structure

The pillar aggregations for cost savings

pillars

: Required: Yes
: Type: Array of strings

The Pillars that the Recommendation is optimizing

resourcesAggregates

: Required: Yes
: Type: RecommendationResourcesAggregates structure

An aggregation of all resources

source

: Required: Yes
: Type: string

The source of the Recommendation

status

: Required: Yes
: Type: string

The status of the Recommendation

type

: Required: Yes
: Type: string

Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

Recommendation

Description

A Recommendation for an Account

Members

arn

: Required: Yes
: Type: string

The ARN of the Recommendation

awsServices

: Type: Array of strings

The AWS Services that the Recommendation applies to

checkArn

: Type: string

The AWS Trusted Advisor Check ARN that relates to the Recommendation

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation was created, if created by AWS Trusted Advisor Priority

createdBy

: Type: string

The creator, if created by AWS Trusted Advisor Priority

description

: Required: Yes
: Type: string

A description for AWS Trusted Advisor recommendations

id

: Required: Yes
: Type: string

The ID which identifies where the Recommendation was produced

lastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation was last updated

lifecycleStage

: Type: string

The lifecycle stage from AWS Trusted Advisor Priority

name

: Required: Yes
: Type: string

The name of the AWS Trusted Advisor Recommendation

pillarSpecificAggregates

: Type: RecommendationPillarSpecificAggregates structure

The pillar aggregations for cost savings

pillars

: Required: Yes
: Type: Array of strings

The Pillars that the Recommendation is optimizing

resolvedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation was resolved

resourcesAggregates

: Required: Yes
: Type: RecommendationResourcesAggregates structure

An aggregation of all resources

source

: Required: Yes
: Type: string

The source of the Recommendation

status

: Required: Yes
: Type: string

The status of the Recommendation

type

: Required: Yes
: Type: string

Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

updateReason

: Type: string

Reason for the lifecycle stage change

updateReasonCode

: Type: string

Reason code for the lifecycle state change

updatedOnBehalfOf

: Type: string

updatedOnBehalfOfJobTitle

: Type: string

RecommendationCostOptimizingAggregates

Description

Cost optimizing aggregates for a Recommendation

Members

estimatedMonthlySavings

: Required: Yes
: Type: double

The estimated monthly savings

estimatedPercentMonthlySavings

: Required: Yes
: Type: double

The estimated percently monthly savings

RecommendationPillarSpecificAggregates

Description

Recommendation pillar aggregates

Members

costOptimizing

: Type: RecommendationCostOptimizingAggregates structure

Cost optimizing aggregates

RecommendationResourceExclusion

Description

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

Members

arn

: Required: Yes
: Type: string

The ARN of the Recommendation Resource

isExcluded

: Required: Yes
: Type: boolean

The exclusion status

RecommendationResourceSummary

Description

Summary of a Recommendation Resource

Members

arn

: Required: Yes
: Type: string

The ARN of the Recommendation Resource

awsResourceId

: Required: Yes
: Type: string

The AWS resource identifier

exclusionStatus

: Type: string

The exclusion status of the Recommendation Resource

id

: Required: Yes
: Type: string

The ID of the Recommendation Resource

lastUpdatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation Resource was last updated

metadata

: Required: Yes
: Type: Associative array of custom strings keys (String) to strings

Metadata associated with the Recommendation Resource

recommendationArn

: Required: Yes
: Type: string

The Recommendation ARN

regionCode

: Required: Yes
: Type: string

The AWS Region code that the Recommendation Resource is in

status

: Required: Yes
: Type: string

The current status of the Recommendation Resource

RecommendationResourcesAggregates

Description

Aggregation of Recommendation Resources

Members

errorCount

: Required: Yes
: Type: long (int|float)

The number of AWS resources that were flagged to have errors according to the Trusted Advisor check

okCount

: Required: Yes
: Type: long (int|float)

The number of AWS resources that were flagged to be OK according to the Trusted Advisor check

warningCount

: Required: Yes
: Type: long (int|float)

The number of AWS resources that were flagged to have warning according to the Trusted Advisor check

RecommendationSummary

Description

Summary of Recommendation for an Account

Members

arn

: Required: Yes
: Type: string

The ARN of the Recommendation

awsServices

: Type: Array of strings

The AWS Services that the Recommendation applies to

checkArn

: Type: string

The AWS Trusted Advisor Check ARN that relates to the Recommendation

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation was created, if created by AWS Trusted Advisor Priority

id

: Required: Yes
: Type: string

The ID which identifies where the Recommendation was produced

lastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Recommendation was last updated

lifecycleStage

: Type: string

The lifecycle stage from AWS Trusted Advisor Priority

name

: Required: Yes
: Type: string

The name of the AWS Trusted Advisor Recommendation

pillarSpecificAggregates

: Type: RecommendationPillarSpecificAggregates structure

The pillar aggregations for cost savings

pillars

: Required: Yes
: Type: Array of strings

The Pillars that the Recommendation is optimizing

resourcesAggregates

: Required: Yes
: Type: RecommendationResourcesAggregates structure

An aggregation of all resources

source

: Required: Yes
: Type: string

The source of the Recommendation

status

: Required: Yes
: Type: string

The status of the Recommendation

type

: Required: Yes
: Type: string

Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

ResourceNotFoundException

Description

Exception that the requested resource has not been found

Members

message

: Required: Yes
: Type: string

ThrottlingException

Description

Exception to notify that requests are being throttled

Members

message

: Required: Yes
: Type: string

UpdateRecommendationResourceExclusionError

Description

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

Members

arn

: Type: string

The ARN of the Recommendation Resource

errorCode

: Type: string

The error code

errorMessage

: Type: string

The error message

ValidationException

Description

Exception that the request failed to satisfy service constraints

Members

message

: Required: Yes
: Type: string

TrustedAdvisor Public API 2022-09-15

Operation Summary

Paginators

Operations

BatchUpdateRecommendationResourceExclusion

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetOrganizationRecommendation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetRecommendation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListChecks

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListOrganizationRecommendationAccounts

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListOrganizationRecommendationResources

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListOrganizationRecommendations

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListRecommendationResources

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListRecommendations

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

UpdateOrganizationRecommendationLifecycle

Parameter Syntax

Parameter Details

Members