Obtaining Access Preview Details

Function

This API is used to obtain access preview details.

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

URI

GET /v5/analyzers/{analyzer_id}/access-previews/{access_preview_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.
access_preview_id	Yes	String	Definition: Unique identifier of an access preview. You can call the ListAccessPreviews API to retrieve all access previews created for a specified analyzer. The response of this API contains an access preview list. Each access preview summary object in the list contains a unique access_preview_id field, which is the preview access analysis 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
access_preview	AccessPreview object	Definition: Access preview. Range: N/A

**Table 3** AccessPreview
Parameter	Type	Description
access_preview_id	String	Definition: Unique identifier of an access preview. Range: 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
analyzer_id	String	Definition: Unique identifier of an analyzer. Range: 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
configurations	Configuration object	Definition: Preview access settings. Range: N/A
created_at	String	Definition: Time when the access preview 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
status	String	Definition: Status of an access preview. Range: creating: being created completed: successfully created failed: creation failed
status_reason	PreviewStatusReason object	Definition: More details about the status of an access preview. Range: N/A

**Table 4** Configuration
Parameter	Type	Description
iam_agency	IAMAgency object	Definition: IAM trust agency. Constraints: N/A Range: N/A Default Value: N/A
obs_bucket	OBSBucket object	Definition: OBS bucket. Constraints: N/A Range: N/A Default Value: N/A
kms_cmk	KMSCmk object	Definition: KMS key. Constraints: N/A Range: N/A Default Value: N/A

**Table 5** IAMAgency
Parameter	Type	Description
trust_policy	String	Definition: JSON policy document. Constraints: N/A Range: The value contains 0 to 131,072 characters. Default Value: N/A

**Table 6** OBSBucket
Parameter	Type	Description
bucket_acl	String	Definition: String format of the bucket ACL XML file. Constraints: N/A Range: N/A Default Value: N/A
bucket_policy	String	Definition: JSON policy document. Constraints: N/A Range: The value contains 0 to 131,072 characters. Default Value: N/A

**Table 7** KMSCmk
Parameter	Type	Description
grants	String	Definition: Used to authorize encryption keys. Constraints: N/A Range: N/A Default Value: N/A

**Table 8** PreviewStatusReason
Parameter	Type	Description
code	String	Definition: Reason for the status of an access preview. Range: internal_error: There is an internal error. invalid_configuration: The configuration is invalid.

Example Requests

Obtaining access preview details

GET https://{hostname}/v5/analyzers/{analyzer_id}/access-previews/{access_preview_id}

Example Responses

Status code: 200

{
  "access_preview" : {
    "analyzer_id" : "{analyzer_id}",
    "configurations" : {
      "iam_agency" : {
        "trust_policy" : "{\"Version\":\"5.0\",\"Statement\":[{\"Condition\":{\"StringMatch\":{\"g:PrincipalOrgId\":[\"org_id\"]}},\"Action\":[\"sts:agencies:assume\",\"sts::tagSession\",\"sts::setSourceIdentity\"],\"Effect\":\"Allow\",\"Principal\":{\"IAM\":[\"dd...\"]}}]}"
      }
    },
    "created_at" : "2023-09-07T07:26:23.440Z",
    "access_preview_id" : "{access_preview_id}",
    "status" : "completed"
  }
}