SDK for PHP 3.x

AWS Billing and Cost Management Recommended Actions 2024-11-14

Client: Aws\BCMRecommendedActions\BCMRecommendedActionsClient
Service ID: bcm-recommended-actions
Version: 2024-11-14

This page describes the parameters and results for the operations of the AWS Billing and Cost Management Recommended Actions (2024-11-14), and shows how to use the Aws\BCMRecommendedActions\BCMRecommendedActionsClient object to call the described operations. This documentation is specific to the 2024-11-14 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 */).

ListRecommendedActions ( array $params = [] )
Returns a list of recommended actions that match the filter criteria.

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:

ListRecommendedActions

Operations

ListRecommendedActions 

$result = $client->listRecommendedActions([/* ... */]);
$promise = $client->listRecommendedActionsAsync([/* ... */]);

Returns a list of recommended actions that match the filter criteria.

Parameter Syntax

$result = $client->listRecommendedActions([
    'filter' => [
        'actions' => [
            [
                'key' => 'FEATURE|SEVERITY|TYPE', // REQUIRED
                'matchOption' => 'EQUALS|NOT_EQUALS', // REQUIRED
                'values' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
filter
Type: RequestFilter structure

The criteria that you want all returned recommended actions to match.

maxResults
Type: int

The maximum number of results to return in the response.

nextToken
Type: string

The pagination token that indicates the next set of results that you want to retrieve.

Result Syntax

[
    'nextToken' => '<string>',
    'recommendedActions' => [
        [
            'accountId' => '<string>',
            'context' => ['<string>', ...],
            'feature' => 'ACCOUNT|BUDGETS|COST_ANOMALY_DETECTION|COST_OPTIMIZATION_HUB|FREE_TIER|IAM|PAYMENTS|RESERVATIONS|SAVINGS_PLANS|TAX_SETTINGS',
            'id' => '<string>',
            'lastUpdatedTimeStamp' => '<string>',
            'nextSteps' => ['<string>', ...],
            'severity' => 'INFO|WARNING|CRITICAL',
            'type' => 'ADD_ALTERNATE_BILLING_CONTACT|CREATE_ANOMALY_MONITOR|CREATE_BUDGET|ENABLE_COST_OPTIMIZATION_HUB|MIGRATE_TO_GRANULAR_PERMISSIONS|PAYMENTS_DUE|PAYMENTS_PAST_DUE|REVIEW_ANOMALIES|REVIEW_BUDGET_ALERTS|REVIEW_BUDGETS_EXCEEDED|REVIEW_EXPIRING_RI|REVIEW_EXPIRING_SP|REVIEW_FREETIER_USAGE_ALERTS|REVIEW_SAVINGS_OPPORTUNITY_RECOMMENDATIONS|UPDATE_EXPIRED_PAYMENT_METHOD|UPDATE_INVALID_PAYMENT_METHOD|UPDATE_TAX_EXEMPTION_CERTIFICATE|UPDATE_TAX_REGISTRATION_NUMBER',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The pagination token that indicates the next set of results that you want to retrieve.

recommendedActions
Required: Yes
Type: Array of RecommendedAction structures

The list of recommended actions that satisfy the filter criteria.

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of your request.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ThrottlingException:

The request was denied due to request throttling.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
message
Required: Yes
Type: string

ActionFilter

Description

Describes a filter that returns a more specific list of recommended actions.

Members
key
Required: Yes
Type: string

The category to filter on. Valid values are FEATURE for feature type, SEVERITY for severity level, and TYPE for recommendation type.

matchOption
Required: Yes
Type: string

Specifies how to apply the filter. Use EQUALS to include matching results or NOT_EQUALS to exclude matching results.

values
Required: Yes
Type: Array of strings

One or more values to match against the specified key.

InternalServerException

Description

An unexpected error occurred during the processing of your request.

Members
message
Required: Yes
Type: string

RecommendedAction

Description

Describes a specific recommended action.

Members
accountId
Type: string

The account that the recommended action is for.

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

Context that applies to the recommended action.

feature
Type: string

The feature associated with the recommended action.

id
Type: string

The ID for the recommended action.

lastUpdatedTimeStamp
Type: string

The time when the recommended action status was last updated.

nextSteps
Type: Array of strings

The possible next steps to execute the recommended action.

severity
Type: string

The severity associated with the recommended action.

type
Type: string

The type of action you can take by adopting the recommended action.

RequestFilter

Description

Enables filtering of results based on specified action criteria. You can define multiple action filters to refine results using combinations of feature type, severity level, and recommendation type.

Members
actions
Type: Array of ActionFilter structures

A list of action filters that define criteria for filtering results. Each filter specifies a key, match option, and corresponding values to filter on.

ThrottlingException

Description

The request was denied due to request throttling.

Members
message
Required: Yes
Type: string

ValidationException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members
fieldList
Type: Array of ValidationExceptionField structures

Lists each problematic field and why it failed validation.

message
Required: Yes
Type: string
reason
Required: Yes
Type: string

Provides a single, overarching explanation for the validation failure.

ValidationExceptionField

Description

Provides specific details about why a particular field failed validation.

Members
message
Required: Yes
Type: string

Provides a message explaining why the field failed validation.

name
Required: Yes
Type: string

Provides the name of the field that failed validation.