S3Client Class

Member Function Documentation

S3Client::S3Client(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a S3Client object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

S3Client::S3Client(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads S3Client().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AbortMultipartUploadResponse *S3Client::abortMultipartUpload(const AbortMultipartUploadRequest &request)

Sends request to the S3Client service, and returns a pointer to an AbortMultipartUploadResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Aborts a multipart upload.</p><p>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

[slot] CompleteMultipartUploadResponse *S3Client::completeMultipartUpload(const CompleteMultipartUploadRequest &request)

Sends request to the S3Client service, and returns a pointer to an CompleteMultipartUploadResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] CopyObjectResponse *S3Client::copyObject(const CopyObjectRequest &request)

Sends request to the S3Client service, and returns a pointer to an CopyObjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] CreateBucketResponse *S3Client::createBucket(const CreateBucketRequest &request)

Sends request to the S3Client service, and returns a pointer to an CreateBucketResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] CreateMultipartUploadResponse *S3Client::createMultipartUpload(const CreateMultipartUploadRequest &request)

Sends request to the S3Client service, and returns a pointer to an CreateMultipartUploadResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Initiates a multipart upload and returns an upload ID.</p><p><b>Note:</b> 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

[slot] DeleteBucketResponse *S3Client::deleteBucket(const DeleteBucketRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteBucketResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteBucketAnalyticsConfigurationResponse *S3Client::deleteBucketAnalyticsConfiguration(const DeleteBucketAnalyticsConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteBucketAnalyticsConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteBucketCorsResponse *S3Client::deleteBucketCors(const DeleteBucketCorsRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteBucketCorsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteBucketEncryptionResponse *S3Client::deleteBucketEncryption(const DeleteBucketEncryptionRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteBucketEncryptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteBucketInventoryConfigurationResponse *S3Client::deleteBucketInventoryConfiguration(const DeleteBucketInventoryConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteBucketInventoryConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteBucketLifecycleResponse *S3Client::deleteBucketLifecycle(const DeleteBucketLifecycleRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteBucketLifecycleResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteBucketMetricsConfigurationResponse *S3Client::deleteBucketMetricsConfiguration(const DeleteBucketMetricsConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteBucketMetricsConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteBucketPolicyResponse *S3Client::deleteBucketPolicy(const DeleteBucketPolicyRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteBucketPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteBucketReplicationResponse *S3Client::deleteBucketReplication(const DeleteBucketReplicationRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteBucketReplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteBucketTaggingResponse *S3Client::deleteBucketTagging(const DeleteBucketTaggingRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteBucketTaggingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteBucketWebsiteResponse *S3Client::deleteBucketWebsite(const DeleteBucketWebsiteRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteBucketWebsiteResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteObjectResponse *S3Client::deleteObject(const DeleteObjectRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteObjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of

[slot] DeleteObjectTaggingResponse *S3Client::deleteObjectTagging(const DeleteObjectTaggingRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteObjectTaggingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteObjectsResponse *S3Client::deleteObjects(const DeleteObjectsRequest &request)

Sends request to the S3Client service, and returns a pointer to an DeleteObjectsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetBucketAccelerateConfigurationResponse *S3Client::getBucketAccelerateConfiguration(const GetBucketAccelerateConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketAccelerateConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketAclResponse *S3Client::getBucketAcl(const GetBucketAclRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketAclResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketAnalyticsConfigurationResponse *S3Client::getBucketAnalyticsConfiguration(const GetBucketAnalyticsConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketAnalyticsConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketCorsResponse *S3Client::getBucketCors(const GetBucketCorsRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketCorsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketEncryptionResponse *S3Client::getBucketEncryption(const GetBucketEncryptionRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketEncryptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketInventoryConfigurationResponse *S3Client::getBucketInventoryConfiguration(const GetBucketInventoryConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketInventoryConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketLifecycleResponse *S3Client::getBucketLifecycle(const GetBucketLifecycleRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketLifecycleResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketLifecycleConfigurationResponse *S3Client::getBucketLifecycleConfiguration(const GetBucketLifecycleConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketLifecycleConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketLocationResponse *S3Client::getBucketLocation(const GetBucketLocationRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketLocationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketLoggingResponse *S3Client::getBucketLogging(const GetBucketLoggingRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketLoggingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you

[slot] GetBucketMetricsConfigurationResponse *S3Client::getBucketMetricsConfiguration(const GetBucketMetricsConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketMetricsConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketNotificationResponse *S3Client::getBucketNotification(const GetBucketNotificationRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketNotificationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketNotificationConfigurationResponse *S3Client::getBucketNotificationConfiguration(const GetBucketNotificationConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketNotificationConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketPolicyResponse *S3Client::getBucketPolicy(const GetBucketPolicyRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketReplicationResponse *S3Client::getBucketReplication(const GetBucketReplicationRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketReplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketRequestPaymentResponse *S3Client::getBucketRequestPayment(const GetBucketRequestPaymentRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketRequestPaymentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketTaggingResponse *S3Client::getBucketTagging(const GetBucketTaggingRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketTaggingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketVersioningResponse *S3Client::getBucketVersioning(const GetBucketVersioningRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketVersioningResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetBucketWebsiteResponse *S3Client::getBucketWebsite(const GetBucketWebsiteRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetBucketWebsiteResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetObjectResponse *S3Client::getObject(const GetObjectRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetObjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetObjectAclResponse *S3Client::getObjectAcl(const GetObjectAclRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetObjectAclResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetObjectTaggingResponse *S3Client::getObjectTagging(const GetObjectTaggingRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetObjectTaggingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetObjectTorrentResponse *S3Client::getObjectTorrent(const GetObjectTorrentRequest &request)

Sends request to the S3Client service, and returns a pointer to an GetObjectTorrentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] HeadBucketResponse *S3Client::headBucket(const HeadBucketRequest &request)

Sends request to the S3Client service, and returns a pointer to an HeadBucketResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] HeadObjectResponse *S3Client::headObject(const HeadObjectRequest &request)

Sends request to the S3Client service, and returns a pointer to an HeadObjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if

[slot] ListBucketAnalyticsConfigurationsResponse *S3Client::listBucketAnalyticsConfigurations(const ListBucketAnalyticsConfigurationsRequest &request)

Sends request to the S3Client service, and returns a pointer to an ListBucketAnalyticsConfigurationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] ListBucketInventoryConfigurationsResponse *S3Client::listBucketInventoryConfigurations(const ListBucketInventoryConfigurationsRequest &request)

Sends request to the S3Client service, and returns a pointer to an ListBucketInventoryConfigurationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] ListBucketMetricsConfigurationsResponse *S3Client::listBucketMetricsConfigurations(const ListBucketMetricsConfigurationsRequest &request)

Sends request to the S3Client service, and returns a pointer to an ListBucketMetricsConfigurationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] ListBucketsResponse *S3Client::listBuckets()

Sends a ListBuckets request to the S3Client service, and returns a pointer to an ListBucketsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] ListMultipartUploadsResponse *S3Client::listMultipartUploads(const ListMultipartUploadsRequest &request)

Sends request to the S3Client service, and returns a pointer to an ListMultipartUploadsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] ListObjectVersionsResponse *S3Client::listObjectVersions(const ListObjectVersionsRequest &request)

Sends request to the S3Client service, and returns a pointer to an ListObjectVersionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] ListObjectsResponse *S3Client::listObjects(const ListObjectsRequest &request)

Sends request to the S3Client service, and returns a pointer to an ListObjectsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to

[slot] ListObjectsV2Response *S3Client::listObjectsV2(const ListObjectsV2Request &request)

Sends request to the S3Client service, and returns a pointer to an ListObjectsV2Response object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListPartsResponse *S3Client::listParts(const ListPartsRequest &request)

Sends request to the S3Client service, and returns a pointer to an ListPartsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketAccelerateConfigurationResponse *S3Client::putBucketAccelerateConfiguration(const PutBucketAccelerateConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketAccelerateConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketAclResponse *S3Client::putBucketAcl(const PutBucketAclRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketAclResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketAnalyticsConfigurationResponse *S3Client::putBucketAnalyticsConfiguration(const PutBucketAnalyticsConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketAnalyticsConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketCorsResponse *S3Client::putBucketCors(const PutBucketCorsRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketCorsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketEncryptionResponse *S3Client::putBucketEncryption(const PutBucketEncryptionRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketEncryptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketInventoryConfigurationResponse *S3Client::putBucketInventoryConfiguration(const PutBucketInventoryConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketInventoryConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketLifecycleResponse *S3Client::putBucketLifecycle(const PutBucketLifecycleRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketLifecycleResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketLifecycleConfigurationResponse *S3Client::putBucketLifecycleConfiguration(const PutBucketLifecycleConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketLifecycleConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketLoggingResponse *S3Client::putBucketLogging(const PutBucketLoggingRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketLoggingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters.

[slot] PutBucketMetricsConfigurationResponse *S3Client::putBucketMetricsConfiguration(const PutBucketMetricsConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketMetricsConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketNotificationResponse *S3Client::putBucketNotification(const PutBucketNotificationRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketNotificationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketNotificationConfigurationResponse *S3Client::putBucketNotificationConfiguration(const PutBucketNotificationConfigurationRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketNotificationConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketPolicyResponse *S3Client::putBucketPolicy(const PutBucketPolicyRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketReplicationResponse *S3Client::putBucketReplication(const PutBucketReplicationRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketReplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketRequestPaymentResponse *S3Client::putBucketRequestPayment(const PutBucketRequestPaymentRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketRequestPaymentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] PutBucketTaggingResponse *S3Client::putBucketTagging(const PutBucketTaggingRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketTaggingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketVersioningResponse *S3Client::putBucketVersioning(const PutBucketVersioningRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketVersioningResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutBucketWebsiteResponse *S3Client::putBucketWebsite(const PutBucketWebsiteRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutBucketWebsiteResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutObjectResponse *S3Client::putObject(const PutObjectRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutObjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutObjectAclResponse *S3Client::putObjectAcl(const PutObjectAclRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutObjectAclResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] PutObjectTaggingResponse *S3Client::putObjectTagging(const PutObjectTaggingRequest &request)

Sends request to the S3Client service, and returns a pointer to an PutObjectTaggingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] RestoreObjectResponse *S3Client::restoreObject(const RestoreObjectRequest &request)

Sends request to the S3Client service, and returns a pointer to an RestoreObjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] SelectObjectContentResponse *S3Client::selectObjectContent(const SelectObjectContentRequest &request)

Sends request to the S3Client service, and returns a pointer to an SelectObjectContentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UploadPartResponse *S3Client::uploadPart(const UploadPartRequest &request)

Sends request to the S3Client service, and returns a pointer to an UploadPartResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Uploads a part in a multipart upload.</p><p><b>Note:</b> 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

[slot] UploadPartCopyResponse *S3Client::uploadPartCopy(const UploadPartCopyRequest &request)

Sends request to the S3Client service, and returns a pointer to an UploadPartCopyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.