Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
Request Syntax
GET /2021-01-01/opensearch/domain/DomainName/vpcEndpoints?nextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- DomainName
-
The name of the domain to list associated VPC endpoints for.
Length Constraints: Minimum length of 3. Maximum length of 28.
Pattern:
[a-z][a-z0-9\-]+Required: Yes
- NextToken
-
If your initial
ListEndpointsForDomainoperation returns anextToken, you can include the returnednextTokenin subsequentListEndpointsForDomainoperations, which returns results in the next page.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"VpcEndpointSummaryList": [
{
"DomainArn": "string",
"Status": "string",
"VpcEndpointId": "string",
"VpcEndpointOwner": "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.
- NextToken
-
When
nextTokenis returned, there are more results available. The value ofnextTokenis a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.Type: String
- VpcEndpointSummaryList
-
Information about each endpoint associated with the domain.
Type: Array of VpcEndpointSummary objects
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
- ResourceNotFoundException
-
An exception for accessing or deleting a resource that doesn't exist.
HTTP Status Code: 409
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
