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(type, name,
  description, policy, clientToken)

Arguments¶

type: [required] The type of policy.
name: [required] The name of the policy.
description: A description of the policy. Typically used to store information about the permissions defined in the policy.
policy: [required] The JSON policy document to use as the content for the policy.
clientToken: Unique, case-sensitive identifier to ensure idempotency of the request.

Value¶

A list with the following syntax:

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

Request syntax¶

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