<a id="cli-aws-s3control-list-access-points"></a>

# list-access-points

## Description

#### NOTE
This operation is not supported by directory buckets.

Returns a list of the access points. You can retrieve up to 1,000 access points per call. If the call returns more than 1,000 access points (or the number specified in `maxResults` , whichever is less), the response will include a continuation token that you can use to list the additional access points.

Returns only access points attached to S3 buckets by default. To return all access points specify `DataSourceType` as `ALL` .

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of `x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control` . For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) section.

The following actions are related to `ListAccessPoints` :

* [CreateAccessPoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html)
* [DeleteAccessPoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html)
* [GetAccessPoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html)

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListAccessPoints)

## Synopsis

```
  list-access-points
--account-id <value>
[--bucket <value>]
[--next-token <value>]
[--max-results <value>]
[--data-source-id <value>]
[--data-source-type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--account-id` (string) [required]

> The Amazon Web Services account ID for the account that owns the specified access points.

> Constraints:

> * max: `64`
> * pattern: `^\d{12}$`

`--bucket` (string)

> The name of the bucket whose associated access points you want to list.

> For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

> For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format `arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>` . For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2` , use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports` . The value must be URL encoded.

> Constraints:

> * min: `3`
> * max: `255`

`--next-token` (string)

> A continuation token. If a previous call to `ListAccessPoints` returned a continuation token in the `NextToken` field, then providing that value here causes Amazon S3 to retrieve the next page of results.

> Constraints:

> * min: `1`
> * max: `1024`

`--max-results` (integer)

> The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the `NextToken` field that you can use to retrieve the next page of access points.

> Constraints:

> * min: `0`
> * max: `1000`

`--data-source-id` (string)

> The unique identifier for the data source of the access point.

> Constraints:

> * max: `191`

`--data-source-type` (string)

> The type of the data source that the access point is attached to. Returns only access points attached to S3 buckets by default. To return all access points specify `DataSourceType` as `ALL` .

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

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

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**Example 1: To retrieve a list of all access points for an account**

The following `list-access-points` example displays a list of all access points attached to buckets owned by account 123456789012.

```bash
aws s3control list-access-points \
    --account-id 123456789012
```

Output:

```json
{
    "AccessPointList": [
        {
            "Name": "finance-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "amzn-s3-demo-bucket1"
        },
        {
            "Name": "managers-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "amzn-s3-demo-bucket1"
        },
        {
            "Name": "private-network-ap",
            "NetworkOrigin": "VPC",
            "VpcConfiguration": {
                "VpcId": "1a2b3c"
            },
            "Bucket": "amzn-s3-demo-bucket1"
        },
        {
            "Name": "customer-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "amzn-s3-demo-bucket2"
        },
        {
            "Name": "public-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "amzn-s3-demo-bucket2"
        }
    ]
}
```

**Example 2: To retrieve a list of all access points for a bucket**

The following `list-access-points` example retrieves a list of all access points attached to the bucket `amzn-s3-demo-bucket2` owned by account 123456789012.

```bash
aws s3control list-access-points \
    --account-id 123456789012 \
    --bucket amzn-s3-demo-bucket2
```

Output:

```json
{
    "AccessPointList": [
        {
            "Name": "customer-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "amzn-s3-demo-bucket2"
        },
        {
            "Name": "public-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "amzn-s3-demo-bucket2"
        }
    ]
}
```

For more information, see [Managing Data Access with Amazon S3 Access Points](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html) in the *Amazon Simple Storage Service Developer Guide*.

## Output

AccessPointList -> (list)

> Contains identification and configuration information for one or more access points associated with the specified bucket.

> (structure)

> > An access point used to access a bucket.

> > Name -> (string) [required]

> > > The name of this access point.

> > > Constraints:

> > > * min: `3`
> > > * max: `255`

> > NetworkOrigin -> (string) [required]

> > > Indicates whether this access point allows access from the public internet. If `VpcConfiguration` is specified for this access point, then `NetworkOrigin` is `VPC` , and the access point doesn’t allow access from the public internet. Otherwise, `NetworkOrigin` is `Internet` , and the access point allows access from the public internet, subject to the access point and bucket access policies.

> > > Possible values:

> > > * `Internet`
> > > * `VPC`

> > VpcConfiguration -> (structure)

> > > The virtual private cloud (VPC) configuration for this access point, if one exists.

> > > #### NOTE
> > > This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other Amazon Web Services services.

> > > VpcId -> (string) [required]

> > > > If this field is specified, this access point will only allow connections from the specified VPC ID.

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `1024`

> > Bucket -> (string) [required]

> > > The name of the bucket associated with this access point.

> > > Constraints:

> > > * max: `255`

> > AccessPointArn -> (string)

> > > The ARN for the access point.

> > > Constraints:

> > > * min: `4`
> > > * max: `128`

> > Alias -> (string)

> > > The name or alias of the access point.

> > > Constraints:

> > > * max: `63`
> > > * pattern: `^[0-9a-z\\-]{63}`

> > BucketAccountId -> (string)

> > > The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

> > > Constraints:

> > > * max: `64`
> > > * pattern: `^\d{12}$`

> > DataSourceId -> (string)

> > > A unique identifier for the data source of the access point.

> > > Constraints:

> > > * max: `191`

> > DataSourceType -> (string)

> > > The type of the data source that the access point is attached to.

NextToken -> (string)

> If the specified bucket has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

> Constraints:

> * min: `1`
> * max: `1024`