software.amazon.awssdk.services.s3control.model

Class ListAccessPointsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.s3control.model.S3ControlRequest

software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAccessPointsRequest.Builder,ListAccessPointsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListAccessPointsRequest
extends S3ControlRequest
implements ToCopyableBuilder<ListAccessPointsRequest.Builder,ListAccessPointsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListAccessPointsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The Amazon Web Services account ID for owner of the bucket whose access points you want to list.
String	bucket() The name of the bucket whose associated access points you want to list.
static ListAccessPointsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of access points that you want to include in the list.
String	nextToken() A continuation token.
List<SdkField<?>>	sdkFields()
static Class<? extends ListAccessPointsRequest.Builder>	serializableBuilderClass()
ListAccessPointsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

accountId

public final String accountId()

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

Returns:

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

bucket

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

Returns:

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.

nextToken

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

Returns:

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.

maxResults

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

Returns:

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.

toBuilder

public ListAccessPointsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAccessPointsRequest.Builder,ListAccessPointsRequest>

Specified by:

toBuilder in class S3ControlRequest

builder

public static ListAccessPointsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListAccessPointsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo