Retrieving Information About an Archive Rule

Function

This API is used to retrieve information about an archive rule.

Authorization Information

Each account root user 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:get	Read	archiveRule *	-	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
analyzer_id	Yes	String	Definition: Unique identifier of an analyzer. You can call the ListAnalyzers API to obtain the analyzer ID. The response parameters of this API return an analyzer list. The id field of each analyzer object is the analyzer ID. Range: 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
archive_rule_id	Yes	String	Definition: Unique identifier of an archive rule. You can call the ListArchiveRules API to retrieve the list of archive rules created for a specified analyzer. The response of this API contains an archive rule list. Each archive rule object in the list contains a unique id field, which is the archive rule ID. Range: 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
archive_rule	ArchiveRuleSummary object	Definition: Archive rule created by an analyzer. Range: N/A

**Table 3** ArchiveRuleSummary
Parameter	Type	Description
created_at	String	Definition: Time when an archive rule was created. The UTC+0 time zone is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-07T07:51:10.502Z. Range: N/A
filters	Array of FindingFilter objects	Definition: A filter to match the returned findings. Range: Array length: 1 to 20.
id	String	Definition: Unique identifier of an archive rule. Range: 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
name	String	Definition: Name of the archive rule. Range: 1 to 255 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
updated_at	String	Definition: Time when the archive rule was last updated. The UTC+0 time zone is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-07T07:51:10.502Z. Range: N/A
urn	String	Definition: Unique resource identifier of an archive rule. Range: The value can contain up to 1,500 characters.

**Table 4** FindingFilter
Parameter	Type	Description
criterion	Criterion object	Definition: Criteria in the filter. Constraints: Only one operator is allowed. Range: N/A Default Value: N/A
key	String	Definition: Filter key. Constraints: N/A Range: 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 type. principal_identifier: 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 Default Value: N/A

**Table 5** Criterion
Parameter	Type	Description
contains	Array of strings	Definition: Matching the "contains" operator in the filter. Constraints: N/A Range: Array length: 1 to 20. Default Value: N/A
eq	Array of strings	Definition: Matching the "eq" operator in the filter. Constraints: N/A Range: Array length: 1 to 20. Default Value: N/A
exists	Boolean	Definition: Matching the "exists" operator in the filter Constraints: N/A Range: N/A Default Value: N/A
neq	Array of strings	Definition: Matching the "neq" operator in the filter. Constraints: N/A Range: Array length: 1 to 20. Default Value: N/A

Example Requests

Retrieving information about an archive rule

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

Example Responses

Status code: 200

{
  "archive_rule" : {
    "created_at" : "2023-09-07T08:35:41.997Z",
    "filters" : [ {
      "criterion" : {
        "eq" : [ "iam:agency" ]
      },
      "key" : "resource_type"
    } ],
    "id" : "{archive_rule_id}",
    "name" : "my-archive-rules",
    "updated_at" : "2023-09-07T08:35:41.997Z",
    "urn" : "AccessAnalyzer:{region_id}:{domain_id}:archiveRule:{analyzer_id}/{archive_rule_id}"
  }
}