software.amazon.awssdk.services.s3control

Interface S3ControlClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface S3ControlClient
extends SdkClient

Service client for accessing AWS S3 Control. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static S3ControlClientBuilder	builder() Create a builder that can be used to configure and create a S3ControlClient.
static S3ControlClient	create() Create a S3ControlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAccessPointResponse	createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest) Creates an access point and associates it with the specified bucket.
default CreateAccessPointResponse	createAccessPoint(CreateAccessPointRequest createAccessPointRequest) Creates an access point and associates it with the specified bucket.
default CreateJobResponse	createJob(Consumer<CreateJobRequest.Builder> createJobRequest) Creates an Amazon S3 batch operations job.
default CreateJobResponse	createJob(CreateJobRequest createJobRequest) Creates an Amazon S3 batch operations job.
default DeleteAccessPointResponse	deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest) Deletes the specified access point.
default DeleteAccessPointResponse	deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest) Deletes the specified access point.
default DeleteAccessPointPolicyResponse	deleteAccessPointPolicy(Consumer<DeleteAccessPointPolicyRequest.Builder> deleteAccessPointPolicyRequest) Deletes the access point policy for the specified access point.
default DeleteAccessPointPolicyResponse	deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest) Deletes the access point policy for the specified access point.
default DeleteJobTaggingResponse	deleteJobTagging(Consumer<DeleteJobTaggingRequest.Builder> deleteJobTaggingRequest) Delete the tags on a Amazon S3 batch operations job, if any.
default DeleteJobTaggingResponse	deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest) Delete the tags on a Amazon S3 batch operations job, if any.
default DeletePublicAccessBlockResponse	deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest) Removes the PublicAccessBlock configuration for an Amazon Web Services account.
default DeletePublicAccessBlockResponse	deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest) Removes the PublicAccessBlock configuration for an Amazon Web Services account.
default DescribeJobResponse	describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest) Retrieves the configuration parameters and status for a batch operations job.
default DescribeJobResponse	describeJob(DescribeJobRequest describeJobRequest) Retrieves the configuration parameters and status for a batch operations job.
default GetAccessPointResponse	getAccessPoint(Consumer<GetAccessPointRequest.Builder> getAccessPointRequest) Returns configuration information about the specified access point.
default GetAccessPointResponse	getAccessPoint(GetAccessPointRequest getAccessPointRequest) Returns configuration information about the specified access point.
default GetAccessPointPolicyResponse	getAccessPointPolicy(Consumer<GetAccessPointPolicyRequest.Builder> getAccessPointPolicyRequest) Returns the access point policy associated with the specified access point.
default GetAccessPointPolicyResponse	getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest) Returns the access point policy associated with the specified access point.
default GetAccessPointPolicyStatusResponse	getAccessPointPolicyStatus(Consumer<GetAccessPointPolicyStatusRequest.Builder> getAccessPointPolicyStatusRequest) Indicates whether the specified access point currently has a policy that allows public access.
default GetAccessPointPolicyStatusResponse	getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest) Indicates whether the specified access point currently has a policy that allows public access.
default GetJobTaggingResponse	getJobTagging(Consumer<GetJobTaggingRequest.Builder> getJobTaggingRequest) Retrieve the tags on a Amazon S3 batch operations job.
default GetJobTaggingResponse	getJobTagging(GetJobTaggingRequest getJobTaggingRequest) Retrieve the tags on a Amazon S3 batch operations job.
default GetPublicAccessBlockResponse	getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest) Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
default GetPublicAccessBlockResponse	getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest) Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
default ListAccessPointsResponse	listAccessPoints(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest) Returns a list of the access points currently associated with the specified bucket.
default ListAccessPointsResponse	listAccessPoints(ListAccessPointsRequest listAccessPointsRequest) Returns a list of the access points currently associated with the specified bucket.
default ListAccessPointsIterable	listAccessPointsPaginator(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest) Returns a list of the access points currently associated with the specified bucket.
default ListAccessPointsIterable	listAccessPointsPaginator(ListAccessPointsRequest listAccessPointsRequest) Returns a list of the access points currently associated with the specified bucket.
default ListJobsResponse	listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
default ListJobsResponse	listJobs(ListJobsRequest listJobsRequest) Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
default ListJobsIterable	listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest) Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
default ListJobsIterable	listJobsPaginator(ListJobsRequest listJobsRequest) Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
default PutAccessPointPolicyResponse	putAccessPointPolicy(Consumer<PutAccessPointPolicyRequest.Builder> putAccessPointPolicyRequest) Associates an access policy with the specified access point.
default PutAccessPointPolicyResponse	putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest) Associates an access policy with the specified access point.
default PutJobTaggingResponse	putJobTagging(Consumer<PutJobTaggingRequest.Builder> putJobTaggingRequest) Replace the set of tags on a Amazon S3 batch operations job.
default PutJobTaggingResponse	putJobTagging(PutJobTaggingRequest putJobTaggingRequest) Replace the set of tags on a Amazon S3 batch operations job.
default PutPublicAccessBlockResponse	putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest) Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
default PutPublicAccessBlockResponse	putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest) Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
static ServiceMetadata	serviceMetadata()
default UpdateJobPriorityResponse	updateJobPriority(Consumer<UpdateJobPriorityRequest.Builder> updateJobPriorityRequest) Updates an existing job's priority.
default UpdateJobPriorityResponse	updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest) Updates an existing job's priority.
default UpdateJobStatusResponse	updateJobStatus(Consumer<UpdateJobStatusRequest.Builder> updateJobStatusRequest) Updates the status for the specified job.
default UpdateJobStatusResponse	updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest) Updates the status for the specified job.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static S3ControlClient create()

Create a S3ControlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static S3ControlClientBuilder builder()

Create a builder that can be used to configure and create a S3ControlClient.

createAccessPoint

default CreateAccessPointResponse createAccessPoint(CreateAccessPointRequest createAccessPointRequest)
                                             throws AwsServiceException,
                                                    SdkClientException,
                                                    S3ControlException

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

Parameters:

createAccessPointRequest -

Returns:

Result of the CreateAccessPoint operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createAccessPoint

default CreateAccessPointResponse createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)
                                             throws AwsServiceException,
                                                    SdkClientException,
                                                    S3ControlException

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

This is a convenience which creates an instance of the CreateAccessPointRequest.Builder avoiding the need to create one manually via CreateAccessPointRequest.builder()

Parameters:

createAccessPointRequest - A Consumer that will call methods on CreateAccessPointRequest.Builder to create a request.

Returns:

Result of the CreateAccessPoint operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createJob

default CreateJobResponse createJob(CreateJobRequest createJobRequest)
                             throws TooManyRequestsException,
                                    BadRequestException,
                                    IdempotencyException,
                                    InternalServiceException,
                                    AwsServiceException,
                                    SdkClientException,
                                    S3ControlException

Creates an Amazon S3 batch operations job.

Parameters:

createJobRequest -

Returns:

Result of the CreateJob operation returned by the service.

Throws:

TooManyRequestsException

BadRequestException

IdempotencyException

InternalServiceException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createJob

default CreateJobResponse createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
                             throws TooManyRequestsException,
                                    BadRequestException,
                                    IdempotencyException,
                                    InternalServiceException,
                                    AwsServiceException,
                                    SdkClientException,
                                    S3ControlException

Creates an Amazon S3 batch operations job.

This is a convenience which creates an instance of the CreateJobRequest.Builder avoiding the need to create one manually via CreateJobRequest.builder()

Parameters:

createJobRequest - A Consumer that will call methods on CreateJobRequest.Builder to create a request.

Returns:

Result of the CreateJob operation returned by the service.

Throws:

TooManyRequestsException

BadRequestException

IdempotencyException

InternalServiceException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteAccessPoint

default DeleteAccessPointResponse deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)
                                             throws AwsServiceException,
                                                    SdkClientException,
                                                    S3ControlException

Deletes the specified access point.

Parameters:

deleteAccessPointRequest -

Returns:

Result of the DeleteAccessPoint operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteAccessPoint

default DeleteAccessPointResponse deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)
                                             throws AwsServiceException,
                                                    SdkClientException,
                                                    S3ControlException

Deletes the specified access point.

This is a convenience which creates an instance of the DeleteAccessPointRequest.Builder avoiding the need to create one manually via DeleteAccessPointRequest.builder()

Parameters:

deleteAccessPointRequest - A Consumer that will call methods on DeleteAccessPointRequest.Builder to create a request.

Returns:

Result of the DeleteAccessPoint operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteAccessPointPolicy

default DeleteAccessPointPolicyResponse deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest)
                                                         throws AwsServiceException,
                                                                SdkClientException,
                                                                S3ControlException

Deletes the access point policy for the specified access point.

Parameters:

deleteAccessPointPolicyRequest -

Returns:

Result of the DeleteAccessPointPolicy operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteAccessPointPolicy

default DeleteAccessPointPolicyResponse deleteAccessPointPolicy(Consumer<DeleteAccessPointPolicyRequest.Builder> deleteAccessPointPolicyRequest)
                                                         throws AwsServiceException,
                                                                SdkClientException,
                                                                S3ControlException

Deletes the access point policy for the specified access point.

This is a convenience which creates an instance of the DeleteAccessPointPolicyRequest.Builder avoiding the need to create one manually via DeleteAccessPointPolicyRequest.builder()

Parameters:

deleteAccessPointPolicyRequest - A Consumer that will call methods on DeleteAccessPointPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteAccessPointPolicy operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteJobTagging

default DeleteJobTaggingResponse deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest)
                                           throws InternalServiceException,
                                                  TooManyRequestsException,
                                                  NotFoundException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  S3ControlException

Delete the tags on a Amazon S3 batch operations job, if any.

Parameters:

deleteJobTaggingRequest -

Returns:

Result of the DeleteJobTagging operation returned by the service.

Throws:

InternalServiceException

TooManyRequestsException

NotFoundException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteJobTagging

default DeleteJobTaggingResponse deleteJobTagging(Consumer<DeleteJobTaggingRequest.Builder> deleteJobTaggingRequest)
                                           throws InternalServiceException,
                                                  TooManyRequestsException,
                                                  NotFoundException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  S3ControlException

Delete the tags on a Amazon S3 batch operations job, if any.

This is a convenience which creates an instance of the DeleteJobTaggingRequest.Builder avoiding the need to create one manually via DeleteJobTaggingRequest.builder()

Parameters:

deleteJobTaggingRequest - A Consumer that will call methods on DeleteJobTaggingRequest.Builder to create a request.

Returns:

Result of the DeleteJobTagging operation returned by the service.

Throws:

InternalServiceException

TooManyRequestsException

NotFoundException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deletePublicAccessBlock

default DeletePublicAccessBlockResponse deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)
                                                         throws AwsServiceException,
                                                                SdkClientException,
                                                                S3ControlException

Removes the PublicAccessBlock configuration for an Amazon Web Services account.

Parameters:

deletePublicAccessBlockRequest -

Returns:

Result of the DeletePublicAccessBlock operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deletePublicAccessBlock

default DeletePublicAccessBlockResponse deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest)
                                                         throws AwsServiceException,
                                                                SdkClientException,
                                                                S3ControlException

Removes the PublicAccessBlock configuration for an Amazon Web Services account.

This is a convenience which creates an instance of the DeletePublicAccessBlockRequest.Builder avoiding the need to create one manually via DeletePublicAccessBlockRequest.builder()

Parameters:

deletePublicAccessBlockRequest - A Consumer that will call methods on DeletePublicAccessBlockRequest.Builder to create a request.

Returns:

Result of the DeletePublicAccessBlock operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeJob

default DescribeJobResponse describeJob(DescribeJobRequest describeJobRequest)
                                 throws BadRequestException,
                                        TooManyRequestsException,
                                        NotFoundException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        S3ControlException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeJob

default DescribeJobResponse describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)
                                 throws BadRequestException,
                                        TooManyRequestsException,
                                        NotFoundException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        S3ControlException

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

This is a convenience which creates an instance of the DescribeJobRequest.Builder avoiding the need to create one manually via DescribeJobRequest.builder()

Parameters:

describeJobRequest - A Consumer that will call methods on DescribeJobRequest.Builder to create a request.

Returns:

Result of the DescribeJob operation returned by the service.

Throws:

BadRequestException

TooManyRequestsException

NotFoundException

InternalServiceException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getAccessPoint

default GetAccessPointResponse getAccessPoint(GetAccessPointRequest getAccessPointRequest)
                                       throws AwsServiceException,
                                              SdkClientException,
                                              S3ControlException

Returns configuration information about the specified access point.

Parameters:

getAccessPointRequest -

Returns:

Result of the GetAccessPoint operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getAccessPoint

default GetAccessPointResponse getAccessPoint(Consumer<GetAccessPointRequest.Builder> getAccessPointRequest)
                                       throws AwsServiceException,
                                              SdkClientException,
                                              S3ControlException

Returns configuration information about the specified access point.

This is a convenience which creates an instance of the GetAccessPointRequest.Builder avoiding the need to create one manually via GetAccessPointRequest.builder()

Parameters:

getAccessPointRequest - A Consumer that will call methods on GetAccessPointRequest.Builder to create a request.

Returns:

Result of the GetAccessPoint operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getAccessPointPolicy

default GetAccessPointPolicyResponse getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest)
                                                   throws AwsServiceException,
                                                          SdkClientException,
                                                          S3ControlException

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

Parameters:

getAccessPointPolicyRequest -

Returns:

Result of the GetAccessPointPolicy operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getAccessPointPolicy

default GetAccessPointPolicyResponse getAccessPointPolicy(Consumer<GetAccessPointPolicyRequest.Builder> getAccessPointPolicyRequest)
                                                   throws AwsServiceException,
                                                          SdkClientException,
                                                          S3ControlException

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

This is a convenience which creates an instance of the GetAccessPointPolicyRequest.Builder avoiding the need to create one manually via GetAccessPointPolicyRequest.builder()

Parameters:

getAccessPointPolicyRequest - A Consumer that will call methods on GetAccessPointPolicyRequest.Builder to create a request.

Returns:

Result of the GetAccessPointPolicy operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getAccessPointPolicyStatus

default GetAccessPointPolicyStatusResponse getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest)
                                                               throws AwsServiceException,
                                                                      SdkClientException,
                                                                      S3ControlException

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.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getAccessPointPolicyStatus

default GetAccessPointPolicyStatusResponse getAccessPointPolicyStatus(Consumer<GetAccessPointPolicyStatusRequest.Builder> getAccessPointPolicyStatusRequest)
                                                               throws AwsServiceException,
                                                                      SdkClientException,
                                                                      S3ControlException

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.

This is a convenience which creates an instance of the GetAccessPointPolicyStatusRequest.Builder avoiding the need to create one manually via GetAccessPointPolicyStatusRequest.builder()

Parameters:

getAccessPointPolicyStatusRequest - A Consumer that will call methods on GetAccessPointPolicyStatusRequest.Builder to create a request.

Returns:

Result of the GetAccessPointPolicyStatus operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getJobTagging

default GetJobTaggingResponse getJobTagging(GetJobTaggingRequest getJobTaggingRequest)
                                     throws InternalServiceException,
                                            TooManyRequestsException,
                                            NotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            S3ControlException

Retrieve the tags on a Amazon S3 batch operations job.

Parameters:

getJobTaggingRequest -

Returns:

Result of the GetJobTagging operation returned by the service.

Throws:

InternalServiceException

TooManyRequestsException

NotFoundException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getJobTagging

default GetJobTaggingResponse getJobTagging(Consumer<GetJobTaggingRequest.Builder> getJobTaggingRequest)
                                     throws InternalServiceException,
                                            TooManyRequestsException,
                                            NotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            S3ControlException

Retrieve the tags on a Amazon S3 batch operations job.

This is a convenience which creates an instance of the GetJobTaggingRequest.Builder avoiding the need to create one manually via GetJobTaggingRequest.builder()

Parameters:

getJobTaggingRequest - A Consumer that will call methods on GetJobTaggingRequest.Builder to create a request.

Returns:

Result of the GetJobTagging operation returned by the service.

Throws:

InternalServiceException

TooManyRequestsException

NotFoundException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getPublicAccessBlock

default GetPublicAccessBlockResponse getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)
                                                   throws NoSuchPublicAccessBlockConfigurationException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          S3ControlException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getPublicAccessBlock

default GetPublicAccessBlockResponse getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest)
                                                   throws NoSuchPublicAccessBlockConfigurationException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          S3ControlException

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.

This is a convenience which creates an instance of the GetPublicAccessBlockRequest.Builder avoiding the need to create one manually via GetPublicAccessBlockRequest.builder()

Parameters:

getPublicAccessBlockRequest - A Consumer that will call methods on GetPublicAccessBlockRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listAccessPoints

default ListAccessPointsResponse listAccessPoints(ListAccessPointsRequest listAccessPointsRequest)
                                           throws AwsServiceException,
                                                  SdkClientException,
                                                  S3ControlException

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.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listAccessPoints

default ListAccessPointsResponse listAccessPoints(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)
                                           throws AwsServiceException,
                                                  SdkClientException,
                                                  S3ControlException

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.

This is a convenience which creates an instance of the ListAccessPointsRequest.Builder avoiding the need to create one manually via ListAccessPointsRequest.builder()

Parameters:

listAccessPointsRequest - A Consumer that will call methods on ListAccessPointsRequest.Builder to create a request.

Returns:

Result of the ListAccessPoints operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listAccessPointsPaginator

default ListAccessPointsIterable listAccessPointsPaginator(ListAccessPointsRequest listAccessPointsRequest)
                                                    throws AwsServiceException,
                                                           SdkClientException,
                                                           S3ControlException

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.

This is a variant of listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client
             .listAccessPointsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation.

Parameters:

listAccessPointsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listAccessPointsPaginator

default ListAccessPointsIterable listAccessPointsPaginator(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)
                                                    throws AwsServiceException,
                                                           SdkClientException,
                                                           S3ControlException

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.

This is a variant of listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client
             .listAccessPointsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation.

This is a convenience which creates an instance of the ListAccessPointsRequest.Builder avoiding the need to create one manually via ListAccessPointsRequest.builder()

Parameters:

listAccessPointsRequest - A Consumer that will call methods on ListAccessPointsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listJobs

default ListJobsResponse listJobs(ListJobsRequest listJobsRequest)
                           throws InvalidRequestException,
                                  InternalServiceException,
                                  InvalidNextTokenException,
                                  AwsServiceException,
                                  SdkClientException,
                                  S3ControlException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listJobs

default ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
                           throws InvalidRequestException,
                                  InternalServiceException,
                                  InvalidNextTokenException,
                                  AwsServiceException,
                                  SdkClientException,
                                  S3ControlException

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

This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to create one manually via ListJobsRequest.builder()

Parameters:

listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.

Returns:

Result of the ListJobs operation returned by the service.

Throws:

InvalidRequestException

InternalServiceException

InvalidNextTokenException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listJobsPaginator

default ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest)
                                    throws InvalidRequestException,
                                           InternalServiceException,
                                           InvalidNextTokenException,
                                           AwsServiceException,
                                           SdkClientException,
                                           S3ControlException

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

This is a variant of listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation.

Parameters:

listJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException

InternalServiceException

InvalidNextTokenException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listJobsPaginator

default ListJobsIterable listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)
                                    throws InvalidRequestException,
                                           InternalServiceException,
                                           InvalidNextTokenException,
                                           AwsServiceException,
                                           SdkClientException,
                                           S3ControlException

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

This is a variant of listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation.

This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to create one manually via ListJobsRequest.builder()

Parameters:

listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException

InternalServiceException

InvalidNextTokenException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putAccessPointPolicy

default PutAccessPointPolicyResponse putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest)
                                                   throws AwsServiceException,
                                                          SdkClientException,
                                                          S3ControlException

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.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putAccessPointPolicy

default PutAccessPointPolicyResponse putAccessPointPolicy(Consumer<PutAccessPointPolicyRequest.Builder> putAccessPointPolicyRequest)
                                                   throws AwsServiceException,
                                                          SdkClientException,
                                                          S3ControlException

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.

This is a convenience which creates an instance of the PutAccessPointPolicyRequest.Builder avoiding the need to create one manually via PutAccessPointPolicyRequest.builder()

Parameters:

putAccessPointPolicyRequest - A Consumer that will call methods on PutAccessPointPolicyRequest.Builder to create a request.

Returns:

Result of the PutAccessPointPolicy operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putJobTagging

default PutJobTaggingResponse putJobTagging(PutJobTaggingRequest putJobTaggingRequest)
                                     throws InternalServiceException,
                                            TooManyRequestsException,
                                            NotFoundException,
                                            TooManyTagsException,
                                            AwsServiceException,
                                            SdkClientException,
                                            S3ControlException

Replace the set of tags on a Amazon S3 batch operations job.

Parameters:

putJobTaggingRequest -

Returns:

Result of the PutJobTagging operation returned by the service.

Throws:

InternalServiceException

TooManyRequestsException

NotFoundException

TooManyTagsException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putJobTagging

default PutJobTaggingResponse putJobTagging(Consumer<PutJobTaggingRequest.Builder> putJobTaggingRequest)
                                     throws InternalServiceException,
                                            TooManyRequestsException,
                                            NotFoundException,
                                            TooManyTagsException,
                                            AwsServiceException,
                                            SdkClientException,
                                            S3ControlException

Replace the set of tags on a Amazon S3 batch operations job.

This is a convenience which creates an instance of the PutJobTaggingRequest.Builder avoiding the need to create one manually via PutJobTaggingRequest.builder()

Parameters:

putJobTaggingRequest - A Consumer that will call methods on PutJobTaggingRequest.Builder to create a request.

Returns:

Result of the PutJobTagging operation returned by the service.

Throws:

InternalServiceException

TooManyRequestsException

NotFoundException

TooManyTagsException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putPublicAccessBlock

default PutPublicAccessBlockResponse putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)
                                                   throws AwsServiceException,
                                                          SdkClientException,
                                                          S3ControlException

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

Parameters:

putPublicAccessBlockRequest -

Returns:

Result of the PutPublicAccessBlock operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putPublicAccessBlock

default PutPublicAccessBlockResponse putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest)
                                                   throws AwsServiceException,
                                                          SdkClientException,
                                                          S3ControlException

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

This is a convenience which creates an instance of the PutPublicAccessBlockRequest.Builder avoiding the need to create one manually via PutPublicAccessBlockRequest.builder()

Parameters:

putPublicAccessBlockRequest - A Consumer that will call methods on PutPublicAccessBlockRequest.Builder to create a request.

Returns:

Result of the PutPublicAccessBlock operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateJobPriority

default UpdateJobPriorityResponse updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest)
                                             throws BadRequestException,
                                                    TooManyRequestsException,
                                                    NotFoundException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    S3ControlException

Updates an existing job's priority.

Parameters:

updateJobPriorityRequest -

Returns:

Result of the UpdateJobPriority operation returned by the service.

Throws:

BadRequestException

TooManyRequestsException

NotFoundException

InternalServiceException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateJobPriority

default UpdateJobPriorityResponse updateJobPriority(Consumer<UpdateJobPriorityRequest.Builder> updateJobPriorityRequest)
                                             throws BadRequestException,
                                                    TooManyRequestsException,
                                                    NotFoundException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    S3ControlException

Updates an existing job's priority.

This is a convenience which creates an instance of the UpdateJobPriorityRequest.Builder avoiding the need to create one manually via UpdateJobPriorityRequest.builder()

Parameters:

updateJobPriorityRequest - A Consumer that will call methods on UpdateJobPriorityRequest.Builder to create a request.

Returns:

Result of the UpdateJobPriority operation returned by the service.

Throws:

BadRequestException

TooManyRequestsException

NotFoundException

InternalServiceException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateJobStatus

default UpdateJobStatusResponse updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest)
                                         throws BadRequestException,
                                                TooManyRequestsException,
                                                NotFoundException,
                                                JobStatusException,
                                                InternalServiceException,
                                                AwsServiceException,
                                                SdkClientException,
                                                S3ControlException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateJobStatus

default UpdateJobStatusResponse updateJobStatus(Consumer<UpdateJobStatusRequest.Builder> updateJobStatusRequest)
                                         throws BadRequestException,
                                                TooManyRequestsException,
                                                NotFoundException,
                                                JobStatusException,
                                                InternalServiceException,
                                                AwsServiceException,
                                                SdkClientException,
                                                S3ControlException

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.

This is a convenience which creates an instance of the UpdateJobStatusRequest.Builder avoiding the need to create one manually via UpdateJobStatusRequest.builder()

Parameters:

updateJobStatusRequest - A Consumer that will call methods on UpdateJobStatusRequest.Builder to create a request.

Returns:

Result of the UpdateJobStatus operation returned by the service.

Throws:

BadRequestException

TooManyRequestsException

NotFoundException

JobStatusException

InternalServiceException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()