Access Analyzer
API Reference (API Version 2019-11-01)

UpdateFindings

Updates the status for the specified findings.

Request Syntax

PUT /finding HTTP/1.1 Content-type: application/json { "analyzerArn": "string", "clientToken": "string", "ids": [ "string" ], "resourceArn": "string", "status": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

analyzerArn

The ARN of the analyzer that generated the findings to update.

Type: String

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

Required: Yes

clientToken

A client token.

Type: String

Required: No

ids

The IDs of the findings to update.

Type: Array of strings

Required: No

resourceArn

The ARN of the resource identified in the finding.

Type: String

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

Required: No

status

The state represents the action to take to update the finding Status. Use ARCHIVE to change an Active finding to an Archived finding. Use ACTIVE to change an Archived finding to an Active finding.

Type: String

Valid Values: ACTIVE | ARCHIVED

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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: