TrustedAdvisorPublicAPI / Client / batch_update_recommendation_resource_exclusion

batch_update_recommendation_resource_exclusion¶

TrustedAdvisorPublicAPI.Client.batch_update_recommendation_resource_exclusion(**kwargs)¶

Update one or more exclusion statuses for a list of recommendation resources. This API supports up to 25 unique recommendation resource ARNs per request. This API currently doesn’t support prioritized recommendation resources. This API updates global recommendations, eliminating the need to call the API in each AWS Region. After submitting an exclusion update, note that it might take a few minutes for the changes to be reflected in the system.

Request Syntax

response = client.batch_update_recommendation_resource_exclusion(
    recommendationResourceExclusions=[
        {
            'arn': 'string',
            'isExcluded': True|False
        },
    ]
)

Parameters:

recommendationResourceExclusions (list) –

[REQUIRED]

A list of recommendation resource ARNs and exclusion status to update

(dict) –

The request entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN and corresponding exclusion status
- arn (string) – [REQUIRED]
  
  The ARN of the Recommendation Resource
- isExcluded (boolean) – [REQUIRED]
  
  The exclusion status

Return type:

dict

Returns:

Response Syntax

{
    'batchUpdateRecommendationResourceExclusionErrors': [
        {
            'arn': 'string',
            'errorCode': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

(dict) –
- batchUpdateRecommendationResourceExclusionErrors (list) –
  
  A list of recommendation resource ARNs whose exclusion status failed to update, if any
  - (dict) –
    
    The error entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN, error code and error message
    - arn (string) –
      
      The ARN of the Recommendation Resource
    - errorCode (string) –
      
      The error code
    - errorMessage (string) –
      
      The error message

Exceptions

TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException
TrustedAdvisorPublicAPI.Client.exceptions.ConflictException
TrustedAdvisorPublicAPI.Client.exceptions.InternalServerException
TrustedAdvisorPublicAPI.Client.exceptions.ValidationException
TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException