com.amazonaws.services.s3control

Class AWSS3ControlClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.s3control.AWSS3ControlClient

All Implemented Interfaces:

AWSS3Control

Direct Known Subclasses:

AWSS3ControlAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSS3ControlClient
extends AmazonWebServiceClient
implements AWSS3Control

Client for accessing AWS S3 Control. All service calls made using this client are blocking, and will not return until the service call completes.

AWS S3 Control provides access to Amazon S3 control plane operations.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.s3control.AWSS3Control

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSS3ControlClientBuilder	builder()
CreateAccessPointResult	createAccessPoint(CreateAccessPointRequest request) Creates an access point and associates it with the specified bucket.
CreateJobResult	createJob(CreateJobRequest request) Creates an Amazon S3 batch operations job.
DeleteAccessPointResult	deleteAccessPoint(DeleteAccessPointRequest request) Deletes the specified access point.
DeleteAccessPointPolicyResult	deleteAccessPointPolicy(DeleteAccessPointPolicyRequest request) Deletes the access point policy for the specified access point.
DeletePublicAccessBlockResult	deletePublicAccessBlock(DeletePublicAccessBlockRequest request) Removes the PublicAccessBlock configuration for an Amazon Web Services account.
DescribeJobResult	describeJob(DescribeJobRequest request) Retrieves the configuration parameters and status for a batch operations job.
GetAccessPointResult	getAccessPoint(GetAccessPointRequest request) Returns configuration information about the specified access point.
GetAccessPointPolicyResult	getAccessPointPolicy(GetAccessPointPolicyRequest request) Returns the access point policy associated with the specified access point.
GetAccessPointPolicyStatusResult	getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest request) Indicates whether the specified access point currently has a policy that allows public access.
S3ControlResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetPublicAccessBlockResult	getPublicAccessBlock(GetPublicAccessBlockRequest request) Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
ListAccessPointsResult	listAccessPoints(ListAccessPointsRequest request) Returns a list of the access points currently associated with the specified bucket.
ListJobsResult	listJobs(ListJobsRequest request) Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
PutAccessPointPolicyResult	putAccessPointPolicy(PutAccessPointPolicyRequest request) Associates an access policy with the specified access point.
PutPublicAccessBlockResult	putPublicAccessBlock(PutPublicAccessBlockRequest request) Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
UpdateJobPriorityResult	updateJobPriority(UpdateJobPriorityRequest request) Updates an existing job's priority.
UpdateJobStatusResult	updateJobStatus(UpdateJobStatusRequest request) Updates the status for the specified job.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.s3control.AWSS3Control

shutdown

Method Detail

builder

public static AWSS3ControlClientBuilder builder()

createAccessPoint

public CreateAccessPointResult createAccessPoint(CreateAccessPointRequest request)

Creates an access point and associates it with the specified bucket.

Specified by:

createAccessPoint in interface AWSS3Control

Parameters:

createAccessPointRequest -

Returns:

Result of the CreateAccessPoint operation returned by the service.

See Also:

AWS API Documentation

createJob

public CreateJobResult createJob(CreateJobRequest request)

Creates an Amazon S3 batch operations job.

Specified by:

createJob in interface AWSS3Control

Parameters:

createJobRequest -

Returns:

Result of the CreateJob operation returned by the service.

Throws:

TooManyRequestsException

BadRequestException

IdempotencyException

InternalServiceException

See Also:

AWS API Documentation

deleteAccessPoint

public DeleteAccessPointResult deleteAccessPoint(DeleteAccessPointRequest request)

Deletes the specified access point.

Specified by:

deleteAccessPoint in interface AWSS3Control

Parameters:

deleteAccessPointRequest -

Returns:

Result of the DeleteAccessPoint operation returned by the service.

See Also:

AWS API Documentation

deleteAccessPointPolicy

public DeleteAccessPointPolicyResult deleteAccessPointPolicy(DeleteAccessPointPolicyRequest request)

Deletes the access point policy for the specified access point.

Specified by:

deleteAccessPointPolicy in interface AWSS3Control

Parameters:

deleteAccessPointPolicyRequest -

Returns:

Result of the DeleteAccessPointPolicy operation returned by the service.

See Also:

AWS API Documentation

deletePublicAccessBlock

public DeletePublicAccessBlockResult deletePublicAccessBlock(DeletePublicAccessBlockRequest request)

Removes the PublicAccessBlock configuration for an Amazon Web Services account.

Specified by:

deletePublicAccessBlock in interface AWSS3Control

Parameters:

deletePublicAccessBlockRequest -

Returns:

Result of the DeletePublicAccessBlock operation returned by the service.

See Also:

AWS API Documentation

describeJob

public DescribeJobResult describeJob(DescribeJobRequest request)

Retrieves the configuration parameters and status for a batch operations job.

Specified by:

describeJob in interface AWSS3Control

Parameters:

describeJobRequest -

Returns:

Result of the DescribeJob operation returned by the service.

Throws:

BadRequestException

TooManyRequestsException

NotFoundException

InternalServiceException

See Also:

AWS API Documentation

getAccessPoint

public GetAccessPointResult getAccessPoint(GetAccessPointRequest request)

Returns configuration information about the specified access point.

Specified by:

getAccessPoint in interface AWSS3Control

Parameters:

getAccessPointRequest -

Returns:

Result of the GetAccessPoint operation returned by the service.

See Also:

AWS API Documentation

getAccessPointPolicy

public GetAccessPointPolicyResult getAccessPointPolicy(GetAccessPointPolicyRequest request)

Returns the access point policy associated with the specified access point.

Specified by:

getAccessPointPolicy in interface AWSS3Control

Parameters:

getAccessPointPolicyRequest -

Returns:

Result of the GetAccessPointPolicy operation returned by the service.

See Also:

AWS API Documentation

getAccessPointPolicyStatus

public GetAccessPointPolicyStatusResult getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest request)

Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Specified by:

getAccessPointPolicyStatus in interface AWSS3Control

Parameters:

getAccessPointPolicyStatusRequest -

Returns:

Result of the GetAccessPointPolicyStatus operation returned by the service.

See Also:

AWS API Documentation

getPublicAccessBlock

public GetPublicAccessBlockResult getPublicAccessBlock(GetPublicAccessBlockRequest request)

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.

Specified by:

getPublicAccessBlock in interface AWSS3Control

Parameters:

getPublicAccessBlockRequest -

Returns:

Result of the GetPublicAccessBlock operation returned by the service.

Throws:

NoSuchPublicAccessBlockConfigurationException - Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an account that doesn't have a PublicAccessBlockConfiguration set.

See Also:

AWS API Documentation

listAccessPoints

public ListAccessPointsResult listAccessPoints(ListAccessPointsRequest request)

Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1000 access points (or the number specified in maxResults, whichever is less), then the response will include a continuation token that you can use to list the additional access points.

Specified by:

listAccessPoints in interface AWSS3Control

Parameters:

listAccessPointsRequest -

Returns:

Result of the ListAccessPoints operation returned by the service.

See Also:

AWS API Documentation

listJobs

public ListJobsResult listJobs(ListJobsRequest request)

Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.

Specified by:

listJobs in interface AWSS3Control

Parameters:

listJobsRequest -

Returns:

Result of the ListJobs operation returned by the service.

Throws:

InvalidRequestException

InternalServiceException

InvalidNextTokenException

See Also:

AWS API Documentation

putAccessPointPolicy

public PutAccessPointPolicyResult putAccessPointPolicy(PutAccessPointPolicyRequest request)

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

Specified by:

putAccessPointPolicy in interface AWSS3Control

Parameters:

putAccessPointPolicyRequest -

Returns:

Result of the PutAccessPointPolicy operation returned by the service.

See Also:

AWS API Documentation

putPublicAccessBlock

public PutPublicAccessBlockResult putPublicAccessBlock(PutPublicAccessBlockRequest request)

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.

Specified by:

putPublicAccessBlock in interface AWSS3Control

Parameters:

putPublicAccessBlockRequest -

Returns:

Result of the PutPublicAccessBlock operation returned by the service.

See Also:

AWS API Documentation

updateJobPriority

public UpdateJobPriorityResult updateJobPriority(UpdateJobPriorityRequest request)

Updates an existing job's priority.

Specified by:

updateJobPriority in interface AWSS3Control

Parameters:

updateJobPriorityRequest -

Returns:

Result of the UpdateJobPriority operation returned by the service.

Throws:

BadRequestException

TooManyRequestsException

NotFoundException

InternalServiceException

See Also:

AWS API Documentation

updateJobStatus

public UpdateJobStatusResult updateJobStatus(UpdateJobStatusRequest request)

Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job.

Specified by:

updateJobStatus in interface AWSS3Control

Parameters:

updateJobStatusRequest -

Returns:

Result of the UpdateJobStatus operation returned by the service.

Throws:

BadRequestException

TooManyRequestsException

NotFoundException

JobStatusException

InternalServiceException

See Also:

AWS API Documentation

getCachedResponseMetadata

public S3ControlResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSS3Control

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.