software.amazon.awssdk.services.s3control.model

Interface ListAccessPointsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListAccessPointsRequest.Builder,ListAccessPointsRequest>, S3ControlRequest.Builder, SdkBuilder<ListAccessPointsRequest.Builder,ListAccessPointsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListAccessPointsRequest

public static interface ListAccessPointsRequest.Builder
extends S3ControlRequest.Builder, SdkPojo, CopyableBuilder<ListAccessPointsRequest.Builder,ListAccessPointsRequest>

Method Summary

Modifier and Type	Method and Description
ListAccessPointsRequest.Builder	accountId(String accountId) The AWS account ID for owner of the bucket whose access points you want to list.
ListAccessPointsRequest.Builder	bucket(String bucket) The name of the bucket whose associated access points you want to list.
ListAccessPointsRequest.Builder	maxResults(Integer maxResults) The maximum number of access points that you want to include in the list.
ListAccessPointsRequest.Builder	nextToken(String nextToken) A continuation token.
ListAccessPointsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListAccessPointsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.s3control.model.S3ControlRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

accountId

ListAccessPointsRequest.Builder accountId(String accountId)

The AWS account ID for owner of the bucket whose access points you want to list.

Parameters:

accountId - The AWS account ID for owner of the bucket whose access points you want to list.

Returns:

Returns a reference to this object so that method calls can be chained together.

bucket

ListAccessPointsRequest.Builder bucket(String bucket)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

ListAccessPointsRequest.Builder nextToken(String nextToken)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

ListAccessPointsRequest.Builder maxResults(Integer maxResults)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ListAccessPointsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListAccessPointsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder