Skip to content

Create Access Policy

opensearchserviceserverless_create_access_policy R Documentation

Creates a data access policy for OpenSearch Serverless

Description

Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.

Usage

opensearchserviceserverless_create_access_policy(clientToken,
  description, name, policy, type)

Arguments

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

description

A description of the policy. Typically used to store information about the permissions defined in the policy.

name

[required] The name of the policy.

policy

[required] The JSON policy document to use as the content for the policy.

type

[required] The type of policy.

Value

A list with the following syntax:

list(
  accessPolicyDetail = list(
    createdDate = 123,
    description = "string",
    lastModifiedDate = 123,
    name = "string",
    policy = list(),
    policyVersion = "string",
    type = "data"
  )
)

Request syntax

svc$create_access_policy(
  clientToken = "string",
  description = "string",
  name = "string",
  policy = "string",
  type = "data"
)