Obtaining All Access Previews

Function

This API is used to obtain all access previews.

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

URI

GET /v5/analyzers/{analyzer_id}/access-previews

**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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Maximum number of results on a page. Constraints: N/A Range: The value ranges from 1 to 200. Default Value: 100
marker	No	String	Definition: Page marker. Constraints: N/A Range: The value contains 4 to 400 characters. Only letters, digits, and special characters (+/=-_) are allowed. Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
access_previews	Array of AccessPreviewSummary objects	Definition: Access preview list. Range: N/A
page_info	PageInfo object	Definition: Page information. Range: N/A

**Table 4** AccessPreviewSummary
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.
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 5** 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.

**Table 6** PageInfo
Parameter	Type	Description
current_count	Integer	Definition: Number of items on the current page. Range: N/A
next_marker	String	Definition: If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this operation until the next_marker response returns null. Range: Only letters, digits, plus signs (+), slashes (/), equal signs (=), underscores (_), and hyphens (-) are allowed.

Example Requests

Obtaining all access previews

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

Example Responses

Status code: 200

{
  "access_previews" : [ {
    "analyzer_id" : "{analyzer_id}",
    "created_at" : "2023-09-07T08:35:41.997Z",
    "access_preview_id" : "{access_preview_id}",
    "status" : "completed"
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : null
  }
}