@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSS3ControlClient extends AmazonWebServiceClient implements AWSS3Control
AWS S3 Control provides access to Amazon S3 control plane operations.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AWSS3ControlClientBuilder builder()
public CreateAccessPointResult createAccessPoint(CreateAccessPointRequest request)
Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
Using this action with Amazon S3 on Outposts
This action:
Requires a virtual private cloud (VPC) configuration as S3 on Outposts only supports VPC style access points.
Does not support ACL on S3 on Outposts buckets.
Does not support Public Access on S3 on Outposts buckets.
Does not support object lock for S3 on Outposts buckets.
For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide .
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to CreateAccessPoint:
createAccessPoint in interface AWSS3ControlcreateAccessPointRequest - public CreateBucketResult createBucket(CreateBucketRequest request)
This API operation creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon Simple Storage Service API.
Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.
Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.
S3 on Outposts buckets do not support
ACLs. Instead, configure access point policies to manage access to buckets.
Public access.
Object Lock
Bucket Location constraint
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the Example section below.
The following actions are related to CreateBucket for Amazon S3 on Outposts:
createBucket in interface AWSS3ControlcreateBucketRequest - BucketAlreadyExistsException - The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the
AWS Outposts in this Region. Select a different name and try again.BucketAlreadyOwnedByYouException - The Outposts bucket you tried to create already exists, and you own it.public CreateJobResult createJob(CreateJobRequest request)
S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects. Batch Operations can run a single operation or action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
This operation creates a S3 Batch Operations job.
Related actions include:
createJob in interface AWSS3ControlcreateJobRequest - TooManyRequestsExceptionBadRequestExceptionIdempotencyExceptionInternalServiceExceptionpublic DeleteAccessPointResult deleteAccessPoint(DeleteAccessPointRequest request)
Deletes the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the ARN, see the Example section below.
The following actions are related to DeleteAccessPoint:
deleteAccessPoint in interface AWSS3ControldeleteAccessPointRequest - public DeleteAccessPointPolicyResult deleteAccessPointPolicy(DeleteAccessPointPolicyRequest request)
Deletes the access point policy for the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to DeleteAccessPointPolicy:
deleteAccessPointPolicy in interface AWSS3ControldeleteAccessPointPolicyRequest - public DeleteBucketResult deleteBucket(DeleteBucketRequest request)
This API operation deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon Simple Storage Service API.
Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
Related Resources
deleteBucket in interface AWSS3ControldeleteBucketRequest - public DeleteBucketLifecycleConfigurationResult deleteBucketLifecycleConfiguration(DeleteBucketLifecycleConfigurationRequest request)
This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon Simple Storage Service API.
Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.
To use this operation, you must have permission to perform the
s3outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and
the Outposts bucket owner can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
deleteBucketLifecycleConfiguration in interface AWSS3ControldeleteBucketLifecycleConfigurationRequest - public DeleteBucketPolicyResult deleteBucketPolicy(DeleteBucketPolicyRequest request)
This API operation deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon Simple Storage Service API.
This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified
Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the AWS account that owns
the bucket, the calling identity must have the s3outposts:DeleteBucketPolicy permissions on the
specified Outposts bucket and belong to the bucket owner's account to use this operation. For more information,
see Using Amazon S3 on Outposts
in Amazon Simple Storage Service Developer Guide.
If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to DeleteBucketPolicy:
deleteBucketPolicy in interface AWSS3ControldeleteBucketPolicyRequest - public DeleteBucketTaggingResult deleteBucketTagging(DeleteBucketTaggingRequest request)
This API operation deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon Simple Storage Service API.
Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.
To use this operation, you must have permission to perform the PutBucketTagging action. By default,
the bucket owner has this permission and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to DeleteBucketTagging:
deleteBucketTagging in interface AWSS3ControldeleteBucketTaggingRequest - public DeleteJobTaggingResult deleteJobTagging(DeleteJobTaggingRequest request)
Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have
permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide.
Related actions include:
deleteJobTagging in interface AWSS3ControldeleteJobTaggingRequest - InternalServiceExceptionTooManyRequestsExceptionNotFoundExceptionpublic DeletePublicAccessBlockResult deletePublicAccessBlock(DeletePublicAccessBlockRequest request)
Removes the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3
block public access.
Related actions include:
deletePublicAccessBlock in interface AWSS3ControldeletePublicAccessBlockRequest - public DescribeJobResult describeJob(DescribeJobRequest request)
Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
describeJob in interface AWSS3ControldescribeJobRequest - BadRequestExceptionTooManyRequestsExceptionNotFoundExceptionInternalServiceExceptionpublic GetAccessPointResult getAccessPoint(GetAccessPointRequest request)
Returns configuration information about the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to GetAccessPoint:
getAccessPoint in interface AWSS3ControlgetAccessPointRequest - public GetAccessPointPolicyResult getAccessPointPolicy(GetAccessPointPolicyRequest request)
Returns the access point policy associated with the specified access point.
The following actions are related to GetAccessPointPolicy:
getAccessPointPolicy in interface AWSS3ControlgetAccessPointPolicyRequest - 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.
getAccessPointPolicyStatus in interface AWSS3ControlgetAccessPointPolicyStatusRequest - public GetBucketResult getBucket(GetBucketRequest request)
Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
The following actions are related to GetBucket for Amazon S3 on Outposts:
getBucket in interface AWSS3ControlgetBucketRequest - public GetBucketLifecycleConfigurationResult getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest request)
This API operation gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon Simple Storage Service API.
Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon Simple Storage Service Developer Guide.
To use this operation, you must have permission to perform the s3outposts:GetLifecycleConfiguration
action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to
others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
GetBucketLifecycleConfiguration has the following special error:
Error code: NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
The following actions are related to GetBucketLifecycleConfiguration:
getBucketLifecycleConfiguration in interface AWSS3ControlgetBucketLifecycleConfigurationRequest - public GetBucketPolicyResult getBucketPolicy(GetBucketPolicyRequest request)
This API action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon Simple Storage Service API.
Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
If you are using an identity other than the root user of the AWS account that owns the bucket, the calling
identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket
owner's account in order to use this operation.
If you don't have s3outposts:GetBucketPolicy permissions, Amazon S3 returns a
403 Access Denied error. If you have the correct permissions, but you're not using an identity that
belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to GetBucketPolicy:
getBucketPolicy in interface AWSS3ControlgetBucketPolicyRequest - public GetBucketTaggingResult getBucketTagging(GetBucketTaggingRequest request)
This API operation gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon Simple Storage Service API.
Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
To use this operation, you must have permission to perform the GetBucketTagging action. By default,
the bucket owner has this permission and can grant this permission to others.
GetBucketTagging has the following special error:
Error code: NoSuchTagSetError
Description: There is no tag set associated with the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to GetBucketTagging:
getBucketTagging in interface AWSS3ControlgetBucketTaggingRequest - public GetJobTaggingResult getJobTagging(GetJobTaggingRequest request)
Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the
s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide.
Related actions include:
getJobTagging in interface AWSS3ControlgetJobTaggingRequest - InternalServiceExceptionTooManyRequestsExceptionNotFoundExceptionpublic GetPublicAccessBlockResult getPublicAccessBlock(GetPublicAccessBlockRequest request)
Retrieves the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3
block public access.
Related actions include:
getPublicAccessBlock in interface AWSS3ControlgetPublicAccessBlockRequest - NoSuchPublicAccessBlockConfigurationException - Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an
account that doesn't have a PublicAccessBlockConfiguration set.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.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to ListAccessPoints:
listAccessPoints in interface AWSS3ControllistAccessPointsRequest - public ListJobsResult listJobs(ListJobsRequest request)
Lists current 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 S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
listJobs in interface AWSS3ControllistJobsRequest - InvalidRequestExceptionInternalServiceExceptionInvalidNextTokenExceptionpublic ListRegionalBucketsResult listRegionalBuckets(ListRegionalBucketsRequest request)
Returns a list of all Outposts buckets in an Outposts that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the Example section below.
listRegionalBuckets in interface AWSS3ControllistRegionalBucketsRequest - 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.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to PutAccessPointPolicy:
putAccessPointPolicy in interface AWSS3ControlputAccessPointPolicyRequest - public PutBucketLifecycleConfigurationResult putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest request)
This API action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon Simple Storage Service API.
Creates a new lifecycle configuration for the Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets can only support a lifecycle that deletes objects after a certain period of time. For more information, see Managing Lifecycle Permissions for Amazon S3 on Outposts.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to PutBucketLifecycleConfiguration:
putBucketLifecycleConfiguration in interface AWSS3ControlputBucketLifecycleConfigurationRequest - public PutBucketPolicyResult putBucketPolicy(PutBucketPolicyRequest request)
This API action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon Simple Storage Service API.
Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the
calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and
belong to the bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to PutBucketPolicy:
putBucketPolicy in interface AWSS3ControlputBucketPolicyRequest - public PutBucketTaggingResult putBucketTagging(PutBucketTaggingRequest request)
This API action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon Simple Storage Service API.
Sets the tags for an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging.
Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.
To use this operation, you must have permissions to perform the s3outposts:PutBucketTagging action.
The Outposts bucket owner has this permission by default and can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
PutBucketTagging has the following special errors:
Error code: InvalidTagError
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and AWS-Generated Cost Allocation Tag Restrictions.
Error code: MalformedXMLError
Description: The XML provided does not match the schema.
Error code: OperationAbortedError
Description: A conflicting conditional operation is currently in progress against this resource. Try again.
Error code: InternalError
Description: The service was unable to apply the provided tag to the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.
The following actions are related to PutBucketTagging:
putBucketTagging in interface AWSS3ControlputBucketTaggingRequest - public PutJobTaggingResult putJobTagging(PutJobTaggingRequest request)
Sets the supplied tag-set on an S3 Batch Operations job.
A tag is a key-value pair. You can associate 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 modified. For more information, see Controlling access and labeling jobs using 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 are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
For deleting existing tags for your Batch Operations job, a 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 in the AWS Billing and Cost Management User Guide.
To use this operation, you must have permission to perform the s3:PutJobTagging action.
Related actions include:
putJobTagging in interface AWSS3ControlputJobTaggingRequest - InternalServiceExceptionTooManyRequestsExceptionNotFoundExceptionTooManyTagsException - Amazon S3 throws this exception if you have too many tags in your tag set.public PutPublicAccessBlockResult putPublicAccessBlock(PutPublicAccessBlockRequest request)
Creates or modifies the PublicAccessBlock configuration for an AWS account. For more information,
see Using
Amazon S3 block public access.
Related actions include:
putPublicAccessBlock in interface AWSS3ControlputPublicAccessBlockRequest - public UpdateJobPriorityResult updateJobPriority(UpdateJobPriorityRequest request)
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
updateJobPriority in interface AWSS3ControlupdateJobPriorityRequest - BadRequestExceptionTooManyRequestsExceptionNotFoundExceptionInternalServiceExceptionpublic 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 S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
updateJobStatus in interface AWSS3ControlupdateJobStatusRequest - BadRequestExceptionTooManyRequestsExceptionNotFoundExceptionJobStatusExceptionInternalServiceExceptionpublic S3ControlResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AWSS3Controlrequest - The originally executed request