Skip to content

List Access Policies

opensearchserviceserverless_list_access_policies R Documentation

Returns information about a list of OpenSearch Serverless access policies

Description

Returns information about a list of OpenSearch Serverless access policies.

Usage

opensearchserviceserverless_list_access_policies(maxResults, nextToken,
  resource, type)

Arguments

maxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

nextToken

If your initial list_access_policies operation returns a nextToken, you can include the returned nextToken in subsequent list_access_policies operations, which returns results in the next page.

resource

Resource filters (can be collections or indexes) that policies can apply to.

type

[required] The type of access policy.

Value

A list with the following syntax:

list(
  accessPolicySummaries = list(
    list(
      createdDate = 123,
      description = "string",
      lastModifiedDate = 123,
      name = "string",
      policyVersion = "string",
      type = "data"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_access_policies(
  maxResults = 123,
  nextToken = "string",
  resource = list(
    "string"
  ),
  type = "data"
)