GetResourcePolicy - Amazon OpenSearch Service

GetResourcePolicy

Retrieves the resource-based policy attached to an OpenSearch Ingestion resource.

Request Syntax

GET /2022-01-01/osis/resourcePolicy/ResourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ResourceArn

The Amazon Resource Name (ARN) of the resource for which to retrieve the policy.

Length Constraints: Minimum length of 46. Maximum length of 76.

Pattern: ^arn:(aws|aws\-cn|aws\-us\-gov|aws\-iso|aws\-iso\-b):osis:.+:pipeline\/.+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Policy": "string", "ResourceArn": "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.

Policy

The resource-based policy document in JSON format.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 204800.

ResourceArn

The Amazon Resource Name (ARN) of the resource.

Type: String

Length Constraints: Minimum length of 46. Maximum length of 76.

Pattern: ^arn:(aws|aws\-cn|aws\-us\-gov|aws\-iso|aws\-iso\-b):osis:.+:pipeline\/.+$

Errors

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

AccessDeniedException

You don't have permissions to access the resource.

HTTP Status Code: 403

DisabledOperationException

Exception is thrown when an operation has been disabled.

HTTP Status Code: 409

InternalException

The request failed because of an unknown error, exception, or failure (the failure is internal to the service).

HTTP Status Code: 500

LimitExceededException

You attempted to create more than the allowed number of tags.

HTTP Status Code: 409

ResourceNotFoundException

You attempted to access or delete a resource that does not exist.

HTTP Status Code: 404

ValidationException

An exception for missing or invalid input fields.

HTTP Status Code: 400

See Also

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