{ "smithy": "2.0", "shapes": { "com.amazonaws.bcmrecommendedactions#AWSBillingAndCostManagementRecommendedActions": { "type": "service", "version": "2024-11-14", "operations": [ { "target": "com.amazonaws.bcmrecommendedactions#ListRecommendedActions" } ], "traits": { "aws.api#service": { "sdkId": "BCM Recommended Actions", "arnNamespace": "bcm-recommended-actions", "endpointPrefix": "bcm-recommended-actions", "docId": "bcm-recommended-actions-2024-11-14" }, "aws.auth#sigv4": { "name": "bcm-recommended-actions" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardPartitionalEndpoints": { "endpointPatternType": "service_region_dnsSuffix" }, "aws.protocols#awsJson1_0": {}, "smithy.api#documentation": "
You can use the Billing and Cost Management Recommended Actions API to programmatically query your best practices and recommendations to optimize your costs.
The Billing and Cost Management Recommended Actions API provides the following endpoint:
https://bcm-recommended-actions.us-east-1.api.aws
You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.bcmrecommendedactions#AccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.bcmrecommendedactions#ActionFilter": { "type": "structure", "members": { "key": { "target": "com.amazonaws.bcmrecommendedactions#FilterName", "traits": { "smithy.api#documentation": "The category to filter on. Valid values are FEATURE for feature type, SEVERITY for severity level, and TYPE for recommendation type.
Specifies how to apply the filter. Use EQUALS to include matching results or NOT_EQUALS to exclude matching results.
One or more values to match against the specified key.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes a filter that returns a more specific list of recommended actions.
" } }, "com.amazonaws.bcmrecommendedactions#ActionFilterList": { "type": "list", "member": { "target": "com.amazonaws.bcmrecommendedactions#ActionFilter" } }, "com.amazonaws.bcmrecommendedactions#ActionType": { "type": "enum", "members": { "ADD_ALTERNATE_BILLING_CONTACT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADD_ALTERNATE_BILLING_CONTACT" } }, "CREATE_ANOMALY_MONITOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_ANOMALY_MONITOR" } }, "CREATE_BUDGET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_BUDGET" } }, "ENABLE_COST_OPTIMIZATION_HUB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLE_COST_OPTIMIZATION_HUB" } }, "MIGRATE_TO_GRANULAR_PERMISSIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MIGRATE_TO_GRANULAR_PERMISSIONS" } }, "PAYMENTS_DUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAYMENTS_DUE" } }, "PAYMENTS_PAST_DUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAYMENTS_PAST_DUE" } }, "REVIEW_ANOMALIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVIEW_ANOMALIES" } }, "REVIEW_BUDGET_ALERTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVIEW_BUDGET_ALERTS" } }, "REVIEW_BUDGETS_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVIEW_BUDGETS_EXCEEDED" } }, "REVIEW_EXPIRING_RI": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVIEW_EXPIRING_RI" } }, "REVIEW_EXPIRING_SP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVIEW_EXPIRING_SP" } }, "REVIEW_FREETIER_USAGE_ALERTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVIEW_FREETIER_USAGE_ALERTS" } }, "REVIEW_FREETIER_CREDITS_REMAINING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVIEW_FREETIER_CREDITS_REMAINING" } }, "REVIEW_FREETIER_DAYS_REMAINING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVIEW_FREETIER_DAYS_REMAINING" } }, "REVIEW_SAVINGS_OPPORTUNITY_RECOMMENDATIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVIEW_SAVINGS_OPPORTUNITY_RECOMMENDATIONS" } }, "UPDATE_EXPIRED_PAYMENT_METHOD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_EXPIRED_PAYMENT_METHOD" } }, "UPDATE_INVALID_PAYMENT_METHOD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_INVALID_PAYMENT_METHOD" } }, "UPDATE_TAX_EXEMPTION_CERTIFICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_TAX_EXEMPTION_CERTIFICATE" } }, "UPDATE_TAX_REGISTRATION_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_TAX_REGISTRATION_NUMBER" } } } }, "com.amazonaws.bcmrecommendedactions#Context": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.bcmrecommendedactions#Feature": { "type": "enum", "members": { "ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT" } }, "BUDGETS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUDGETS" } }, "COST_ANOMALY_DETECTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COST_ANOMALY_DETECTION" } }, "COST_OPTIMIZATION_HUB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COST_OPTIMIZATION_HUB" } }, "FREE_TIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FREE_TIER" } }, "IAM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IAM" } }, "PAYMENTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAYMENTS" } }, "RESERVATIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESERVATIONS" } }, "SAVINGS_PLANS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAVINGS_PLANS" } }, "TAX_SETTINGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TAX_SETTINGS" } } } }, "com.amazonaws.bcmrecommendedactions#FilterName": { "type": "enum", "members": { "FEATURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FEATURE" } }, "SEVERITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SEVERITY" } }, "TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TYPE" } } } }, "com.amazonaws.bcmrecommendedactions#FilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "[\\S\\s]*" } }, "com.amazonaws.bcmrecommendedactions#FilterValues": { "type": "list", "member": { "target": "com.amazonaws.bcmrecommendedactions#FilterValue" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.bcmrecommendedactions#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "BCMRecommendedActionsInternalServer", "httpResponseCode": 500 }, "smithy.api#documentation": "An unexpected error occurred during the processing of your request.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.bcmrecommendedactions#ListRecommendedActions": { "type": "operation", "input": { "target": "com.amazonaws.bcmrecommendedactions#ListRecommendedActionsRequest" }, "output": { "target": "com.amazonaws.bcmrecommendedactions#ListRecommendedActionsResponse" }, "errors": [ { "target": "com.amazonaws.bcmrecommendedactions#AccessDeniedException" }, { "target": "com.amazonaws.bcmrecommendedactions#InternalServerException" }, { "target": "com.amazonaws.bcmrecommendedactions#ThrottlingException" }, { "target": "com.amazonaws.bcmrecommendedactions#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a list of recommended actions that match the filter criteria.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "recommendedActions" }, "smithy.test#smokeTests": [ { "id": "ListRecommendedActionsSuccess", "params": { "maxResults": 5 }, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams" } ] } }, "com.amazonaws.bcmrecommendedactions#ListRecommendedActionsRequest": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.bcmrecommendedactions#RequestFilter", "traits": { "smithy.api#documentation": "The criteria that you want all returned recommended actions to match.
" } }, "maxResults": { "target": "com.amazonaws.bcmrecommendedactions#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in the response.
" } }, "nextToken": { "target": "com.amazonaws.bcmrecommendedactions#NextToken", "traits": { "smithy.api#documentation": "The pagination token that indicates the next set of results that you want to retrieve.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bcmrecommendedactions#ListRecommendedActionsResponse": { "type": "structure", "members": { "recommendedActions": { "target": "com.amazonaws.bcmrecommendedactions#RecommendedActions", "traits": { "smithy.api#documentation": "The list of recommended actions that satisfy the filter criteria.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.bcmrecommendedactions#NextToken", "traits": { "smithy.api#documentation": "The pagination token that indicates the next set of results that you want to retrieve.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bcmrecommendedactions#MatchOption": { "type": "enum", "members": { "EQUALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EQUALS" } }, "NOT_EQUALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_EQUALS" } } } }, "com.amazonaws.bcmrecommendedactions#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.bcmrecommendedactions#NextStep": { "type": "string" }, "com.amazonaws.bcmrecommendedactions#NextSteps": { "type": "list", "member": { "target": "com.amazonaws.bcmrecommendedactions#NextStep" } }, "com.amazonaws.bcmrecommendedactions#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8192 }, "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.bcmrecommendedactions#RecommendedAction": { "type": "structure", "members": { "id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID for the recommended action.
" } }, "type": { "target": "com.amazonaws.bcmrecommendedactions#ActionType", "traits": { "smithy.api#documentation": "The type of action you can take by adopting the recommended action.
" } }, "accountId": { "target": "com.amazonaws.bcmrecommendedactions#AccountId", "traits": { "smithy.api#documentation": "The account that the recommended action is for.
" } }, "severity": { "target": "com.amazonaws.bcmrecommendedactions#Severity", "traits": { "smithy.api#documentation": "The severity associated with the recommended action.
" } }, "feature": { "target": "com.amazonaws.bcmrecommendedactions#Feature", "traits": { "smithy.api#documentation": "The feature associated with the recommended action.
" } }, "context": { "target": "com.amazonaws.bcmrecommendedactions#Context", "traits": { "smithy.api#documentation": "Context that applies to the recommended action.
" } }, "nextSteps": { "target": "com.amazonaws.bcmrecommendedactions#NextSteps", "traits": { "smithy.api#documentation": "The possible next steps to execute the recommended action.
" } }, "lastUpdatedTimeStamp": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The time when the recommended action status was last updated.
" } } }, "traits": { "smithy.api#documentation": "Describes a specific recommended action.
" } }, "com.amazonaws.bcmrecommendedactions#RecommendedActions": { "type": "list", "member": { "target": "com.amazonaws.bcmrecommendedactions#RecommendedAction" } }, "com.amazonaws.bcmrecommendedactions#RequestFilter": { "type": "structure", "members": { "actions": { "target": "com.amazonaws.bcmrecommendedactions#ActionFilterList", "traits": { "smithy.api#documentation": "A list of action filters that define criteria for filtering results. Each filter specifies a key, match option, and corresponding values to filter on.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.bcmrecommendedactions#Severity": { "type": "enum", "members": { "INFO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INFO" } }, "WARNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WARNING" } }, "CRITICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRITICAL" } } } }, "com.amazonaws.bcmrecommendedactions#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "BCMRecommendedActionsThrottling", "httpResponseCode": 429 }, "smithy.api#documentation": "The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.bcmrecommendedactions#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.bcmrecommendedactions#ValidationExceptionReason", "traits": { "smithy.api#documentation": "Provides a single, overarching explanation for the validation failure.
", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.bcmrecommendedactions#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "Lists each problematic field and why it failed validation.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "BCMRecommendedActionsValidation", "httpResponseCode": 400 }, "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.bcmrecommendedactions#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Provides the name of the field that failed validation.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Provides a message explaining why the field failed validation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Provides specific details about why a particular field failed validation.
" } }, "com.amazonaws.bcmrecommendedactions#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.bcmrecommendedactions#ValidationExceptionField" } }, "com.amazonaws.bcmrecommendedactions#ValidationExceptionReason": { "type": "enum", "members": { "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unknownOperation" } }, "CANNOT_PARSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cannotParse" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "fieldValidationFailed" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "other" } } } } } }