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

UpdateAuditSuppression

Updates a Device Defender audit suppression.

Request Syntax


PATCH /audit/suppressions/update HTTP/1.1
Content-type: application/json

{
   "checkName": "string",
   "description": "string",
   "expirationDate": number,
   "resourceIdentifier": { 
      "account": "string",
      "caCertificateId": "string",
      "clientId": "string",
      "cognitoIdentityPoolId": "string",
      "deviceCertificateArn": "string",
      "deviceCertificateId": "string",
      "iamRoleArn": "string",
      "issuerCertificateIdentifier": { 
         "issuerCertificateSerialNumber": "string",
         "issuerCertificateSubject": "string",
         "issuerId": "string"
      },
      "policyVersionIdentifier": { 
         "policyName": "string",
         "policyVersionId": "string"
      },
      "roleAliasArn": "string"
   },
   "suppressIndefinitely": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

checkName

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

Type: String

Required: Yes

description

The description of the audit suppression.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: [\p{Graph}\x20]*

Required: No

expirationDate

The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.

Type: Timestamp

Required: No

resourceIdentifier

Information that identifies the noncompliant resource.

Type: ResourceIdentifier object

Required: Yes

suppressIndefinitely

Indicates whether a suppression should exist indefinitely or not.

Type: Boolean

Required: No

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

InternalFailureException

An unexpected error has occurred.

message: The message for the exception.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

message: The message for the exception.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

message: The message for the exception.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

message: The message for the exception.

HTTP Status Code: 400