AWSS3
Objective-C
@interface AWSS3
Swift
class AWSS3
-
The service configuration used to instantiate this service client.
Warning
Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.Declaration
Objective-C
@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration
-
Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with
defaultServiceConfiguration
from[AWSServiceManager defaultServiceManager]
. The reference to this object is maintained by the SDK, and you do not need to retain it manually.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) AWSServiceManager.default().defaultServiceConfiguration = configuration return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 credentialsProvider:credentialsProvider]; [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; return YES; }
Then call the following to get the default service client:
Swift
let S3 = AWSS3.default()
Objective-C
AWSS3 *S3 = [AWSS3 defaultS3];
Declaration
Objective-C
+ (nonnull instancetype)defaultS3;
Swift
class func `default`() -> Self
Return Value
The default service client.
-
Creates a service client with the given service configuration and registers it for the key.
For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSS3.register(with: configuration!, forKey: "USWest2S3") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSS3 registerS3WithConfiguration:configuration forKey:@"USWest2S3"]; return YES; }
Then call the following to get the service client:
Swift
let S3 = AWSS3(forKey: "USWest2S3")
Objective-C
AWSS3 *S3 = [AWSS3 S3ForKey:@"USWest2S3"];
Warning
After calling this method, do not modify the configuration object. It may cause unspecified behaviors.
Declaration
Objective-C
+ (void)registerS3WithConfiguration:(id)configuration forKey:(nonnull NSString *)key;
Swift
class func register(withConfiguration configuration: Any!, forKey key: String)
Parameters
configuration
A service configuration object.
key
A string to identify the service client.
-
Retrieves the service client associated with the key. You need to call
+ registerS3WithConfiguration:forKey:
before invoking this method.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSS3.register(with: configuration!, forKey: "USWest2S3") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSS3 registerS3WithConfiguration:configuration forKey:@"USWest2S3"]; return YES; }
Then call the following to get the service client:
Swift
let S3 = AWSS3(forKey: "USWest2S3")
Objective-C
AWSS3 *S3 = [AWSS3 S3ForKey:@"USWest2S3"];
Declaration
Objective-C
+ (nonnull instancetype)S3ForKey:(nonnull NSString *)key;
Swift
class func s3(forKey key: String) -> Self
Parameters
key
A string to identify the service client.
Return Value
An instance of the service client.
-
Removes the service client associated with the key and release it.
Warning
Before calling this method, make sure no method is running on this client.
Declaration
Objective-C
+ (void)removeS3ForKey:(nonnull NSString *)key;
Swift
class func remove(forKey key: String)
Parameters
key
A string to identify the service client.
-
This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.
To verify that all parts have been removed, so you don’t get charged for the part storage, you should call the ListParts operation and ensure that the parts list is empty.
For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to
AbortMultipartUpload
:See
AWSS3AbortMultipartUploadRequest
See
AWSS3AbortMultipartUploadOutput
Declaration
Objective-C
- (id)abortMultipartUpload:(nonnull AWSS3AbortMultipartUploadRequest *)request;
Swift
func abortMultipartUpload(_ request: AWSS3AbortMultipartUploadRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AbortMultipartUpload service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3AbortMultipartUploadOutput
. On failed execution,task.error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchUpload
. -
This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.
To verify that all parts have been removed, so you don’t get charged for the part storage, you should call the ListParts operation and ensure that the parts list is empty.
For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to
AbortMultipartUpload
:See
AWSS3AbortMultipartUploadRequest
See
AWSS3AbortMultipartUploadOutput
Declaration
Objective-C
- (void)abortMultipartUpload:(nonnull AWSS3AbortMultipartUploadRequest *)request completionHandler: (void (^_Nullable)(AWSS3AbortMultipartUploadOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func abortMultipartUpload(_ request: AWSS3AbortMultipartUploadRequest) async throws -> AWSS3AbortMultipartUploadOutput
Parameters
request
A container for the necessary parameters to execute the AbortMultipartUpload service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchUpload
. -
Completes a multipart upload by assembling previously uploaded parts.
You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This operation concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the
ETag
value, returned after that part was uploaded.Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.
Note that if
CompleteMultipartUpload
fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.For more information about multipart uploads, see Uploading Objects Using Multipart Upload.
For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
CompleteMultipartUpload
has the following special errors:Error code:
EntityTooSmall
Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
400 Bad Request
Error code:
InvalidPart
Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part’s entity tag.
400 Bad Request
Error code:
InvalidPartOrder
Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.
400 Bad Request
Error code:
NoSuchUpload
Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
404 Not Found
The following operations are related to
CompleteMultipartUpload
:See
AWSS3CompleteMultipartUploadRequest
See
AWSS3CompleteMultipartUploadOutput
Declaration
Objective-C
- (id)completeMultipartUpload: (nonnull AWSS3CompleteMultipartUploadRequest *)request;
Swift
func completeMultipartUpload(_ request: AWSS3CompleteMultipartUploadRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CompleteMultipartUpload service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3CompleteMultipartUploadOutput
. -
Completes a multipart upload by assembling previously uploaded parts.
You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This operation concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the
ETag
value, returned after that part was uploaded.Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.
Note that if
CompleteMultipartUpload
fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.For more information about multipart uploads, see Uploading Objects Using Multipart Upload.
For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
CompleteMultipartUpload
has the following special errors:Error code:
EntityTooSmall
Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
400 Bad Request
Error code:
InvalidPart
Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part’s entity tag.
400 Bad Request
Error code:
InvalidPartOrder
Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.
400 Bad Request
Error code:
NoSuchUpload
Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
404 Not Found
The following operations are related to
CompleteMultipartUpload
:See
AWSS3CompleteMultipartUploadRequest
See
AWSS3CompleteMultipartUploadOutput
Declaration
Objective-C
- (void) completeMultipartUpload: (nonnull AWSS3CompleteMultipartUploadRequest *)request completionHandler: (void (^_Nullable)(AWSS3CompleteMultipartUploadOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func completeMultipartUpload(_ request: AWSS3CompleteMultipartUploadRequest) async throws -> AWSS3CompleteMultipartUploadOutput
Parameters
request
A container for the necessary parameters to execute the CompleteMultipartUpload service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.
All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the
200 OK
response. This means that a200 OK
response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.If the copy is successful, you receive a response with information about the copied object.
If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.
The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing.
Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400
Bad Request
error. For more information, see Transfer Acceleration.Metadata
When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.
To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the
x-amz-metadata-directive
header. When you grant permissions, you can use thes3:x-amz-metadata-directive
condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 Developer Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.x-amz-copy-source-if
HeadersTo only copy an object under certain conditions, such as whether the
Etag
matches or whether the object was modified before or after a specified date, use the following request parameters:x-amz-copy-source-if-match
x-amz-copy-source-if-none-match
x-amz-copy-source-if-unmodified-since
x-amz-copy-source-if-modified-since
If both the
x-amz-copy-source-if-match
andx-amz-copy-source-if-unmodified-since
headers are present in the request and evaluate as follows, Amazon S3 returns200 OK
and copies the data:x-amz-copy-source-if-match
condition evaluates to truex-amz-copy-source-if-unmodified-since
condition evaluates to false
If both the
x-amz-copy-source-if-none-match
andx-amz-copy-source-if-modified-since
headers are present in the request and evaluate as follows, Amazon S3 returns the412 Precondition Failed
response code:x-amz-copy-source-if-none-match
condition evaluates to falsex-amz-copy-source-if-modified-since
condition evaluates to true
All headers with the
x-amz-
prefix, includingx-amz-copy-source
, must be signed.Encryption
The source object that you are copying can be encrypted or unencrypted. The source object can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it.
You can optionally use the appropriate encryption-related headers to request server-side encryption for the target object. You have the option to provide your own encryption key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to encrypt the source object. You can even request encryption if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption.
Access Control List (ACL)-Specific Request Headers
When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.
Storage Class Options
You can use the
CopyObject
operation to change the storage class of an object that is already stored in Amazon S3 using theStorageClass
parameter. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.Versioning
By default,
x-amz-copy-source
identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use theversionId
subresource.If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the
x-amz-version-id
response header in the response.If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.
If the source object’s storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject.
The following operations are related to
CopyObject
:For more information, see Copying Objects.
See
AWSS3ReplicateObjectRequest
See
AWSS3ReplicateObjectOutput
Declaration
Objective-C
- (id)replicateObject:(nonnull AWSS3ReplicateObjectRequest *)request;
Swift
func replicateObject(_ request: AWSS3ReplicateObjectRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CopyObject service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3ReplicateObjectOutput
. On failed execution,task.error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorObjectNotInActiveTier
. -
Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.
All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the
200 OK
response. This means that a200 OK
response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.If the copy is successful, you receive a response with information about the copied object.
If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.
The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing.
Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400
Bad Request
error. For more information, see Transfer Acceleration.Metadata
When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.
To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the
x-amz-metadata-directive
header. When you grant permissions, you can use thes3:x-amz-metadata-directive
condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 Developer Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.x-amz-copy-source-if
HeadersTo only copy an object under certain conditions, such as whether the
Etag
matches or whether the object was modified before or after a specified date, use the following request parameters:x-amz-copy-source-if-match
x-amz-copy-source-if-none-match
x-amz-copy-source-if-unmodified-since
x-amz-copy-source-if-modified-since
If both the
x-amz-copy-source-if-match
andx-amz-copy-source-if-unmodified-since
headers are present in the request and evaluate as follows, Amazon S3 returns200 OK
and copies the data:x-amz-copy-source-if-match
condition evaluates to truex-amz-copy-source-if-unmodified-since
condition evaluates to false
If both the
x-amz-copy-source-if-none-match
andx-amz-copy-source-if-modified-since
headers are present in the request and evaluate as follows, Amazon S3 returns the412 Precondition Failed
response code:x-amz-copy-source-if-none-match
condition evaluates to falsex-amz-copy-source-if-modified-since
condition evaluates to true
All headers with the
x-amz-
prefix, includingx-amz-copy-source
, must be signed.Encryption
The source object that you are copying can be encrypted or unencrypted. The source object can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it.
You can optionally use the appropriate encryption-related headers to request server-side encryption for the target object. You have the option to provide your own encryption key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to encrypt the source object. You can even request encryption if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption.
Access Control List (ACL)-Specific Request Headers
When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.
Storage Class Options
You can use the
CopyObject
operation to change the storage class of an object that is already stored in Amazon S3 using theStorageClass
parameter. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.Versioning
By default,
x-amz-copy-source
identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use theversionId
subresource.If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the
x-amz-version-id
response header in the response.If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.
If the source object’s storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject.
The following operations are related to
CopyObject
:For more information, see Copying Objects.
See
AWSS3ReplicateObjectRequest
See
AWSS3ReplicateObjectOutput
Declaration
Objective-C
- (void)replicateObject:(nonnull AWSS3ReplicateObjectRequest *)request completionHandler: (void (^_Nullable)(AWSS3ReplicateObjectOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func replicateObject(_ request: AWSS3ReplicateObjectRequest) async throws -> AWSS3ReplicateObjectOutput
Parameters
request
A container for the necessary parameters to execute the CopyObject service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorObjectNotInActiveTier
. -
Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.
Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Working with Amazon S3 buckets.
If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see Accessing a bucket.
If you send your create bucket request to the
s3.amazonaws.com
endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets.When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.
Specify a canned ACL using the
x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.Specify access permissions explicitly using the
x-amz-grant-read
,x-amz-grant-write
,x-amz-grant-read-acp
,x-amz-grant-write-acp
, andx-amz-grant-full-control
headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access control list (ACL) overview.You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS accounturi
– if you are granting permissions to a predefined groupemailAddress
– if the value specified is the email address of an AWS accountUsing email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following
x-amz-grant-read
header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:x-amz-grant-read: id="11112222333", id="444455556666"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
The following operations are related to
CreateBucket
:See
AWSS3CreateBucketRequest
See
AWSS3CreateBucketOutput
Declaration
Objective-C
- (id)createBucket:(nonnull AWSS3CreateBucketRequest *)request;
Swift
func createBucket(_ request: AWSS3CreateBucketRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateBucket service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3CreateBucketOutput
. On failed execution,task.error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorBucketAlreadyExists
,AWSS3ErrorBucketAlreadyOwnedByYou
. -
Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.
Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Working with Amazon S3 buckets.
If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see Accessing a bucket.
If you send your create bucket request to the
s3.amazonaws.com
endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets.When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.
Specify a canned ACL using the
x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.Specify access permissions explicitly using the
x-amz-grant-read
,x-amz-grant-write
,x-amz-grant-read-acp
,x-amz-grant-write-acp
, andx-amz-grant-full-control
headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access control list (ACL) overview.You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS accounturi
– if you are granting permissions to a predefined groupemailAddress
– if the value specified is the email address of an AWS accountUsing email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following
x-amz-grant-read
header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:x-amz-grant-read: id="11112222333", id="444455556666"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
The following operations are related to
CreateBucket
:See
AWSS3CreateBucketRequest
See
AWSS3CreateBucketOutput
Declaration
Objective-C
- (void)createBucket:(nonnull AWSS3CreateBucketRequest *)request completionHandler:(void (^_Nullable)(AWSS3CreateBucketOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createBucket(_ request: AWSS3CreateBucketRequest) async throws -> AWSS3CreateBucketOutput
Parameters
request
A container for the necessary parameters to execute the CreateBucket service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorBucketAlreadyExists
,AWSS3ErrorBucketAlreadyOwnedByYou
. -
This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.
For more information about multipart uploads, see Multipart Upload Overview.
If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4).
After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.
You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using
CreateMultipartUpload
.To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the
kms:Encrypt
,kms:Decrypt
,kms:ReEncrypt*
,kms:GenerateDataKey*
, andkms:DescribeKey
actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload.If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.
For more information, see Protecting Data Using Server-Side Encryption.
- Access Permissions
When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the
x-amz-acl
request header. For more information, see Canned ACL.Specify access permissions explicitly with the
x-amz-grant-read
,x-amz-grant-read-acp
,x-amz-grant-write-acp
, andx-amz-grant-full-control
headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
- Server-Side- Encryption-Specific Request Headers
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key.
Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify
x-amz-server-side-encryption:aws:kms
, but don’t providex-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.All GET and PUT requests for an object protected by AWS KMS fail if you don’t make them with SSL or by using SigV4.
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
- Access-Control-List (ACL)-Specific Request Headers
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (
x-amz-acl
) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS accounturi
– if you are granting permissions to a predefined groupemailAddress
– if the value specified is the email address of an AWS accountUsing email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following
x-amz-grant-read
header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:x-amz-grant-read: id="11112222333", id="444455556666"
The following operations are related to
CreateMultipartUpload
:See
AWSS3CreateMultipartUploadRequest
See
AWSS3CreateMultipartUploadOutput
Declaration
Objective-C
- (id)createMultipartUpload: (nonnull AWSS3CreateMultipartUploadRequest *)request;
Swift
func createMultipartUpload(_ request: AWSS3CreateMultipartUploadRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateMultipartUpload service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3CreateMultipartUploadOutput
. -
This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.
For more information about multipart uploads, see Multipart Upload Overview.
If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4).
After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.
You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using
CreateMultipartUpload
.To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the
kms:Encrypt
,kms:Decrypt
,kms:ReEncrypt*
,kms:GenerateDataKey*
, andkms:DescribeKey
actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload.If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.
For more information, see Protecting Data Using Server-Side Encryption.
- Access Permissions
When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the
x-amz-acl
request header. For more information, see Canned ACL.Specify access permissions explicitly with the
x-amz-grant-read
,x-amz-grant-read-acp
,x-amz-grant-write-acp
, andx-amz-grant-full-control
headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
- Server-Side- Encryption-Specific Request Headers
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key.
Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify
x-amz-server-side-encryption:aws:kms
, but don’t providex-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.All GET and PUT requests for an object protected by AWS KMS fail if you don’t make them with SSL or by using SigV4.
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
- Access-Control-List (ACL)-Specific Request Headers
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (
x-amz-acl
) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS accounturi
– if you are granting permissions to a predefined groupemailAddress
– if the value specified is the email address of an AWS accountUsing email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following
x-amz-grant-read
header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:x-amz-grant-read: id="11112222333", id="444455556666"
The following operations are related to
CreateMultipartUpload
:See
AWSS3CreateMultipartUploadRequest
See
AWSS3CreateMultipartUploadOutput
Declaration
Objective-C
- (void)createMultipartUpload: (nonnull AWSS3CreateMultipartUploadRequest *)request completionHandler: (void (^_Nullable)(AWSS3CreateMultipartUploadOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createMultipartUpload(_ request: AWSS3CreateMultipartUploadRequest) async throws -> AWSS3CreateMultipartUploadOutput
Parameters
request
A container for the necessary parameters to execute the CreateMultipartUpload service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.
Related Resources
See
AWSS3DeleteBucketRequest
Declaration
Objective-C
- (id)deleteBucket:(nonnull AWSS3DeleteBucketRequest *)request;
Swift
func deleteBucket(_ request: AWSS3DeleteBucketRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucket service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.
Related Resources
See
AWSS3DeleteBucketRequest
Declaration
Objective-C
- (void)deleteBucket:(nonnull AWSS3DeleteBucketRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteBucket(_ request: AWSS3DeleteBucketRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucket service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
To use this operation, you must have permissions to perform the
s3:PutAnalyticsConfiguration
action. The 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.For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to
DeleteBucketAnalyticsConfiguration
:See
AWSS3DeleteBucketAnalyticsConfigurationRequest
Declaration
Objective-C
- (id)deleteBucketAnalyticsConfiguration: (nonnull AWSS3DeleteBucketAnalyticsConfigurationRequest *)request;
Swift
func deleteBucketAnalyticsConfiguration(_ request: AWSS3DeleteBucketAnalyticsConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
To use this operation, you must have permissions to perform the
s3:PutAnalyticsConfiguration
action. The 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.For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to
DeleteBucketAnalyticsConfiguration
:See
AWSS3DeleteBucketAnalyticsConfigurationRequest
Declaration
Objective-C
- (void)deleteBucketAnalyticsConfiguration: (nonnull AWSS3DeleteBucketAnalyticsConfigurationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func deleteBucketAnalyticsConfiguration(_ request: AWSS3DeleteBucketAnalyticsConfigurationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Deletes the
cors
configuration information set for the bucket.To use this operation, you must have permission to perform the
s3:PutBucketCORS
action. The bucket owner has this permission by default and can grant this permission to others.For information about
cors
, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.Related Resources:
See
AWSS3DeleteBucketCorsRequest
Declaration
Objective-C
- (id)deleteBucketCors:(nonnull AWSS3DeleteBucketCorsRequest *)request;
Swift
func deleteBucketCors(_ request: AWSS3DeleteBucketCorsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucketCors service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Deletes the
cors
configuration information set for the bucket.To use this operation, you must have permission to perform the
s3:PutBucketCORS
action. The bucket owner has this permission by default and can grant this permission to others.For information about
cors
, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.Related Resources:
See
AWSS3DeleteBucketCorsRequest
Declaration
Objective-C
- (void)deleteBucketCors:(nonnull AWSS3DeleteBucketCorsRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteBucketCors(_ request: AWSS3DeleteBucketCorsRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucketCors service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This implementation of the DELETE operation removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon Simple Storage Service Developer Guide.
To use this operation, you must have permissions to perform the
s3:PutEncryptionConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.Related Resources
See
AWSS3DeleteBucketEncryptionRequest
Declaration
Objective-C
- (id)deleteBucketEncryption: (nonnull AWSS3DeleteBucketEncryptionRequest *)request;
Swift
func deleteBucketEncryption(_ request: AWSS3DeleteBucketEncryptionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucketEncryption service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
This implementation of the DELETE operation removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon Simple Storage Service Developer Guide.
To use this operation, you must have permissions to perform the
s3:PutEncryptionConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.Related Resources
See
AWSS3DeleteBucketEncryptionRequest
Declaration
Objective-C
- (void)deleteBucketEncryption: (nonnull AWSS3DeleteBucketEncryptionRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteBucketEncryption(_ request: AWSS3DeleteBucketEncryptionRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucketEncryption service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
To use this operation, you must have permissions to perform the
s3:PutInventoryConfiguration
action. The 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.For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
Operations related to
DeleteBucketInventoryConfiguration
include:See
AWSS3DeleteBucketInventoryConfigurationRequest
Declaration
Objective-C
- (id)deleteBucketInventoryConfiguration: (nonnull AWSS3DeleteBucketInventoryConfigurationRequest *)request;
Swift
func deleteBucketInventoryConfiguration(_ request: AWSS3DeleteBucketInventoryConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
To use this operation, you must have permissions to perform the
s3:PutInventoryConfiguration
action. The 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.For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
Operations related to
DeleteBucketInventoryConfiguration
include:See
AWSS3DeleteBucketInventoryConfigurationRequest
Declaration
Objective-C
- (void)deleteBucketInventoryConfiguration: (nonnull AWSS3DeleteBucketInventoryConfigurationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func deleteBucketInventoryConfiguration(_ request: AWSS3DeleteBucketInventoryConfigurationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.
To use this operation, you must have permission to perform the
s3:PutLifecycleConfiguration
action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.
For more information about the object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
See
AWSS3DeleteBucketLifecycleRequest
Declaration
Objective-C
- (id)deleteBucketLifecycle: (nonnull AWSS3DeleteBucketLifecycleRequest *)request;
Swift
func deleteBucketLifecycle(_ request: AWSS3DeleteBucketLifecycleRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucketLifecycle service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.
To use this operation, you must have permission to perform the
s3:PutLifecycleConfiguration
action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.
For more information about the object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
See
AWSS3DeleteBucketLifecycleRequest
Declaration
Objective-C
- (void)deleteBucketLifecycle: (nonnull AWSS3DeleteBucketLifecycleRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteBucketLifecycle(_ request: AWSS3DeleteBucketLifecycleRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucketLifecycle service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn’t include the daily storage metrics.
To use this operation, you must have permissions to perform the
s3:PutMetricsConfiguration
action. The 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.For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to
DeleteBucketMetricsConfiguration
:See
AWSS3DeleteBucketMetricsConfigurationRequest
Declaration
Objective-C
- (id)deleteBucketMetricsConfiguration: (nonnull AWSS3DeleteBucketMetricsConfigurationRequest *)request;
Swift
func deleteBucketMetricsConfiguration(_ request: AWSS3DeleteBucketMetricsConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn’t include the daily storage metrics.
To use this operation, you must have permissions to perform the
s3:PutMetricsConfiguration
action. The 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.For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to
DeleteBucketMetricsConfiguration
:See
AWSS3DeleteBucketMetricsConfigurationRequest
Declaration
Objective-C
- (void)deleteBucketMetricsConfiguration: (nonnull AWSS3DeleteBucketMetricsConfigurationRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func deleteBucketMetricsConfiguration(_ request: AWSS3DeleteBucketMetricsConfigurationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Removes
OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have thes3:PutBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to
DeleteBucketOwnershipControls
:See
AWSS3DeleteBucketOwnershipControlsRequest
Declaration
Objective-C
- (id)deleteBucketOwnershipControls: (nonnull AWSS3DeleteBucketOwnershipControlsRequest *)request;
Swift
func deleteBucketOwnershipControls(_ request: AWSS3DeleteBucketOwnershipControlsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucketOwnershipControls service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Removes
OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have thes3:PutBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to
DeleteBucketOwnershipControls
:See
AWSS3DeleteBucketOwnershipControlsRequest
Declaration
Objective-C
- (void)deleteBucketOwnershipControls: (nonnull AWSS3DeleteBucketOwnershipControlsRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func deleteBucketOwnershipControls(_ request: AWSS3DeleteBucketOwnershipControlsRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucketOwnershipControls service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified 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
DeleteBucketPolicy
permissions on the specified bucket and belong to the bucket owner’s account to use this operation.If you don’t have
DeleteBucketPolicy
permissions, Amazon S3 returns a403 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 a405 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 UserPolicies.
The following operations are related to
DeleteBucketPolicy
See
AWSS3DeleteBucketPolicyRequest
Declaration
Objective-C
- (id)deleteBucketPolicy:(nonnull AWSS3DeleteBucketPolicyRequest *)request;
Swift
func deleteBucketPolicy(_ request: AWSS3DeleteBucketPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucketPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified 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
DeleteBucketPolicy
permissions on the specified bucket and belong to the bucket owner’s account to use this operation.If you don’t have
DeleteBucketPolicy
permissions, Amazon S3 returns a403 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 a405 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 UserPolicies.
The following operations are related to
DeleteBucketPolicy
See
AWSS3DeleteBucketPolicyRequest
Declaration
Objective-C
- (void)deleteBucketPolicy:(nonnull AWSS3DeleteBucketPolicyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteBucketPolicy(_ request: AWSS3DeleteBucketPolicyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucketPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Deletes the replication configuration from the bucket.
To use this operation, you must have permissions to perform the
s3:PutReplicationConfiguration
action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.It can take a while for the deletion of a replication configuration to fully propagate.
For information about replication configuration, see Replication in the Amazon S3 Developer Guide.
The following operations are related to
DeleteBucketReplication
:See
AWSS3DeleteBucketReplicationRequest
Declaration
Objective-C
- (id)deleteBucketReplication: (nonnull AWSS3DeleteBucketReplicationRequest *)request;
Swift
func deleteBucketReplication(_ request: AWSS3DeleteBucketReplicationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucketReplication service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Deletes the replication configuration from the bucket.
To use this operation, you must have permissions to perform the
s3:PutReplicationConfiguration
action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.It can take a while for the deletion of a replication configuration to fully propagate.
For information about replication configuration, see Replication in the Amazon S3 Developer Guide.
The following operations are related to
DeleteBucketReplication
:See
AWSS3DeleteBucketReplicationRequest
Declaration
Objective-C
- (void)deleteBucketReplication: (nonnull AWSS3DeleteBucketReplicationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteBucketReplication(_ request: AWSS3DeleteBucketReplicationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucketReplication service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Deletes the tags from the bucket.
To use this operation, you must have permission to perform the
s3:PutBucketTagging
action. By default, the bucket owner has this permission and can grant this permission to others.The following operations are related to
DeleteBucketTagging
:See
AWSS3DeleteBucketTaggingRequest
Declaration
Objective-C
- (id)deleteBucketTagging:(nonnull AWSS3DeleteBucketTaggingRequest *)request;
Swift
func deleteBucketTagging(_ request: AWSS3DeleteBucketTaggingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucketTagging service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Deletes the tags from the bucket.
To use this operation, you must have permission to perform the
s3:PutBucketTagging
action. By default, the bucket owner has this permission and can grant this permission to others.The following operations are related to
DeleteBucketTagging
:See
AWSS3DeleteBucketTaggingRequest
Declaration
Objective-C
- (void)deleteBucketTagging:(nonnull AWSS3DeleteBucketTaggingRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteBucketTagging(_ request: AWSS3DeleteBucketTaggingRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucketTagging service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This operation removes the website configuration for a bucket. Amazon S3 returns a
200 OK
response upon successfully deleting a website configuration on the specified bucket. You will get a200 OK
response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a404
response if the bucket specified in the request does not exist.This DELETE operation requires the
S3:DeleteBucketWebsite
permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them theS3:DeleteBucketWebsite
permission.For more information about hosting websites, see Hosting Websites on Amazon S3.
The following operations are related to
DeleteBucketWebsite
:See
AWSS3DeleteBucketWebsiteRequest
Declaration
Objective-C
- (id)deleteBucketWebsite:(nonnull AWSS3DeleteBucketWebsiteRequest *)request;
Swift
func deleteBucketWebsite(_ request: AWSS3DeleteBucketWebsiteRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBucketWebsite service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
This operation removes the website configuration for a bucket. Amazon S3 returns a
200 OK
response upon successfully deleting a website configuration on the specified bucket. You will get a200 OK
response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a404
response if the bucket specified in the request does not exist.This DELETE operation requires the
S3:DeleteBucketWebsite
permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them theS3:DeleteBucketWebsite
permission.For more information about hosting websites, see Hosting Websites on Amazon S3.
The following operations are related to
DeleteBucketWebsite
:See
AWSS3DeleteBucketWebsiteRequest
Declaration
Objective-C
- (void)deleteBucketWebsite:(nonnull AWSS3DeleteBucketWebsiteRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteBucketWebsite(_ request: AWSS3DeleteBucketWebsiteRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteBucketWebsite service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn’t a null version, Amazon S3 does not remove any objects.
To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header,
x-amz-delete-marker
, to true.If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the
x-amz-mfa
request header in the DELETEversionId
request. Requests that includex-amz-mfa
must use HTTPS.For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.
You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the
s3:DeleteObject
,s3:DeleteObjectVersion
, ands3:PutLifeCycleConfiguration
actions.The following operation is related to
DeleteObject
:See
AWSS3DeleteObjectRequest
See
AWSS3DeleteObjectOutput
Declaration
Objective-C
- (id)deleteObject:(nonnull AWSS3DeleteObjectRequest *)request;
Swift
func deleteObject(_ request: AWSS3DeleteObjectRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteObject service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3DeleteObjectOutput
. -
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn’t a null version, Amazon S3 does not remove any objects.
To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header,
x-amz-delete-marker
, to true.If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the
x-amz-mfa
request header in the DELETEversionId
request. Requests that includex-amz-mfa
must use HTTPS.For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.
You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the
s3:DeleteObject
,s3:DeleteObjectVersion
, ands3:PutLifeCycleConfiguration
actions.The following operation is related to
DeleteObject
:See
AWSS3DeleteObjectRequest
See
AWSS3DeleteObjectOutput
Declaration
Objective-C
- (void)deleteObject:(nonnull AWSS3DeleteObjectRequest *)request completionHandler:(void (^_Nullable)(AWSS3DeleteObjectOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteObject(_ request: AWSS3DeleteObjectRequest) async throws -> AWSS3DeleteObjectOutput
Parameters
request
A container for the necessary parameters to execute the DeleteObject service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.
To use this operation, you must have permission to perform the
s3:DeleteObjectTagging
action.To delete tags of a specific object version, add the
versionId
query parameter in the request. You will need permission for thes3:DeleteObjectVersionTagging
action.The following operations are related to
DeleteBucketMetricsConfiguration
:See
AWSS3DeleteObjectTaggingRequest
See
AWSS3DeleteObjectTaggingOutput
Declaration
Objective-C
- (id)deleteObjectTagging:(nonnull AWSS3DeleteObjectTaggingRequest *)request;
Swift
func deleteObjectTagging(_ request: AWSS3DeleteObjectTaggingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteObjectTagging service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3DeleteObjectTaggingOutput
. -
Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.
To use this operation, you must have permission to perform the
s3:DeleteObjectTagging
action.To delete tags of a specific object version, add the
versionId
query parameter in the request. You will need permission for thes3:DeleteObjectVersionTagging
action.The following operations are related to
DeleteBucketMetricsConfiguration
:See
AWSS3DeleteObjectTaggingRequest
See
AWSS3DeleteObjectTaggingOutput
Declaration
Objective-C
- (void)deleteObjectTagging:(nonnull AWSS3DeleteObjectTaggingRequest *)request completionHandler: (void (^_Nullable)(AWSS3DeleteObjectTaggingOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteObjectTagging(_ request: AWSS3DeleteObjectTaggingRequest) async throws -> AWSS3DeleteObjectTaggingOutput
Parameters
request
A container for the necessary parameters to execute the DeleteObjectTagging service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.
The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body.
When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.
Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.
The following operations are related to
DeleteObjects
:See
AWSS3DeleteObjectsRequest
See
AWSS3DeleteObjectsOutput
Declaration
Objective-C
- (id)deleteObjects:(nonnull AWSS3DeleteObjectsRequest *)request;
Swift
func deleteObjects(_ request: AWSS3DeleteObjectsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteObjects service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3DeleteObjectsOutput
. -
This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.
The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body.
When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.
Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.
The following operations are related to
DeleteObjects
:See
AWSS3DeleteObjectsRequest
See
AWSS3DeleteObjectsOutput
Declaration
Objective-C
- (void)deleteObjects:(nonnull AWSS3DeleteObjectsRequest *)request completionHandler:(void (^_Nullable)(AWSS3DeleteObjectsOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteObjects(_ request: AWSS3DeleteObjectsRequest) async throws -> AWSS3DeleteObjectsOutput
Parameters
request
A container for the necessary parameters to execute the DeleteObjects service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Removes the
PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you must have thes3:PutBucketPublicAccessBlock
permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.The following operations are related to
DeletePublicAccessBlock
:See
AWSS3DeletePublicAccessBlockRequest
Declaration
Objective-C
- (id)deletePublicAccessBlock: (nonnull AWSS3DeletePublicAccessBlockRequest *)request;
Swift
func deletePublicAccessBlock(_ request: AWSS3DeletePublicAccessBlockRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeletePublicAccessBlock service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Removes the
PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you must have thes3:PutBucketPublicAccessBlock
permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.The following operations are related to
DeletePublicAccessBlock
:See
AWSS3DeletePublicAccessBlockRequest
Declaration
Objective-C
- (void)deletePublicAccessBlock: (nonnull AWSS3DeletePublicAccessBlockRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deletePublicAccessBlock(_ request: AWSS3DeletePublicAccessBlockRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeletePublicAccessBlock service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This implementation of the GET operation uses the
accelerate
subresource to return the Transfer Acceleration state of a bucket, which is eitherEnabled
orSuspended
. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.To use this operation, you must have permission to perform the
s3:GetAccelerateConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.You set the Transfer Acceleration state of an existing bucket to
Enabled
orSuspended
by using the PutBucketAccelerateConfiguration operation.A GET
accelerate
request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.For more information about transfer acceleration, see Transfer Acceleration in the Amazon Simple Storage Service Developer Guide.
Related Resources
See
AWSS3GetBucketAccelerateConfigurationRequest
See
AWSS3GetBucketAccelerateConfigurationOutput
Declaration
Objective-C
- (id)getBucketAccelerateConfiguration: (nonnull AWSS3GetBucketAccelerateConfigurationRequest *)request;
Swift
func getBucketAccelerateConfiguration(_ request: AWSS3GetBucketAccelerateConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketAccelerateConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketAccelerateConfigurationOutput
. -
This implementation of the GET operation uses the
accelerate
subresource to return the Transfer Acceleration state of a bucket, which is eitherEnabled
orSuspended
. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.To use this operation, you must have permission to perform the
s3:GetAccelerateConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.You set the Transfer Acceleration state of an existing bucket to
Enabled
orSuspended
by using the PutBucketAccelerateConfiguration operation.A GET
accelerate
request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.For more information about transfer acceleration, see Transfer Acceleration in the Amazon Simple Storage Service Developer Guide.
Related Resources
See
AWSS3GetBucketAccelerateConfigurationRequest
See
AWSS3GetBucketAccelerateConfigurationOutput
Declaration
Objective-C
- (void)getBucketAccelerateConfiguration: (nonnull AWSS3GetBucketAccelerateConfigurationRequest *)request completionHandler: (void (^_Nullable)( AWSS3GetBucketAccelerateConfigurationOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketAccelerateConfiguration(_ request: AWSS3GetBucketAccelerateConfigurationRequest) async throws -> AWSS3GetBucketAccelerateConfigurationOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketAccelerateConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This implementation of the
GET
operation uses theacl
subresource to return the access control list (ACL) of a bucket. To useGET
to return the ACL of the bucket, you must haveREAD_ACP
access to the bucket. IfREAD_ACP
permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.Related Resources
See
AWSS3GetBucketAclRequest
See
AWSS3GetBucketAclOutput
Declaration
Objective-C
- (id)getBucketAcl:(nonnull AWSS3GetBucketAclRequest *)request;
Swift
func getBucketAcl(_ request: AWSS3GetBucketAclRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketAcl service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketAclOutput
. -
This implementation of the
GET
operation uses theacl
subresource to return the access control list (ACL) of a bucket. To useGET
to return the ACL of the bucket, you must haveREAD_ACP
access to the bucket. IfREAD_ACP
permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.Related Resources
See
AWSS3GetBucketAclRequest
See
AWSS3GetBucketAclOutput
Declaration
Objective-C
- (void)getBucketAcl:(nonnull AWSS3GetBucketAclRequest *)request completionHandler:(void (^_Nullable)(AWSS3GetBucketAclOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketAcl(_ request: AWSS3GetBucketAclRequest) async throws -> AWSS3GetBucketAclOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketAcl service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This implementation of the GET operation returns an analytics configuration (identified by the analytics configuration ID) from the bucket.
To use this operation, you must have permissions to perform the
s3:GetAnalyticsConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon Simple Storage Service Developer Guide.
Related Resources
See
AWSS3GetBucketAnalyticsConfigurationRequest
See
AWSS3GetBucketAnalyticsConfigurationOutput
Declaration
Objective-C
- (id)getBucketAnalyticsConfiguration: (nonnull AWSS3GetBucketAnalyticsConfigurationRequest *)request;
Swift
func getBucketAnalyticsConfiguration(_ request: AWSS3GetBucketAnalyticsConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketAnalyticsConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketAnalyticsConfigurationOutput
. -
This implementation of the GET operation returns an analytics configuration (identified by the analytics configuration ID) from the bucket.
To use this operation, you must have permissions to perform the
s3:GetAnalyticsConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon Simple Storage Service Developer Guide.
Related Resources
See
AWSS3GetBucketAnalyticsConfigurationRequest
See
AWSS3GetBucketAnalyticsConfigurationOutput
Declaration
Objective-C
- (void) getBucketAnalyticsConfiguration: (nonnull AWSS3GetBucketAnalyticsConfigurationRequest *)request completionHandler: (void (^_Nullable)( AWSS3GetBucketAnalyticsConfigurationOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketAnalyticsConfiguration(_ request: AWSS3GetBucketAnalyticsConfigurationRequest) async throws -> AWSS3GetBucketAnalyticsConfigurationOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketAnalyticsConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the cors configuration information set for the bucket.
To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.
For more information about cors, see Enabling Cross-Origin Resource Sharing.
The following operations are related to
GetBucketCors
:See
AWSS3GetBucketCorsRequest
See
AWSS3GetBucketCorsOutput
Declaration
Objective-C
- (id)getBucketCors:(nonnull AWSS3GetBucketCorsRequest *)request;
Swift
func getBucketCors(_ request: AWSS3GetBucketCorsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketCors service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketCorsOutput
. -
Returns the cors configuration information set for the bucket.
To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.
For more information about cors, see Enabling Cross-Origin Resource Sharing.
The following operations are related to
GetBucketCors
:See
AWSS3GetBucketCorsRequest
See
AWSS3GetBucketCorsOutput
Declaration
Objective-C
- (void)getBucketCors:(nonnull AWSS3GetBucketCorsRequest *)request completionHandler:(void (^_Nullable)(AWSS3GetBucketCorsOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketCors(_ request: AWSS3GetBucketCorsRequest) async throws -> AWSS3GetBucketCorsOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketCors service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.
To use this operation, you must have permission to perform the
s3:GetEncryptionConfiguration
action. The 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.The following operations are related to
GetBucketEncryption
:See
AWSS3GetBucketEncryptionRequest
See
AWSS3GetBucketEncryptionOutput
Declaration
Objective-C
- (id)getBucketEncryption:(nonnull AWSS3GetBucketEncryptionRequest *)request;
Swift
func getBucketEncryption(_ request: AWSS3GetBucketEncryptionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketEncryption service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketEncryptionOutput
. -
Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.
To use this operation, you must have permission to perform the
s3:GetEncryptionConfiguration
action. The 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.The following operations are related to
GetBucketEncryption
:See
AWSS3GetBucketEncryptionRequest
See
AWSS3GetBucketEncryptionOutput
Declaration
Objective-C
- (void)getBucketEncryption:(nonnull AWSS3GetBucketEncryptionRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetBucketEncryptionOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketEncryption(_ request: AWSS3GetBucketEncryptionRequest) async throws -> AWSS3GetBucketEncryptionOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketEncryption service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
To use this operation, you must have permissions to perform the
s3:GetInventoryConfiguration
action. The 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.For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
The following operations are related to
GetBucketInventoryConfiguration
:See
AWSS3GetBucketInventoryConfigurationRequest
See
AWSS3GetBucketInventoryConfigurationOutput
Declaration
Objective-C
- (id)getBucketInventoryConfiguration: (nonnull AWSS3GetBucketInventoryConfigurationRequest *)request;
Swift
func getBucketInventoryConfiguration(_ request: AWSS3GetBucketInventoryConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketInventoryConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketInventoryConfigurationOutput
. -
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
To use this operation, you must have permissions to perform the
s3:GetInventoryConfiguration
action. The 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.For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
The following operations are related to
GetBucketInventoryConfiguration
:See
AWSS3GetBucketInventoryConfigurationRequest
See
AWSS3GetBucketInventoryConfigurationOutput
Declaration
Objective-C
- (void) getBucketInventoryConfiguration: (nonnull AWSS3GetBucketInventoryConfigurationRequest *)request completionHandler: (void (^_Nullable)( AWSS3GetBucketInventoryConfigurationOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketInventoryConfiguration(_ request: AWSS3GetBucketInventoryConfigurationRequest) async throws -> AWSS3GetBucketInventoryConfigurationOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketInventoryConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the
filter
element, you should see the updated version of this topic. This topic is provided for backward compatibility.Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the
s3:GetLifecycleConfiguration
action. The 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.GetBucketLifecycle
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 operations are related to
GetBucketLifecycle
:See
AWSS3GetBucketLifecycleRequest
See
AWSS3GetBucketLifecycleOutput
Declaration
Objective-C
- (id)getBucketLifecycle:(nonnull AWSS3GetBucketLifecycleRequest *)request;
Swift
func getBucketLifecycle(_ request: AWSS3GetBucketLifecycleRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketLifecycle service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketLifecycleOutput
. -
For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the
filter
element, you should see the updated version of this topic. This topic is provided for backward compatibility.Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the
s3:GetLifecycleConfiguration
action. The 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.GetBucketLifecycle
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 operations are related to
GetBucketLifecycle
:See
AWSS3GetBucketLifecycleRequest
See
AWSS3GetBucketLifecycleOutput
Declaration
Objective-C
- (void)getBucketLifecycle:(nonnull AWSS3GetBucketLifecycleRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetBucketLifecycleOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketLifecycle(_ request: AWSS3GetBucketLifecycleRequest) async throws -> AWSS3GetBucketLifecycleOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketLifecycle service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier API description, see GetBucketLifecycle.
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the
s3:GetLifecycleConfiguration
action. The 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.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 operations are related to
GetBucketLifecycleConfiguration
:See
AWSS3GetBucketLifecycleConfigurationRequest
See
AWSS3GetBucketLifecycleConfigurationOutput
Declaration
Objective-C
- (id)getBucketLifecycleConfiguration: (nonnull AWSS3GetBucketLifecycleConfigurationRequest *)request;
Swift
func getBucketLifecycleConfiguration(_ request: AWSS3GetBucketLifecycleConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketLifecycleConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketLifecycleConfigurationOutput
. -
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier API description, see GetBucketLifecycle.
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the
s3:GetLifecycleConfiguration
action. The 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.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 operations are related to
GetBucketLifecycleConfiguration
:See
AWSS3GetBucketLifecycleConfigurationRequest
See
AWSS3GetBucketLifecycleConfigurationOutput
Declaration
Objective-C
- (void) getBucketLifecycleConfiguration: (nonnull AWSS3GetBucketLifecycleConfigurationRequest *)request completionHandler: (void (^_Nullable)( AWSS3GetBucketLifecycleConfigurationOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketLifecycleConfiguration(_ request: AWSS3GetBucketLifecycleConfigurationRequest) async throws -> AWSS3GetBucketLifecycleConfigurationOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketLifecycleConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the Region the bucket resides in. You set the bucket’s Region using the
LocationConstraint
request parameter in aCreateBucket
request. For more information, see CreateBucket.To use this implementation of the operation, you must be the bucket owner.
The following operations are related to
GetBucketLocation
:See
AWSS3GetBucketLocationRequest
See
AWSS3GetBucketLocationOutput
Declaration
Objective-C
- (id)getBucketLocation:(nonnull AWSS3GetBucketLocationRequest *)request;
Swift
func getBucketLocation(_ request: AWSS3GetBucketLocationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketLocation service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketLocationOutput
. -
Returns the Region the bucket resides in. You set the bucket’s Region using the
LocationConstraint
request parameter in aCreateBucket
request. For more information, see CreateBucket.To use this implementation of the operation, you must be the bucket owner.
The following operations are related to
GetBucketLocation
:See
AWSS3GetBucketLocationRequest
See
AWSS3GetBucketLocationOutput
Declaration
Objective-C
- (void)getBucketLocation:(nonnull AWSS3GetBucketLocationRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetBucketLocationOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketLocation(_ request: AWSS3GetBucketLocationRequest) async throws -> AWSS3GetBucketLocationOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketLocation service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.
The following operations are related to
GetBucketLogging
:See
AWSS3GetBucketLoggingRequest
See
AWSS3GetBucketLoggingOutput
Declaration
Objective-C
- (id)getBucketLogging:(nonnull AWSS3GetBucketLoggingRequest *)request;
Swift
func getBucketLogging(_ request: AWSS3GetBucketLoggingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketLogging service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketLoggingOutput
. -
Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.
The following operations are related to
GetBucketLogging
:See
AWSS3GetBucketLoggingRequest
See
AWSS3GetBucketLoggingOutput
Declaration
Objective-C
- (void)getBucketLogging:(nonnull AWSS3GetBucketLoggingRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetBucketLoggingOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketLogging(_ request: AWSS3GetBucketLoggingRequest) async throws -> AWSS3GetBucketLoggingOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketLogging service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn’t include the daily storage metrics.
To use this operation, you must have permissions to perform the
s3:GetMetricsConfiguration
action. The 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.For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to
GetBucketMetricsConfiguration
:See
AWSS3GetBucketMetricsConfigurationRequest
See
AWSS3GetBucketMetricsConfigurationOutput
Declaration
Objective-C
- (id)getBucketMetricsConfiguration: (nonnull AWSS3GetBucketMetricsConfigurationRequest *)request;
Swift
func getBucketMetricsConfiguration(_ request: AWSS3GetBucketMetricsConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketMetricsConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketMetricsConfigurationOutput
. -
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn’t include the daily storage metrics.
To use this operation, you must have permissions to perform the
s3:GetMetricsConfiguration
action. The 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.For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to
GetBucketMetricsConfiguration
:See
AWSS3GetBucketMetricsConfigurationRequest
See
AWSS3GetBucketMetricsConfigurationOutput
Declaration
Objective-C
- (void)getBucketMetricsConfiguration: (nonnull AWSS3GetBucketMetricsConfigurationRequest *)request completionHandler: (void (^_Nullable)( AWSS3GetBucketMetricsConfigurationOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketMetricsConfiguration(_ request: AWSS3GetBucketMetricsConfigurationRequest) async throws -> AWSS3GetBucketMetricsConfigurationOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketMetricsConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
No longer used, see GetBucketNotificationConfiguration.
See
AWSS3GetBucketNotificationConfigurationRequest
See
AWSS3NotificationConfigurationDeprecated
Declaration
Objective-C
- (id)getBucketNotification: (nonnull AWSS3GetBucketNotificationConfigurationRequest *)request;
Swift
func getBucketNotification(_ request: AWSS3GetBucketNotificationConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketNotification service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3NotificationConfigurationDeprecated
. -
No longer used, see GetBucketNotificationConfiguration.
See
AWSS3GetBucketNotificationConfigurationRequest
See
AWSS3NotificationConfigurationDeprecated
Declaration
Objective-C
- (void)getBucketNotification: (nonnull AWSS3GetBucketNotificationConfigurationRequest *)request completionHandler: (void (^_Nullable)( AWSS3NotificationConfigurationDeprecated *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketNotification(_ request: AWSS3GetBucketNotificationConfigurationRequest) async throws -> AWSS3NotificationConfigurationDeprecated
Parameters
request
A container for the necessary parameters to execute the GetBucketNotification service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the notification configuration of a bucket.
If notifications are not enabled on the bucket, the operation returns an empty
NotificationConfiguration
element.By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the
s3:GetBucketNotification
permission.For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.
The following operation is related to
GetBucketNotification
:See
AWSS3GetBucketNotificationConfigurationRequest
See
AWSS3NotificationConfiguration
Declaration
Objective-C
- (id)getBucketNotificationConfiguration: (nonnull AWSS3GetBucketNotificationConfigurationRequest *)request;
Swift
func getBucketNotificationConfiguration(_ request: AWSS3GetBucketNotificationConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketNotificationConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3NotificationConfiguration
. -
Returns the notification configuration of a bucket.
If notifications are not enabled on the bucket, the operation returns an empty
NotificationConfiguration
element.By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the
s3:GetBucketNotification
permission.For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.
The following operation is related to
GetBucketNotification
:See
AWSS3GetBucketNotificationConfigurationRequest
See
AWSS3NotificationConfiguration
Declaration
Objective-C
- (void)getBucketNotificationConfiguration: (nonnull AWSS3GetBucketNotificationConfigurationRequest *)request completionHandler: (void (^_Nullable)( AWSS3NotificationConfiguration *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketNotificationConfiguration(_ request: AWSS3GetBucketNotificationConfigurationRequest) async throws -> AWSS3NotificationConfiguration
Parameters
request
A container for the necessary parameters to execute the GetBucketNotificationConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Retrieves
OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have thes3:GetBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to
GetBucketOwnershipControls
:See
AWSS3GetBucketOwnershipControlsRequest
See
AWSS3GetBucketOwnershipControlsOutput
Declaration
Objective-C
- (id)getBucketOwnershipControls: (nonnull AWSS3GetBucketOwnershipControlsRequest *)request;
Swift
func getBucketOwnershipControls(_ request: AWSS3GetBucketOwnershipControlsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketOwnershipControls service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketOwnershipControlsOutput
. -
Retrieves
OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have thes3:GetBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to
GetBucketOwnershipControls
:See
AWSS3GetBucketOwnershipControlsRequest
See
AWSS3GetBucketOwnershipControlsOutput
Declaration
Objective-C
- (void)getBucketOwnershipControls: (nonnull AWSS3GetBucketOwnershipControlsRequest *)request completionHandler: (void (^_Nullable)( AWSS3GetBucketOwnershipControlsOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketOwnershipControls(_ request: AWSS3GetBucketOwnershipControlsRequest) async throws -> AWSS3GetBucketOwnershipControlsOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketOwnershipControls service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the policy of a specified 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
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
GetBucketPolicy
permissions, Amazon S3 returns a403 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 a405 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.
The following operation is related to
GetBucketPolicy
:See
AWSS3GetBucketPolicyRequest
See
AWSS3GetBucketPolicyOutput
Declaration
Objective-C
- (id)getBucketPolicy:(nonnull AWSS3GetBucketPolicyRequest *)request;
Swift
func getBucketPolicy(_ request: AWSS3GetBucketPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketPolicyOutput
. -
Returns the policy of a specified 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
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
GetBucketPolicy
permissions, Amazon S3 returns a403 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 a405 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.
The following operation is related to
GetBucketPolicy
:See
AWSS3GetBucketPolicyRequest
See
AWSS3GetBucketPolicyOutput
Declaration
Objective-C
- (void)getBucketPolicy:(nonnull AWSS3GetBucketPolicyRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetBucketPolicyOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketPolicy(_ request: AWSS3GetBucketPolicyRequest) async throws -> AWSS3GetBucketPolicyOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the
s3:GetBucketPolicyStatus
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.For more information about when Amazon S3 considers a bucket public, see The Meaning of “Public”.
The following operations are related to
GetBucketPolicyStatus
:See
AWSS3GetBucketPolicyStatusRequest
See
AWSS3GetBucketPolicyStatusOutput
Declaration
Objective-C
- (id)getBucketPolicyStatus: (nonnull AWSS3GetBucketPolicyStatusRequest *)request;
Swift
func getBucketPolicyStatus(_ request: AWSS3GetBucketPolicyStatusRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketPolicyStatus service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketPolicyStatusOutput
. -
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the
s3:GetBucketPolicyStatus
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.For more information about when Amazon S3 considers a bucket public, see The Meaning of “Public”.
The following operations are related to
GetBucketPolicyStatus
:See
AWSS3GetBucketPolicyStatusRequest
See
AWSS3GetBucketPolicyStatusOutput
Declaration
Objective-C
- (void)getBucketPolicyStatus: (nonnull AWSS3GetBucketPolicyStatusRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetBucketPolicyStatusOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketPolicyStatus(_ request: AWSS3GetBucketPolicyStatusRequest) async throws -> AWSS3GetBucketPolicyStatusOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketPolicyStatus service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the replication configuration of a bucket.
It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.
For information about replication configuration, see Replication in the Amazon Simple Storage Service Developer Guide.
This operation requires permissions for the
s3:GetReplicationConfiguration
action. For more information about permissions, see Using Bucket Policies and User Policies.If you include the
Filter
element in a replication configuration, you must also include theDeleteMarkerReplication
andPriority
elements. The response also returns those elements.For information about
GetBucketReplication
errors, see List of replication-related error codesThe following operations are related to
GetBucketReplication
:See
AWSS3GetBucketReplicationRequest
See
AWSS3GetBucketReplicationOutput
Declaration
Objective-C
- (id)getBucketReplication:(nonnull AWSS3GetBucketReplicationRequest *)request;
Swift
func getBucketReplication(_ request: AWSS3GetBucketReplicationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketReplication service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketReplicationOutput
. -
Returns the replication configuration of a bucket.
It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.
For information about replication configuration, see Replication in the Amazon Simple Storage Service Developer Guide.
This operation requires permissions for the
s3:GetReplicationConfiguration
action. For more information about permissions, see Using Bucket Policies and User Policies.If you include the
Filter
element in a replication configuration, you must also include theDeleteMarkerReplication
andPriority
elements. The response also returns those elements.For information about
GetBucketReplication
errors, see List of replication-related error codesThe following operations are related to
GetBucketReplication
:See
AWSS3GetBucketReplicationRequest
See
AWSS3GetBucketReplicationOutput
Declaration
Objective-C
- (void)getBucketReplication:(nonnull AWSS3GetBucketReplicationRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetBucketReplicationOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketReplication(_ request: AWSS3GetBucketReplicationRequest) async throws -> AWSS3GetBucketReplicationOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketReplication service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.
The following operations are related to
GetBucketRequestPayment
:See
AWSS3GetBucketRequestPaymentRequest
See
AWSS3GetBucketRequestPaymentOutput
Declaration
Objective-C
- (id)getBucketRequestPayment: (nonnull AWSS3GetBucketRequestPaymentRequest *)request;
Swift
func getBucketRequestPayment(_ request: AWSS3GetBucketRequestPaymentRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketRequestPayment service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketRequestPaymentOutput
. -
Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.
The following operations are related to
GetBucketRequestPayment
:See
AWSS3GetBucketRequestPaymentRequest
See
AWSS3GetBucketRequestPaymentOutput
Declaration
Objective-C
- (void) getBucketRequestPayment: (nonnull AWSS3GetBucketRequestPaymentRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetBucketRequestPaymentOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketRequestPayment(_ request: AWSS3GetBucketRequestPaymentRequest) async throws -> AWSS3GetBucketRequestPaymentOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketRequestPayment service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the tag set associated with the bucket.
To use this operation, you must have permission to perform the
s3: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.
The following operations are related to
GetBucketTagging
:See
AWSS3GetBucketTaggingRequest
See
AWSS3GetBucketTaggingOutput
Declaration
Objective-C
- (id)getBucketTagging:(nonnull AWSS3GetBucketTaggingRequest *)request;
Swift
func getBucketTagging(_ request: AWSS3GetBucketTaggingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketTagging service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketTaggingOutput
. -
Returns the tag set associated with the bucket.
To use this operation, you must have permission to perform the
s3: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.
The following operations are related to
GetBucketTagging
:See
AWSS3GetBucketTaggingRequest
See
AWSS3GetBucketTaggingOutput
Declaration
Objective-C
- (void)getBucketTagging:(nonnull AWSS3GetBucketTaggingRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetBucketTaggingOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketTagging(_ request: AWSS3GetBucketTaggingRequest) async throws -> AWSS3GetBucketTaggingOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketTagging service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the versioning state of a bucket.
To retrieve the versioning state of a bucket, you must be the bucket owner.
This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is
enabled
, the bucket owner must use an authentication device to change the versioning state of the bucket.The following operations are related to
GetBucketVersioning
:See
AWSS3GetBucketVersioningRequest
See
AWSS3GetBucketVersioningOutput
Declaration
Objective-C
- (id)getBucketVersioning:(nonnull AWSS3GetBucketVersioningRequest *)request;
Swift
func getBucketVersioning(_ request: AWSS3GetBucketVersioningRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketVersioning service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketVersioningOutput
. -
Returns the versioning state of a bucket.
To retrieve the versioning state of a bucket, you must be the bucket owner.
This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is
enabled
, the bucket owner must use an authentication device to change the versioning state of the bucket.The following operations are related to
GetBucketVersioning
:See
AWSS3GetBucketVersioningRequest
See
AWSS3GetBucketVersioningOutput
Declaration
Objective-C
- (void)getBucketVersioning:(nonnull AWSS3GetBucketVersioningRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetBucketVersioningOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketVersioning(_ request: AWSS3GetBucketVersioningRequest) async throws -> AWSS3GetBucketVersioningOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketVersioning service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.
This GET operation requires the
S3:GetBucketWebsite
permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them theS3:GetBucketWebsite
permission.The following operations are related to
DeleteBucketWebsite
:See
AWSS3GetBucketWebsiteRequest
See
AWSS3GetBucketWebsiteOutput
Declaration
Objective-C
- (id)getBucketWebsite:(nonnull AWSS3GetBucketWebsiteRequest *)request;
Swift
func getBucketWebsite(_ request: AWSS3GetBucketWebsiteRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBucketWebsite service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetBucketWebsiteOutput
. -
Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.
This GET operation requires the
S3:GetBucketWebsite
permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them theS3:GetBucketWebsite
permission.The following operations are related to
DeleteBucketWebsite
:See
AWSS3GetBucketWebsiteRequest
See
AWSS3GetBucketWebsiteOutput
Declaration
Objective-C
- (void)getBucketWebsite:(nonnull AWSS3GetBucketWebsiteRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetBucketWebsiteOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bucketWebsite(_ request: AWSS3GetBucketWebsiteRequest) async throws -> AWSS3GetBucketWebsiteOutput
Parameters
request
A container for the necessary parameters to execute the GetBucketWebsite service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Retrieves objects from Amazon S3. To use
GET
, you must haveREAD
access to the object. If you grantREAD
access to the anonymous user, you can return the object without using an authorization header.An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object
sample.jpg
, you can name itphotos/2006/February/sample.jpg
.To get an object from such a logical hierarchy, specify the full key name for the object in the
GET
operation. For a virtual hosted-style request example, if you have the objectphotos/2006/February/sample.jpg
, specify the resource as/photos/2006/February/sample.jpg
. For a path-style request example, if you have the objectphotos/2006/February/sample.jpg
in the bucket namedexamplebucket
, specify the resource as/examplebucket/photos/2006/February/sample.jpg
. For more information about request types, see HTTP Host Header Bucket Specification.To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an
InvalidObjectStateError
error. For information about restoring archived objects, see Restoring Archived Objects.Encryption request headers, like
x-amz-server-side-encryption
, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Assuming you have permission to read object tags (permission for the
s3:GetObjectVersionTagging
action), the response also returns thex-amz-tagging-count
header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.Permissions
You need the
s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have thes3:ListBucket
permission.If you have the
s3:ListBucket
permission on the bucket, Amazon S3 will return an HTTP status code 404 (“no such key”) error.If you don’t have the
s3:ListBucket
permission, Amazon S3 will return an HTTP status code 403 (“access denied”) error.
Versioning
By default, the GET operation returns the current version of an object. To return a different version, use the
versionId
subresource.If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes
x-amz-delete-marker: true
in the response.For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are
Content-Type
,Content-Language
,Expires
,Cache-Control
,Content-Disposition
, andContent-Encoding
. To override these header values in the GET response, you use the following request parameters.You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding
Additional Considerations about Request Headers
If both of the
If-Match
andIf-Unmodified-Since
headers are present in the request as follows:If-Match
condition evaluates totrue
, and;If-Unmodified-Since
condition evaluates tofalse
; then, S3 returns 200 OK and the data requested.If both of the
If-None-Match
andIf-Modified-Since
headers are present in the request as follows:If-None-Match
condition evaluates tofalse
, and;If-Modified-Since
condition evaluates totrue
; then, S3 returns 304 Not Modified response code.For more information about conditional requests, see RFC 7232.
The following operations are related to
GetObject
:See
AWSS3GetObjectRequest
See
AWSS3GetObjectOutput
Declaration
Objective-C
- (id)getObject:(nonnull AWSS3GetObjectRequest *)request;
Swift
func getObject(_ request: AWSS3GetObjectRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetObject service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetObjectOutput
. On failed execution,task.error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchKey
. -
Retrieves objects from Amazon S3. To use
GET
, you must haveREAD
access to the object. If you grantREAD
access to the anonymous user, you can return the object without using an authorization header.An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object
sample.jpg
, you can name itphotos/2006/February/sample.jpg
.To get an object from such a logical hierarchy, specify the full key name for the object in the
GET
operation. For a virtual hosted-style request example, if you have the objectphotos/2006/February/sample.jpg
, specify the resource as/photos/2006/February/sample.jpg
. For a path-style request example, if you have the objectphotos/2006/February/sample.jpg
in the bucket namedexamplebucket
, specify the resource as/examplebucket/photos/2006/February/sample.jpg
. For more information about request types, see HTTP Host Header Bucket Specification.To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an
InvalidObjectStateError
error. For information about restoring archived objects, see Restoring Archived Objects.Encryption request headers, like
x-amz-server-side-encryption
, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Assuming you have permission to read object tags (permission for the
s3:GetObjectVersionTagging
action), the response also returns thex-amz-tagging-count
header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.Permissions
You need the
s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have thes3:ListBucket
permission.If you have the
s3:ListBucket
permission on the bucket, Amazon S3 will return an HTTP status code 404 (“no such key”) error.If you don’t have the
s3:ListBucket
permission, Amazon S3 will return an HTTP status code 403 (“access denied”) error.
Versioning
By default, the GET operation returns the current version of an object. To return a different version, use the
versionId
subresource.If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes
x-amz-delete-marker: true
in the response.For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are
Content-Type
,Content-Language
,Expires
,Cache-Control
,Content-Disposition
, andContent-Encoding
. To override these header values in the GET response, you use the following request parameters.You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding
Additional Considerations about Request Headers
If both of the
If-Match
andIf-Unmodified-Since
headers are present in the request as follows:If-Match
condition evaluates totrue
, and;If-Unmodified-Since
condition evaluates tofalse
; then, S3 returns 200 OK and the data requested.If both of the
If-None-Match
andIf-Modified-Since
headers are present in the request as follows:If-None-Match
condition evaluates tofalse
, and;If-Modified-Since
condition evaluates totrue
; then, S3 returns 304 Not Modified response code.For more information about conditional requests, see RFC 7232.
The following operations are related to
GetObject
:See
AWSS3GetObjectRequest
See
AWSS3GetObjectOutput
Declaration
Objective-C
- (void)getObject:(nonnull AWSS3GetObjectRequest *)request completionHandler:(void (^_Nullable)(AWSS3GetObjectOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func object(_ request: AWSS3GetObjectRequest) async throws -> AWSS3GetObjectOutput
Parameters
request
A container for the necessary parameters to execute the GetObject service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchKey
. -
Returns the access control list (ACL) of an object. To use this operation, you must have
READ_ACP
access to the object.This action is not supported by Amazon S3 on Outposts.
Versioning
By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.
The following operations are related to
GetObjectAcl
:See
AWSS3GetObjectAclRequest
See
AWSS3GetObjectAclOutput
Declaration
Objective-C
- (id)getObjectAcl:(nonnull AWSS3GetObjectAclRequest *)request;
Swift
func getObjectAcl(_ request: AWSS3GetObjectAclRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetObjectAcl service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetObjectAclOutput
. On failed execution,task.error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchKey
. -
Returns the access control list (ACL) of an object. To use this operation, you must have
READ_ACP
access to the object.This action is not supported by Amazon S3 on Outposts.
Versioning
By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.
The following operations are related to
GetObjectAcl
:See
AWSS3GetObjectAclRequest
See
AWSS3GetObjectAclOutput
Declaration
Objective-C
- (void)getObjectAcl:(nonnull AWSS3GetObjectAclRequest *)request completionHandler:(void (^_Nullable)(AWSS3GetObjectAclOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func objectAcl(_ request: AWSS3GetObjectAclRequest) async throws -> AWSS3GetObjectAclOutput
Parameters
request
A container for the necessary parameters to execute the GetObjectAcl service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchKey
. -
Gets an object’s current Legal Hold status. For more information, see Locking Objects.
This action is not supported by Amazon S3 on Outposts.
See
AWSS3GetObjectLegalHoldRequest
See
AWSS3GetObjectLegalHoldOutput
Declaration
Objective-C
- (id)getObjectLegalHold:(nonnull AWSS3GetObjectLegalHoldRequest *)request;
Swift
func getObjectLegalHold(_ request: AWSS3GetObjectLegalHoldRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetObjectLegalHold service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetObjectLegalHoldOutput
. -
Gets an object’s current Legal Hold status. For more information, see Locking Objects.
This action is not supported by Amazon S3 on Outposts.
See
AWSS3GetObjectLegalHoldRequest
See
AWSS3GetObjectLegalHoldOutput
Declaration
Objective-C
- (void)getObjectLegalHold:(nonnull AWSS3GetObjectLegalHoldRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetObjectLegalHoldOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func objectLegalHold(_ request: AWSS3GetObjectLegalHoldRequest) async throws -> AWSS3GetObjectLegalHoldOutput
Parameters
request
A container for the necessary parameters to execute the GetObjectLegalHold service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
See
AWSS3GetObjectLockConfigurationRequest
See
AWSS3GetObjectLockConfigurationOutput
Declaration
Objective-C
- (id)getObjectLockConfiguration: (nonnull AWSS3GetObjectLockConfigurationRequest *)request;
Swift
func getObjectLockConfiguration(_ request: AWSS3GetObjectLockConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetObjectLockConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetObjectLockConfigurationOutput
. -
Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
See
AWSS3GetObjectLockConfigurationRequest
See
AWSS3GetObjectLockConfigurationOutput
Declaration
Objective-C
- (void)getObjectLockConfiguration: (nonnull AWSS3GetObjectLockConfigurationRequest *)request completionHandler: (void (^_Nullable)( AWSS3GetObjectLockConfigurationOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func objectLockConfiguration(_ request: AWSS3GetObjectLockConfigurationRequest) async throws -> AWSS3GetObjectLockConfigurationOutput
Parameters
request
A container for the necessary parameters to execute the GetObjectLockConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Retrieves an object’s retention settings. For more information, see Locking Objects.
This action is not supported by Amazon S3 on Outposts.
See
AWSS3GetObjectRetentionRequest
See
AWSS3GetObjectRetentionOutput
Declaration
Objective-C
- (id)getObjectRetention:(nonnull AWSS3GetObjectRetentionRequest *)request;
Swift
func getObjectRetention(_ request: AWSS3GetObjectRetentionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetObjectRetention service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetObjectRetentionOutput
. -
Retrieves an object’s retention settings. For more information, see Locking Objects.
This action is not supported by Amazon S3 on Outposts.
See
AWSS3GetObjectRetentionRequest
See
AWSS3GetObjectRetentionOutput
Declaration
Objective-C
- (void)getObjectRetention:(nonnull AWSS3GetObjectRetentionRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetObjectRetentionOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func objectRetention(_ request: AWSS3GetObjectRetentionRequest) async throws -> AWSS3GetObjectRetentionOutput
Parameters
request
A container for the necessary parameters to execute the GetObjectRetention service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.
To use this operation, you must have permission to perform the
s3:GetObjectTagging
action. By default, the GET operation returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for thes3:GetObjectVersionTagging
action.By default, the bucket owner has this permission and can grant this permission to others.
For information about the Amazon S3 object tagging feature, see Object Tagging.
The following operation is related to
GetObjectTagging
:See
AWSS3GetObjectTaggingRequest
See
AWSS3GetObjectTaggingOutput
Declaration
Objective-C
- (id)getObjectTagging:(nonnull AWSS3GetObjectTaggingRequest *)request;
Swift
func getObjectTagging(_ request: AWSS3GetObjectTaggingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetObjectTagging service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetObjectTaggingOutput
. -
Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.
To use this operation, you must have permission to perform the
s3:GetObjectTagging
action. By default, the GET operation returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for thes3:GetObjectVersionTagging
action.By default, the bucket owner has this permission and can grant this permission to others.
For information about the Amazon S3 object tagging feature, see Object Tagging.
The following operation is related to
GetObjectTagging
:See
AWSS3GetObjectTaggingRequest
See
AWSS3GetObjectTaggingOutput
Declaration
Objective-C
- (void)getObjectTagging:(nonnull AWSS3GetObjectTaggingRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetObjectTaggingOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func objectTagging(_ request: AWSS3GetObjectTaggingRequest) async throws -> AWSS3GetObjectTaggingOutput
Parameters
request
A container for the necessary parameters to execute the GetObjectTagging service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns torrent files from a bucket. BitTorrent can save you bandwidth when you’re distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.
You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.
To use GET, you must have READ access to the object.
This action is not supported by Amazon S3 on Outposts.
The following operation is related to
GetObjectTorrent
:See
AWSS3GetObjectTorrentRequest
See
AWSS3GetObjectTorrentOutput
Declaration
Objective-C
- (id)getObjectTorrent:(nonnull AWSS3GetObjectTorrentRequest *)request;
Swift
func getObjectTorrent(_ request: AWSS3GetObjectTorrentRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetObjectTorrent service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetObjectTorrentOutput
. -
Returns torrent files from a bucket. BitTorrent can save you bandwidth when you’re distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.
You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.
To use GET, you must have READ access to the object.
This action is not supported by Amazon S3 on Outposts.
The following operation is related to
GetObjectTorrent
:See
AWSS3GetObjectTorrentRequest
See
AWSS3GetObjectTorrentOutput
Declaration
Objective-C
- (void)getObjectTorrent:(nonnull AWSS3GetObjectTorrentRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetObjectTorrentOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func objectTorrent(_ request: AWSS3GetObjectTorrentRequest) async throws -> AWSS3GetObjectTorrentOutput
Parameters
request
A container for the necessary parameters to execute the GetObjectTorrent service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Retrieves the
PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you must have thes3:GetBucketPublicAccessBlock
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.When Amazon S3 evaluates the
PublicAccessBlock
configuration for a bucket or an object, it checks thePublicAccessBlock
configuration for both the bucket (or the bucket that contains the object) and the bucket owner’s account. If thePublicAccessBlock
settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of “Public”.
The following operations are related to
GetPublicAccessBlock
:See
AWSS3GetPublicAccessBlockRequest
See
AWSS3GetPublicAccessBlockOutput
Declaration
Objective-C
- (id)getPublicAccessBlock:(nonnull AWSS3GetPublicAccessBlockRequest *)request;
Swift
func getPublicAccessBlock(_ request: AWSS3GetPublicAccessBlockRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetPublicAccessBlock service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3GetPublicAccessBlockOutput
. -
Retrieves the
PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you must have thes3:GetBucketPublicAccessBlock
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.When Amazon S3 evaluates the
PublicAccessBlock
configuration for a bucket or an object, it checks thePublicAccessBlock
configuration for both the bucket (or the bucket that contains the object) and the bucket owner’s account. If thePublicAccessBlock
settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of “Public”.
The following operations are related to
GetPublicAccessBlock
:See
AWSS3GetPublicAccessBlockRequest
See
AWSS3GetPublicAccessBlockOutput
Declaration
Objective-C
- (void)getPublicAccessBlock:(nonnull AWSS3GetPublicAccessBlockRequest *)request completionHandler: (void (^_Nullable)(AWSS3GetPublicAccessBlockOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func publicAccessBlock(_ request: AWSS3GetPublicAccessBlockRequest) async throws -> AWSS3GetPublicAccessBlockOutput
Parameters
request
A container for the necessary parameters to execute the GetPublicAccessBlock service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This operation is useful to determine if a bucket exists and you have permission to access it. The operation returns a
200 OK
if the bucket exists and you have permission to access it. Otherwise, the operation might return responses such as404 Not Found
and403 Forbidden
.To use this operation, you must have permissions to perform the
s3:ListBucket
action. The 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.See
AWSS3HeadBucketRequest
Declaration
Objective-C
- (id)headBucket:(nonnull AWSS3HeadBucketRequest *)request;
Swift
func headBucket(_ request: AWSS3HeadBucketRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the HeadBucket service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchBucket
. -
This operation is useful to determine if a bucket exists and you have permission to access it. The operation returns a
200 OK
if the bucket exists and you have permission to access it. Otherwise, the operation might return responses such as404 Not Found
and403 Forbidden
.To use this operation, you must have permissions to perform the
s3:ListBucket
action. The 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.See
AWSS3HeadBucketRequest
Declaration
Objective-C
- (void)headBucket:(nonnull AWSS3HeadBucketRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func headBucket(_ request: AWSS3HeadBucketRequest) async throws
Parameters
request
A container for the necessary parameters to execute the HeadBucket service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchBucket
. -
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you’re only interested in an object’s metadata. To use HEAD, you must have READ access to the object.
A
HEAD
request has the same options as aGET
operation on an object. The response is identical to theGET
response except that there is no response body.If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Encryption request headers, like
x-amz-server-side-encryption
, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
Consider the following when using request headers:
Consideration 1 – If both of the
If-Match
andIf-Unmodified-Since
headers are present in the request as follows:If-Match
condition evaluates totrue
, and;If-Unmodified-Since
condition evaluates tofalse
;
Then Amazon S3 returns
200 OK
and the data requested.Consideration 2 – If both of the
If-None-Match
andIf-Modified-Since
headers are present in the request as follows:If-None-Match
condition evaluates tofalse
, and;If-Modified-Since
condition evaluates totrue
;
Then Amazon S3 returns the
304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
Permissions
You need the
s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.If you have the
s3:ListBucket
permission on the bucket, Amazon S3 returns an HTTP status code 404 (“no such key”) error.If you don’t have the
s3:ListBucket
permission, Amazon S3 returns an HTTP status code 403 (“access denied”) error.
The following operation is related to
HeadObject
:See
AWSS3HeadObjectRequest
See
AWSS3HeadObjectOutput
Declaration
Objective-C
- (id)headObject:(nonnull AWSS3HeadObjectRequest *)request;
Swift
func headObject(_ request: AWSS3HeadObjectRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the HeadObject service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3HeadObjectOutput
. On failed execution,task.error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchKey
. -
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you’re only interested in an object’s metadata. To use HEAD, you must have READ access to the object.
A
HEAD
request has the same options as aGET
operation on an object. The response is identical to theGET
response except that there is no response body.If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Encryption request headers, like
x-amz-server-side-encryption
, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
Consider the following when using request headers:
Consideration 1 – If both of the
If-Match
andIf-Unmodified-Since
headers are present in the request as follows:If-Match
condition evaluates totrue
, and;If-Unmodified-Since
condition evaluates tofalse
;
Then Amazon S3 returns
200 OK
and the data requested.Consideration 2 – If both of the
If-None-Match
andIf-Modified-Since
headers are present in the request as follows:If-None-Match
condition evaluates tofalse
, and;If-Modified-Since
condition evaluates totrue
;
Then Amazon S3 returns the
304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
Permissions
You need the
s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.If you have the
s3:ListBucket
permission on the bucket, Amazon S3 returns an HTTP status code 404 (“no such key”) error.If you don’t have the
s3:ListBucket
permission, Amazon S3 returns an HTTP status code 403 (“access denied”) error.
The following operation is related to
HeadObject
:See
AWSS3HeadObjectRequest
See
AWSS3HeadObjectOutput
Declaration
Objective-C
- (void)headObject:(nonnull AWSS3HeadObjectRequest *)request completionHandler:(void (^_Nullable)(AWSS3HeadObjectOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func headObject(_ request: AWSS3HeadObjectRequest) async throws -> AWSS3HeadObjectOutput
Parameters
request
A container for the necessary parameters to execute the HeadObject service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchKey
. -
Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. You should always check the
IsTruncated
element in the response. If there are no more configurations to list,IsTruncated
is set to false. If there are more configurations to list,IsTruncated
is set to true, and there will be a value inNextContinuationToken
. You use theNextContinuationToken
value to continue the pagination of the list by passing the value in continuation-token in the request toGET
the next page.To use this operation, you must have permissions to perform the
s3:GetAnalyticsConfiguration
action. The 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.For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to
ListBucketAnalyticsConfigurations
:See
AWSS3ListBucketAnalyticsConfigurationsRequest
See
AWSS3ListBucketAnalyticsConfigurationsOutput
Declaration
Objective-C
- (id)listBucketAnalyticsConfigurations: (nonnull AWSS3ListBucketAnalyticsConfigurationsRequest *)request;
Swift
func listBucketAnalyticsConfigurations(_ request: AWSS3ListBucketAnalyticsConfigurationsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3ListBucketAnalyticsConfigurationsOutput
. -
Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. You should always check the
IsTruncated
element in the response. If there are no more configurations to list,IsTruncated
is set to false. If there are more configurations to list,IsTruncated
is set to true, and there will be a value inNextContinuationToken
. You use theNextContinuationToken
value to continue the pagination of the list by passing the value in continuation-token in the request toGET
the next page.To use this operation, you must have permissions to perform the
s3:GetAnalyticsConfiguration
action. The 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.For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to
ListBucketAnalyticsConfigurations
:See
AWSS3ListBucketAnalyticsConfigurationsRequest
See
AWSS3ListBucketAnalyticsConfigurationsOutput
Declaration
Objective-C
- (void)listBucketAnalyticsConfigurations: (nonnull AWSS3ListBucketAnalyticsConfigurationsRequest *)request completionHandler: (void (^_Nullable)( AWSS3ListBucketAnalyticsConfigurationsOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listBucketAnalyticsConfigurations(_ request: AWSS3ListBucketAnalyticsConfigurationsRequest) async throws -> AWSS3ListBucketAnalyticsConfigurationsOutput
Parameters
request
A container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. Always check the
IsTruncated
element in the response. If there are no more configurations to list,IsTruncated
is set to false. If there are more configurations to list,IsTruncated
is set to true, and there is a value inNextContinuationToken
. You use theNextContinuationToken
value to continue the pagination of the list by passing the value in continuation-token in the request toGET
the next page.To use this operation, you must have permissions to perform the
s3:GetInventoryConfiguration
action. The 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.For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
The following operations are related to
ListBucketInventoryConfigurations
:See
AWSS3ListBucketInventoryConfigurationsRequest
See
AWSS3ListBucketInventoryConfigurationsOutput
Declaration
Objective-C
- (id)listBucketInventoryConfigurations: (nonnull AWSS3ListBucketInventoryConfigurationsRequest *)request;
Swift
func listBucketInventoryConfigurations(_ request: AWSS3ListBucketInventoryConfigurationsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListBucketInventoryConfigurations service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3ListBucketInventoryConfigurationsOutput
. -
Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. Always check the
IsTruncated
element in the response. If there are no more configurations to list,IsTruncated
is set to false. If there are more configurations to list,IsTruncated
is set to true, and there is a value inNextContinuationToken
. You use theNextContinuationToken
value to continue the pagination of the list by passing the value in continuation-token in the request toGET
the next page.To use this operation, you must have permissions to perform the
s3:GetInventoryConfiguration
action. The 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.For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
The following operations are related to
ListBucketInventoryConfigurations
:See
AWSS3ListBucketInventoryConfigurationsRequest
See
AWSS3ListBucketInventoryConfigurationsOutput
Declaration
Objective-C
- (void)listBucketInventoryConfigurations: (nonnull AWSS3ListBucketInventoryConfigurationsRequest *)request completionHandler: (void (^_Nullable)( AWSS3ListBucketInventoryConfigurationsOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listBucketInventoryConfigurations(_ request: AWSS3ListBucketInventoryConfigurationsRequest) async throws -> AWSS3ListBucketInventoryConfigurationsOutput
Parameters
request
A container for the necessary parameters to execute the ListBucketInventoryConfigurations service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. Always check the
IsTruncated
element in the response. If there are no more configurations to list,IsTruncated
is set to false. If there are more configurations to list,IsTruncated
is set to true, and there is a value inNextContinuationToken
. You use theNextContinuationToken
value to continue the pagination of the list by passing the value incontinuation-token
in the request toGET
the next page.To use this operation, you must have permissions to perform the
s3:GetMetricsConfiguration
action. The 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.For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to
ListBucketMetricsConfigurations
:See
AWSS3ListBucketMetricsConfigurationsRequest
See
AWSS3ListBucketMetricsConfigurationsOutput
Declaration
Objective-C
- (id)listBucketMetricsConfigurations: (nonnull AWSS3ListBucketMetricsConfigurationsRequest *)request;
Swift
func listBucketMetricsConfigurations(_ request: AWSS3ListBucketMetricsConfigurationsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListBucketMetricsConfigurations service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3ListBucketMetricsConfigurationsOutput
. -
Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. Always check the
IsTruncated
element in the response. If there are no more configurations to list,IsTruncated
is set to false. If there are more configurations to list,IsTruncated
is set to true, and there is a value inNextContinuationToken
. You use theNextContinuationToken
value to continue the pagination of the list by passing the value incontinuation-token
in the request toGET
the next page.To use this operation, you must have permissions to perform the
s3:GetMetricsConfiguration
action. The 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.For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to
ListBucketMetricsConfigurations
:See
AWSS3ListBucketMetricsConfigurationsRequest
See
AWSS3ListBucketMetricsConfigurationsOutput
Declaration
Objective-C
- (void) listBucketMetricsConfigurations: (nonnull AWSS3ListBucketMetricsConfigurationsRequest *)request completionHandler: (void (^_Nullable)( AWSS3ListBucketMetricsConfigurationsOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listBucketMetricsConfigurations(_ request: AWSS3ListBucketMetricsConfigurationsRequest) async throws -> AWSS3ListBucketMetricsConfigurationsOutput
Parameters
request
A container for the necessary parameters to execute the ListBucketMetricsConfigurations service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns a list of all buckets owned by the authenticated sender of the request.
See
AWSRequest
See
AWSS3ListBucketsOutput
Declaration
Objective-C
- (id)listBuckets:(id)request;
Swift
func listBuckets(_ request: Any!) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListBuckets service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3ListBucketsOutput
. -
Returns a list of all buckets owned by the authenticated sender of the request.
See
AWSRequest
See
AWSS3ListBucketsOutput
Declaration
Objective-C
- (void)listBuckets:(id)request completionHandler:(void (^_Nullable)(AWSS3ListBucketsOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listBuckets(_ request: Any!) async throws -> AWSS3ListBucketsOutput
Parameters
request
A container for the necessary parameters to execute the ListBuckets service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the
max-uploads
parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain anIsTruncated
element with the value true. To list the additional multipart uploads, use thekey-marker
andupload-id-marker
request parameters.In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to
ListMultipartUploads
:See
AWSS3ListMultipartUploadsRequest
See
AWSS3ListMultipartUploadsOutput
Declaration
Objective-C
- (id)listMultipartUploads:(nonnull AWSS3ListMultipartUploadsRequest *)request;
Swift
func listMultipartUploads(_ request: AWSS3ListMultipartUploadsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListMultipartUploads service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3ListMultipartUploadsOutput
. -
This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the
max-uploads
parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain anIsTruncated
element with the value true. To list the additional multipart uploads, use thekey-marker
andupload-id-marker
request parameters.In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to
ListMultipartUploads
:See
AWSS3ListMultipartUploadsRequest
See
AWSS3ListMultipartUploadsOutput
Declaration
Objective-C
- (void)listMultipartUploads:(nonnull AWSS3ListMultipartUploadsRequest *)request completionHandler: (void (^_Nullable)(AWSS3ListMultipartUploadsOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listMultipartUploads(_ request: AWSS3ListMultipartUploadsRequest) async throws -> AWSS3ListMultipartUploadsOutput
Parameters
request
A container for the necessary parameters to execute the ListMultipartUploads service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.
A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.
To use this operation, you must have READ access to the bucket.
This action is not supported by Amazon S3 on Outposts.
The following operations are related to
ListObjectVersions
:See
AWSS3ListObjectVersionsRequest
See
AWSS3ListObjectVersionsOutput
Declaration
Objective-C
- (id)listObjectVersions:(nonnull AWSS3ListObjectVersionsRequest *)request;
Swift
func listObjectVersions(_ request: AWSS3ListObjectVersionsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListObjectVersions service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3ListObjectVersionsOutput
. -
Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.
A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.
To use this operation, you must have READ access to the bucket.
This action is not supported by Amazon S3 on Outposts.
The following operations are related to
ListObjectVersions
:See
AWSS3ListObjectVersionsRequest
See
AWSS3ListObjectVersionsOutput
Declaration
Objective-C
- (void)listObjectVersions:(nonnull AWSS3ListObjectVersionsRequest *)request completionHandler: (void (^_Nullable)(AWSS3ListObjectVersionsOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listObjectVersions(_ request: AWSS3ListObjectVersionsRequest) async throws -> AWSS3ListObjectVersionsOutput
Parameters
request
A container for the necessary parameters to execute the ListObjectVersions service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.
This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support
ListObjects
.The following operations are related to
ListObjects
:See
AWSS3ListObjectsRequest
See
AWSS3ListObjectsOutput
Declaration
Objective-C
- (id)listObjects:(nonnull AWSS3ListObjectsRequest *)request;
Swift
func listObjects(_ request: AWSS3ListObjectsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListObjects service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3ListObjectsOutput
. On failed execution,task.error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchBucket
. -
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.
This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support
ListObjects
.The following operations are related to
ListObjects
:See
AWSS3ListObjectsRequest
See
AWSS3ListObjectsOutput
Declaration
Objective-C
- (void)listObjects:(nonnull AWSS3ListObjectsRequest *)request completionHandler:(void (^_Nullable)(AWSS3ListObjectsOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listObjects(_ request: AWSS3ListObjectsRequest) async throws -> AWSS3ListObjectsOutput
Parameters
request
A container for the necessary parameters to execute the ListObjects service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchBucket
. -
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A
200 OK
response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.To use this operation, you must have READ access to the bucket.
To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the
s3:ListBucket
action. The 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.This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.
To get a list of your buckets, see ListBuckets.
The following operations are related to
ListObjectsV2
:See
AWSS3ListObjectsV2Request
See
AWSS3ListObjectsV2Output
Declaration
Objective-C
- (id)listObjectsV2:(nonnull AWSS3ListObjectsV2Request *)request;
Swift
func listObjectsV2(_ request: AWSS3ListObjectsV2Request) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListObjectsV2 service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3ListObjectsV2Output
. On failed execution,task.error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchBucket
. -
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A
200 OK
response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.To use this operation, you must have READ access to the bucket.
To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the
s3:ListBucket
action. The 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.This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.
To get a list of your buckets, see ListBuckets.
The following operations are related to
ListObjectsV2
:See
AWSS3ListObjectsV2Request
See
AWSS3ListObjectsV2Output
Declaration
Objective-C
- (void)listObjectsV2:(nonnull AWSS3ListObjectsV2Request *)request completionHandler:(void (^_Nullable)(AWSS3ListObjectsV2Output *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listObjectsV2(_ request: AWSS3ListObjectsV2Request) async throws -> AWSS3ListObjectsV2Output
Parameters
request
A container for the necessary parameters to execute the ListObjectsV2 service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSS3ErrorDomain
domain and the following error code:AWSS3ErrorNoSuchBucket
. -
Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the
max-parts
request parameter. If your multipart upload consists of more than 1,000 parts, the response returns anIsTruncated
field with the value of true, and aNextPartNumberMarker
element. In subsequentListParts
requests you can include the part-number-marker query string parameter and set its value to theNextPartNumberMarker
field value from the previous response.For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to
ListParts
:See
AWSS3ListPartsRequest
See
AWSS3ListPartsOutput
Declaration
Objective-C
- (id)listParts:(nonnull AWSS3ListPartsRequest *)request;
Swift
func listParts(_ request: AWSS3ListPartsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListParts service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSS3ListPartsOutput
. -
Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the
max-parts
request parameter. If your multipart upload consists of more than 1,000 parts, the response returns anIsTruncated
field with the value of true, and aNextPartNumberMarker
element. In subsequentListParts
requests you can include the part-number-marker query string parameter and set its value to theNextPartNumberMarker
field value from the previous response.For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to
ListParts
:See
AWSS3ListPartsRequest
See
AWSS3ListPartsOutput
Declaration
Objective-C
- (void)listParts:(nonnull AWSS3ListPartsRequest *)request completionHandler:(void (^_Nullable)(AWSS3ListPartsOutput *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listParts(_ request: AWSS3ListPartsRequest) async throws -> AWSS3ListPartsOutput
Parameters
request
A container for the necessary parameters to execute the ListParts service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.
To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The 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.
The Transfer Acceleration state of a bucket can be set to one of the following two values:
Enabled – Enables accelerated data transfers to the bucket.
Suspended – Disables accelerated data transfers to the bucket.
The GetBucketAccelerateConfiguration operation returns the transfer acceleration state of a bucket.
After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.
The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (“.”).
For more information about transfer acceleration, see Transfer Acceleration.
The following operations are related to
PutBucketAccelerateConfiguration
:See
AWSS3PutBucketAccelerateConfigurationRequest
Declaration
Objective-C
- (id)putBucketAccelerateConfiguration: (nonnull AWSS3PutBucketAccelerateConfigurationRequest *)request;
Swift
func putBucketAccelerateConfiguration(_ request: AWSS3PutBucketAccelerateConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.
To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The 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.
The Transfer Acceleration state of a bucket can be set to one of the following two values:
Enabled – Enables accelerated data transfers to the bucket.
Suspended – Disables accelerated data transfers to the bucket.
The GetBucketAccelerateConfiguration operation returns the transfer acceleration state of a bucket.
After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.
The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (“.”).
For more information about transfer acceleration, see Transfer Acceleration.
The following operations are related to
PutBucketAccelerateConfiguration
:See
AWSS3PutBucketAccelerateConfigurationRequest
Declaration
Objective-C
- (void)putBucketAccelerateConfiguration: (nonnull AWSS3PutBucketAccelerateConfigurationRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func putBucketAccelerateConfiguration(_ request: AWSS3PutBucketAccelerateConfigurationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have
WRITE_ACP
permission.You can use one of the following two ways to set a bucket’s permissions:
Specify the ACL in the request body
Specify permissions using request headers
You cannot specify access permission using both the body and the request headers.
Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the
x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value ofx-amz-acl
. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.Specify access permissions explicitly with the
x-amz-grant-read
,x-amz-grant-read-acp
,x-amz-grant-write-acp
, andx-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use thex-amz-acl
header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS accounturi
– if you are granting permissions to a predefined groupemailAddress
– if the value specified is the email address of an AWS accountUsing email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following
x-amz-grant-write
header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses.x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you’re assigning access rights (using request elements) in the following ways:
By the person’s ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
Related Resources
See
AWSS3PutBucketAclRequest
Declaration
Objective-C
- (id)putBucketAcl:(nonnull AWSS3PutBucketAclRequest *)request;
Swift
func putBucketAcl(_ request: AWSS3PutBucketAclRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketAcl service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have
WRITE_ACP
permission.You can use one of the following two ways to set a bucket’s permissions:
Specify the ACL in the request body
Specify permissions using request headers
You cannot specify access permission using both the body and the request headers.
Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the
x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value ofx-amz-acl
. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.Specify access permissions explicitly with the
x-amz-grant-read
,x-amz-grant-read-acp
,x-amz-grant-write-acp
, andx-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use thex-amz-acl
header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS accounturi
– if you are granting permissions to a predefined groupemailAddress
– if the value specified is the email address of an AWS accountUsing email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following
x-amz-grant-write
header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses.x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you’re assigning access rights (using request elements) in the following ways:
By the person’s ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
Related Resources
See
AWSS3PutBucketAclRequest
Declaration
Objective-C
- (void)putBucketAcl:(nonnull AWSS3PutBucketAclRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketAcl(_ request: AWSS3PutBucketAclRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketAcl service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the
DataExport
request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the
s3:PutAnalyticsConfiguration
action. The 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.Special Errors
HTTP Error: HTTP 400 Bad Request
Code: InvalidArgument
Cause: Invalid argument.
HTTP Error: HTTP 400 Bad Request
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Error: HTTP 403 Forbidden
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.
Related Resources
See
AWSS3PutBucketAnalyticsConfigurationRequest
Declaration
Objective-C
- (id)putBucketAnalyticsConfiguration: (nonnull AWSS3PutBucketAnalyticsConfigurationRequest *)request;
Swift
func putBucketAnalyticsConfiguration(_ request: AWSS3PutBucketAnalyticsConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketAnalyticsConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the
DataExport
request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the
s3:PutAnalyticsConfiguration
action. The 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.Special Errors
HTTP Error: HTTP 400 Bad Request
Code: InvalidArgument
Cause: Invalid argument.
HTTP Error: HTTP 400 Bad Request
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Error: HTTP 403 Forbidden
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.
Related Resources
See
AWSS3PutBucketAnalyticsConfigurationRequest
Declaration
Objective-C
- (void)putBucketAnalyticsConfiguration: (nonnull AWSS3PutBucketAnalyticsConfigurationRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func putBucketAnalyticsConfiguration(_ request: AWSS3PutBucketAnalyticsConfigurationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketAnalyticsConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Sets the
cors
configuration for your bucket. If the configuration exists, Amazon S3 replaces it.To use this operation, you must be allowed to perform the
s3:PutBucketCORS
action. By default, the bucket owner has this permission and can grant it to others.You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is
http://www.example.com
to access your Amazon S3 bucket atmy.example.bucket.com
by using the browser’sXMLHttpRequest
capability.To enable cross-origin resource sharing (CORS) on a bucket, you add the
cors
subresource to the bucket. Thecors
subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the
cors
configuration on the bucket and uses the firstCORSRule
rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:The request’s
Origin
header must matchAllowedOrigin
elements.The request method (for example, GET, PUT, HEAD, and so on) or the
Access-Control-Request-Method
header in case of a pre-flightOPTIONS
request must be one of theAllowedMethod
elements.Every header specified in the
Access-Control-Request-Headers
request header of a pre-flight request must match anAllowedHeader
element.
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
Related Resources
See
AWSS3PutBucketCorsRequest
Declaration
Objective-C
- (id)putBucketCors:(nonnull AWSS3PutBucketCorsRequest *)request;
Swift
func putBucketCors(_ request: AWSS3PutBucketCorsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketCors service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Sets the
cors
configuration for your bucket. If the configuration exists, Amazon S3 replaces it.To use this operation, you must be allowed to perform the
s3:PutBucketCORS
action. By default, the bucket owner has this permission and can grant it to others.You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is
http://www.example.com
to access your Amazon S3 bucket atmy.example.bucket.com
by using the browser’sXMLHttpRequest
capability.To enable cross-origin resource sharing (CORS) on a bucket, you add the
cors
subresource to the bucket. Thecors
subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the
cors
configuration on the bucket and uses the firstCORSRule
rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:The request’s
Origin
header must matchAllowedOrigin
elements.The request method (for example, GET, PUT, HEAD, and so on) or the
Access-Control-Request-Method
header in case of a pre-flightOPTIONS
request must be one of theAllowedMethod
elements.Every header specified in the
Access-Control-Request-Headers
request header of a pre-flight request must match anAllowedHeader
element.
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
Related Resources
See
AWSS3PutBucketCorsRequest
Declaration
Objective-C
- (void)putBucketCors:(nonnull AWSS3PutBucketCorsRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketCors(_ request: AWSS3PutBucketCorsRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketCors service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This implementation of the
PUT
operation uses theencryption
subresource to set the default encryption state of an existing bucket.This implementation of the
PUT
operation sets default encryption for a bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4).
To use this operation, you must have permissions to perform the
s3:PutEncryptionConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.Related Resources
See
AWSS3PutBucketEncryptionRequest
Declaration
Objective-C
- (id)putBucketEncryption:(nonnull AWSS3PutBucketEncryptionRequest *)request;
Swift
func putBucketEncryption(_ request: AWSS3PutBucketEncryptionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketEncryption service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
This implementation of the
PUT
operation uses theencryption
subresource to set the default encryption state of an existing bucket.This implementation of the
PUT
operation sets default encryption for a bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4).
To use this operation, you must have permissions to perform the
s3:PutEncryptionConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.Related Resources
See
AWSS3PutBucketEncryptionRequest
Declaration
Objective-C
- (void)putBucketEncryption:(nonnull AWSS3PutBucketEncryptionRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketEncryption(_ request: AWSS3PutBucketEncryptionRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketEncryption service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This implementation of the
PUT
operation adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same AWS Region as the source bucket.
When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide.
You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the
s3:PutInventoryConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.Special Errors
HTTP 400 Bad Request Error
Code: InvalidArgument
Cause: Invalid Argument
HTTP 400 Bad Request Error
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP 403 Forbidden Error
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the
s3:PutInventoryConfiguration
bucket permission to set the configuration on the bucket.
Related Resources
See
AWSS3PutBucketInventoryConfigurationRequest
Declaration
Objective-C
- (id)putBucketInventoryConfiguration: (nonnull AWSS3PutBucketInventoryConfigurationRequest *)request;
Swift
func putBucketInventoryConfiguration(_ request: AWSS3PutBucketInventoryConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketInventoryConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
This implementation of the
PUT
operation adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same AWS Region as the source bucket.
When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide.
You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the
s3:PutInventoryConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.Special Errors
HTTP 400 Bad Request Error
Code: InvalidArgument
Cause: Invalid Argument
HTTP 400 Bad Request Error
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP 403 Forbidden Error
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the
s3:PutInventoryConfiguration
bucket permission to set the configuration on the bucket.
Related Resources
See
AWSS3PutBucketInventoryConfigurationRequest
Declaration
Objective-C
- (void)putBucketInventoryConfiguration: (nonnull AWSS3PutBucketInventoryConfigurationRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func putBucketInventoryConfiguration(_ request: AWSS3PutBucketInventoryConfigurationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketInventoryConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon Simple Storage Service Developer Guide.
By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the AWS account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the
s3:PutLifecycleConfiguration
permission.You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.
For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.
Related Resources
GetBucketLifecycle(Deprecated)
By default, a resource owner—in this case, a bucket owner, which is the AWS account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon Simple Storage Service Developer Guide:
See
AWSS3PutBucketLifecycleRequest
Declaration
Objective-C
- (id)putBucketLifecycle:(nonnull AWSS3PutBucketLifecycleRequest *)request;
Swift
func putBucketLifecycle(_ request: AWSS3PutBucketLifecycleRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketLifecycle service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon Simple Storage Service Developer Guide.
By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the AWS account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the
s3:PutLifecycleConfiguration
permission.You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.
For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.
Related Resources
GetBucketLifecycle(Deprecated)
By default, a resource owner—in this case, a bucket owner, which is the AWS account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon Simple Storage Service Developer Guide:
See
AWSS3PutBucketLifecycleRequest
Declaration
Objective-C
- (void)putBucketLifecycle:(nonnull AWSS3PutBucketLifecycleRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketLifecycle(_ request: AWSS3PutBucketLifecycleRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketLifecycle service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
Rules
You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:
Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.
Status whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.
For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.
Permissions
By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.
You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
The following are related to
PutBucketLifecycleConfiguration
:See
AWSS3PutBucketLifecycleConfigurationRequest
Declaration
Objective-C
- (id)putBucketLifecycleConfiguration: (nonnull AWSS3PutBucketLifecycleConfigurationRequest *)request;
Swift
func putBucketLifecycleConfiguration(_ request: AWSS3PutBucketLifecycleConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketLifecycleConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
Rules
You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:
Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.
Status whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.
For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.
Permissions
By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.
You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
The following are related to
PutBucketLifecycleConfiguration
:See
AWSS3PutBucketLifecycleConfigurationRequest
Declaration
Objective-C
- (void)putBucketLifecycleConfiguration: (nonnull AWSS3PutBucketLifecycleConfigurationRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func putBucketLifecycleConfiguration(_ request: AWSS3PutBucketLifecycleConfigurationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketLifecycleConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.
The bucket owner is automatically granted FULL_CONTROL to all logs. You use the
Grantee
request element to grant access to other people. ThePermissions
request element specifies the kind of access the grantee has to the logs.Grantee Values
You can specify the person (grantee) to whom you’re assigning access rights (using request elements) in the following ways:
By the person’s ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request.
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:
<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />
For more information about server access logging, see Server Access Logging.
For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.
The following operations are related to
PutBucketLogging
:See
AWSS3PutBucketLoggingRequest
Declaration
Objective-C
- (id)putBucketLogging:(nonnull AWSS3PutBucketLoggingRequest *)request;
Swift
func putBucketLogging(_ request: AWSS3PutBucketLoggingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketLogging service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.
The bucket owner is automatically granted FULL_CONTROL to all logs. You use the
Grantee
request element to grant access to other people. ThePermissions
request element specifies the kind of access the grantee has to the logs.Grantee Values
You can specify the person (grantee) to whom you’re assigning access rights (using request elements) in the following ways:
By the person’s ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request.
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:
<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />
For more information about server access logging, see Server Access Logging.
For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.
The following operations are related to
PutBucketLogging
:See
AWSS3PutBucketLoggingRequest
Declaration
Objective-C
- (void)putBucketLogging:(nonnull AWSS3PutBucketLoggingRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketLogging(_ request: AWSS3PutBucketLoggingRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketLogging service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you’re updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don’t include the elements you want to keep, they are erased.
To use this operation, you must have permissions to perform the
s3:PutMetricsConfiguration
action. The 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.For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to
PutBucketMetricsConfiguration
:GetBucketLifecycle
has the following special error:Error code:
TooManyConfigurations
Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Status Code: HTTP 400 Bad Request
See
AWSS3PutBucketMetricsConfigurationRequest
Declaration
Objective-C
- (id)putBucketMetricsConfiguration: (nonnull AWSS3PutBucketMetricsConfigurationRequest *)request;
Swift
func putBucketMetricsConfiguration(_ request: AWSS3PutBucketMetricsConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketMetricsConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you’re updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don’t include the elements you want to keep, they are erased.
To use this operation, you must have permissions to perform the
s3:PutMetricsConfiguration
action. The 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.For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to
PutBucketMetricsConfiguration
:GetBucketLifecycle
has the following special error:Error code:
TooManyConfigurations
Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Status Code: HTTP 400 Bad Request
See
AWSS3PutBucketMetricsConfigurationRequest
Declaration
Objective-C
- (void)putBucketMetricsConfiguration: (nonnull AWSS3PutBucketMetricsConfigurationRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func putBucketMetricsConfiguration(_ request: AWSS3PutBucketMetricsConfigurationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketMetricsConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
No longer used, see the PutBucketNotificationConfiguration operation.
See
AWSS3PutBucketNotificationRequest
Declaration
Objective-C
- (id)putBucketNotification: (nonnull AWSS3PutBucketNotificationRequest *)request;
Swift
func putBucketNotification(_ request: AWSS3PutBucketNotificationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketNotification service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
No longer used, see the PutBucketNotificationConfiguration operation.
See
AWSS3PutBucketNotificationRequest
Declaration
Objective-C
- (void)putBucketNotification: (nonnull AWSS3PutBucketNotificationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketNotification(_ request: AWSS3PutBucketNotificationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketNotification service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.
Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.
By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty
NotificationConfiguration
.<NotificationConfiguration>
</NotificationConfiguration>
This operation replaces the existing notification configuration with the configuration you include in the request body.
After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.
You can disable notifications by adding the empty NotificationConfiguration element.
By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with
s3:PutBucketNotification
permission.The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket.
Responses
If the configuration in the request body includes only one
TopicConfiguration
specifying only thes3:ReducedRedundancyLostObject
event type, the response will also include thex-amz-sns-test-message-id
header containing the message ID of the test notification sent to the topic.The following operation is related to
PutBucketNotificationConfiguration
:See
AWSS3PutBucketNotificationConfigurationRequest
Declaration
Objective-C
- (id)putBucketNotificationConfiguration: (nonnull AWSS3PutBucketNotificationConfigurationRequest *)request;
Swift
func putBucketNotificationConfiguration(_ request: AWSS3PutBucketNotificationConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketNotificationConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.
Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.
By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty
NotificationConfiguration
.<NotificationConfiguration>
</NotificationConfiguration>
This operation replaces the existing notification configuration with the configuration you include in the request body.
After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.
You can disable notifications by adding the empty NotificationConfiguration element.
By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with
s3:PutBucketNotification
permission.The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket.
Responses
If the configuration in the request body includes only one
TopicConfiguration
specifying only thes3:ReducedRedundancyLostObject
event type, the response will also include thex-amz-sns-test-message-id
header containing the message ID of the test notification sent to the topic.The following operation is related to
PutBucketNotificationConfiguration
:See
AWSS3PutBucketNotificationConfigurationRequest
Declaration
Objective-C
- (void)putBucketNotificationConfiguration: (nonnull AWSS3PutBucketNotificationConfigurationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func putBucketNotificationConfiguration(_ request: AWSS3PutBucketNotificationConfigurationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketNotificationConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Creates or modifies
OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have thes3:GetBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to
GetBucketOwnershipControls
:See
AWSS3PutBucketOwnershipControlsRequest
Declaration
Objective-C
- (id)putBucketOwnershipControls: (nonnull AWSS3PutBucketOwnershipControlsRequest *)request;
Swift
func putBucketOwnershipControls(_ request: AWSS3PutBucketOwnershipControlsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketOwnershipControls service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Creates or modifies
OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have thes3:GetBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to
GetBucketOwnershipControls
:See
AWSS3PutBucketOwnershipControlsRequest
Declaration
Objective-C
- (void)putBucketOwnershipControls: (nonnull AWSS3PutBucketOwnershipControlsRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketOwnershipControls(_ request: AWSS3PutBucketOwnershipControlsRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketOwnershipControls service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Applies an Amazon S3 bucket policy to an Amazon S3 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
PutBucketPolicy
permissions on the specified 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 a403 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 a405 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.
The following operations are related to
PutBucketPolicy
:See
AWSS3PutBucketPolicyRequest
Declaration
Objective-C
- (id)putBucketPolicy:(nonnull AWSS3PutBucketPolicyRequest *)request;
Swift
func putBucketPolicy(_ request: AWSS3PutBucketPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Applies an Amazon S3 bucket policy to an Amazon S3 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
PutBucketPolicy
permissions on the specified 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 a403 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 a405 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.
The following operations are related to
PutBucketPolicy
:See
AWSS3PutBucketPolicyRequest
Declaration
Objective-C
- (void)putBucketPolicy:(nonnull AWSS3PutBucketPolicyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketPolicy(_ request: AWSS3PutBucketPolicyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 Developer Guide.
To perform this operation, the user or role performing the operation must have the iam:PassRole permission.
Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.
A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.
To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements:
DeleteMarkerReplication
,Status
, andPriority
.The latest version of the replication configuration XML is V2. XML V2 replication configurations are those that contain the
Filter
element for rules, and rules that specify S3 Replication Time Control (S3 RTC). In XML V2 replication configurations, Amazon S3 doesn’t replicate delete markers. Therefore, you must set theDeleteMarkerReplication
element toDisabled
. For backward compatibility, Amazon S3 continues to support the XML V1 replication configuration.For information about enabling versioning on a bucket, see Using Versioning.
By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.
Handling Replication of Encrypted Objects
By default, Amazon S3 doesn’t replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following:
SourceSelectionCriteria
,SseKmsEncryptedObjects
,Status
,EncryptionConfiguration
, andReplicaKmsKeyID
. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS.For information on
PutBucketReplication
errors, see List of replication-related error codesThe following operations are related to
PutBucketReplication
:See
AWSS3PutBucketReplicationRequest
Declaration
Objective-C
- (id)putBucketReplication:(nonnull AWSS3PutBucketReplicationRequest *)request;
Swift
func putBucketReplication(_ request: AWSS3PutBucketReplicationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketReplication service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 Developer Guide.
To perform this operation, the user or role performing the operation must have the iam:PassRole permission.
Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.
A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.
To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements:
DeleteMarkerReplication
,Status
, andPriority
.The latest version of the replication configuration XML is V2. XML V2 replication configurations are those that contain the
Filter
element for rules, and rules that specify S3 Replication Time Control (S3 RTC). In XML V2 replication configurations, Amazon S3 doesn’t replicate delete markers. Therefore, you must set theDeleteMarkerReplication
element toDisabled
. For backward compatibility, Amazon S3 continues to support the XML V1 replication configuration.For information about enabling versioning on a bucket, see Using Versioning.
By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.
Handling Replication of Encrypted Objects
By default, Amazon S3 doesn’t replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following:
SourceSelectionCriteria
,SseKmsEncryptedObjects
,Status
,EncryptionConfiguration
, andReplicaKmsKeyID
. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS.For information on
PutBucketReplication
errors, see List of replication-related error codesThe following operations are related to
PutBucketReplication
:See
AWSS3PutBucketReplicationRequest
Declaration
Objective-C
- (void)putBucketReplication:(nonnull AWSS3PutBucketReplicationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketReplication(_ request: AWSS3PutBucketReplicationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketReplication service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.
The following operations are related to
PutBucketRequestPayment
:See
AWSS3PutBucketRequestPaymentRequest
Declaration
Objective-C
- (id)putBucketRequestPayment: (nonnull AWSS3PutBucketRequestPaymentRequest *)request;
Swift
func putBucketRequestPayment(_ request: AWSS3PutBucketRequestPaymentRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketRequestPayment service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.
The following operations are related to
PutBucketRequestPayment
:See
AWSS3PutBucketRequestPaymentRequest
Declaration
Objective-C
- (void)putBucketRequestPayment: (nonnull AWSS3PutBucketRequestPaymentRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketRequestPayment(_ request: AWSS3PutBucketRequestPaymentRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketRequestPayment service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Sets the tags for a bucket.
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
s3:PutBucketTagging
action. The 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. Please try again.
Error code:
InternalError
Description: The service was unable to apply the provided tag to the bucket.
The following operations are related to
PutBucketTagging
:See
AWSS3PutBucketTaggingRequest
Declaration
Objective-C
- (id)putBucketTagging:(nonnull AWSS3PutBucketTaggingRequest *)request;
Swift
func putBucketTagging(_ request: AWSS3PutBucketTaggingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketTagging service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Sets the tags for a bucket.
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
s3:PutBucketTagging
action. The 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. Please try again.
Error code:
InternalError
Description: The service was unable to apply the provided tag to the bucket.
The following operations are related to
PutBucketTagging
:See
AWSS3PutBucketTaggingRequest
Declaration
Objective-C
- (void)putBucketTagging:(nonnull AWSS3PutBucketTaggingRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketTagging(_ request: AWSS3PutBucketTaggingRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketTagging service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
You can set the versioning state with one of the following values:
Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.
If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.
If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the
x-amz-mfa request
header and theStatus
and theMfaDelete
request elements in a request to set the versioning state of the bucket.If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.
Related Resources
See
AWSS3PutBucketVersioningRequest
Declaration
Objective-C
- (id)putBucketVersioning:(nonnull AWSS3PutBucketVersioningRequest *)request;
Swift
func putBucketVersioning(_ request: AWSS3PutBucketVersioningRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketVersioning service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
You can set the versioning state with one of the following values:
Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.
If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.
If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the
x-amz-mfa request
header and theStatus
and theMfaDelete
request elements in a request to set the versioning state of the bucket.If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.
Related Resources
See
AWSS3PutBucketVersioningRequest
Declaration
Objective-C
- (void)putBucketVersioning:(nonnull AWSS3PutBucketVersioningRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putBucketVersioning(_ request: AWSS3PutBucketVersioningRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutBucketVersioning service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Sets the configuration of the website that is specified in the
website
subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3.This PUT operation requires the
S3:PutBucketWebsite
permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them theS3:PutBucketWebsite
permission.To redirect all website requests sent to the bucket’s website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don’t need to provide index document name for the bucket.
WebsiteConfiguration
RedirectAllRequestsTo
HostName
Protocol
If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.
WebsiteConfiguration
IndexDocument
Suffix
ErrorDocument
Key
RoutingRules
RoutingRule
Condition
HttpErrorCodeReturnedEquals
KeyPrefixEquals
Redirect
Protocol
HostName
ReplaceKeyPrefixWith
ReplaceKeyWith
HttpRedirectCode
Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon Simple Storage Service Developer Guide.
See
AWSS3PutBucketWebsiteRequest
Declaration
Objective-C
- (id)putBucketWebsite:(nonnull AWSS3PutBucketWebsiteRequest *)request;
Swift
func putBucketWebsite(_ request: AWSS3PutBucketWebsiteRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutBucketWebsite service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
.