[ aws . s3outposts ]

list-endpoints

Description

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points .

This action lists endpoints associated with the Outposts.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-endpoints 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-endpoints
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

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

See ‘aws help’ for descriptions of global parameters.

Output

Endpoints -> (list)

Returns an array of endpoints associated with AWS Outposts.

(structure)

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points .

EndpointArn -> (string)

The Amazon Resource Name (ARN) of the endpoint.

OutpostsId -> (string)

The ID of the AWS Outposts.

CidrBlock -> (string)

The VPC CIDR committed by this endpoint.

Status -> (string)

The status of the endpoint.

CreationTime -> (timestamp)

The time the endpoint was created.

NetworkInterfaces -> (list)

The network interface of the endpoint.

(structure)

The container for the network interface.

NetworkInterfaceId -> (string)

The ID for the network interface.

VpcId -> (string)

The ID of the VPC used for the endpoint.

SubnetId -> (string)

The ID of the subnet used for the endpoint.

SecurityGroupId -> (string)

The ID of the security group used for the endpoint.

AccessType -> (string)

CustomerOwnedIpv4Pool -> (string)

The ID of the customer-owned IPv4 pool used for the endpoint.

NextToken -> (string)

The next endpoint returned in the list.