Amazon Elasticsearch Service
    Amazon Elasticsearch Service
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept
      PUT
    • /2015-01-01/tags
      POST
    • /2015-01-01/packages/associate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/cancel
      POST
    • /2015-01-01/es/domain
      POST
    • /2015-01-01/es/ccs/outboundConnection
      POST
    • /2015-01-01/packages
      POST
    • /2015-01-01/es/vpcEndpoints
      POST
    • /2015-01-01/es/vpcEndpoints
      GET
    • /2015-01-01/es/domain/{DomainName}
      DELETE
    • /2015-01-01/es/domain/{DomainName}
      GET
    • /2015-01-01/es/role
      DELETE
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/es/ccs/outboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/packages/{PackageID}
      DELETE
    • /2015-01-01/es/vpcEndpoints/{VpcEndpointId}
      DELETE
    • /2015-01-01/es/domain/{DomainName}/autoTunes
      GET
    • /2015-01-01/es/domain/{DomainName}/progress
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      POST
    • /2015-01-01/es/domain-info
      POST
    • /2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}
      GET
    • /2015-01-01/es/ccs/inboundConnection/search
      POST
    • /2015-01-01/es/ccs/outboundConnection/search
      POST
    • /2015-01-01/packages/describe
      POST
    • /2015-01-01/es/reservedInstanceOfferings
      GET
    • /2015-01-01/es/reservedInstances
      GET
    • /2015-01-01/es/vpcEndpoints/describe
      POST
    • /2015-01-01/packages/dissociate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/compatibleVersions
      GET
    • /2015-01-01/packages/{PackageID}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/status
      GET
    • /2015-01-01/domain
      GET
    • /2015-01-01/packages/{PackageID}/domains
      GET
    • /2015-01-01/es/instanceTypes/{ElasticsearchVersion}
      GET
    • /2015-01-01/es/versions
      GET
    • /2015-01-01/domain/{DomainName}/packages
      GET
    • /2015-01-01/tags/
      GET
    • /2015-01-01/es/domain/{DomainName}/listVpcEndpointAccess
      GET
    • /2015-01-01/es/domain/{DomainName}/vpcEndpoints
      GET
    • /2015-01-01/es/purchaseReservedInstanceOffering
      POST
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject
      PUT
    • /2015-01-01/tags-removal
      POST
    • /2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/start
      POST
    • /2015-01-01/packages/update
      POST
    • /2015-01-01/es/vpcEndpoints/update
      POST
    • /2015-01-01/es/upgradeDomain
      POST

      /2015-01-01/es/vpcEndpoints

      The Amazon Elasticsearch Service multi-region endpoint
      The Amazon Elasticsearch Service multi-region endpoint
      POST
      /2015-01-01/es/vpcEndpoints
      Creates an Amazon OpenSearch Service-managed VPC endpoint.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/es/vpcEndpoints' \
--header 'Content-Type: application/json' \
--data-raw ''
      Response Response Example
      200 - Example 1
      {
  "VpcEndpoint": {
    "VpcEndpointId": "string",
    "VpcEndpointOwner": "string",
    "DomainArn": "string",
    "VpcOptions": {
      "VPCId": "string",
      "SubnetIds": [],
      "AvailabilityZones": [],
      "SecurityGroupIds": []
    },
    "Status": {},
    "Endpoint": "string"
  }
}

      Request

      Body Params application/json
      DomainArn
      string 
      required
      The Amazon Resource Name (ARN) of the domain to grant access to.
      >= 1 characters<= 512 characters
      Match pattern:
      arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+
      VpcOptions
      object 
      required
      Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
      SubnetIds
      array[string]
      optional
      Specifies the subnets for VPC endpoint.
      SecurityGroupIds
      array[string]
      optional
      Specifies the security groups for VPC endpoint.
      ClientToken
      string 
      optional
      Unique, case-sensitive identifier to ensure idempotency of the request.
      >= 1 characters<= 64 characters
      Examples

      Responses

      🟢200Success
      application/json
      Body
      Container for response parameters to the <code><a>CreateVpcEndpoint</a></code> operation. Contains the configuration and status of the VPC Endpoint being created.
      VpcEndpoint
      object 
      required
      Information about the newly created VPC endpoint.
      VpcEndpointId
      string 
      optional
      The unique identifier of the endpoint.
      >= 5 characters<= 256 characters
      Match pattern:
      ^aos-[a-zA-Z0-9]*$
      VpcEndpointOwner
      string 
      optional
      The creator of the endpoint.
      Match pattern:
      ^[0-9]+$
      DomainArn
      string 
      optional
      The Amazon Resource Name (ARN) of the domain associated with the endpoint.
      >= 1 characters<= 512 characters
      Match pattern:
      arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+
      VpcOptions
      object 
      optional
      Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
      Status
      object 
      optional
      The current status of the endpoint.
      Endpoint
      string 
      optional
      The connection endpoint ID for connecting to the domain.
      Match pattern:
      ^[A-Za-z0-9\-\.]+$
      🟠480ConflictException
      🟠481ValidationException
      🟠482LimitExceededException
      🟠483InternalException
      🟠484DisabledOperationException
      🟠485BaseException
      Modified at 2023-08-15 04:15:52
      Previous
      /2015-01-01/packages
      Next
      /2015-01-01/es/vpcEndpoints
      Built with