CreateEndpointAccess - Amazon Redshift Serverless


Creates an Amazon Redshift Serverless managed VPC endpoint.

Request Syntax

{ "endpointName": "string", "ownerAccount": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ], "workgroupName": "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.


The name of the VPC endpoint. An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.

Type: String

Required: Yes


The owner AWS account for the Amazon Redshift Serverless workgroup.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: (\d{12})

Required: No


The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.

Type: Array of strings

Required: Yes


The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

Type: Array of strings

Required: No


The name of the workgroup to associate with the VPC endpoint.

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", "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.


The created VPC endpoint.

Type: EndpointAccess object


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


You do not have sufficient access to perform this action.

HTTP Status Code: 400


The submitted action has conflicts.

HTTP Status Code: 400


The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500


The resource could not be found.

HTTP Status Code: 400


The service limit was exceeded.

HTTP Status Code: 400


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: