GetEndpointAccess
Returns information, such as the name, about a VPC endpoint.
Request Syntax
{
"endpointName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- endpointName
-
The name of the VPC endpoint to return information for.
Type: String
Required: Yes
Response Syntax
{
"endpoint": {
"address": "string",
"endpointArn": "string",
"endpointCreateTime": "string",
"endpointName": "string",
"endpointStatus": "string",
"port": number,
"subnetIds": [ "string" ],
"vpcEndpoint": {
"networkInterfaces": [
{
"availabilityZone": "string",
"ipv6Address": "string",
"networkInterfaceId": "string",
"privateIpAddress": "string",
"subnetId": "string"
}
],
"vpcEndpointId": "string",
"vpcId": "string"
},
"vpcSecurityGroups": [
{
"status": "string",
"vpcSecurityGroupId": "string"
}
],
"workgroupName": "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.
- endpoint
-
The returned VPC endpoint.
Type: EndpointAccess object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The submitted action has conflicts.
HTTP Status Code: 400
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
- resourceName
-
The name of the resource that could not be found.
HTTP Status Code: 400
- ValidationException
-
The input failed to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
