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
CreateJobResult	createJob(CreateJobRequest createJobRequest) Creates an Amazon S3 batch operations job.
DeletePublicAccessBlockResult	deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest) Deletes the block public access configuration for the specified account.
DescribeJobResult	describeJob(DescribeJobRequest describeJobRequest) Retrieves the configuration parameters and status for a batch operations job.
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)
ListJobsResult	listJobs(ListJobsRequest listJobsRequest) Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
PutPublicAccessBlockResult	putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)
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

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

deletePublicAccessBlock

DeletePublicAccessBlockResult deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)

Deletes the block public access configuration for the specified 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

getPublicAccessBlock

GetPublicAccessBlockResult getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)

Parameters:

getPublicAccessBlockRequest -

Returns:

Result of the GetPublicAccessBlock operation returned by the service.

Throws:

NoSuchPublicAccessBlockConfigurationException

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

putPublicAccessBlock

PutPublicAccessBlockResult putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)

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.