AWSS3 Class Reference

Inherits from AWSService : NSObject
Declared in AWSS3Service.h
AWSS3Service.m

  configuration

The service configuration used to instantiate this service client.

@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

Discussion

Warning: Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSS3Service.h

+ defaultS3

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.

+ (instancetype)defaultS3

Return Value

The default service client.

Discussion

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];

Declared In

AWSS3Service.h

+ registerS3WithConfiguration:forKey:

Creates a service client with the given service configuration and registers it for the key.

+ (void)registerS3WithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

configuration

A service configuration object.

key

A string to identify the service client.

Discussion

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.

Declared In

AWSS3Service.h

+ S3ForKey:

Retrieves the service client associated with the key. You need to call + registerS3WithConfiguration:forKey: before invoking this method.

+ (instancetype)S3ForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.

Discussion

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"];

Declared In

AWSS3Service.h

+ removeS3ForKey:

Removes the service client associated with the key and release it.

+ (void)removeS3ForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Discussion

Warning: Before calling this method, make sure no method is running on this client.

Declared In

AWSS3Service.h

– abortMultipartUpload:

Aborts a multipart upload.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.

- (AWSTask<AWSS3AbortMultipartUploadOutput*> *)abortMultipartUpload:(AWSS3AbortMultipartUploadRequest *)request

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 of AWSS3AbortMultipartUploadOutput. On failed execution, task.error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchUpload.

Declared In

AWSS3Service.h

– abortMultipartUpload:completionHandler:

Aborts a multipart upload.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.

- (void)abortMultipartUpload:(AWSS3AbortMultipartUploadRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3AbortMultipartUploadOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchUpload.

Declared In

AWSS3Service.h

– completeMultipartUpload:

Completes a multipart upload by assembling previously uploaded parts.

- (AWSTask<AWSS3CompleteMultipartUploadOutput*> *)completeMultipartUpload:(AWSS3CompleteMultipartUploadRequest *)request

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 of AWSS3CompleteMultipartUploadOutput.

Declared In

AWSS3Service.h

– completeMultipartUpload:completionHandler:

Completes a multipart upload by assembling previously uploaded parts.

- (void)completeMultipartUpload:(AWSS3CompleteMultipartUploadRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3CompleteMultipartUploadOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– replicateObject:

Creates a copy of an object that is already stored in Amazon S3.

- (AWSTask<AWSS3ReplicateObjectOutput*> *)replicateObject:(AWSS3ReplicateObjectRequest *)request

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 of AWSS3ReplicateObjectOutput. On failed execution, task.error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorObjectNotInActiveTier.

Declared In

AWSS3Service.h

– replicateObject:completionHandler:

Creates a copy of an object that is already stored in Amazon S3.

- (void)replicateObject:(AWSS3ReplicateObjectRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3ReplicateObjectOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorObjectNotInActiveTier.

Declared In

AWSS3Service.h

– createBucket:

Creates a new bucket.

- (AWSTask<AWSS3CreateBucketOutput*> *)createBucket:(AWSS3CreateBucketRequest *)request

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 of AWSS3CreateBucketOutput. On failed execution, task.error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorBucketAlreadyExists, AWSS3ErrorBucketAlreadyOwnedByYou.

Declared In

AWSS3Service.h

– createBucket:completionHandler:

Creates a new bucket.

- (void)createBucket:(AWSS3CreateBucketRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3CreateBucketOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorBucketAlreadyExists, AWSS3ErrorBucketAlreadyOwnedByYou.

Declared In

AWSS3Service.h

– createMultipartUpload:

Initiates a multipart upload and returns an upload ID.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

- (AWSTask<AWSS3CreateMultipartUploadOutput*> *)createMultipartUpload:(AWSS3CreateMultipartUploadRequest *)request

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 of AWSS3CreateMultipartUploadOutput.

Declared In

AWSS3Service.h

– createMultipartUpload:completionHandler:

Initiates a multipart upload and returns an upload ID.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

- (void)createMultipartUpload:(AWSS3CreateMultipartUploadRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3CreateMultipartUploadOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteBucket:

Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.

- (AWSTask *)deleteBucket:(AWSS3DeleteBucketRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– deleteBucket:completionHandler:

Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.

- (void)deleteBucket:(AWSS3DeleteBucketRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteBucketAnalyticsConfiguration:

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

- (AWSTask *)deleteBucketAnalyticsConfiguration:(AWSS3DeleteBucketAnalyticsConfigurationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– deleteBucketAnalyticsConfiguration:completionHandler:

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

- (void)deleteBucketAnalyticsConfiguration:(AWSS3DeleteBucketAnalyticsConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteBucketCors:

Deletes the cors configuration information set for the bucket.

- (AWSTask *)deleteBucketCors:(AWSS3DeleteBucketCorsRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– deleteBucketCors:completionHandler:

Deletes the cors configuration information set for the bucket.

- (void)deleteBucketCors:(AWSS3DeleteBucketCorsRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteBucketInventoryConfiguration:

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

- (AWSTask *)deleteBucketInventoryConfiguration:(AWSS3DeleteBucketInventoryConfigurationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– deleteBucketInventoryConfiguration:completionHandler:

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

- (void)deleteBucketInventoryConfiguration:(AWSS3DeleteBucketInventoryConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteBucketLifecycle:

Deletes the lifecycle configuration from the bucket.

- (AWSTask *)deleteBucketLifecycle:(AWSS3DeleteBucketLifecycleRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– deleteBucketLifecycle:completionHandler:

Deletes the lifecycle configuration from the bucket.

- (void)deleteBucketLifecycle:(AWSS3DeleteBucketLifecycleRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteBucketMetricsConfiguration:

Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.

- (AWSTask *)deleteBucketMetricsConfiguration:(AWSS3DeleteBucketMetricsConfigurationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– deleteBucketMetricsConfiguration:completionHandler:

Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.

- (void)deleteBucketMetricsConfiguration:(AWSS3DeleteBucketMetricsConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteBucketPolicy:

Deletes the policy from the bucket.

- (AWSTask *)deleteBucketPolicy:(AWSS3DeleteBucketPolicyRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– deleteBucketPolicy:completionHandler:

Deletes the policy from the bucket.

- (void)deleteBucketPolicy:(AWSS3DeleteBucketPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteBucketReplication:

Deletes the replication configuration from the bucket.

- (AWSTask *)deleteBucketReplication:(AWSS3DeleteBucketReplicationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– deleteBucketReplication:completionHandler:

Deletes the replication configuration from the bucket.

- (void)deleteBucketReplication:(AWSS3DeleteBucketReplicationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteBucketTagging:

Deletes the tags from the bucket.

- (AWSTask *)deleteBucketTagging:(AWSS3DeleteBucketTaggingRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– deleteBucketTagging:completionHandler:

Deletes the tags from the bucket.

- (void)deleteBucketTagging:(AWSS3DeleteBucketTaggingRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteBucketWebsite:

This operation removes the website configuration from the bucket.

- (AWSTask *)deleteBucketWebsite:(AWSS3DeleteBucketWebsiteRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– deleteBucketWebsite:completionHandler:

This operation removes the website configuration from the bucket.

- (void)deleteBucketWebsite:(AWSS3DeleteBucketWebsiteRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteObject:

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.

- (AWSTask<AWSS3DeleteObjectOutput*> *)deleteObject:(AWSS3DeleteObjectRequest *)request

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 of AWSS3DeleteObjectOutput.

Declared In

AWSS3Service.h

– deleteObject:completionHandler:

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.

- (void)deleteObject:(AWSS3DeleteObjectRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3DeleteObjectOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteObjectTagging:

Removes the tag-set from an existing object.

- (AWSTask<AWSS3DeleteObjectTaggingOutput*> *)deleteObjectTagging:(AWSS3DeleteObjectTaggingRequest *)request

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 of AWSS3DeleteObjectTaggingOutput.

Declared In

AWSS3Service.h

– deleteObjectTagging:completionHandler:

Removes the tag-set from an existing object.

- (void)deleteObjectTagging:(AWSS3DeleteObjectTaggingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3DeleteObjectTaggingOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– deleteObjects:

This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.

- (AWSTask<AWSS3DeleteObjectsOutput*> *)deleteObjects:(AWSS3DeleteObjectsRequest *)request

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 of AWSS3DeleteObjectsOutput.

Declared In

AWSS3Service.h

– deleteObjects:completionHandler:

This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.

- (void)deleteObjects:(AWSS3DeleteObjectsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3DeleteObjectsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketAccelerateConfiguration:

Returns the accelerate configuration of a bucket.

- (AWSTask<AWSS3GetBucketAccelerateConfigurationOutput*> *)getBucketAccelerateConfiguration:(AWSS3GetBucketAccelerateConfigurationRequest *)request

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 of AWSS3GetBucketAccelerateConfigurationOutput.

Declared In

AWSS3Service.h

– getBucketAccelerateConfiguration:completionHandler:

Returns the accelerate configuration of a bucket.

- (void)getBucketAccelerateConfiguration:(AWSS3GetBucketAccelerateConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketAccelerateConfigurationOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketAcl:

Gets the access control policy for the bucket.

- (AWSTask<AWSS3GetBucketAclOutput*> *)getBucketAcl:(AWSS3GetBucketAclRequest *)request

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 of AWSS3GetBucketAclOutput.

Declared In

AWSS3Service.h

– getBucketAcl:completionHandler:

Gets the access control policy for the bucket.

- (void)getBucketAcl:(AWSS3GetBucketAclRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketAclOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketAnalyticsConfiguration:

Gets an analytics configuration for the bucket (specified by the analytics configuration ID).

- (AWSTask<AWSS3GetBucketAnalyticsConfigurationOutput*> *)getBucketAnalyticsConfiguration:(AWSS3GetBucketAnalyticsConfigurationRequest *)request

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 of AWSS3GetBucketAnalyticsConfigurationOutput.

Declared In

AWSS3Service.h

– getBucketAnalyticsConfiguration:completionHandler:

Gets an analytics configuration for the bucket (specified by the analytics configuration ID).

- (void)getBucketAnalyticsConfiguration:(AWSS3GetBucketAnalyticsConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketAnalyticsConfigurationOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketCors:

Returns the cors configuration for the bucket.

- (AWSTask<AWSS3GetBucketCorsOutput*> *)getBucketCors:(AWSS3GetBucketCorsRequest *)request

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 of AWSS3GetBucketCorsOutput.

Declared In

AWSS3Service.h

– getBucketCors:completionHandler:

Returns the cors configuration for the bucket.

- (void)getBucketCors:(AWSS3GetBucketCorsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketCorsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketInventoryConfiguration:

Returns an inventory configuration (identified by the inventory ID) from the bucket.

- (AWSTask<AWSS3GetBucketInventoryConfigurationOutput*> *)getBucketInventoryConfiguration:(AWSS3GetBucketInventoryConfigurationRequest *)request

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 of AWSS3GetBucketInventoryConfigurationOutput.

Declared In

AWSS3Service.h

– getBucketInventoryConfiguration:completionHandler:

Returns an inventory configuration (identified by the inventory ID) from the bucket.

- (void)getBucketInventoryConfiguration:(AWSS3GetBucketInventoryConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketInventoryConfigurationOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketLifecycle:

Deprecated, see the GetBucketLifecycleConfiguration operation.

- (AWSTask<AWSS3GetBucketLifecycleOutput*> *)getBucketLifecycle:(AWSS3GetBucketLifecycleRequest *)request

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 of AWSS3GetBucketLifecycleOutput.

Declared In

AWSS3Service.h

– getBucketLifecycle:completionHandler:

Deprecated, see the GetBucketLifecycleConfiguration operation.

- (void)getBucketLifecycle:(AWSS3GetBucketLifecycleRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketLifecycleOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketLifecycleConfiguration:

Returns the lifecycle configuration information set on the bucket.

- (AWSTask<AWSS3GetBucketLifecycleConfigurationOutput*> *)getBucketLifecycleConfiguration:(AWSS3GetBucketLifecycleConfigurationRequest *)request

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 of AWSS3GetBucketLifecycleConfigurationOutput.

Declared In

AWSS3Service.h

– getBucketLifecycleConfiguration:completionHandler:

Returns the lifecycle configuration information set on the bucket.

- (void)getBucketLifecycleConfiguration:(AWSS3GetBucketLifecycleConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketLifecycleConfigurationOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketLocation:

Returns the region the bucket resides in.

- (AWSTask<AWSS3GetBucketLocationOutput*> *)getBucketLocation:(AWSS3GetBucketLocationRequest *)request

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 of AWSS3GetBucketLocationOutput.

Declared In

AWSS3Service.h

– getBucketLocation:completionHandler:

Returns the region the bucket resides in.

- (void)getBucketLocation:(AWSS3GetBucketLocationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketLocationOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketLogging:

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.

- (AWSTask<AWSS3GetBucketLoggingOutput*> *)getBucketLogging:(AWSS3GetBucketLoggingRequest *)request

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 of AWSS3GetBucketLoggingOutput.

Declared In

AWSS3Service.h

– getBucketLogging:completionHandler:

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.

- (void)getBucketLogging:(AWSS3GetBucketLoggingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketLoggingOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketMetricsConfiguration:

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.

- (AWSTask<AWSS3GetBucketMetricsConfigurationOutput*> *)getBucketMetricsConfiguration:(AWSS3GetBucketMetricsConfigurationRequest *)request

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 of AWSS3GetBucketMetricsConfigurationOutput.

Declared In

AWSS3Service.h

– getBucketMetricsConfiguration:completionHandler:

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.

- (void)getBucketMetricsConfiguration:(AWSS3GetBucketMetricsConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketMetricsConfigurationOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketNotification:

Deprecated, see the GetBucketNotificationConfiguration operation.

- (AWSTask<AWSS3NotificationConfigurationDeprecated*> *)getBucketNotification:(AWSS3GetBucketNotificationConfigurationRequest *)request

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 of AWSS3NotificationConfigurationDeprecated.

Declared In

AWSS3Service.h

– getBucketNotification:completionHandler:

Deprecated, see the GetBucketNotificationConfiguration operation.

- (void)getBucketNotification:(AWSS3GetBucketNotificationConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3NotificationConfigurationDeprecated *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketNotificationConfiguration:

Returns the notification configuration of a bucket.

- (AWSTask<AWSS3NotificationConfiguration*> *)getBucketNotificationConfiguration:(AWSS3GetBucketNotificationConfigurationRequest *)request

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 of AWSS3NotificationConfiguration.

Declared In

AWSS3Service.h

– getBucketNotificationConfiguration:completionHandler:

Returns the notification configuration of a bucket.

- (void)getBucketNotificationConfiguration:(AWSS3GetBucketNotificationConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3NotificationConfiguration *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketPolicy:

Returns the policy of a specified bucket.

- (AWSTask<AWSS3GetBucketPolicyOutput*> *)getBucketPolicy:(AWSS3GetBucketPolicyRequest *)request

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 of AWSS3GetBucketPolicyOutput.

Declared In

AWSS3Service.h

– getBucketPolicy:completionHandler:

Returns the policy of a specified bucket.

- (void)getBucketPolicy:(AWSS3GetBucketPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketPolicyOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketReplication:

Returns the replication configuration of a bucket.

- (AWSTask<AWSS3GetBucketReplicationOutput*> *)getBucketReplication:(AWSS3GetBucketReplicationRequest *)request

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 of AWSS3GetBucketReplicationOutput.

Declared In

AWSS3Service.h

– getBucketReplication:completionHandler:

Returns the replication configuration of a bucket.

- (void)getBucketReplication:(AWSS3GetBucketReplicationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketReplicationOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketRequestPayment:

Returns the request payment configuration of a bucket.

- (AWSTask<AWSS3GetBucketRequestPaymentOutput*> *)getBucketRequestPayment:(AWSS3GetBucketRequestPaymentRequest *)request

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 of AWSS3GetBucketRequestPaymentOutput.

Declared In

AWSS3Service.h

– getBucketRequestPayment:completionHandler:

Returns the request payment configuration of a bucket.

- (void)getBucketRequestPayment:(AWSS3GetBucketRequestPaymentRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketRequestPaymentOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketTagging:

Returns the tag set associated with the bucket.

- (AWSTask<AWSS3GetBucketTaggingOutput*> *)getBucketTagging:(AWSS3GetBucketTaggingRequest *)request

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 of AWSS3GetBucketTaggingOutput.

Declared In

AWSS3Service.h

– getBucketTagging:completionHandler:

Returns the tag set associated with the bucket.

- (void)getBucketTagging:(AWSS3GetBucketTaggingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketTaggingOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketVersioning:

Returns the versioning state of a bucket.

- (AWSTask<AWSS3GetBucketVersioningOutput*> *)getBucketVersioning:(AWSS3GetBucketVersioningRequest *)request

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 of AWSS3GetBucketVersioningOutput.

Declared In

AWSS3Service.h

– getBucketVersioning:completionHandler:

Returns the versioning state of a bucket.

- (void)getBucketVersioning:(AWSS3GetBucketVersioningRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketVersioningOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getBucketWebsite:

Returns the website configuration for a bucket.

- (AWSTask<AWSS3GetBucketWebsiteOutput*> *)getBucketWebsite:(AWSS3GetBucketWebsiteRequest *)request

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 of AWSS3GetBucketWebsiteOutput.

Declared In

AWSS3Service.h

– getBucketWebsite:completionHandler:

Returns the website configuration for a bucket.

- (void)getBucketWebsite:(AWSS3GetBucketWebsiteRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetBucketWebsiteOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getObject:

Retrieves objects from Amazon S3.

- (AWSTask<AWSS3GetObjectOutput*> *)getObject:(AWSS3GetObjectRequest *)request

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 of AWSS3GetObjectOutput. On failed execution, task.error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchKey.

Declared In

AWSS3Service.h

– getObject:completionHandler:

Retrieves objects from Amazon S3.

- (void)getObject:(AWSS3GetObjectRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetObjectOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchKey.

Declared In

AWSS3Service.h

– getObjectAcl:

Returns the access control list (ACL) of an object.

- (AWSTask<AWSS3GetObjectAclOutput*> *)getObjectAcl:(AWSS3GetObjectAclRequest *)request

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 of AWSS3GetObjectAclOutput. On failed execution, task.error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchKey.

Declared In

AWSS3Service.h

– getObjectAcl:completionHandler:

Returns the access control list (ACL) of an object.

- (void)getObjectAcl:(AWSS3GetObjectAclRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetObjectAclOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchKey.

Declared In

AWSS3Service.h

– getObjectTagging:

Returns the tag-set of an object.

- (AWSTask<AWSS3GetObjectTaggingOutput*> *)getObjectTagging:(AWSS3GetObjectTaggingRequest *)request

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 of AWSS3GetObjectTaggingOutput.

Declared In

AWSS3Service.h

– getObjectTagging:completionHandler:

Returns the tag-set of an object.

- (void)getObjectTagging:(AWSS3GetObjectTaggingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetObjectTaggingOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– getObjectTorrent:

Return torrent files from a bucket.

- (AWSTask<AWSS3GetObjectTorrentOutput*> *)getObjectTorrent:(AWSS3GetObjectTorrentRequest *)request

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 of AWSS3GetObjectTorrentOutput.

Declared In

AWSS3Service.h

– getObjectTorrent:completionHandler:

Return torrent files from a bucket.

- (void)getObjectTorrent:(AWSS3GetObjectTorrentRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3GetObjectTorrentOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– headBucket:

This operation is useful to determine if a bucket exists and you have permission to access it.

- (AWSTask *)headBucket:(AWSS3HeadBucketRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchBucket.

Declared In

AWSS3Service.h

– headBucket:completionHandler:

This operation is useful to determine if a bucket exists and you have permission to access it.

- (void)headBucket:(AWSS3HeadBucketRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchBucket.

Declared In

AWSS3Service.h

– headObject:

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.

- (AWSTask<AWSS3HeadObjectOutput*> *)headObject:(AWSS3HeadObjectRequest *)request

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 of AWSS3HeadObjectOutput. On failed execution, task.error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchKey.

Declared In

AWSS3Service.h

– headObject:completionHandler:

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.

- (void)headObject:(AWSS3HeadObjectRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3HeadObjectOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchKey.

Declared In

AWSS3Service.h

– listBucketAnalyticsConfigurations:

Lists the analytics configurations for the bucket.

- (AWSTask<AWSS3ListBucketAnalyticsConfigurationsOutput*> *)listBucketAnalyticsConfigurations:(AWSS3ListBucketAnalyticsConfigurationsRequest *)request

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 of AWSS3ListBucketAnalyticsConfigurationsOutput.

Declared In

AWSS3Service.h

– listBucketAnalyticsConfigurations:completionHandler:

Lists the analytics configurations for the bucket.

- (void)listBucketAnalyticsConfigurations:(AWSS3ListBucketAnalyticsConfigurationsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3ListBucketAnalyticsConfigurationsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– listBucketInventoryConfigurations:

Returns a list of inventory configurations for the bucket.

- (AWSTask<AWSS3ListBucketInventoryConfigurationsOutput*> *)listBucketInventoryConfigurations:(AWSS3ListBucketInventoryConfigurationsRequest *)request

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 of AWSS3ListBucketInventoryConfigurationsOutput.

Declared In

AWSS3Service.h

– listBucketInventoryConfigurations:completionHandler:

Returns a list of inventory configurations for the bucket.

- (void)listBucketInventoryConfigurations:(AWSS3ListBucketInventoryConfigurationsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3ListBucketInventoryConfigurationsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– listBucketMetricsConfigurations:

Lists the metrics configurations for the bucket.

- (AWSTask<AWSS3ListBucketMetricsConfigurationsOutput*> *)listBucketMetricsConfigurations:(AWSS3ListBucketMetricsConfigurationsRequest *)request

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 of AWSS3ListBucketMetricsConfigurationsOutput.

Declared In

AWSS3Service.h

– listBucketMetricsConfigurations:completionHandler:

Lists the metrics configurations for the bucket.

- (void)listBucketMetricsConfigurations:(AWSS3ListBucketMetricsConfigurationsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3ListBucketMetricsConfigurationsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– listBuckets:

Returns a list of all buckets owned by the authenticated sender of the request.

- (AWSTask<AWSS3ListBucketsOutput*> *)listBuckets:(AWSRequest *)request

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 of AWSS3ListBucketsOutput.

Declared In

AWSS3Service.h

– listBuckets:completionHandler:

Returns a list of all buckets owned by the authenticated sender of the request.

- (void)listBuckets:(AWSRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3ListBucketsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– listMultipartUploads:

This operation lists in-progress multipart uploads.

- (AWSTask<AWSS3ListMultipartUploadsOutput*> *)listMultipartUploads:(AWSS3ListMultipartUploadsRequest *)request

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 of AWSS3ListMultipartUploadsOutput.

Declared In

AWSS3Service.h

– listMultipartUploads:completionHandler:

This operation lists in-progress multipart uploads.

- (void)listMultipartUploads:(AWSS3ListMultipartUploadsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3ListMultipartUploadsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– listObjectVersions:

Returns metadata about all of the versions of objects in a bucket.

- (AWSTask<AWSS3ListObjectVersionsOutput*> *)listObjectVersions:(AWSS3ListObjectVersionsRequest *)request

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 of AWSS3ListObjectVersionsOutput.

Declared In

AWSS3Service.h

– listObjectVersions:completionHandler:

Returns metadata about all of the versions of objects in a bucket.

- (void)listObjectVersions:(AWSS3ListObjectVersionsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3ListObjectVersionsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– listObjects:

Returns some or all (up to 1000) 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.

- (AWSTask<AWSS3ListObjectsOutput*> *)listObjects:(AWSS3ListObjectsRequest *)request

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 of AWSS3ListObjectsOutput. On failed execution, task.error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchBucket.

Declared In

AWSS3Service.h

– listObjects:completionHandler:

Returns some or all (up to 1000) 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.

- (void)listObjects:(AWSS3ListObjectsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3ListObjectsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchBucket.

Declared In

AWSS3Service.h

– listObjectsV2:

Returns some or all (up to 1000) 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. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.

- (AWSTask<AWSS3ListObjectsV2Output*> *)listObjectsV2:(AWSS3ListObjectsV2Request *)request

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 of AWSS3ListObjectsV2Output. On failed execution, task.error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchBucket.

Declared In

AWSS3Service.h

– listObjectsV2:completionHandler:

Returns some or all (up to 1000) 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. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.

- (void)listObjectsV2:(AWSS3ListObjectsV2Request *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3ListObjectsV2Output *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchBucket.

Declared In

AWSS3Service.h

– listParts:

Lists the parts that have been uploaded for a specific multipart upload.

- (AWSTask<AWSS3ListPartsOutput*> *)listParts:(AWSS3ListPartsRequest *)request

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 of AWSS3ListPartsOutput.

Declared In

AWSS3Service.h

– listParts:completionHandler:

Lists the parts that have been uploaded for a specific multipart upload.

- (void)listParts:(AWSS3ListPartsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3ListPartsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketAccelerateConfiguration:

Sets the accelerate configuration of an existing bucket.

- (AWSTask *)putBucketAccelerateConfiguration:(AWSS3PutBucketAccelerateConfigurationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketAccelerateConfiguration:completionHandler:

Sets the accelerate configuration of an existing bucket.

- (void)putBucketAccelerateConfiguration:(AWSS3PutBucketAccelerateConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketAcl:

Sets the permissions on a bucket using access control lists (ACL).

- (AWSTask *)putBucketAcl:(AWSS3PutBucketAclRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketAcl:completionHandler:

Sets the permissions on a bucket using access control lists (ACL).

- (void)putBucketAcl:(AWSS3PutBucketAclRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketAnalyticsConfiguration:

Sets an analytics configuration for the bucket (specified by the analytics configuration ID).

- (AWSTask *)putBucketAnalyticsConfiguration:(AWSS3PutBucketAnalyticsConfigurationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketAnalyticsConfiguration:completionHandler:

Sets an analytics configuration for the bucket (specified by the analytics configuration ID).

- (void)putBucketAnalyticsConfiguration:(AWSS3PutBucketAnalyticsConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketCors:

Sets the cors configuration for a bucket.

- (AWSTask *)putBucketCors:(AWSS3PutBucketCorsRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketCors:completionHandler:

Sets the cors configuration for a bucket.

- (void)putBucketCors:(AWSS3PutBucketCorsRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketInventoryConfiguration:

Adds an inventory configuration (identified by the inventory ID) from the bucket.

- (AWSTask *)putBucketInventoryConfiguration:(AWSS3PutBucketInventoryConfigurationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketInventoryConfiguration:completionHandler:

Adds an inventory configuration (identified by the inventory ID) from the bucket.

- (void)putBucketInventoryConfiguration:(AWSS3PutBucketInventoryConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketLifecycle:

Deprecated, see the PutBucketLifecycleConfiguration operation.

- (AWSTask *)putBucketLifecycle:(AWSS3PutBucketLifecycleRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketLifecycle:completionHandler:

Deprecated, see the PutBucketLifecycleConfiguration operation.

- (void)putBucketLifecycle:(AWSS3PutBucketLifecycleRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketLifecycleConfiguration:

Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.

- (AWSTask *)putBucketLifecycleConfiguration:(AWSS3PutBucketLifecycleConfigurationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketLifecycleConfiguration:completionHandler:

Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.

- (void)putBucketLifecycleConfiguration:(AWSS3PutBucketLifecycleConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketLogging:

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.

- (AWSTask *)putBucketLogging:(AWSS3PutBucketLoggingRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketLogging:completionHandler:

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.

- (void)putBucketLogging:(AWSS3PutBucketLoggingRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketMetricsConfiguration:

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.

- (AWSTask *)putBucketMetricsConfiguration:(AWSS3PutBucketMetricsConfigurationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketMetricsConfiguration:completionHandler:

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.

- (void)putBucketMetricsConfiguration:(AWSS3PutBucketMetricsConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketNotification:

Deprecated, see the PutBucketNotificationConfiguraiton operation.

- (AWSTask *)putBucketNotification:(AWSS3PutBucketNotificationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketNotification:completionHandler:

Deprecated, see the PutBucketNotificationConfiguraiton operation.

- (void)putBucketNotification:(AWSS3PutBucketNotificationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketNotificationConfiguration:

Enables notifications of specified events for a bucket.

- (AWSTask *)putBucketNotificationConfiguration:(AWSS3PutBucketNotificationConfigurationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketNotificationConfiguration:completionHandler:

Enables notifications of specified events for a bucket.

- (void)putBucketNotificationConfiguration:(AWSS3PutBucketNotificationConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketPolicy:

Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.

- (AWSTask *)putBucketPolicy:(AWSS3PutBucketPolicyRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketPolicy:completionHandler:

Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.

- (void)putBucketPolicy:(AWSS3PutBucketPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketReplication:

Creates a new replication configuration (or replaces an existing one, if present).

- (AWSTask *)putBucketReplication:(AWSS3PutBucketReplicationRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketReplication:completionHandler:

Creates a new replication configuration (or replaces an existing one, if present).

- (void)putBucketReplication:(AWSS3PutBucketReplicationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketRequestPayment:

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. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html

- (AWSTask *)putBucketRequestPayment:(AWSS3PutBucketRequestPaymentRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketRequestPayment:completionHandler:

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. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html

- (void)putBucketRequestPayment:(AWSS3PutBucketRequestPaymentRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketTagging:

Sets the tags for a bucket.

- (AWSTask *)putBucketTagging:(AWSS3PutBucketTaggingRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketTagging:completionHandler:

Sets the tags for a bucket.

- (void)putBucketTagging:(AWSS3PutBucketTaggingRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketVersioning:

Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

- (AWSTask *)putBucketVersioning:(AWSS3PutBucketVersioningRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketVersioning:completionHandler:

Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

- (void)putBucketVersioning:(AWSS3PutBucketVersioningRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful.

Declared In

AWSS3Service.h

– putBucketWebsite:

Set the website configuration for a bucket.

- (AWSTask *)putBucketWebsite:(AWSS3PutBucketWebsiteRequest *)request

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 be nil.

Declared In

AWSS3Service.h

– putBucketWebsite:completionHandler:

Set the website configuration for a bucket.

- (void)putBucketWebsite:(AWSS3PutBucketWebsiteRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the PutBucketWebsite service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– putObject:

Adds an object to a bucket.

- (AWSTask<AWSS3PutObjectOutput*> *)putObject:(AWSS3PutObjectRequest *)request

Parameters

request

A container for the necessary parameters to execute the PutObject service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSS3PutObjectOutput.

Declared In

AWSS3Service.h

– putObject:completionHandler:

Adds an object to a bucket.

- (void)putObject:(AWSS3PutObjectRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3PutObjectOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the PutObject service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– putObjectAcl:

uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket

- (AWSTask<AWSS3PutObjectAclOutput*> *)putObjectAcl:(AWSS3PutObjectAclRequest *)request

Parameters

request

A container for the necessary parameters to execute the PutObjectAcl service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSS3PutObjectAclOutput. On failed execution, task.error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchKey.

Declared In

AWSS3Service.h

– putObjectAcl:completionHandler:

uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket

- (void)putObjectAcl:(AWSS3PutObjectAclRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3PutObjectAclOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the PutObjectAcl service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorNoSuchKey.

Declared In

AWSS3Service.h

– putObjectTagging:

Sets the supplied tag-set to an object that already exists in a bucket

- (AWSTask<AWSS3PutObjectTaggingOutput*> *)putObjectTagging:(AWSS3PutObjectTaggingRequest *)request

Parameters

request

A container for the necessary parameters to execute the PutObjectTagging service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSS3PutObjectTaggingOutput.

Declared In

AWSS3Service.h

– putObjectTagging:completionHandler:

Sets the supplied tag-set to an object that already exists in a bucket

- (void)putObjectTagging:(AWSS3PutObjectTaggingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3PutObjectTaggingOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the PutObjectTagging service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– restoreObject:

Restores an archived copy of an object back into Amazon S3

- (AWSTask<AWSS3RestoreObjectOutput*> *)restoreObject:(AWSS3RestoreObjectRequest *)request

Parameters

request

A container for the necessary parameters to execute the RestoreObject service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSS3RestoreObjectOutput. On failed execution, task.error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorObjectAlreadyInActiveTier.

Declared In

AWSS3Service.h

– restoreObject:completionHandler:

Restores an archived copy of an object back into Amazon S3

- (void)restoreObject:(AWSS3RestoreObjectRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3RestoreObjectOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the RestoreObject service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSS3ErrorDomain domain and the following error code: AWSS3ErrorObjectAlreadyInActiveTier.

Declared In

AWSS3Service.h

– uploadPart:

Uploads a part in a multipart upload.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

- (AWSTask<AWSS3UploadPartOutput*> *)uploadPart:(AWSS3UploadPartRequest *)request

Parameters

request

A container for the necessary parameters to execute the UploadPart service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSS3UploadPartOutput.

Declared In

AWSS3Service.h

– uploadPart:completionHandler:

Uploads a part in a multipart upload.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

- (void)uploadPart:(AWSS3UploadPartRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3UploadPartOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UploadPart service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h

– uploadPartCopy:

Uploads a part by copying data from an existing object as data source.

- (AWSTask<AWSS3UploadPartCopyOutput*> *)uploadPartCopy:(AWSS3UploadPartCopyRequest *)request

Parameters

request

A container for the necessary parameters to execute the UploadPartCopy service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSS3UploadPartCopyOutput.

Declared In

AWSS3Service.h

– uploadPartCopy:completionHandler:

Uploads a part by copying data from an existing object as data source.

- (void)uploadPartCopy:(AWSS3UploadPartCopyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSS3UploadPartCopyOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UploadPartCopy service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSS3Service.h