GetFindingRecommendation - IAM Access Analyzer
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetFindingRecommendation

Retrieves information about a finding recommendation for the specified analyzer.

Request Syntax

GET /recommendation/id?analyzerArn=analyzerArn&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

analyzerArn

The ARN of the analyzer used to generate the finding recommendation.

Pattern: [^:]*:[^:]*:[^:]*:[^:]*:[^:]*:analyzer/.{1,255}

Required: Yes

id

The unique ID for the finding recommendation.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes

maxResults

The maximum number of results to return in the response.

Valid Range: Minimum value of 1. Maximum value of 1000.

nextToken

A token used for pagination of results returned.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "completedAt": "string",
   "error": { 
      "code": "string",
      "message": "string"
   },
   "nextToken": "string",
   "recommendationType": "string",
   "recommendedSteps": [ 
      { ... }
   ],
   "resourceArn": "string",
   "startedAt": "string",
   "status": "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.

completedAt

The time at which the retrieval of the finding recommendation was completed.

Type: Timestamp

error

Detailed information about the reason that the retrieval of a recommendation for the finding failed.

Type: RecommendationError object

nextToken

A token used for pagination of results returned.

Type: String

recommendationType

The type of recommendation for the finding.

Type: String

Valid Values: UnusedPermissionRecommendation

recommendedSteps

A group of recommended steps for the finding.

Type: Array of RecommendedStep objects

resourceArn

The ARN of the resource of the finding.

Type: String

Pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:.*

startedAt

The time at which the retrieval of the finding recommendation was started.

Type: Timestamp

status

The status of the retrieval of the finding recommendation.

Type: String

Valid Values: SUCCEEDED | FAILED | IN_PROGRESS

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

ThrottlingException

Throttling limit exceeded error.

HTTP Status Code: 429

ValidationException

Validation exception error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: