GetAccessPolicy - Amazon OpenSearch Serverless


Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

Request Syntax

{ "name": "string", "type": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The name of the access policy.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 32.

Pattern: ^[a-z][a-z0-9-]+$

Required: Yes


Tye type of policy. Currently, the only supported value is data.

Type: String

Valid Values: data

Required: Yes

Response Syntax

{ "accessPolicyDetail": { "createdDate": number, "description": "string", "lastModifiedDate": number, "name": "string", "policy": JSON value, "policyVersion": "string", "type": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Details about the requested access policy.

Type: AccessPolicyDetail object


For information about the errors that are common to all actions, see Common Errors.


Thrown when an error internal to the service occurs while processing a request.

HTTP Status Code: 500


Thrown when accessing or deleting a resource that does not exist.

HTTP Status Code: 400


Thrown when the HTTP request contains invalid input or is missing required input.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: