AWSS3

Objective-C

@interface AWSS3

Swift

class AWSS3
  • The service configuration used to instantiate this service client.

    Warning

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

    Declaration

    Objective-C

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

    Swift

    var configuration: UnsafeMutablePointer<Int32> { get }
  • Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
       AWSServiceManager.default().defaultServiceConfiguration = configuration
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
         AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                         identityPoolId:@"YourIdentityPoolId"];
         AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                              credentialsProvider:credentialsProvider];
         [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;
    
         return YES;
     }
    

    Then call the following to get the default service client:

    Swift

    let S3 = AWSS3.default()
    

    Objective-C

    AWSS3 *S3 = [AWSS3 defaultS3];
    

    Declaration

    Objective-C

    + (nonnull instancetype)defaultS3;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

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

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSS3.register(with: configuration!, forKey: "USWest2S3")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSS3 registerS3WithConfiguration:configuration forKey:@"USWest2S3"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let S3 = AWSS3(forKey: "USWest2S3")
    

    Objective-C

    AWSS3 *S3 = [AWSS3 S3ForKey:@"USWest2S3"];
    

    Warning

    After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    + (void)registerS3WithConfiguration:(id)configuration
                                 forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.

    key

    A string to identify the service client.

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

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSS3.register(with: configuration!, forKey: "USWest2S3")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSS3 registerS3WithConfiguration:configuration forKey:@"USWest2S3"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let S3 = AWSS3(forKey: "USWest2S3")
    

    Objective-C

    AWSS3 *S3 = [AWSS3 S3ForKey:@"USWest2S3"];
    

    Declaration

    Objective-C

    + (nonnull instancetype)S3ForKey:(nonnull NSString *)key;

    Swift

    class func s3(forKey key: String) -> Self

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

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

    Warning

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

    Declaration

    Objective-C

    + (void)removeS3ForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • 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.

    See

    AWSS3AbortMultipartUploadRequest

    See

    AWSS3AbortMultipartUploadOutput

    Declaration

    Objective-C

    - (id)abortMultipartUpload:(nonnull AWSS3AbortMultipartUploadRequest *)request;

    Swift

    func abortMultipartUpload(_ request: AWSS3AbortMultipartUploadRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • 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.

    See

    AWSS3AbortMultipartUploadRequest

    See

    AWSS3AbortMultipartUploadOutput

    Declaration

    Objective-C

    - (void)abortMultipartUpload:(nonnull AWSS3AbortMultipartUploadRequest *)request
               completionHandler:
                   (void (^_Nullable)(AWSS3AbortMultipartUploadOutput *_Nullable,
                                      NSError *_Nullable))completionHandler;

    Swift

    func abortMultipartUpload(_ request: AWSS3AbortMultipartUploadRequest, completionHandler: ((AWSS3AbortMultipartUploadOutput?, Error?) -> Void)? = nil)

    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.

  • Completes a multipart upload by assembling previously uploaded parts.

    See

    AWSS3CompleteMultipartUploadRequest

    See

    AWSS3CompleteMultipartUploadOutput

    Declaration

    Objective-C

    - (id)completeMultipartUpload:
        (nonnull AWSS3CompleteMultipartUploadRequest *)request;

    Swift

    func completeMultipartUpload(_ request: AWSS3CompleteMultipartUploadRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Completes a multipart upload by assembling previously uploaded parts.

    See

    AWSS3CompleteMultipartUploadRequest

    See

    AWSS3CompleteMultipartUploadOutput

    Declaration

    Objective-C

    - (void)
        completeMultipartUpload:
            (nonnull AWSS3CompleteMultipartUploadRequest *)request
              completionHandler:
                  (void (^_Nullable)(AWSS3CompleteMultipartUploadOutput *_Nullable,
                                     NSError *_Nullable))completionHandler;

    Swift

    func completeMultipartUpload(_ request: AWSS3CompleteMultipartUploadRequest, completionHandler: ((AWSS3CompleteMultipartUploadOutput?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3ReplicateObjectRequest

    See

    AWSS3ReplicateObjectOutput

    Declaration

    Objective-C

    - (id)replicateObject:(nonnull AWSS3ReplicateObjectRequest *)request;

    Swift

    func replicateObject(_ request: AWSS3ReplicateObjectRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSS3ReplicateObjectRequest

    See

    AWSS3ReplicateObjectOutput

    Declaration

    Objective-C

    - (void)replicateObject:(nonnull AWSS3ReplicateObjectRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSS3ReplicateObjectOutput *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func replicateObject(_ request: AWSS3ReplicateObjectRequest, completionHandler: ((AWSS3ReplicateObjectOutput?, Error?) -> Void)? = nil)

    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.

  • Creates a new bucket.

    See

    AWSS3CreateBucketRequest

    See

    AWSS3CreateBucketOutput

    Declaration

    Objective-C

    - (id)createBucket:(nonnull AWSS3CreateBucketRequest *)request;

    Swift

    func createBucket(_ request: AWSS3CreateBucketRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a new bucket.

    See

    AWSS3CreateBucketRequest

    See

    AWSS3CreateBucketOutput

    Declaration

    Objective-C

    - (void)createBucket:(nonnull AWSS3CreateBucketRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3CreateBucketOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func createBucket(_ request: AWSS3CreateBucketRequest, completionHandler: ((AWSS3CreateBucketOutput?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSS3CreateMultipartUploadRequest

    See

    AWSS3CreateMultipartUploadOutput

    Declaration

    Objective-C

    - (id)createMultipartUpload:
        (nonnull AWSS3CreateMultipartUploadRequest *)request;

    Swift

    func createMultipartUpload(_ request: AWSS3CreateMultipartUploadRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • 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.

    See

    AWSS3CreateMultipartUploadRequest

    See

    AWSS3CreateMultipartUploadOutput

    Declaration

    Objective-C

    - (void)createMultipartUpload:
                (nonnull AWSS3CreateMultipartUploadRequest *)request
                completionHandler:
                    (void (^_Nullable)(AWSS3CreateMultipartUploadOutput *_Nullable,
                                       NSError *_Nullable))completionHandler;

    Swift

    func createMultipartUpload(_ request: AWSS3CreateMultipartUploadRequest, completionHandler: ((AWSS3CreateMultipartUploadOutput?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSS3DeleteBucketRequest

    Declaration

    Objective-C

    - (id)deleteBucket:(nonnull AWSS3DeleteBucketRequest *)request;

    Swift

    func deleteBucket(_ request: AWSS3DeleteBucketRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • 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.

    See

    AWSS3DeleteBucketRequest

    Declaration

    Objective-C

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

    Swift

    func deleteBucket(_ request: AWSS3DeleteBucketRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3DeleteBucketAnalyticsConfigurationRequest

    Declaration

    Objective-C

    - (id)deleteBucketAnalyticsConfiguration:
        (nonnull AWSS3DeleteBucketAnalyticsConfigurationRequest *)request;

    Swift

    func deleteBucketAnalyticsConfiguration(_ request: AWSS3DeleteBucketAnalyticsConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

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

    See

    AWSS3DeleteBucketAnalyticsConfigurationRequest

    Declaration

    Objective-C

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

    Swift

    func deleteBucketAnalyticsConfiguration(_ request: AWSS3DeleteBucketAnalyticsConfigurationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Deletes the CORS configuration information set for the bucket.

    See

    AWSS3DeleteBucketCorsRequest

    Declaration

    Objective-C

    - (id)deleteBucketCors:(nonnull AWSS3DeleteBucketCorsRequest *)request;

    Swift

    func deleteBucketCors(_ request: AWSS3DeleteBucketCorsRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Deletes the CORS configuration information set for the bucket.

    See

    AWSS3DeleteBucketCorsRequest

    Declaration

    Objective-C

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

    Swift

    func deleteBucketCors(_ request: AWSS3DeleteBucketCorsRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Deletes the server-side encryption configuration from the bucket.

    See

    AWSS3DeleteBucketEncryptionRequest

    Declaration

    Objective-C

    - (id)deleteBucketEncryption:
        (nonnull AWSS3DeleteBucketEncryptionRequest *)request;

    Swift

    func deleteBucketEncryption(_ request: AWSS3DeleteBucketEncryptionRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Deletes the server-side encryption configuration from the bucket.

    See

    AWSS3DeleteBucketEncryptionRequest

    Declaration

    Objective-C

    - (void)deleteBucketEncryption:
                (nonnull AWSS3DeleteBucketEncryptionRequest *)request
                 completionHandler:
                     (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteBucketEncryption(_ request: AWSS3DeleteBucketEncryptionRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

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

    completionHandler

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

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

    See

    AWSS3DeleteBucketInventoryConfigurationRequest

    Declaration

    Objective-C

    - (id)deleteBucketInventoryConfiguration:
        (nonnull AWSS3DeleteBucketInventoryConfigurationRequest *)request;

    Swift

    func deleteBucketInventoryConfiguration(_ request: AWSS3DeleteBucketInventoryConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

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

    See

    AWSS3DeleteBucketInventoryConfigurationRequest

    Declaration

    Objective-C

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

    Swift

    func deleteBucketInventoryConfiguration(_ request: AWSS3DeleteBucketInventoryConfigurationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Deletes the lifecycle configuration from the bucket.

    See

    AWSS3DeleteBucketLifecycleRequest

    Declaration

    Objective-C

    - (id)deleteBucketLifecycle:
        (nonnull AWSS3DeleteBucketLifecycleRequest *)request;

    Swift

    func deleteBucketLifecycle(_ request: AWSS3DeleteBucketLifecycleRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Deletes the lifecycle configuration from the bucket.

    See

    AWSS3DeleteBucketLifecycleRequest

    Declaration

    Objective-C

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

    Swift

    func deleteBucketLifecycle(_ request: AWSS3DeleteBucketLifecycleRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3DeleteBucketMetricsConfigurationRequest

    Declaration

    Objective-C

    - (id)deleteBucketMetricsConfiguration:
        (nonnull AWSS3DeleteBucketMetricsConfigurationRequest *)request;

    Swift

    func deleteBucketMetricsConfiguration(_ request: AWSS3DeleteBucketMetricsConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

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

    See

    AWSS3DeleteBucketMetricsConfigurationRequest

    Declaration

    Objective-C

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

    Swift

    func deleteBucketMetricsConfiguration(_ request: AWSS3DeleteBucketMetricsConfigurationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Deletes the policy from the bucket.

    See

    AWSS3DeleteBucketPolicyRequest

    Declaration

    Objective-C

    - (id)deleteBucketPolicy:(nonnull AWSS3DeleteBucketPolicyRequest *)request;

    Swift

    func deleteBucketPolicy(_ request: AWSS3DeleteBucketPolicyRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Deletes the policy from the bucket.

    See

    AWSS3DeleteBucketPolicyRequest

    Declaration

    Objective-C

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

    Swift

    func deleteBucketPolicy(_ request: AWSS3DeleteBucketPolicyRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Deletes the replication configuration from the bucket. For information about replication configuration, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

    See

    AWSS3DeleteBucketReplicationRequest

    Declaration

    Objective-C

    - (id)deleteBucketReplication:
        (nonnull AWSS3DeleteBucketReplicationRequest *)request;

    Swift

    func deleteBucketReplication(_ request: AWSS3DeleteBucketReplicationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Deletes the replication configuration from the bucket. For information about replication configuration, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

    See

    AWSS3DeleteBucketReplicationRequest

    Declaration

    Objective-C

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

    Swift

    func deleteBucketReplication(_ request: AWSS3DeleteBucketReplicationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Deletes the tags from the bucket.

    See

    AWSS3DeleteBucketTaggingRequest

    Declaration

    Objective-C

    - (id)deleteBucketTagging:(nonnull AWSS3DeleteBucketTaggingRequest *)request;

    Swift

    func deleteBucketTagging(_ request: AWSS3DeleteBucketTaggingRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Deletes the tags from the bucket.

    See

    AWSS3DeleteBucketTaggingRequest

    Declaration

    Objective-C

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

    Swift

    func deleteBucketTagging(_ request: AWSS3DeleteBucketTaggingRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • This operation removes the website configuration from the bucket.

    See

    AWSS3DeleteBucketWebsiteRequest

    Declaration

    Objective-C

    - (id)deleteBucketWebsite:(nonnull AWSS3DeleteBucketWebsiteRequest *)request;

    Swift

    func deleteBucketWebsite(_ request: AWSS3DeleteBucketWebsiteRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • This operation removes the website configuration from the bucket.

    See

    AWSS3DeleteBucketWebsiteRequest

    Declaration

    Objective-C

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

    Swift

    func deleteBucketWebsite(_ request: AWSS3DeleteBucketWebsiteRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSS3DeleteObjectRequest

    See

    AWSS3DeleteObjectOutput

    Declaration

    Objective-C

    - (id)deleteObject:(nonnull AWSS3DeleteObjectRequest *)request;

    Swift

    func deleteObject(_ request: AWSS3DeleteObjectRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • 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.

    See

    AWSS3DeleteObjectRequest

    See

    AWSS3DeleteObjectOutput

    Declaration

    Objective-C

    - (void)deleteObject:(nonnull AWSS3DeleteObjectRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3DeleteObjectOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func deleteObject(_ request: AWSS3DeleteObjectRequest, completionHandler: ((AWSS3DeleteObjectOutput?, Error?) -> Void)? = nil)

    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.

  • Removes the tag-set from an existing object.

    See

    AWSS3DeleteObjectTaggingRequest

    See

    AWSS3DeleteObjectTaggingOutput

    Declaration

    Objective-C

    - (id)deleteObjectTagging:(nonnull AWSS3DeleteObjectTaggingRequest *)request;

    Swift

    func deleteObjectTagging(_ request: AWSS3DeleteObjectTaggingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Removes the tag-set from an existing object.

    See

    AWSS3DeleteObjectTaggingRequest

    See

    AWSS3DeleteObjectTaggingOutput

    Declaration

    Objective-C

    - (void)deleteObjectTagging:(nonnull AWSS3DeleteObjectTaggingRequest *)request
              completionHandler:
                  (void (^_Nullable)(AWSS3DeleteObjectTaggingOutput *_Nullable,
                                     NSError *_Nullable))completionHandler;

    Swift

    func deleteObjectTagging(_ request: AWSS3DeleteObjectTaggingRequest, completionHandler: ((AWSS3DeleteObjectTaggingOutput?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3DeleteObjectsRequest

    See

    AWSS3DeleteObjectsOutput

    Declaration

    Objective-C

    - (id)deleteObjects:(nonnull AWSS3DeleteObjectsRequest *)request;

    Swift

    func deleteObjects(_ request: AWSS3DeleteObjectsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSS3DeleteObjectsRequest

    See

    AWSS3DeleteObjectsOutput

    Declaration

    Objective-C

    - (void)deleteObjects:(nonnull AWSS3DeleteObjectsRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3DeleteObjectsOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func deleteObjects(_ request: AWSS3DeleteObjectsRequest, completionHandler: ((AWSS3DeleteObjectsOutput?, Error?) -> Void)? = nil)

    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.

  • Removes the PublicAccessBlock configuration from an Amazon S3 bucket.

    See

    AWSS3DeletePublicAccessBlockRequest

    Declaration

    Objective-C

    - (id)deletePublicAccessBlock:
        (nonnull AWSS3DeletePublicAccessBlockRequest *)request;

    Swift

    func deletePublicAccessBlock(_ request: AWSS3DeletePublicAccessBlockRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Removes the PublicAccessBlock configuration from an Amazon S3 bucket.

    See

    AWSS3DeletePublicAccessBlockRequest

    Declaration

    Objective-C

    - (void)deletePublicAccessBlock:
                (nonnull AWSS3DeletePublicAccessBlockRequest *)request
                  completionHandler:
                      (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deletePublicAccessBlock(_ request: AWSS3DeletePublicAccessBlockRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

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

    completionHandler

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

  • Returns the accelerate configuration of a bucket.

    See

    AWSS3GetBucketAccelerateConfigurationRequest

    See

    AWSS3GetBucketAccelerateConfigurationOutput

    Declaration

    Objective-C

    - (id)getBucketAccelerateConfiguration:
        (nonnull AWSS3GetBucketAccelerateConfigurationRequest *)request;

    Swift

    func getBucketAccelerateConfiguration(_ request: AWSS3GetBucketAccelerateConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the accelerate configuration of a bucket.

    See

    AWSS3GetBucketAccelerateConfigurationRequest

    See

    AWSS3GetBucketAccelerateConfigurationOutput

    Declaration

    Objective-C

    - (void)getBucketAccelerateConfiguration:
                (nonnull AWSS3GetBucketAccelerateConfigurationRequest *)request
                           completionHandler:
                               (void (^_Nullable)(
                                   AWSS3GetBucketAccelerateConfigurationOutput
                                       *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func getBucketAccelerateConfiguration(_ request: AWSS3GetBucketAccelerateConfigurationRequest, completionHandler: ((AWSS3GetBucketAccelerateConfigurationOutput?, Error?) -> Void)? = nil)

    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.

  • Gets the access control policy for the bucket.

    See

    AWSS3GetBucketAclRequest

    See

    AWSS3GetBucketAclOutput

    Declaration

    Objective-C

    - (id)getBucketAcl:(nonnull AWSS3GetBucketAclRequest *)request;

    Swift

    func getBucketAcl(_ request: AWSS3GetBucketAclRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the access control policy for the bucket.

    See

    AWSS3GetBucketAclRequest

    See

    AWSS3GetBucketAclOutput

    Declaration

    Objective-C

    - (void)getBucketAcl:(nonnull AWSS3GetBucketAclRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3GetBucketAclOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func getBucketAcl(_ request: AWSS3GetBucketAclRequest, completionHandler: ((AWSS3GetBucketAclOutput?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3GetBucketAnalyticsConfigurationRequest

    See

    AWSS3GetBucketAnalyticsConfigurationOutput

    Declaration

    Objective-C

    - (id)getBucketAnalyticsConfiguration:
        (nonnull AWSS3GetBucketAnalyticsConfigurationRequest *)request;

    Swift

    func getBucketAnalyticsConfiguration(_ request: AWSS3GetBucketAnalyticsConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSS3GetBucketAnalyticsConfigurationRequest

    See

    AWSS3GetBucketAnalyticsConfigurationOutput

    Declaration

    Objective-C

    - (void)
        getBucketAnalyticsConfiguration:
            (nonnull AWSS3GetBucketAnalyticsConfigurationRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSS3GetBucketAnalyticsConfigurationOutput *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func getBucketAnalyticsConfiguration(_ request: AWSS3GetBucketAnalyticsConfigurationRequest, completionHandler: ((AWSS3GetBucketAnalyticsConfigurationOutput?, Error?) -> Void)? = nil)

    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.

  • Returns the CORS configuration for the bucket.

    See

    AWSS3GetBucketCorsRequest

    See

    AWSS3GetBucketCorsOutput

    Declaration

    Objective-C

    - (id)getBucketCors:(nonnull AWSS3GetBucketCorsRequest *)request;

    Swift

    func getBucketCors(_ request: AWSS3GetBucketCorsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the CORS configuration for the bucket.

    See

    AWSS3GetBucketCorsRequest

    See

    AWSS3GetBucketCorsOutput

    Declaration

    Objective-C

    - (void)getBucketCors:(nonnull AWSS3GetBucketCorsRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3GetBucketCorsOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func getBucketCors(_ request: AWSS3GetBucketCorsRequest, completionHandler: ((AWSS3GetBucketCorsOutput?, Error?) -> Void)? = nil)

    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.

  • Returns the server-side encryption configuration of a bucket.

    See

    AWSS3GetBucketEncryptionRequest

    See

    AWSS3GetBucketEncryptionOutput

    Declaration

    Objective-C

    - (id)getBucketEncryption:(nonnull AWSS3GetBucketEncryptionRequest *)request;

    Swift

    func getBucketEncryption(_ request: AWSS3GetBucketEncryptionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the server-side encryption configuration of a bucket.

    See

    AWSS3GetBucketEncryptionRequest

    See

    AWSS3GetBucketEncryptionOutput

    Declaration

    Objective-C

    - (void)getBucketEncryption:(nonnull AWSS3GetBucketEncryptionRequest *)request
              completionHandler:
                  (void (^_Nullable)(AWSS3GetBucketEncryptionOutput *_Nullable,
                                     NSError *_Nullable))completionHandler;

    Swift

    func getBucketEncryption(_ request: AWSS3GetBucketEncryptionRequest, completionHandler: ((AWSS3GetBucketEncryptionOutput?, Error?) -> Void)? = nil)

    Parameters

    request

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

    completionHandler

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

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

    See

    AWSS3GetBucketInventoryConfigurationRequest

    See

    AWSS3GetBucketInventoryConfigurationOutput

    Declaration

    Objective-C

    - (id)getBucketInventoryConfiguration:
        (nonnull AWSS3GetBucketInventoryConfigurationRequest *)request;

    Swift

    func getBucketInventoryConfiguration(_ request: AWSS3GetBucketInventoryConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSS3GetBucketInventoryConfigurationRequest

    See

    AWSS3GetBucketInventoryConfigurationOutput

    Declaration

    Objective-C

    - (void)
        getBucketInventoryConfiguration:
            (nonnull AWSS3GetBucketInventoryConfigurationRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSS3GetBucketInventoryConfigurationOutput *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func getBucketInventoryConfiguration(_ request: AWSS3GetBucketInventoryConfigurationRequest, completionHandler: ((AWSS3GetBucketInventoryConfigurationOutput?, Error?) -> Void)? = nil)

    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.

  • Deprecated, see the GetBucketLifecycleConfiguration operation.

    See

    AWSS3GetBucketLifecycleRequest

    See

    AWSS3GetBucketLifecycleOutput

    Declaration

    Objective-C

    - (id)getBucketLifecycle:(nonnull AWSS3GetBucketLifecycleRequest *)request;

    Swift

    func getBucketLifecycle(_ request: AWSS3GetBucketLifecycleRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deprecated, see the GetBucketLifecycleConfiguration operation.

    See

    AWSS3GetBucketLifecycleRequest

    See

    AWSS3GetBucketLifecycleOutput

    Declaration

    Objective-C

    - (void)getBucketLifecycle:(nonnull AWSS3GetBucketLifecycleRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSS3GetBucketLifecycleOutput *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func getBucketLifecycle(_ request: AWSS3GetBucketLifecycleRequest, completionHandler: ((AWSS3GetBucketLifecycleOutput?, Error?) -> Void)? = nil)

    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.

  • Returns the lifecycle configuration information set on the bucket.

    See

    AWSS3GetBucketLifecycleConfigurationRequest

    See

    AWSS3GetBucketLifecycleConfigurationOutput

    Declaration

    Objective-C

    - (id)getBucketLifecycleConfiguration:
        (nonnull AWSS3GetBucketLifecycleConfigurationRequest *)request;

    Swift

    func getBucketLifecycleConfiguration(_ request: AWSS3GetBucketLifecycleConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the lifecycle configuration information set on the bucket.

    See

    AWSS3GetBucketLifecycleConfigurationRequest

    See

    AWSS3GetBucketLifecycleConfigurationOutput

    Declaration

    Objective-C

    - (void)
        getBucketLifecycleConfiguration:
            (nonnull AWSS3GetBucketLifecycleConfigurationRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSS3GetBucketLifecycleConfigurationOutput *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func getBucketLifecycleConfiguration(_ request: AWSS3GetBucketLifecycleConfigurationRequest, completionHandler: ((AWSS3GetBucketLifecycleConfigurationOutput?, Error?) -> Void)? = nil)

    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.

  • Returns the region the bucket resides in.

    See

    AWSS3GetBucketLocationRequest

    See

    AWSS3GetBucketLocationOutput

    Declaration

    Objective-C

    - (id)getBucketLocation:(nonnull AWSS3GetBucketLocationRequest *)request;

    Swift

    func getBucketLocation(_ request: AWSS3GetBucketLocationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the region the bucket resides in.

    See

    AWSS3GetBucketLocationRequest

    See

    AWSS3GetBucketLocationOutput

    Declaration

    Objective-C

    - (void)getBucketLocation:(nonnull AWSS3GetBucketLocationRequest *)request
            completionHandler:
                (void (^_Nullable)(AWSS3GetBucketLocationOutput *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func getBucketLocation(_ request: AWSS3GetBucketLocationRequest, completionHandler: ((AWSS3GetBucketLocationOutput?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSS3GetBucketLoggingRequest

    See

    AWSS3GetBucketLoggingOutput

    Declaration

    Objective-C

    - (id)getBucketLogging:(nonnull AWSS3GetBucketLoggingRequest *)request;

    Swift

    func getBucketLogging(_ request: AWSS3GetBucketLoggingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • 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.

    See

    AWSS3GetBucketLoggingRequest

    See

    AWSS3GetBucketLoggingOutput

    Declaration

    Objective-C

    - (void)getBucketLogging:(nonnull AWSS3GetBucketLoggingRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSS3GetBucketLoggingOutput *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func getBucketLogging(_ request: AWSS3GetBucketLoggingRequest, completionHandler: ((AWSS3GetBucketLoggingOutput?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3GetBucketMetricsConfigurationRequest

    See

    AWSS3GetBucketMetricsConfigurationOutput

    Declaration

    Objective-C

    - (id)getBucketMetricsConfiguration:
        (nonnull AWSS3GetBucketMetricsConfigurationRequest *)request;

    Swift

    func getBucketMetricsConfiguration(_ request: AWSS3GetBucketMetricsConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSS3GetBucketMetricsConfigurationRequest

    See

    AWSS3GetBucketMetricsConfigurationOutput

    Declaration

    Objective-C

    - (void)getBucketMetricsConfiguration:
                (nonnull AWSS3GetBucketMetricsConfigurationRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSS3GetBucketMetricsConfigurationOutput *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func getBucketMetricsConfiguration(_ request: AWSS3GetBucketMetricsConfigurationRequest, completionHandler: ((AWSS3GetBucketMetricsConfigurationOutput?, Error?) -> Void)? = nil)

    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.

  • Deprecated, see the GetBucketNotificationConfiguration operation.

    See

    AWSS3GetBucketNotificationConfigurationRequest

    See

    AWSS3NotificationConfigurationDeprecated

    Declaration

    Objective-C

    - (id)getBucketNotification:
        (nonnull AWSS3GetBucketNotificationConfigurationRequest *)request;

    Swift

    func getBucketNotification(_ request: AWSS3GetBucketNotificationConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deprecated, see the GetBucketNotificationConfiguration operation.

    See

    AWSS3GetBucketNotificationConfigurationRequest

    See

    AWSS3NotificationConfigurationDeprecated

    Declaration

    Objective-C

    - (void)getBucketNotification:
                (nonnull AWSS3GetBucketNotificationConfigurationRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSS3NotificationConfigurationDeprecated *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func getBucketNotification(_ request: AWSS3GetBucketNotificationConfigurationRequest, completionHandler: ((AWSS3NotificationConfigurationDeprecated?, Error?) -> Void)? = nil)

    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.

  • Returns the notification configuration of a bucket.

    See

    AWSS3GetBucketNotificationConfigurationRequest

    See

    AWSS3NotificationConfiguration

    Declaration

    Objective-C

    - (id)getBucketNotificationConfiguration:
        (nonnull AWSS3GetBucketNotificationConfigurationRequest *)request;

    Swift

    func getBucketNotificationConfiguration(_ request: AWSS3GetBucketNotificationConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the notification configuration of a bucket.

    See

    AWSS3GetBucketNotificationConfigurationRequest

    See

    AWSS3NotificationConfiguration

    Declaration

    Objective-C

    - (void)getBucketNotificationConfiguration:
                (nonnull AWSS3GetBucketNotificationConfigurationRequest *)request
                             completionHandler:
                                 (void (^_Nullable)(
                                     AWSS3NotificationConfiguration *_Nullable,
                                     NSError *_Nullable))completionHandler;

    Swift

    func getBucketNotificationConfiguration(_ request: AWSS3GetBucketNotificationConfigurationRequest, completionHandler: ((AWSS3NotificationConfiguration?, Error?) -> Void)? = nil)

    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.

  • Returns the policy of a specified bucket.

    See

    AWSS3GetBucketPolicyRequest

    See

    AWSS3GetBucketPolicyOutput

    Declaration

    Objective-C

    - (id)getBucketPolicy:(nonnull AWSS3GetBucketPolicyRequest *)request;

    Swift

    func getBucketPolicy(_ request: AWSS3GetBucketPolicyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the policy of a specified bucket.

    See

    AWSS3GetBucketPolicyRequest

    See

    AWSS3GetBucketPolicyOutput

    Declaration

    Objective-C

    - (void)getBucketPolicy:(nonnull AWSS3GetBucketPolicyRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSS3GetBucketPolicyOutput *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func getBucketPolicy(_ request: AWSS3GetBucketPolicyRequest, completionHandler: ((AWSS3GetBucketPolicyOutput?, Error?) -> Void)? = nil)

    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.

  • Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.

    See

    AWSS3GetBucketPolicyStatusRequest

    See

    AWSS3GetBucketPolicyStatusOutput

    Declaration

    Objective-C

    - (id)getBucketPolicyStatus:
        (nonnull AWSS3GetBucketPolicyStatusRequest *)request;

    Swift

    func getBucketPolicyStatus(_ request: AWSS3GetBucketPolicyStatusRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.

    See

    AWSS3GetBucketPolicyStatusRequest

    See

    AWSS3GetBucketPolicyStatusOutput

    Declaration

    Objective-C

    - (void)getBucketPolicyStatus:
                (nonnull AWSS3GetBucketPolicyStatusRequest *)request
                completionHandler:
                    (void (^_Nullable)(AWSS3GetBucketPolicyStatusOutput *_Nullable,
                                       NSError *_Nullable))completionHandler;

    Swift

    func getBucketPolicyStatus(_ request: AWSS3GetBucketPolicyStatusRequest, completionHandler: ((AWSS3GetBucketPolicyStatusOutput?, Error?) -> Void)? = nil)

    Parameters

    request

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

    completionHandler

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

  • Returns the replication configuration of a bucket.

    It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

    See

    AWSS3GetBucketReplicationRequest

    See

    AWSS3GetBucketReplicationOutput

    Declaration

    Objective-C

    - (id)getBucketReplication:(nonnull AWSS3GetBucketReplicationRequest *)request;

    Swift

    func getBucketReplication(_ request: AWSS3GetBucketReplicationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the replication configuration of a bucket.

    It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

    See

    AWSS3GetBucketReplicationRequest

    See

    AWSS3GetBucketReplicationOutput

    Declaration

    Objective-C

    - (void)getBucketReplication:(nonnull AWSS3GetBucketReplicationRequest *)request
               completionHandler:
                   (void (^_Nullable)(AWSS3GetBucketReplicationOutput *_Nullable,
                                      NSError *_Nullable))completionHandler;

    Swift

    func getBucketReplication(_ request: AWSS3GetBucketReplicationRequest, completionHandler: ((AWSS3GetBucketReplicationOutput?, Error?) -> Void)? = nil)

    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.

  • Returns the request payment configuration of a bucket.

    See

    AWSS3GetBucketRequestPaymentRequest

    See

    AWSS3GetBucketRequestPaymentOutput

    Declaration

    Objective-C

    - (id)getBucketRequestPayment:
        (nonnull AWSS3GetBucketRequestPaymentRequest *)request;

    Swift

    func getBucketRequestPayment(_ request: AWSS3GetBucketRequestPaymentRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the request payment configuration of a bucket.

    See

    AWSS3GetBucketRequestPaymentRequest

    See

    AWSS3GetBucketRequestPaymentOutput

    Declaration

    Objective-C

    - (void)
        getBucketRequestPayment:
            (nonnull AWSS3GetBucketRequestPaymentRequest *)request
              completionHandler:
                  (void (^_Nullable)(AWSS3GetBucketRequestPaymentOutput *_Nullable,
                                     NSError *_Nullable))completionHandler;

    Swift

    func getBucketRequestPayment(_ request: AWSS3GetBucketRequestPaymentRequest, completionHandler: ((AWSS3GetBucketRequestPaymentOutput?, Error?) -> Void)? = nil)

    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.

  • Returns the tag set associated with the bucket.

    See

    AWSS3GetBucketTaggingRequest

    See

    AWSS3GetBucketTaggingOutput

    Declaration

    Objective-C

    - (id)getBucketTagging:(nonnull AWSS3GetBucketTaggingRequest *)request;

    Swift

    func getBucketTagging(_ request: AWSS3GetBucketTaggingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the tag set associated with the bucket.

    See

    AWSS3GetBucketTaggingRequest

    See

    AWSS3GetBucketTaggingOutput

    Declaration

    Objective-C

    - (void)getBucketTagging:(nonnull AWSS3GetBucketTaggingRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSS3GetBucketTaggingOutput *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func getBucketTagging(_ request: AWSS3GetBucketTaggingRequest, completionHandler: ((AWSS3GetBucketTaggingOutput?, Error?) -> Void)? = nil)

    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.

  • Returns the versioning state of a bucket.

    See

    AWSS3GetBucketVersioningRequest

    See

    AWSS3GetBucketVersioningOutput

    Declaration

    Objective-C

    - (id)getBucketVersioning:(nonnull AWSS3GetBucketVersioningRequest *)request;

    Swift

    func getBucketVersioning(_ request: AWSS3GetBucketVersioningRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the versioning state of a bucket.

    See

    AWSS3GetBucketVersioningRequest

    See

    AWSS3GetBucketVersioningOutput

    Declaration

    Objective-C

    - (void)getBucketVersioning:(nonnull AWSS3GetBucketVersioningRequest *)request
              completionHandler:
                  (void (^_Nullable)(AWSS3GetBucketVersioningOutput *_Nullable,
                                     NSError *_Nullable))completionHandler;

    Swift

    func getBucketVersioning(_ request: AWSS3GetBucketVersioningRequest, completionHandler: ((AWSS3GetBucketVersioningOutput?, Error?) -> Void)? = nil)

    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.

  • Returns the website configuration for a bucket.

    See

    AWSS3GetBucketWebsiteRequest

    See

    AWSS3GetBucketWebsiteOutput

    Declaration

    Objective-C

    - (id)getBucketWebsite:(nonnull AWSS3GetBucketWebsiteRequest *)request;

    Swift

    func getBucketWebsite(_ request: AWSS3GetBucketWebsiteRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the website configuration for a bucket.

    See

    AWSS3GetBucketWebsiteRequest

    See

    AWSS3GetBucketWebsiteOutput

    Declaration

    Objective-C

    - (void)getBucketWebsite:(nonnull AWSS3GetBucketWebsiteRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSS3GetBucketWebsiteOutput *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func getBucketWebsite(_ request: AWSS3GetBucketWebsiteRequest, completionHandler: ((AWSS3GetBucketWebsiteOutput?, Error?) -> Void)? = nil)

    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.

  • Retrieves objects from Amazon S3.

    See

    AWSS3GetObjectRequest

    See

    AWSS3GetObjectOutput

    Declaration

    Objective-C

    - (id)getObject:(nonnull AWSS3GetObjectRequest *)request;

    Swift

    func getObject(_ request: AWSS3GetObjectRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Retrieves objects from Amazon S3.

    See

    AWSS3GetObjectRequest

    See

    AWSS3GetObjectOutput

    Declaration

    Objective-C

    - (void)getObject:(nonnull AWSS3GetObjectRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3GetObjectOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func getObject(_ request: AWSS3GetObjectRequest, completionHandler: ((AWSS3GetObjectOutput?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3GetObjectAclRequest

    See

    AWSS3GetObjectAclOutput

    Declaration

    Objective-C

    - (id)getObjectAcl:(nonnull AWSS3GetObjectAclRequest *)request;

    Swift

    func getObjectAcl(_ request: AWSS3GetObjectAclRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSS3GetObjectAclRequest

    See

    AWSS3GetObjectAclOutput

    Declaration

    Objective-C

    - (void)getObjectAcl:(nonnull AWSS3GetObjectAclRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3GetObjectAclOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func getObjectAcl(_ request: AWSS3GetObjectAclRequest, completionHandler: ((AWSS3GetObjectAclOutput?, Error?) -> Void)? = nil)

    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.

  • Gets an object’s current Legal Hold status.

    See

    AWSS3GetObjectLegalHoldRequest

    See

    AWSS3GetObjectLegalHoldOutput

    Declaration

    Objective-C

    - (id)getObjectLegalHold:(nonnull AWSS3GetObjectLegalHoldRequest *)request;

    Swift

    func getObjectLegalHold(_ request: AWSS3GetObjectLegalHoldRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets an object’s current Legal Hold status.

    See

    AWSS3GetObjectLegalHoldRequest

    See

    AWSS3GetObjectLegalHoldOutput

    Declaration

    Objective-C

    - (void)getObjectLegalHold:(nonnull AWSS3GetObjectLegalHoldRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSS3GetObjectLegalHoldOutput *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func getObjectLegalHold(_ request: AWSS3GetObjectLegalHoldRequest, completionHandler: ((AWSS3GetObjectLegalHoldOutput?, Error?) -> Void)? = nil)

    Parameters

    request

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

    completionHandler

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

  • Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.

    See

    AWSS3GetObjectLockConfigurationRequest

    See

    AWSS3GetObjectLockConfigurationOutput

    Declaration

    Objective-C

    - (id)getObjectLockConfiguration:
        (nonnull AWSS3GetObjectLockConfigurationRequest *)request;

    Swift

    func getObjectLockConfiguration(_ request: AWSS3GetObjectLockConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.

    See

    AWSS3GetObjectLockConfigurationRequest

    See

    AWSS3GetObjectLockConfigurationOutput

    Declaration

    Objective-C

    - (void)getObjectLockConfiguration:
                (nonnull AWSS3GetObjectLockConfigurationRequest *)request
                     completionHandler:
                         (void (^_Nullable)(
                             AWSS3GetObjectLockConfigurationOutput *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func getObjectLockConfiguration(_ request: AWSS3GetObjectLockConfigurationRequest, completionHandler: ((AWSS3GetObjectLockConfigurationOutput?, Error?) -> Void)? = nil)

    Parameters

    request

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

    completionHandler

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

  • Retrieves an object’s retention settings.

    See

    AWSS3GetObjectRetentionRequest

    See

    AWSS3GetObjectRetentionOutput

    Declaration

    Objective-C

    - (id)getObjectRetention:(nonnull AWSS3GetObjectRetentionRequest *)request;

    Swift

    func getObjectRetention(_ request: AWSS3GetObjectRetentionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Retrieves an object’s retention settings.

    See

    AWSS3GetObjectRetentionRequest

    See

    AWSS3GetObjectRetentionOutput

    Declaration

    Objective-C

    - (void)getObjectRetention:(nonnull AWSS3GetObjectRetentionRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSS3GetObjectRetentionOutput *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func getObjectRetention(_ request: AWSS3GetObjectRetentionRequest, completionHandler: ((AWSS3GetObjectRetentionOutput?, Error?) -> Void)? = nil)

    Parameters

    request

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

    completionHandler

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

  • Returns the tag-set of an object.

    See

    AWSS3GetObjectTaggingRequest

    See

    AWSS3GetObjectTaggingOutput

    Declaration

    Objective-C

    - (id)getObjectTagging:(nonnull AWSS3GetObjectTaggingRequest *)request;

    Swift

    func getObjectTagging(_ request: AWSS3GetObjectTaggingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the tag-set of an object.

    See

    AWSS3GetObjectTaggingRequest

    See

    AWSS3GetObjectTaggingOutput

    Declaration

    Objective-C

    - (void)getObjectTagging:(nonnull AWSS3GetObjectTaggingRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSS3GetObjectTaggingOutput *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func getObjectTagging(_ request: AWSS3GetObjectTaggingRequest, completionHandler: ((AWSS3GetObjectTaggingOutput?, Error?) -> Void)? = nil)

    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.

  • Return torrent files from a bucket.

    See

    AWSS3GetObjectTorrentRequest

    See

    AWSS3GetObjectTorrentOutput

    Declaration

    Objective-C

    - (id)getObjectTorrent:(nonnull AWSS3GetObjectTorrentRequest *)request;

    Swift

    func getObjectTorrent(_ request: AWSS3GetObjectTorrentRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Return torrent files from a bucket.

    See

    AWSS3GetObjectTorrentRequest

    See

    AWSS3GetObjectTorrentOutput

    Declaration

    Objective-C

    - (void)getObjectTorrent:(nonnull AWSS3GetObjectTorrentRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSS3GetObjectTorrentOutput *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func getObjectTorrent(_ request: AWSS3GetObjectTorrentRequest, completionHandler: ((AWSS3GetObjectTorrentOutput?, Error?) -> Void)? = nil)

    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.

  • Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket.

    See

    AWSS3GetPublicAccessBlockRequest

    See

    AWSS3GetPublicAccessBlockOutput

    Declaration

    Objective-C

    - (id)getPublicAccessBlock:(nonnull AWSS3GetPublicAccessBlockRequest *)request;

    Swift

    func getPublicAccessBlock(_ request: AWSS3GetPublicAccessBlockRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket.

    See

    AWSS3GetPublicAccessBlockRequest

    See

    AWSS3GetPublicAccessBlockOutput

    Declaration

    Objective-C

    - (void)getPublicAccessBlock:(nonnull AWSS3GetPublicAccessBlockRequest *)request
               completionHandler:
                   (void (^_Nullable)(AWSS3GetPublicAccessBlockOutput *_Nullable,
                                      NSError *_Nullable))completionHandler;

    Swift

    func getPublicAccessBlock(_ request: AWSS3GetPublicAccessBlockRequest, completionHandler: ((AWSS3GetPublicAccessBlockOutput?, Error?) -> Void)? = nil)

    Parameters

    request

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

    completionHandler

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

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

    See

    AWSS3HeadBucketRequest

    Declaration

    Objective-C

    - (id)headBucket:(nonnull AWSS3HeadBucketRequest *)request;

    Swift

    func headBucket(_ request: AWSS3HeadBucketRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSS3HeadBucketRequest

    Declaration

    Objective-C

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

    Swift

    func headBucket(_ request: AWSS3HeadBucketRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSS3HeadObjectRequest

    See

    AWSS3HeadObjectOutput

    Declaration

    Objective-C

    - (id)headObject:(nonnull AWSS3HeadObjectRequest *)request;

    Swift

    func headObject(_ request: AWSS3HeadObjectRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you’re only interested in an object’s metadata. To use HEAD, you must have READ access to the object.

    See

    AWSS3HeadObjectRequest

    See

    AWSS3HeadObjectOutput

    Declaration

    Objective-C

    - (void)headObject:(nonnull AWSS3HeadObjectRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3HeadObjectOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func headObject(_ request: AWSS3HeadObjectRequest, completionHandler: ((AWSS3HeadObjectOutput?, Error?) -> Void)? = nil)

    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.

  • Lists the analytics configurations for the bucket.

    See

    AWSS3ListBucketAnalyticsConfigurationsRequest

    See

    AWSS3ListBucketAnalyticsConfigurationsOutput

    Declaration

    Objective-C

    - (id)listBucketAnalyticsConfigurations:
        (nonnull AWSS3ListBucketAnalyticsConfigurationsRequest *)request;

    Swift

    func listBucketAnalyticsConfigurations(_ request: AWSS3ListBucketAnalyticsConfigurationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the analytics configurations for the bucket.

    See

    AWSS3ListBucketAnalyticsConfigurationsRequest

    See

    AWSS3ListBucketAnalyticsConfigurationsOutput

    Declaration

    Objective-C

    - (void)listBucketAnalyticsConfigurations:
                (nonnull AWSS3ListBucketAnalyticsConfigurationsRequest *)request
                            completionHandler:
                                (void (^_Nullable)(
                                    AWSS3ListBucketAnalyticsConfigurationsOutput
                                        *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func listBucketAnalyticsConfigurations(_ request: AWSS3ListBucketAnalyticsConfigurationsRequest, completionHandler: ((AWSS3ListBucketAnalyticsConfigurationsOutput?, Error?) -> Void)? = nil)

    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.

  • Returns a list of inventory configurations for the bucket.

    See

    AWSS3ListBucketInventoryConfigurationsRequest

    See

    AWSS3ListBucketInventoryConfigurationsOutput

    Declaration

    Objective-C

    - (id)listBucketInventoryConfigurations:
        (nonnull AWSS3ListBucketInventoryConfigurationsRequest *)request;

    Swift

    func listBucketInventoryConfigurations(_ request: AWSS3ListBucketInventoryConfigurationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns a list of inventory configurations for the bucket.

    See

    AWSS3ListBucketInventoryConfigurationsRequest

    See

    AWSS3ListBucketInventoryConfigurationsOutput

    Declaration

    Objective-C

    - (void)listBucketInventoryConfigurations:
                (nonnull AWSS3ListBucketInventoryConfigurationsRequest *)request
                            completionHandler:
                                (void (^_Nullable)(
                                    AWSS3ListBucketInventoryConfigurationsOutput
                                        *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func listBucketInventoryConfigurations(_ request: AWSS3ListBucketInventoryConfigurationsRequest, completionHandler: ((AWSS3ListBucketInventoryConfigurationsOutput?, Error?) -> Void)? = nil)

    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.

  • Lists the metrics configurations for the bucket.

    See

    AWSS3ListBucketMetricsConfigurationsRequest

    See

    AWSS3ListBucketMetricsConfigurationsOutput

    Declaration

    Objective-C

    - (id)listBucketMetricsConfigurations:
        (nonnull AWSS3ListBucketMetricsConfigurationsRequest *)request;

    Swift

    func listBucketMetricsConfigurations(_ request: AWSS3ListBucketMetricsConfigurationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the metrics configurations for the bucket.

    See

    AWSS3ListBucketMetricsConfigurationsRequest

    See

    AWSS3ListBucketMetricsConfigurationsOutput

    Declaration

    Objective-C

    - (void)
        listBucketMetricsConfigurations:
            (nonnull AWSS3ListBucketMetricsConfigurationsRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSS3ListBucketMetricsConfigurationsOutput *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listBucketMetricsConfigurations(_ request: AWSS3ListBucketMetricsConfigurationsRequest, completionHandler: ((AWSS3ListBucketMetricsConfigurationsOutput?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRequest

    See

    AWSS3ListBucketsOutput

    Declaration

    Objective-C

    - (id)listBuckets:(id)request;

    Swift

    func listBuckets(_ request: Any!) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSRequest

    See

    AWSS3ListBucketsOutput

    Declaration

    Objective-C

    - (void)listBuckets:(id)request
        completionHandler:(void (^_Nullable)(AWSS3ListBucketsOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func listBuckets(_ request: Any!, completionHandler: ((AWSS3ListBucketsOutput?, Error?) -> Void)? = nil)

    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.

  • This operation lists in-progress multipart uploads.

    See

    AWSS3ListMultipartUploadsRequest

    See

    AWSS3ListMultipartUploadsOutput

    Declaration

    Objective-C

    - (id)listMultipartUploads:(nonnull AWSS3ListMultipartUploadsRequest *)request;

    Swift

    func listMultipartUploads(_ request: AWSS3ListMultipartUploadsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • This operation lists in-progress multipart uploads.

    See

    AWSS3ListMultipartUploadsRequest

    See

    AWSS3ListMultipartUploadsOutput

    Declaration

    Objective-C

    - (void)listMultipartUploads:(nonnull AWSS3ListMultipartUploadsRequest *)request
               completionHandler:
                   (void (^_Nullable)(AWSS3ListMultipartUploadsOutput *_Nullable,
                                      NSError *_Nullable))completionHandler;

    Swift

    func listMultipartUploads(_ request: AWSS3ListMultipartUploadsRequest, completionHandler: ((AWSS3ListMultipartUploadsOutput?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3ListObjectVersionsRequest

    See

    AWSS3ListObjectVersionsOutput

    Declaration

    Objective-C

    - (id)listObjectVersions:(nonnull AWSS3ListObjectVersionsRequest *)request;

    Swift

    func listObjectVersions(_ request: AWSS3ListObjectVersionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSS3ListObjectVersionsRequest

    See

    AWSS3ListObjectVersionsOutput

    Declaration

    Objective-C

    - (void)listObjectVersions:(nonnull AWSS3ListObjectVersionsRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSS3ListObjectVersionsOutput *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func listObjectVersions(_ request: AWSS3ListObjectVersionsRequest, completionHandler: ((AWSS3ListObjectVersionsOutput?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSS3ListObjectsRequest

    See

    AWSS3ListObjectsOutput

    Declaration

    Objective-C

    - (id)listObjects:(nonnull AWSS3ListObjectsRequest *)request;

    Swift

    func listObjects(_ request: AWSS3ListObjectsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • 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.

    See

    AWSS3ListObjectsRequest

    See

    AWSS3ListObjectsOutput

    Declaration

    Objective-C

    - (void)listObjects:(nonnull AWSS3ListObjectsRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3ListObjectsOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func listObjects(_ request: AWSS3ListObjectsRequest, completionHandler: ((AWSS3ListObjectsOutput?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSS3ListObjectsV2Request

    See

    AWSS3ListObjectsV2Output

    Declaration

    Objective-C

    - (id)listObjectsV2:(nonnull AWSS3ListObjectsV2Request *)request;

    Swift

    func listObjectsV2(_ request: AWSS3ListObjectsV2Request) -> Any!

    Parameters

    request

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

    Return Value

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

  • 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.

    See

    AWSS3ListObjectsV2Request

    See

    AWSS3ListObjectsV2Output

    Declaration

    Objective-C

    - (void)listObjectsV2:(nonnull AWSS3ListObjectsV2Request *)request
        completionHandler:(void (^_Nullable)(AWSS3ListObjectsV2Output *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func listObjectsV2(_ request: AWSS3ListObjectsV2Request, completionHandler: ((AWSS3ListObjectsV2Output?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3ListPartsRequest

    See

    AWSS3ListPartsOutput

    Declaration

    Objective-C

    - (id)listParts:(nonnull AWSS3ListPartsRequest *)request;

    Swift

    func listParts(_ request: AWSS3ListPartsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSS3ListPartsRequest

    See

    AWSS3ListPartsOutput

    Declaration

    Objective-C

    - (void)listParts:(nonnull AWSS3ListPartsRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3ListPartsOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func listParts(_ request: AWSS3ListPartsRequest, completionHandler: ((AWSS3ListPartsOutput?, Error?) -> Void)? = nil)

    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.

  • Sets the accelerate configuration of an existing bucket.

    See

    AWSS3PutBucketAccelerateConfigurationRequest

    Declaration

    Objective-C

    - (id)putBucketAccelerateConfiguration:
        (nonnull AWSS3PutBucketAccelerateConfigurationRequest *)request;

    Swift

    func putBucketAccelerateConfiguration(_ request: AWSS3PutBucketAccelerateConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Sets the accelerate configuration of an existing bucket.

    See

    AWSS3PutBucketAccelerateConfigurationRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketAccelerateConfiguration(_ request: AWSS3PutBucketAccelerateConfigurationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3PutBucketAclRequest

    Declaration

    Objective-C

    - (id)putBucketAcl:(nonnull AWSS3PutBucketAclRequest *)request;

    Swift

    func putBucketAcl(_ request: AWSS3PutBucketAclRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

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

    See

    AWSS3PutBucketAclRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketAcl(_ request: AWSS3PutBucketAclRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3PutBucketAnalyticsConfigurationRequest

    Declaration

    Objective-C

    - (id)putBucketAnalyticsConfiguration:
        (nonnull AWSS3PutBucketAnalyticsConfigurationRequest *)request;

    Swift

    func putBucketAnalyticsConfiguration(_ request: AWSS3PutBucketAnalyticsConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

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

    See

    AWSS3PutBucketAnalyticsConfigurationRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketAnalyticsConfiguration(_ request: AWSS3PutBucketAnalyticsConfigurationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Sets the CORS configuration for a bucket.

    See

    AWSS3PutBucketCorsRequest

    Declaration

    Objective-C

    - (id)putBucketCors:(nonnull AWSS3PutBucketCorsRequest *)request;

    Swift

    func putBucketCors(_ request: AWSS3PutBucketCorsRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Sets the CORS configuration for a bucket.

    See

    AWSS3PutBucketCorsRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketCors(_ request: AWSS3PutBucketCorsRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Creates a new server-side encryption configuration (or replaces an existing one, if present).

    See

    AWSS3PutBucketEncryptionRequest

    Declaration

    Objective-C

    - (id)putBucketEncryption:(nonnull AWSS3PutBucketEncryptionRequest *)request;

    Swift

    func putBucketEncryption(_ request: AWSS3PutBucketEncryptionRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Creates a new server-side encryption configuration (or replaces an existing one, if present).

    See

    AWSS3PutBucketEncryptionRequest

    Declaration

    Objective-C

    - (void)putBucketEncryption:(nonnull AWSS3PutBucketEncryptionRequest *)request
              completionHandler:
                  (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func putBucketEncryption(_ request: AWSS3PutBucketEncryptionRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

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

    completionHandler

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

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

    See

    AWSS3PutBucketInventoryConfigurationRequest

    Declaration

    Objective-C

    - (id)putBucketInventoryConfiguration:
        (nonnull AWSS3PutBucketInventoryConfigurationRequest *)request;

    Swift

    func putBucketInventoryConfiguration(_ request: AWSS3PutBucketInventoryConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

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

    See

    AWSS3PutBucketInventoryConfigurationRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketInventoryConfiguration(_ request: AWSS3PutBucketInventoryConfigurationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Deprecated, see the PutBucketLifecycleConfiguration operation.

    See

    AWSS3PutBucketLifecycleRequest

    Declaration

    Objective-C

    - (id)putBucketLifecycle:(nonnull AWSS3PutBucketLifecycleRequest *)request;

    Swift

    func putBucketLifecycle(_ request: AWSS3PutBucketLifecycleRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Deprecated, see the PutBucketLifecycleConfiguration operation.

    See

    AWSS3PutBucketLifecycleRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketLifecycle(_ request: AWSS3PutBucketLifecycleRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3PutBucketLifecycleConfigurationRequest

    Declaration

    Objective-C

    - (id)putBucketLifecycleConfiguration:
        (nonnull AWSS3PutBucketLifecycleConfigurationRequest *)request;

    Swift

    func putBucketLifecycleConfiguration(_ request: AWSS3PutBucketLifecycleConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

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

    See

    AWSS3PutBucketLifecycleConfigurationRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketLifecycleConfiguration(_ request: AWSS3PutBucketLifecycleConfigurationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSS3PutBucketLoggingRequest

    Declaration

    Objective-C

    - (id)putBucketLogging:(nonnull AWSS3PutBucketLoggingRequest *)request;

    Swift

    func putBucketLogging(_ request: AWSS3PutBucketLoggingRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • 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.

    See

    AWSS3PutBucketLoggingRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketLogging(_ request: AWSS3PutBucketLoggingRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3PutBucketMetricsConfigurationRequest

    Declaration

    Objective-C

    - (id)putBucketMetricsConfiguration:
        (nonnull AWSS3PutBucketMetricsConfigurationRequest *)request;

    Swift

    func putBucketMetricsConfiguration(_ request: AWSS3PutBucketMetricsConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

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

    See

    AWSS3PutBucketMetricsConfigurationRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketMetricsConfiguration(_ request: AWSS3PutBucketMetricsConfigurationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Deprecated, see the PutBucketNotificationConfiguraiton operation.

    See

    AWSS3PutBucketNotificationRequest

    Declaration

    Objective-C

    - (id)putBucketNotification:
        (nonnull AWSS3PutBucketNotificationRequest *)request;

    Swift

    func putBucketNotification(_ request: AWSS3PutBucketNotificationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Deprecated, see the PutBucketNotificationConfiguraiton operation.

    See

    AWSS3PutBucketNotificationRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketNotification(_ request: AWSS3PutBucketNotificationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Enables notifications of specified events for a bucket.

    See

    AWSS3PutBucketNotificationConfigurationRequest

    Declaration

    Objective-C

    - (id)putBucketNotificationConfiguration:
        (nonnull AWSS3PutBucketNotificationConfigurationRequest *)request;

    Swift

    func putBucketNotificationConfiguration(_ request: AWSS3PutBucketNotificationConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Enables notifications of specified events for a bucket.

    See

    AWSS3PutBucketNotificationConfigurationRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketNotificationConfiguration(_ request: AWSS3PutBucketNotificationConfigurationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3PutBucketPolicyRequest

    Declaration

    Objective-C

    - (id)putBucketPolicy:(nonnull AWSS3PutBucketPolicyRequest *)request;

    Swift

    func putBucketPolicy(_ request: AWSS3PutBucketPolicyRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

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

    See

    AWSS3PutBucketPolicyRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketPolicy(_ request: AWSS3PutBucketPolicyRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

    See

    AWSS3PutBucketReplicationRequest

    Declaration

    Objective-C

    - (id)putBucketReplication:(nonnull AWSS3PutBucketReplicationRequest *)request;

    Swift

    func putBucketReplication(_ request: AWSS3PutBucketReplicationRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

    See

    AWSS3PutBucketReplicationRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketReplication(_ request: AWSS3PutBucketReplicationRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • 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

    See

    AWSS3PutBucketRequestPaymentRequest

    Declaration

    Objective-C

    - (id)putBucketRequestPayment:
        (nonnull AWSS3PutBucketRequestPaymentRequest *)request;

    Swift

    func putBucketRequestPayment(_ request: AWSS3PutBucketRequestPaymentRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • 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

    See

    AWSS3PutBucketRequestPaymentRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketRequestPayment(_ request: AWSS3PutBucketRequestPaymentRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Sets the tags for a bucket.

    See

    AWSS3PutBucketTaggingRequest

    Declaration

    Objective-C

    - (id)putBucketTagging:(nonnull AWSS3PutBucketTaggingRequest *)request;

    Swift

    func putBucketTagging(_ request: AWSS3PutBucketTaggingRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Sets the tags for a bucket.

    See

    AWSS3PutBucketTaggingRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketTagging(_ request: AWSS3PutBucketTaggingRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3PutBucketVersioningRequest

    Declaration

    Objective-C

    - (id)putBucketVersioning:(nonnull AWSS3PutBucketVersioningRequest *)request;

    Swift

    func putBucketVersioning(_ request: AWSS3PutBucketVersioningRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

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

    See

    AWSS3PutBucketVersioningRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketVersioning(_ request: AWSS3PutBucketVersioningRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Set the website configuration for a bucket.

    See

    AWSS3PutBucketWebsiteRequest

    Declaration

    Objective-C

    - (id)putBucketWebsite:(nonnull AWSS3PutBucketWebsiteRequest *)request;

    Swift

    func putBucketWebsite(_ request: AWSS3PutBucketWebsiteRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Set the website configuration for a bucket.

    See

    AWSS3PutBucketWebsiteRequest

    Declaration

    Objective-C

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

    Swift

    func putBucketWebsite(_ request: AWSS3PutBucketWebsiteRequest, completionHandler: ((Error?) -> Void)? = nil)

    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.

  • Adds an object to a bucket.

    See

    AWSS3PutObjectRequest

    See

    AWSS3PutObjectOutput

    Declaration

    Objective-C

    - (id)putObject:(nonnull AWSS3PutObjectRequest *)request;

    Swift

    func putObject(_ request: AWSS3PutObjectRequest) -> Any!

    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.

  • Adds an object to a bucket.

    See

    AWSS3PutObjectRequest

    See

    AWSS3PutObjectOutput

    Declaration

    Objective-C

    - (void)putObject:(nonnull AWSS3PutObjectRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3PutObjectOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func putObject(_ request: AWSS3PutObjectRequest, completionHandler: ((AWSS3PutObjectOutput?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3PutObjectAclRequest

    See

    AWSS3PutObjectAclOutput

    Declaration

    Objective-C

    - (id)putObjectAcl:(nonnull AWSS3PutObjectAclRequest *)request;

    Swift

    func putObjectAcl(_ request: AWSS3PutObjectAclRequest) -> Any!

    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.

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

    See

    AWSS3PutObjectAclRequest

    See

    AWSS3PutObjectAclOutput

    Declaration

    Objective-C

    - (void)putObjectAcl:(nonnull AWSS3PutObjectAclRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3PutObjectAclOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func putObjectAcl(_ request: AWSS3PutObjectAclRequest, completionHandler: ((AWSS3PutObjectAclOutput?, Error?) -> Void)? = nil)

    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.

  • Applies a Legal Hold configuration to the specified object.

    See

    AWSS3PutObjectLegalHoldRequest

    See

    AWSS3PutObjectLegalHoldOutput

    Declaration

    Objective-C

    - (id)putObjectLegalHold:(nonnull AWSS3PutObjectLegalHoldRequest *)request;

    Swift

    func putObjectLegalHold(_ request: AWSS3PutObjectLegalHoldRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Applies a Legal Hold configuration to the specified object.

    See

    AWSS3PutObjectLegalHoldRequest

    See

    AWSS3PutObjectLegalHoldOutput

    Declaration

    Objective-C

    - (void)putObjectLegalHold:(nonnull AWSS3PutObjectLegalHoldRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSS3PutObjectLegalHoldOutput *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func putObjectLegalHold(_ request: AWSS3PutObjectLegalHoldRequest, completionHandler: ((AWSS3PutObjectLegalHoldOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the PutObjectLegalHold 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.

  • Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.

    See

    AWSS3PutObjectLockConfigurationRequest

    See

    AWSS3PutObjectLockConfigurationOutput

    Declaration

    Objective-C

    - (id)putObjectLockConfiguration:
        (nonnull AWSS3PutObjectLockConfigurationRequest *)request;

    Swift

    func putObjectLockConfiguration(_ request: AWSS3PutObjectLockConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.

    See

    AWSS3PutObjectLockConfigurationRequest

    See

    AWSS3PutObjectLockConfigurationOutput

    Declaration

    Objective-C

    - (void)putObjectLockConfiguration:
                (nonnull AWSS3PutObjectLockConfigurationRequest *)request
                     completionHandler:
                         (void (^_Nullable)(
                             AWSS3PutObjectLockConfigurationOutput *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func putObjectLockConfiguration(_ request: AWSS3PutObjectLockConfigurationRequest, completionHandler: ((AWSS3PutObjectLockConfigurationOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the PutObjectLockConfiguration 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.

  • Places an Object Retention configuration on an object.

    See

    AWSS3PutObjectRetentionRequest

    See

    AWSS3PutObjectRetentionOutput

    Declaration

    Objective-C

    - (id)putObjectRetention:(nonnull AWSS3PutObjectRetentionRequest *)request;

    Swift

    func putObjectRetention(_ request: AWSS3PutObjectRetentionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Places an Object Retention configuration on an object.

    See

    AWSS3PutObjectRetentionRequest

    See

    AWSS3PutObjectRetentionOutput

    Declaration

    Objective-C

    - (void)putObjectRetention:(nonnull AWSS3PutObjectRetentionRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSS3PutObjectRetentionOutput *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func putObjectRetention(_ request: AWSS3PutObjectRetentionRequest, completionHandler: ((AWSS3PutObjectRetentionOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the PutObjectRetention 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.

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

    See

    AWSS3PutObjectTaggingRequest

    See

    AWSS3PutObjectTaggingOutput

    Declaration

    Objective-C

    - (id)putObjectTagging:(nonnull AWSS3PutObjectTaggingRequest *)request;

    Swift

    func putObjectTagging(_ request: AWSS3PutObjectTaggingRequest) -> Any!

    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.

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

    See

    AWSS3PutObjectTaggingRequest

    See

    AWSS3PutObjectTaggingOutput

    Declaration

    Objective-C

    - (void)putObjectTagging:(nonnull AWSS3PutObjectTaggingRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSS3PutObjectTaggingOutput *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func putObjectTagging(_ request: AWSS3PutObjectTaggingRequest, completionHandler: ((AWSS3PutObjectTaggingOutput?, Error?) -> Void)? = nil)

    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.

  • Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.

    See

    AWSS3PutPublicAccessBlockRequest

    Declaration

    Objective-C

    - (id)putPublicAccessBlock:(nonnull AWSS3PutPublicAccessBlockRequest *)request;

    Swift

    func putPublicAccessBlock(_ request: AWSS3PutPublicAccessBlockRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.

    See

    AWSS3PutPublicAccessBlockRequest

    Declaration

    Objective-C

    - (void)putPublicAccessBlock:(nonnull AWSS3PutPublicAccessBlockRequest *)request
               completionHandler:
                   (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func putPublicAccessBlock(_ request: AWSS3PutPublicAccessBlockRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the PutPublicAccessBlock 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.

  • Restores an archived copy of an object back into Amazon S3

    See

    AWSS3RestoreObjectRequest

    See

    AWSS3RestoreObjectOutput

    Declaration

    Objective-C

    - (id)restoreObject:(nonnull AWSS3RestoreObjectRequest *)request;

    Swift

    func restoreObject(_ request: AWSS3RestoreObjectRequest) -> Any!

    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.

  • Restores an archived copy of an object back into Amazon S3

    See

    AWSS3RestoreObjectRequest

    See

    AWSS3RestoreObjectOutput

    Declaration

    Objective-C

    - (void)restoreObject:(nonnull AWSS3RestoreObjectRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3RestoreObjectOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func restoreObject(_ request: AWSS3RestoreObjectRequest, completionHandler: ((AWSS3RestoreObjectOutput?, Error?) -> Void)? = nil)

    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.

  • This operation filters the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

    See

    AWSS3SelectObjectContentRequest

    See

    AWSS3SelectObjectContentOutput

    Declaration

    Objective-C

    - (id)selectObjectContent:(nonnull AWSS3SelectObjectContentRequest *)request;

    Swift

    func selectObjectContent(_ request: AWSS3SelectObjectContentRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • This operation filters the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

    See

    AWSS3SelectObjectContentRequest

    See

    AWSS3SelectObjectContentOutput

    Declaration

    Objective-C

    - (void)selectObjectContent:(nonnull AWSS3SelectObjectContentRequest *)request
              completionHandler:
                  (void (^_Nullable)(AWSS3SelectObjectContentOutput *_Nullable,
                                     NSError *_Nullable))completionHandler;

    Swift

    func selectObjectContent(_ request: AWSS3SelectObjectContentRequest, completionHandler: ((AWSS3SelectObjectContentOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the SelectObjectContent 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.

  • 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.

    See

    AWSS3UploadPartRequest

    See

    AWSS3UploadPartOutput

    Declaration

    Objective-C

    - (id)uploadPart:(nonnull AWSS3UploadPartRequest *)request;

    Swift

    func uploadPart(_ request: AWSS3UploadPartRequest) -> Any!

    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.

  • 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.

    See

    AWSS3UploadPartRequest

    See

    AWSS3UploadPartOutput

    Declaration

    Objective-C

    - (void)uploadPart:(nonnull AWSS3UploadPartRequest *)request
        completionHandler:(void (^_Nullable)(AWSS3UploadPartOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func uploadPart(_ request: AWSS3UploadPartRequest, completionHandler: ((AWSS3UploadPartOutput?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSS3UploadPartCopyRequest

    See

    AWSS3UploadPartCopyOutput

    Declaration

    Objective-C

    - (id)uploadPartCopy:(nonnull AWSS3UploadPartCopyRequest *)request;

    Swift

    func uploadPartCopy(_ request: AWSS3UploadPartCopyRequest) -> Any!

    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.

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

    See

    AWSS3UploadPartCopyRequest

    See

    AWSS3UploadPartCopyOutput

    Declaration

    Objective-C

    - (void)uploadPartCopy:(nonnull AWSS3UploadPartCopyRequest *)request
         completionHandler:(void (^_Nullable)(AWSS3UploadPartCopyOutput *_Nullable,
                                              NSError *_Nullable))completionHandler;

    Swift

    func uploadPartCopy(_ request: AWSS3UploadPartCopyRequest, completionHandler: ((AWSS3UploadPartCopyOutput?, Error?) -> Void)? = nil)

    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.