Updating the Criteria and Values of the Specified Archive Rule

Function

This API is used to update the criteria and values of the specified archive rule.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
AccessAnalyzer:archiveRule:update	Write	archiveRule *	-	-	-

URI

PUT /v5/analyzers/{analyzer_id}/archive-rules/{archive_rule_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
analyzer_id	Yes	String	Unique identifier of an analyzer Minimum: 1 Maximum: 36
archive_rule_id	Yes	String	Unique identifier of an archive rule Minimum: 1 Maximum: 36

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
filters	Yes	Array of FindingFilter objects	A filter to match the returned findings. Array Length: 1 - 10

**Table 3** FindingFilter
Parameter	Mandatory	Type	Description
criterion	Yes	Criterion object	Criteria in the filter. Only one operator is allowed.
key	Yes	String	Filter key. resource: resource URN resource_type: resource type resource_owner_account: resource owner account is_public: public access permission id: finding ID status: finding type principal_type principal_identifier change_type: finding status change existing_finding_id: ID of an existing finding existing_finding_status: status of an existing finding condition.g:PrincipalUrn: principal URN condition.g:PrincipalId: principal ID condition.g:PrincipalAccount: principal account condition.g:PrincipalOrgId: principal organization ID condition.g:PrincipalOrgPath: principal organization path condition.g:PrincipalOrgManagementAccountId: principal organization management account ID condition.g:SourceIp: source IP address condition.g:SourceVpc: source VPC condition.g: SourceVpce: source VPC endpoint finding_type: finding type

**Table 4** Criterion
Parameter	Mandatory	Type	Description
contains	No	Array of strings	Matching the "contains" operator in the filter Array Length: 1 - 20
eq	No	Array of strings	Matching the "eq" operator in the filter Array Length: 1 - 20
exists	No	Boolean	Matching the "exists" operator in the filter
neq	No	Array of strings	Matching the "neq" operator in the filter Array Length: 1 - 20

Response Parameters

Status code: 200

None

Example Requests

Updating the criteria and values of the specified archive rule

PUT https://{hostname}/v5/analyzers/{analyzer_id}/archive-rules/{archive_rule_id}

{
  "filters" : [ {
    "criterion" : {
      "eq" : [ "iam:agency" ]
    },
    "key" : "resource_type"
  }, {
    "criterion" : {
      "eq" : [ "obs:bucket" ]
    },
    "key" : "resource_type"
  } ]
}