Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

BatchUpdateRecommendationStatus

Enables you to include or exclude one or more operational recommendations.

Request Syntax


POST /batch-update-recommendation-status HTTP/1.1
Content-type: application/json

{
   "appArn": "string",
   "requestEntries": [ 
      { 
         "entryId": "string",
         "excluded": boolean,
         "excludeReason": "string",
         "item": { 
            "resourceId": "string",
            "targetAccountId": "string",
            "targetRegion": "string"
         },
         "referenceId": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

appArn

Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Type: String

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}$

Required: Yes

requestEntries

Defines the list of operational recommendations that need to be included or excluded.

Type: Array of UpdateRecommendationStatusRequestEntry objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "appArn": "string",
   "failedEntries": [ 
      { 
         "entryId": "string",
         "errorMessage": "string"
      }
   ],
   "successfulEntries": [ 
      { 
         "entryId": "string",
         "excluded": boolean,
         "excludeReason": "string",
         "item": { 
            "resourceId": "string",
            "targetAccountId": "string",
            "targetRegion": "string"
         },
         "referenceId": "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.

appArn

Type: String

failedEntries

A list of items with error details about each item, which could not be included or excluded.

Type: Array of BatchUpdateRecommendationStatusFailedEntry objects

successfulEntries

A list of items that were included or excluded.

Type: Array of BatchUpdateRecommendationStatusSuccessfulEntry objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the AWS Resilience Hub service.

HTTP Status Code: 500

ResourceNotFoundException

This exception occurs when the specified resource could not be found.

HTTP Status Code: 404

ThrottlingException

This exception occurs when you have exceeded the limit on the number of requests per second.

HTTP Status Code: 429

ValidationException

This exception occurs when a request is not valid.

HTTP Status Code: 400

Examples

Sample request

This example illustrates one usage of BatchUpdateRecommendationStatus.


{
  "appArn": "APP_ARN",
  "requestEntries": [
    {
      "entryId": "entry_num_1",
      "referenceId": "s3:alarm:health_4xx_errors_count:2020-04-01",
      "item": {
        "resourceId": "a-resource-id",
        "targetAccountId": "123456789012",
        "targetRegion": "us-west-2"
      },
      "excluded": true,
      "excludeReason": "AlreadyImplemented"
    },
    {
      "entryId": "entry_num_2",
      "referenceId": "s3:alarm:health_total_request_latency:2020-04-01",
      "item": {
        "resourceId": "a-resource-id",
        "targetAccountId": "123456789012",
        "targetRegion": "us-west-2"
      },
      "excluded": true
    }
  ]
}

Sample response

This example illustrates one usage of BatchUpdateRecommendationStatus.


{
  "appArn": "APP_ARN",
  "successfulEntries": [
    {
      "entryId": "entry_num_2",
      "referenceId": "s3:alarm:health_total_request_latency:2020-04-01",
      "item": {
        "resourceId": "a-resource-id",
        "targetAccountId": "123456789012",
        "targetRegion": "us-west-2"
      },
      "excluded": true
    },
    {
      "entryId": "entry_num_1",
      "referenceId": "s3:alarm:health_4xx_errors_count:2020-04-01",
      "item": {
        "resourceId": "a-resource-id",
        "targetAccountId": "123456789012",
        "targetRegion": "us-west-2"
      },
      "excluded": true,
      "excludeReason": "AlreadyImplemented"
    }
  ],
  "failedEntries": []
}