Returns an array of EndpointAccess objects and relevant information.
Request Syntax
{
"maxResults": number,
"nextToken": "string",
"ownerAccount": "string",
"vpcId": "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.
- maxResults
-
An optional parameter that specifies the maximum number of results to return. You can use
nextTokento display the next page of results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
If your initial
ListEndpointAccessoperation returns anextToken, you can include the returnednextTokenin followingListEndpointAccessoperations, which returns results in the next page.Type: String
Required: No
- ownerAccount
-
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
- vpcId
-
The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.
Type: String
Required: No
- workgroupName
-
The name of the workgroup associated with the VPC endpoint to return.
Type: String
Required: No
Response Syntax
{
"endpoints": [
{
"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"
}
],
"nextToken": "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.
- endpoints
-
The returned VPC endpoints.
Type: Array of EndpointAccess objects
- nextToken
-
When
nextTokenis returned, there are more results available. The value ofnextTokenis a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.Type: String
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.
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:
