Skip to content

List Endpoint Access

redshiftserverless_list_endpoint_access R Documentation

Returns an array of EndpointAccess objects and relevant information

Description

Returns an array of EndpointAccess objects and relevant information.

Usage

redshiftserverless_list_endpoint_access(maxResults, nextToken,
  ownerAccount, vpcId, workgroupName)

Arguments

maxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

nextToken

If your initial list_endpoint_access operation returns a nextToken, you can include the returned nextToken in following list_endpoint_access operations, which returns results in the next page.

ownerAccount

The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.

vpcId

The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.

workgroupName

The name of the workgroup associated with the VPC endpoint to return.

Value

A list with the following syntax:

list(
  endpoints = list(
    list(
      address = "string",
      endpointArn = "string",
      endpointCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      endpointName = "string",
      endpointStatus = "string",
      port = 123,
      subnetIds = list(
        "string"
      ),
      vpcEndpoint = list(
        networkInterfaces = list(
          list(
            availabilityZone = "string",
            ipv6Address = "string",
            networkInterfaceId = "string",
            privateIpAddress = "string",
            subnetId = "string"
          )
        ),
        vpcEndpointId = "string",
        vpcId = "string"
      ),
      vpcSecurityGroups = list(
        list(
          status = "string",
          vpcSecurityGroupId = "string"
        )
      ),
      workgroupName = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_endpoint_access(
  maxResults = 123,
  nextToken = "string",
  ownerAccount = "string",
  vpcId = "string",
  workgroupName = "string"
)