Obtaining All Access Previews

Function

This API is used to obtain all access previews.

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: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	Unique identifier of an analyzer Minimum: 1 Maximum: 36

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results on a page Minimum: 1 Maximum: 200 Default: 100
marker	No	String	Page marker Minimum: 4 Maximum: 400

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
access_previews	Array of AccessPreviewSummary objects	Access preview list.
page_info	PageInfo object	Information on the page

**Table 4** AccessPreviewSummary
Parameter	Type	Description
access_preview_id	String	Unique identifier of an access preview.
analyzer_id	String	Unique identifier of an analyzer
created_at	String	Time when the access preview was created.
status	String	Status of an access preview. creating: The preview is being created. completed: The preview is created. failed: Failed to create the preview.
status_reason	PreviewStatusReason object	More details about the status of an access preview.

**Table 5** PreviewStatusReason
Parameter	Type	Description
code	String	Reason for the status of an access preview.

**Table 6** PageInfo
Parameter	Type	Description
current_count	Integer	Number of items on the current page
next_marker	String	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.

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