/2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess

The Amazon Elasticsearch Service multi-region endpoint

POST

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/es/domain//authorizeVpcEndpointAccess' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

200 - Example 1

{
  "AuthorizedPrincipal": {
    "PrincipalType": "AWS_ACCOUNT",
    "Principal": "string"
  }
}

Request

Path Params

DomainName

string

required

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

Body Params application/json

Account

string

required

The account ID to grant access to.

Match pattern:

^[0-9]+$

Examples

Responses

🟢200Success

application/json

Body

Container for response parameters to the <code><a>AuthorizeVpcEndpointAccess</a></code> operation. Contains the account ID and the type of the account being authorized to access the VPC endpoint.

AuthorizedPrincipal

object

required

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

PrincipalType

enum<string>

optional

The type of principal.

Allowed values:

AWS_ACCOUNTAWS_SERVICE

Principal

string

optional

The IAM principal that is allowed access to the domain.

🟠480ResourceNotFoundException

🟠481DisabledOperationException

🟠482LimitExceededException

🟠483ValidationException

🟠484InternalException

🟠485BaseException

Modified at 2023-08-15 04:15:52

/2015-01-01/packages/associate/{PackageID}/{DomainName}

/2015-01-01/es/serviceSoftwareUpdate/cancel