AWSS3Control (AWS SDK for Java

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.

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

Method Summary

All Methods Instance Methods Abstract Methods
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)` You can use Amazon S3 Batch Operations to perform large-scale Batch Operations on Amazon S3 objects.
`DeleteAccessPointResult`	`deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)` Deletes the specified access point.
`DeleteAccessPointPolicyResult`	`deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest)` Deletes the access point policy for the specified access point.
`DeleteJobTaggingResult`	`deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest)` Removes the entire tag set from the specified Amazon S3 Batch Operations job.
`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.
`GetJobTaggingResult`	`getJobTagging(GetJobTaggingRequest getJobTaggingRequest)` Returns the tags on an Amazon S3 Batch Operations job.
`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 Amazon S3 Batch Operations 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.
`PutJobTaggingResult`	`putJobTagging(PutJobTaggingRequest putJobTaggingRequest)` Set the supplied tag-set on an Amazon S3 Batch Operations job.
`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 Amazon S3 Batch Operations 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)
```
    You can use Amazon S3 Batch Operations to perform large-scale Batch Operations on Amazon S3 objects. Amazon S3 Batch Operations can execute a single operation or action on lists of Amazon S3 objects that you specify. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
    
    Related actions include:
    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
  - deleteJobTagging
```
DeleteJobTaggingResult deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest)
```
    Removes the entire tag set from the specified Amazon S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide.
    
    Related actions include:
    Parameters:
    
    deleteJobTaggingRequest -
    
    Returns:
    
    Result of the DeleteJobTagging operation returned by the service.
    
    Throws:
    
    InternalServiceException
    
    TooManyRequestsException
    
    NotFoundException
    
    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. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
    
    Related actions include:
    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
  - getJobTagging
```
GetJobTaggingResult getJobTagging(GetJobTaggingRequest getJobTaggingRequest)
```
    Returns the tags on an Amazon S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide.
    
    Related actions include:
    Parameters:
    
    getJobTaggingRequest -
    
    Returns:
    
    Result of the GetJobTagging operation returned by the service.
    
    Throws:
    
    InternalServiceException
    
    TooManyRequestsException
    
    NotFoundException
    
    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 1,000 access points (or the number specified in maxResults, whichever is less), 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 Amazon S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
    
    Related actions include:
    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
  - putJobTagging
```
PutJobTaggingResult putJobTagging(PutJobTaggingRequest putJobTaggingRequest)
```
    Set the supplied tag-set on an Amazon S3 Batch Operations job.
    
    A tag is a key-value pair. You can associate Amazon S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this API action to replace the tag set with the one you have modified.. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide.
    - If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you will be charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
    - For deleting existing tags for your batch operations job, DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
    - A few things to consider about using tags:
      
      Amazon S3 limits the maximum number of tags to 50 tags per job.
      
      You can associate up to 50 tags with a job as long as they have unique tag keys.
      
      A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
      
      The key and values are case sensitive.
      
      For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions.
    To use this operation, you must have permission to perform the s3:PutJobTagging action.
    
    Related actions include:
    Parameters:
    
    putJobTaggingRequest -
    
    Returns:
    
    Result of the PutJobTagging operation returned by the service.
    
    Throws:
    
    InternalServiceException
    
    TooManyRequestsException
    
    NotFoundException
    
    TooManyTagsException
    
    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 Amazon S3 Batch Operations job's priority. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
    
    Related actions include:
    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. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
    
    Related actions include:
    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.

Did this page help you?

Interface AWSS3Control

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createAccessPoint

createJob

deleteAccessPoint

deleteAccessPointPolicy

deleteJobTagging

deletePublicAccessBlock

describeJob

getAccessPoint

getAccessPointPolicy

getAccessPointPolicyStatus

getJobTagging

getPublicAccessBlock

listAccessPoints

listJobs

putAccessPointPolicy

putJobTagging

putPublicAccessBlock

updateJobPriority

updateJobStatus

shutdown

getCachedResponseMetadata