AWSS3ControlClient (AWS SDK for Java

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

All Methods Static Methods Instance Methods Concrete Methods
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)` You can use Amazon S3 Batch Operations to perform large-scale Batch Operations on Amazon S3 objects.
`DeleteAccessPointResult`	`deleteAccessPoint(DeleteAccessPointRequest request)` Deletes the specified access point.
`DeleteAccessPointPolicyResult`	`deleteAccessPointPolicy(DeleteAccessPointPolicyRequest request)` Deletes the access point policy for the specified access point.
`DeleteJobTaggingResult`	`deleteJobTagging(DeleteJobTaggingRequest request)` Removes the entire tag set from the specified Amazon S3 Batch Operations job.
`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.
`GetJobTaggingResult`	`getJobTagging(GetJobTaggingRequest request)` Returns the tags on an Amazon S3 Batch Operations job.
`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 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 request)` Associates an access policy with the specified access point.
`PutJobTaggingResult`	`putJobTagging(PutJobTaggingRequest request)` Set the supplied tag-set on an Amazon S3 Batch Operations job.
`PutPublicAccessBlockResult`	`putPublicAccessBlock(PutPublicAccessBlockRequest request)` Creates or modifies the `PublicAccessBlock` configuration for an Amazon Web Services account.
`UpdateJobPriorityResult`	`updateJobPriority(UpdateJobPriorityRequest request)` Updates an existing Amazon S3 Batch Operations job's priority.
`UpdateJobStatusResult`	`updateJobStatus(UpdateJobStatusRequest request)` Updates the status for the specified job.

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)
```
    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:
    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
  - deleteJobTagging
```
public DeleteJobTaggingResult deleteJobTagging(DeleteJobTaggingRequest request)
```
    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:
    Specified by:
    
    deleteJobTagging in interface AWSS3Control
    
    Parameters:
    
    deleteJobTaggingRequest -
    
    Returns:
    
    Result of the DeleteJobTagging operation returned by the service.
    
    Throws:
    
    InternalServiceException
    
    TooManyRequestsException
    
    NotFoundException
    
    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. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
    
    Related actions include:
    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
  - getJobTagging
```
public GetJobTaggingResult getJobTagging(GetJobTaggingRequest request)
```
    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:
    Specified by:
    
    getJobTagging in interface AWSS3Control
    
    Parameters:
    
    getJobTaggingRequest -
    
    Returns:
    
    Result of the GetJobTagging operation returned by the service.
    
    Throws:
    
    InternalServiceException
    
    TooManyRequestsException
    
    NotFoundException
    
    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 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.
    
    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 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:
    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
  - putJobTagging
```
public PutJobTaggingResult putJobTagging(PutJobTaggingRequest request)
```
    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:
    Specified by:
    
    putJobTagging in interface AWSS3Control
    
    Parameters:
    
    putJobTaggingRequest -
    
    Returns:
    
    Result of the PutJobTagging operation returned by the service.
    
    Throws:
    
    InternalServiceException
    
    TooManyRequestsException
    
    NotFoundException
    
    TooManyTagsException
    
    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 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:
    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. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
    
    Related actions include:
    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.

Did this page help you?

Class AWSS3ControlClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

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

Method Detail

builder

createAccessPoint

createJob

deleteAccessPoint

deleteAccessPointPolicy

deleteJobTagging

deletePublicAccessBlock

describeJob

getAccessPoint

getAccessPointPolicy

getAccessPointPolicyStatus

getJobTagging

getPublicAccessBlock

listAccessPoints

listJobs

putAccessPointPolicy

putJobTagging

putPublicAccessBlock

updateJobPriority

updateJobStatus

getCachedResponseMetadata