[ aws . redshift-serverless ]

list-endpoint-access

Description

Returns an array of EndpointAccess objects and relevant information.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-endpoint-access is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: endpoints

Synopsis

  list-endpoint-access
[--vpc-id <value>]
[--workgroup-name <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--vpc-id (string)

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

--workgroup-name (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

endpoints -> (list)

The returned VPC endpoints.

(structure)

Information about an Amazon Redshift Serverless VPC endpoint.

address -> (string)

The DNS address of the endpoint.

endpointArn -> (string)

The Amazon Resource Name (ARN) of the VPC endpoint.

endpointCreateTime -> (timestamp)

The time that the endpoint was created.

endpointName -> (string)

The name of the VPC endpoint.

endpointStatus -> (string)

The status of the VPC endpoint.

port -> (integer)

The port number on which Amazon Redshift Serverless accepts incoming connections.

subnetIds -> (list)

The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.

(string)

vpcEndpoint -> (structure)

The connection endpoint for connecting to Amazon Redshift Serverless.

networkInterfaces -> (list)

One or more network interfaces of the endpoint. Also known as an interface endpoint.

(structure)

Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

availabilityZone -> (string)

The availability Zone.

networkInterfaceId -> (string)

The unique identifier of the network interface.

privateIpAddress -> (string)

The IPv4 address of the network interface within the subnet.

subnetId -> (string)

The unique identifier of the subnet.

vpcEndpointId -> (string)

The connection endpoint ID for connecting to Amazon Redshift Serverless.

vpcId -> (string)

The VPC identifier that the endpoint is associated with.

vpcSecurityGroups -> (list)

The security groups associated with the endpoint.

(structure)

Describes the members of a VPC security group.

status -> (string)

The status of the VPC security group.

vpcSecurityGroupId -> (string)

The unique identifier of the VPC security group.

workgroupName -> (string)

The name of the workgroup associated with the endpoint.

nextToken -> (string)

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.