Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

AuthorizeVpcEndpointAccess

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Request Syntax


POST /2021-01-01/opensearch/domain/DomainName/authorizeVpcEndpointAccess HTTP/1.1
Content-type: application/json

{
   "Account": "string",
   "Service": "string"
}

URI Request Parameters

The request uses the following URI parameters.

DomainName

The name of the OpenSearch Service domain to provide access to.

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

Pattern: [a-z][a-z0-9\-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

Account

The AWS account ID to grant access to.

Type: String

Pattern: ^[0-9]+$

Required: No

Service

The AWS service SP to grant access to.

Type: String

Valid Values: application.opensearchservice.amazonaws.com

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AuthorizedPrincipal": { 
      "Principal": "string",
      "PrincipalType": "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.

AuthorizedPrincipal

Information about the AWS account or service that was provided access to the domain.

Type: AuthorizedPrincipal object

Errors

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

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

LimitExceededException

An exception for trying to create more than the allowed number of resources or sub-resources.

HTTP Status Code: 409

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400