Updating the Configuration of an Analyzer

Function

This API is used to update the configuration of an analyzer.

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:analyzer:update	Write	analyzer *	g:ResourceTag/<tag-key>	-	-

URI

PUT /v5/analyzers/{analyzer_id}

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

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
configuration	No	AnalyzerConfiguration object	Analyzer settings.

**Table 3** AnalyzerConfiguration
Parameter	Mandatory	Type	Description
unused_access	No	unused_access object	Settings of an unused access analyzer.

**Table 4** unused_access
Parameter	Mandatory	Type	Description
unused_access_age	No	Integer	Preset number of days for generating findings. Minimum: 1 Maximum: 180 Default: 90
unused_analysis_rule	No	UnusedAnalysisRule object	Unused analysis rule.

**Table 5** UnusedAnalysisRule
Parameter	Mandatory	Type	Description
exclusions	No	Array of UnusedAnalysisRuleCriteria objects	Exclusion rule.

**Table 6** UnusedAnalysisRuleCriteria
Parameter	Mandatory	Type	Description
account_ids	No	Array of strings	Account ID list. Minimum: 1 Maximum: 36 Array Length: 1 - 2000
resource_tags	No	Array of Tag objects	Resource tag list. Array Length: 1 - 20

**Table 7** Tag
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key
value	Yes	String	String value associated with the tag key.

Response Parameters

Status code: 200

None

Example Requests

Updating the configuration of a specified analyzer

PUT https://{hostname}/v5/analyzers/{analyzer_id}

{
  "configuration" : {
    "unused_access" : {
      "unused_access_age" : 30,
      "unused_analysis_rule" : {
        "exclusions" : [ {
          "account_ids" : [ "123", "456" ]
        }, {
          "resource_tags" : [ {
            "key" : "key-1",
            "value" : "value-1"
          }, {
            "key" : "key-2",
            "value" : "value-2"
          } ]
        } ]
      }
    }
  }
}