com.amazonaws.services.s3control

Interface AWSS3Control

All Known Subinterfaces:

AWSS3ControlAsync

All Known Implementing Classes:

AbstractAWSS3Control, AbstractAWSS3ControlAsync, AWSS3ControlAsyncClient, AWSS3ControlClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSS3Control

Interface for accessing AWS S3 Control.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSS3Control instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateAccessPointResult	createAccessPoint(CreateAccessPointRequest createAccessPointRequest) Creates an access point and associates it with the specified bucket.
CreateJobResult	createJob(CreateJobRequest createJobRequest) Creates an Amazon S3 batch operations job.
DeleteAccessPointResult	deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest) Deletes the specified access point.
DeleteAccessPointPolicyResult	deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest) Deletes the access point policy for the specified access point.
DeletePublicAccessBlockResult	deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest) Removes the PublicAccessBlock configuration for an Amazon Web Services account.
DescribeJobResult	describeJob(DescribeJobRequest describeJobRequest) Retrieves the configuration parameters and status for a batch operations job.
GetAccessPointResult	getAccessPoint(GetAccessPointRequest getAccessPointRequest) Returns configuration information about the specified access point.
GetAccessPointPolicyResult	getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest) Returns the access point policy associated with the specified access point.
GetAccessPointPolicyStatusResult	getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest) 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 getPublicAccessBlockRequest) Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
ListAccessPointsResult	listAccessPoints(ListAccessPointsRequest listAccessPointsRequest) Returns a list of the access points currently associated with the specified bucket.
ListJobsResult	listJobs(ListJobsRequest listJobsRequest) Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
PutAccessPointPolicyResult	putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest) Associates an access policy with the specified access point.
PutPublicAccessBlockResult	putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest) Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateJobPriorityResult	updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest) Updates an existing job's priority.
UpdateJobStatusResult	updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest) Updates the status for the specified job.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createAccessPoint

CreateAccessPointResult createAccessPoint(CreateAccessPointRequest createAccessPointRequest)

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

Parameters:

createAccessPointRequest -

Returns:

Result of the CreateAccessPoint operation returned by the service.

See Also:

AWS API Documentation

createJob

CreateJobResult createJob(CreateJobRequest createJobRequest)

Creates an Amazon S3 batch operations job.

Parameters:

createJobRequest -

Returns:

Result of the CreateJob operation returned by the service.

Throws:

TooManyRequestsException

BadRequestException

IdempotencyException

InternalServiceException

See Also:

AWS API Documentation

deleteAccessPoint

DeleteAccessPointResult deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)

Deletes the specified access point.

Parameters:

deleteAccessPointRequest -

Returns:

Result of the DeleteAccessPoint operation returned by the service.

See Also:

AWS API Documentation

deleteAccessPointPolicy

DeleteAccessPointPolicyResult deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest)

Deletes the access point policy for the specified access point.

Parameters:

deleteAccessPointPolicyRequest -

Returns:

Result of the DeleteAccessPointPolicy operation returned by the service.

See Also:

AWS API Documentation

deletePublicAccessBlock

DeletePublicAccessBlockResult deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)

Removes the PublicAccessBlock configuration for an Amazon Web Services account.

Parameters:

deletePublicAccessBlockRequest -

Returns:

Result of the DeletePublicAccessBlock operation returned by the service.

See Also:

AWS API Documentation

describeJob

DescribeJobResult describeJob(DescribeJobRequest describeJobRequest)

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

Parameters:

describeJobRequest -

Returns:

Result of the DescribeJob operation returned by the service.

Throws:

BadRequestException

TooManyRequestsException

NotFoundException

InternalServiceException

See Also:

AWS API Documentation

getAccessPoint

GetAccessPointResult getAccessPoint(GetAccessPointRequest getAccessPointRequest)

Returns configuration information about the specified access point.

Parameters:

getAccessPointRequest -

Returns:

Result of the GetAccessPoint operation returned by the service.

See Also:

AWS API Documentation

getAccessPointPolicy

GetAccessPointPolicyResult getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest)

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

Parameters:

getAccessPointPolicyRequest -

Returns:

Result of the GetAccessPointPolicy operation returned by the service.

See Also:

AWS API Documentation

getAccessPointPolicyStatus

GetAccessPointPolicyStatusResult getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest)

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.

Parameters:

getAccessPointPolicyStatusRequest -

Returns:

Result of the GetAccessPointPolicyStatus operation returned by the service.

See Also:

AWS API Documentation

getPublicAccessBlock

GetPublicAccessBlockResult getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.

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

ListAccessPointsResult listAccessPoints(ListAccessPointsRequest listAccessPointsRequest)

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.

Parameters:

listAccessPointsRequest -

Returns:

Result of the ListAccessPoints operation returned by the service.

See Also:

AWS API Documentation

listJobs

ListJobsResult listJobs(ListJobsRequest listJobsRequest)

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

Parameters:

listJobsRequest -

Returns:

Result of the ListJobs operation returned by the service.

Throws:

InvalidRequestException

InternalServiceException

InvalidNextTokenException

See Also:

AWS API Documentation

putAccessPointPolicy

PutAccessPointPolicyResult putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest)

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.

Parameters:

putAccessPointPolicyRequest -

Returns:

Result of the PutAccessPointPolicy operation returned by the service.

See Also:

AWS API Documentation

putPublicAccessBlock

PutPublicAccessBlockResult putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)

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

Parameters:

putPublicAccessBlockRequest -

Returns:

Result of the PutPublicAccessBlock operation returned by the service.

See Also:

AWS API Documentation

updateJobPriority

UpdateJobPriorityResult updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest)

Updates an existing job's priority.

Parameters:

updateJobPriorityRequest -

Returns:

Result of the UpdateJobPriority operation returned by the service.

Throws:

BadRequestException

TooManyRequestsException

NotFoundException

InternalServiceException

See Also:

AWS API Documentation

updateJobStatus

UpdateJobStatusResult updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest)

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.

Parameters:

updateJobStatusRequest -

Returns:

Result of the UpdateJobStatus operation returned by the service.

Throws:

BadRequestException

TooManyRequestsException

NotFoundException

JobStatusException

InternalServiceException

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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