Retrieving Information About an Archive Rule

Function

This API is used to retrieve information about an 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: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	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

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
archive_rule	ArchiveRuleSummary object	Archive rule created by an analyzer.

**Table 3** ArchiveRuleSummary
Parameter	Type	Description
created_at	String	Time when an archive rule was created.
filters	Array of FindingFilter objects	A filter to match the returned findings.
id	String	Unique identifier of an archive rule
name	String	Name of the archive rule.
updated_at	String	Time when the archive rule was last updated
urn	String	Unique resource identifier of an archive rule.

**Table 4** FindingFilter
Parameter	Type	Description
criterion	Criterion object	Criteria in the filter. Only one operator is allowed.
key	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 5** Criterion
Parameter	Type	Description
contains	Array of strings	Matching the "contains" operator in the filter Array Length: 1 - 20
eq	Array of strings	Matching the "eq" operator in the filter Array Length: 1 - 20
exists	Boolean	Matching the "exists" operator in the filter
neq	Array of strings	Matching the "neq" operator in the filter Array Length: 1 - 20

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}"
  }
}