root
/
gl-store-s3.js
mirror of https://github.com/cderche/greenlock-storage-s3
2
0
Fork 0
Code Issues 1 Releases Wiki Activity
gl-store-s3.js/node_modules/aws-sdk/clients/s3.d.ts

5067 lines
188 KiB
TypeScript
Raw Normal View History

implemented cleanup.
2019-05-08 11:19:12 +00:00
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {S3Customizations} from '../lib/services/s3';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
import {UseDualstackConfigOptions} from '../lib/config_use_dualstack';
import {EventStream} from '../lib/event-stream/event-stream';
import {ManagedUpload as managed_upload} from '../lib/s3/managed_upload';
import {PresignedPost as presigned_post} from '../lib/s3/presigned_post';
import {Readable} from 'stream';
interface Blob {}
declare class S3 extends S3Customizations {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: S3.Types.ClientConfiguration)
config: Config & S3.Types.ClientConfiguration;
/**
* 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.
*/
abortMultipartUpload(params: S3.Types.AbortMultipartUploadRequest, callback?: (err: AWSError, data: S3.Types.AbortMultipartUploadOutput) => void): Request<S3.Types.AbortMultipartUploadOutput, AWSError>;
/**
* 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.
*/
abortMultipartUpload(callback?: (err: AWSError, data: S3.Types.AbortMultipartUploadOutput) => void): Request<S3.Types.AbortMultipartUploadOutput, AWSError>;
/**
* Completes a multipart upload by assembling previously uploaded parts.
*/
completeMultipartUpload(params: S3.Types.CompleteMultipartUploadRequest, callback?: (err: AWSError, data: S3.Types.CompleteMultipartUploadOutput) => void): Request<S3.Types.CompleteMultipartUploadOutput, AWSError>;
/**
* Completes a multipart upload by assembling previously uploaded parts.
*/
completeMultipartUpload(callback?: (err: AWSError, data: S3.Types.CompleteMultipartUploadOutput) => void): Request<S3.Types.CompleteMultipartUploadOutput, AWSError>;
/**
* Creates a copy of an object that is already stored in Amazon S3.
*/
copyObject(params: S3.Types.CopyObjectRequest, callback?: (err: AWSError, data: S3.Types.CopyObjectOutput) => void): Request<S3.Types.CopyObjectOutput, AWSError>;
/**
* Creates a copy of an object that is already stored in Amazon S3.
*/
copyObject(callback?: (err: AWSError, data: S3.Types.CopyObjectOutput) => void): Request<S3.Types.CopyObjectOutput, AWSError>;
/**
* Creates a new bucket.
*/
createBucket(params: S3.Types.CreateBucketRequest, callback?: (err: AWSError, data: S3.Types.CreateBucketOutput) => void): Request<S3.Types.CreateBucketOutput, AWSError>;
/**
* Creates a new bucket.
*/
createBucket(callback?: (err: AWSError, data: S3.Types.CreateBucketOutput) => void): Request<S3.Types.CreateBucketOutput, AWSError>;
/**
* 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.
*/
createMultipartUpload(params: S3.Types.CreateMultipartUploadRequest, callback?: (err: AWSError, data: S3.Types.CreateMultipartUploadOutput) => void): Request<S3.Types.CreateMultipartUploadOutput, AWSError>;
/**
* 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.
*/
createMultipartUpload(callback?: (err: AWSError, data: S3.Types.CreateMultipartUploadOutput) => void): Request<S3.Types.CreateMultipartUploadOutput, AWSError>;
/**
* 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.
*/
deleteBucket(params: S3.Types.DeleteBucketRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deleteBucket(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
*/
deleteBucketAnalyticsConfiguration(params: S3.Types.DeleteBucketAnalyticsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
*/
deleteBucketAnalyticsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the CORS configuration information set for the bucket.
*/
deleteBucketCors(params: S3.Types.DeleteBucketCorsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the CORS configuration information set for the bucket.
*/
deleteBucketCors(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the server-side encryption configuration from the bucket.
*/
deleteBucketEncryption(params: S3.Types.DeleteBucketEncryptionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the server-side encryption configuration from the bucket.
*/
deleteBucketEncryption(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an inventory configuration (identified by the inventory ID) from the bucket.
*/
deleteBucketInventoryConfiguration(params: S3.Types.DeleteBucketInventoryConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an inventory configuration (identified by the inventory ID) from the bucket.
*/
deleteBucketInventoryConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the lifecycle configuration from the bucket.
*/
deleteBucketLifecycle(params: S3.Types.DeleteBucketLifecycleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the lifecycle configuration from the bucket.
*/
deleteBucketLifecycle(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.
*/
deleteBucketMetricsConfiguration(params: S3.Types.DeleteBucketMetricsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.
*/
deleteBucketMetricsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the policy from the bucket.
*/
deleteBucketPolicy(params: S3.Types.DeleteBucketPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the policy from the bucket.
*/
deleteBucketPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the replication configuration from the bucket. For information about replication configuration, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.
*/
deleteBucketReplication(params: S3.Types.DeleteBucketReplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the replication configuration from the bucket. For information about replication configuration, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.
*/
deleteBucketReplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the tags from the bucket.
*/
deleteBucketTagging(params: S3.Types.DeleteBucketTaggingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the tags from the bucket.
*/
deleteBucketTagging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation removes the website configuration from the bucket.
*/
deleteBucketWebsite(params: S3.Types.DeleteBucketWebsiteRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation removes the website configuration from the bucket.
*/
deleteBucketWebsite(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deleteObject(params: S3.Types.DeleteObjectRequest, callback?: (err: AWSError, data: S3.Types.DeleteObjectOutput) => void): Request<S3.Types.DeleteObjectOutput, AWSError>;
/**
* 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.
*/
deleteObject(callback?: (err: AWSError, data: S3.Types.DeleteObjectOutput) => void): Request<S3.Types.DeleteObjectOutput, AWSError>;
/**
* Removes the tag-set from an existing object.
*/
deleteObjectTagging(params: S3.Types.DeleteObjectTaggingRequest, callback?: (err: AWSError, data: S3.Types.DeleteObjectTaggingOutput) => void): Request<S3.Types.DeleteObjectTaggingOutput, AWSError>;
/**
* Removes the tag-set from an existing object.
*/
deleteObjectTagging(callback?: (err: AWSError, data: S3.Types.DeleteObjectTaggingOutput) => void): Request<S3.Types.DeleteObjectTaggingOutput, AWSError>;
/**
* This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.
*/
deleteObjects(params: S3.Types.DeleteObjectsRequest, callback?: (err: AWSError, data: S3.Types.DeleteObjectsOutput) => void): Request<S3.Types.DeleteObjectsOutput, AWSError>;
/**
* This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.
*/
deleteObjects(callback?: (err: AWSError, data: S3.Types.DeleteObjectsOutput) => void): Request<S3.Types.DeleteObjectsOutput, AWSError>;
/**
* Removes the PublicAccessBlock configuration from an Amazon S3 bucket.
*/
deletePublicAccessBlock(params: S3.Types.DeletePublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the PublicAccessBlock configuration from an Amazon S3 bucket.
*/
deletePublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns the accelerate configuration of a bucket.
*/
getBucketAccelerateConfiguration(params: S3.Types.GetBucketAccelerateConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketAccelerateConfigurationOutput) => void): Request<S3.Types.GetBucketAccelerateConfigurationOutput, AWSError>;
/**
* Returns the accelerate configuration of a bucket.
*/
getBucketAccelerateConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketAccelerateConfigurationOutput) => void): Request<S3.Types.GetBucketAccelerateConfigurationOutput, AWSError>;
/**
* Gets the access control policy for the bucket.
*/
getBucketAcl(params: S3.Types.GetBucketAclRequest, callback?: (err: AWSError, data: S3.Types.GetBucketAclOutput) => void): Request<S3.Types.GetBucketAclOutput, AWSError>;
/**
* Gets the access control policy for the bucket.
*/
getBucketAcl(callback?: (err: AWSError, data: S3.Types.GetBucketAclOutput) => void): Request<S3.Types.GetBucketAclOutput, AWSError>;
/**
* Gets an analytics configuration for the bucket (specified by the analytics configuration ID).
*/
getBucketAnalyticsConfiguration(params: S3.Types.GetBucketAnalyticsConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketAnalyticsConfigurationOutput) => void): Request<S3.Types.GetBucketAnalyticsConfigurationOutput, AWSError>;
/**
* Gets an analytics configuration for the bucket (specified by the analytics configuration ID).
*/
getBucketAnalyticsConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketAnalyticsConfigurationOutput) => void): Request<S3.Types.GetBucketAnalyticsConfigurationOutput, AWSError>;
/**
* Returns the CORS configuration for the bucket.
*/
getBucketCors(params: S3.Types.GetBucketCorsRequest, callback?: (err: AWSError, data: S3.Types.GetBucketCorsOutput) => void): Request<S3.Types.GetBucketCorsOutput, AWSError>;
/**
* Returns the CORS configuration for the bucket.
*/
getBucketCors(callback?: (err: AWSError, data: S3.Types.GetBucketCorsOutput) => void): Request<S3.Types.GetBucketCorsOutput, AWSError>;
/**
* Returns the server-side encryption configuration of a bucket.
*/
getBucketEncryption(params: S3.Types.GetBucketEncryptionRequest, callback?: (err: AWSError, data: S3.Types.GetBucketEncryptionOutput) => void): Request<S3.Types.GetBucketEncryptionOutput, AWSError>;
/**
* Returns the server-side encryption configuration of a bucket.
*/
getBucketEncryption(callback?: (err: AWSError, data: S3.Types.GetBucketEncryptionOutput) => void): Request<S3.Types.GetBucketEncryptionOutput, AWSError>;
/**
* Returns an inventory configuration (identified by the inventory ID) from the bucket.
*/
getBucketInventoryConfiguration(params: S3.Types.GetBucketInventoryConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketInventoryConfigurationOutput) => void): Request<S3.Types.GetBucketInventoryConfigurationOutput, AWSError>;
/**
* Returns an inventory configuration (identified by the inventory ID) from the bucket.
*/
getBucketInventoryConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketInventoryConfigurationOutput) => void): Request<S3.Types.GetBucketInventoryConfigurationOutput, AWSError>;
/**
* No longer used, see the GetBucketLifecycleConfiguration operation.
*/
getBucketLifecycle(params: S3.Types.GetBucketLifecycleRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleOutput) => void): Request<S3.Types.GetBucketLifecycleOutput, AWSError>;
/**
* No longer used, see the GetBucketLifecycleConfiguration operation.
*/
getBucketLifecycle(callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleOutput) => void): Request<S3.Types.GetBucketLifecycleOutput, AWSError>;
/**
* Returns the lifecycle configuration information set on the bucket.
*/
getBucketLifecycleConfiguration(params: S3.Types.GetBucketLifecycleConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleConfigurationOutput) => void): Request<S3.Types.GetBucketLifecycleConfigurationOutput, AWSError>;
/**
* Returns the lifecycle configuration information set on the bucket.
*/
getBucketLifecycleConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleConfigurationOutput) => void): Request<S3.Types.GetBucketLifecycleConfigurationOutput, AWSError>;
/**
* Returns the region the bucket resides in.
*/
getBucketLocation(params: S3.Types.GetBucketLocationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLocationOutput) => void): Request<S3.Types.GetBucketLocationOutput, AWSError>;
/**
* Returns the region the bucket resides in.
*/
getBucketLocation(callback?: (err: AWSError, data: S3.Types.GetBucketLocationOutput) => void): Request<S3.Types.GetBucketLocationOutput, AWSError>;
/**
* 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.
*/
getBucketLogging(params: S3.Types.GetBucketLoggingRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLoggingOutput) => void): Request<S3.Types.GetBucketLoggingOutput, AWSError>;
/**
* 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.
*/
getBucketLogging(callback?: (err: AWSError, data: S3.Types.GetBucketLoggingOutput) => void): Request<S3.Types.GetBucketLoggingOutput, AWSError>;
/**
* Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
*/
getBucketMetricsConfiguration(params: S3.Types.GetBucketMetricsConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketMetricsConfigurationOutput) => void): Request<S3.Types.GetBucketMetricsConfigurationOutput, AWSError>;
/**
* Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
*/
getBucketMetricsConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketMetricsConfigurationOutput) => void): Request<S3.Types.GetBucketMetricsConfigurationOutput, AWSError>;
/**
* No longer used, see the GetBucketNotificationConfiguration operation.
*/
getBucketNotification(params: S3.Types.GetBucketNotificationConfigurationRequest, callback?: (err: AWSError, data: S3.Types.NotificationConfigurationDeprecated) => void): Request<S3.Types.NotificationConfigurationDeprecated, AWSError>;
/**
* No longer used, see the GetBucketNotificationConfiguration operation.
*/
getBucketNotification(callback?: (err: AWSError, data: S3.Types.NotificationConfigurationDeprecated) => void): Request<S3.Types.NotificationConfigurationDeprecated, AWSError>;
/**
* Returns the notification configuration of a bucket.
*/
getBucketNotificationConfiguration(params: S3.Types.GetBucketNotificationConfigurationRequest, callback?: (err: AWSError, data: S3.Types.NotificationConfiguration) => void): Request<S3.Types.NotificationConfiguration, AWSError>;
/**
* Returns the notification configuration of a bucket.
*/
getBucketNotificationConfiguration(callback?: (err: AWSError, data: S3.Types.NotificationConfiguration) => void): Request<S3.Types.NotificationConfiguration, AWSError>;
/**
* Returns the policy of a specified bucket.
*/
getBucketPolicy(params: S3.Types.GetBucketPolicyRequest, callback?: (err: AWSError, data: S3.Types.GetBucketPolicyOutput) => void): Request<S3.Types.GetBucketPolicyOutput, AWSError>;
/**
* Returns the policy of a specified bucket.
*/
getBucketPolicy(callback?: (err: AWSError, data: S3.Types.GetBucketPolicyOutput) => void): Request<S3.Types.GetBucketPolicyOutput, AWSError>;
/**
* Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
*/
getBucketPolicyStatus(params: S3.Types.GetBucketPolicyStatusRequest, callback?: (err: AWSError, data: S3.Types.GetBucketPolicyStatusOutput) => void): Request<S3.Types.GetBucketPolicyStatusOutput, AWSError>;
/**
* Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
*/
getBucketPolicyStatus(callback?: (err: AWSError, data: S3.Types.GetBucketPolicyStatusOutput) => void): Request<S3.Types.GetBucketPolicyStatusOutput, AWSError>;
/**
* 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.
*/
getBucketReplication(params: S3.Types.GetBucketReplicationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketReplicationOutput) => void): Request<S3.Types.GetBucketReplicationOutput, AWSError>;
/**
* 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.
*/
getBucketReplication(callback?: (err: AWSError, data: S3.Types.GetBucketReplicationOutput) => void): Request<S3.Types.GetBucketReplicationOutput, AWSError>;
/**
* Returns the request payment configuration of a bucket.
*/
getBucketRequestPayment(params: S3.Types.GetBucketRequestPaymentRequest, callback?: (err: AWSError, data: S3.Types.GetBucketRequestPaymentOutput) => void): Request<S3.Types.GetBucketRequestPaymentOutput, AWSError>;
/**
* Returns the request payment configuration of a bucket.
*/
getBucketRequestPayment(callback?: (err: AWSError, data: S3.Types.GetBucketRequestPaymentOutput) => void): Request<S3.Types.GetBucketRequestPaymentOutput, AWSError>;
/**
* Returns the tag set associated with the bucket.
*/
getBucketTagging(params: S3.Types.GetBucketTaggingRequest, callback?: (err: AWSError, data: S3.Types.GetBucketTaggingOutput) => void): Request<S3.Types.GetBucketTaggingOutput, AWSError>;
/**
* Returns the tag set associated with the bucket.
*/
getBucketTagging(callback?: (err: AWSError, data: S3.Types.GetBucketTaggingOutput) => void): Request<S3.Types.GetBucketTaggingOutput, AWSError>;
/**
* Returns the versioning state of a bucket.
*/
getBucketVersioning(params: S3.Types.GetBucketVersioningRequest, callback?: (err: AWSError, data: S3.Types.GetBucketVersioningOutput) => void): Request<S3.Types.GetBucketVersioningOutput, AWSError>;
/**
* Returns the versioning state of a bucket.
*/
getBucketVersioning(callback?: (err: AWSError, data: S3.Types.GetBucketVersioningOutput) => void): Request<S3.Types.GetBucketVersioningOutput, AWSError>;
/**
* Returns the website configuration for a bucket.
*/
getBucketWebsite(params: S3.Types.GetBucketWebsiteRequest, callback?: (err: AWSError, data: S3.Types.GetBucketWebsiteOutput) => void): Request<S3.Types.GetBucketWebsiteOutput, AWSError>;
/**
* Returns the website configuration for a bucket.
*/
getBucketWebsite(callback?: (err: AWSError, data: S3.Types.GetBucketWebsiteOutput) => void): Request<S3.Types.GetBucketWebsiteOutput, AWSError>;
/**
* Retrieves objects from Amazon S3.
*/
getObject(params: S3.Types.GetObjectRequest, callback?: (err: AWSError, data: S3.Types.GetObjectOutput) => void): Request<S3.Types.GetObjectOutput, AWSError>;
/**
* Retrieves objects from Amazon S3.
*/
getObject(callback?: (err: AWSError, data: S3.Types.GetObjectOutput) => void): Request<S3.Types.GetObjectOutput, AWSError>;
/**
* Returns the access control list (ACL) of an object.
*/
getObjectAcl(params: S3.Types.GetObjectAclRequest, callback?: (err: AWSError, data: S3.Types.GetObjectAclOutput) => void): Request<S3.Types.GetObjectAclOutput, AWSError>;
/**
* Returns the access control list (ACL) of an object.
*/
getObjectAcl(callback?: (err: AWSError, data: S3.Types.GetObjectAclOutput) => void): Request<S3.Types.GetObjectAclOutput, AWSError>;
/**
* Gets an object's current Legal Hold status.
*/
getObjectLegalHold(params: S3.Types.GetObjectLegalHoldRequest, callback?: (err: AWSError, data: S3.Types.GetObjectLegalHoldOutput) => void): Request<S3.Types.GetObjectLegalHoldOutput, AWSError>;
/**
* Gets an object's current Legal Hold status.
*/
getObjectLegalHold(callback?: (err: AWSError, data: S3.Types.GetObjectLegalHoldOutput) => void): Request<S3.Types.GetObjectLegalHoldOutput, AWSError>;
/**
* 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.
*/
getObjectLockConfiguration(params: S3.Types.GetObjectLockConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetObjectLockConfigurationOutput) => void): Request<S3.Types.GetObjectLockConfigurationOutput, AWSError>;
/**
* 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.
*/
getObjectLockConfiguration(callback?: (err: AWSError, data: S3.Types.GetObjectLockConfigurationOutput) => void): Request<S3.Types.GetObjectLockConfigurationOutput, AWSError>;
/**
* Retrieves an object's retention settings.
*/
getObjectRetention(params: S3.Types.GetObjectRetentionRequest, callback?: (err: AWSError, data: S3.Types.GetObjectRetentionOutput) => void): Request<S3.Types.GetObjectRetentionOutput, AWSError>;
/**
* Retrieves an object's retention settings.
*/
getObjectRetention(callback?: (err: AWSError, data: S3.Types.GetObjectRetentionOutput) => void): Request<S3.Types.GetObjectRetentionOutput, AWSError>;
/**
* Returns the tag-set of an object.
*/
getObjectTagging(params: S3.Types.GetObjectTaggingRequest, callback?: (err: AWSError, data: S3.Types.GetObjectTaggingOutput) => void): Request<S3.Types.GetObjectTaggingOutput, AWSError>;
/**
* Returns the tag-set of an object.
*/
getObjectTagging(callback?: (err: AWSError, data: S3.Types.GetObjectTaggingOutput) => void): Request<S3.Types.GetObjectTaggingOutput, AWSError>;
/**
* Return torrent files from a bucket.
*/
getObjectTorrent(params: S3.Types.GetObjectTorrentRequest, callback?: (err: AWSError, data: S3.Types.GetObjectTorrentOutput) => void): Request<S3.Types.GetObjectTorrentOutput, AWSError>;
/**
* Return torrent files from a bucket.
*/
getObjectTorrent(callback?: (err: AWSError, data: S3.Types.GetObjectTorrentOutput) => void): Request<S3.Types.GetObjectTorrentOutput, AWSError>;
/**
* Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket.
*/
getPublicAccessBlock(params: S3.Types.GetPublicAccessBlockRequest, callback?: (err: AWSError, data: S3.Types.GetPublicAccessBlockOutput) => void): Request<S3.Types.GetPublicAccessBlockOutput, AWSError>;
/**
* Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket.
*/
getPublicAccessBlock(callback?: (err: AWSError, data: S3.Types.GetPublicAccessBlockOutput) => void): Request<S3.Types.GetPublicAccessBlockOutput, AWSError>;
/**
* This operation is useful to determine if a bucket exists and you have permission to access it.
*/
headBucket(params: S3.Types.HeadBucketRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation is useful to determine if a bucket exists and you have permission to access it.
*/
headBucket(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
headObject(params: S3.Types.HeadObjectRequest, callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
/**
* 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.
*/
headObject(callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
/**
* Lists the analytics configurations for the bucket.
*/
listBucketAnalyticsConfigurations(params: S3.Types.ListBucketAnalyticsConfigurationsRequest, callback?: (err: AWSError, data: S3.Types.ListBucketAnalyticsConfigurationsOutput) => void): Request<S3.Types.ListBucketAnalyticsConfigurationsOutput, AWSError>;
/**
* Lists the analytics configurations for the bucket.
*/
listBucketAnalyticsConfigurations(callback?: (err: AWSError, data: S3.Types.ListBucketAnalyticsConfigurationsOutput) => void): Request<S3.Types.ListBucketAnalyticsConfigurationsOutput, AWSError>;
/**
* Returns a list of inventory configurations for the bucket.
*/
listBucketInventoryConfigurations(params: S3.Types.ListBucketInventoryConfigurationsRequest, callback?: (err: AWSError, data: S3.Types.ListBucketInventoryConfigurationsOutput) => void): Request<S3.Types.ListBucketInventoryConfigurationsOutput, AWSError>;
/**
* Returns a list of inventory configurations for the bucket.
*/
listBucketInventoryConfigurations(callback?: (err: AWSError, data: S3.Types.ListBucketInventoryConfigurationsOutput) => void): Request<S3.Types.ListBucketInventoryConfigurationsOutput, AWSError>;
/**
* Lists the metrics configurations for the bucket.
*/
listBucketMetricsConfigurations(params: S3.Types.ListBucketMetricsConfigurationsRequest, callback?: (err: AWSError, data: S3.Types.ListBucketMetricsConfigurationsOutput) => void): Request<S3.Types.ListBucketMetricsConfigurationsOutput, AWSError>;
/**
* Lists the metrics configurations for the bucket.
*/
listBucketMetricsConfigurations(callback?: (err: AWSError, data: S3.Types.ListBucketMetricsConfigurationsOutput) => void): Request<S3.Types.ListBucketMetricsConfigurationsOutput, AWSError>;
/**
* Returns a list of all buckets owned by the authenticated sender of the request.
*/
listBuckets(callback?: (err: AWSError, data: S3.Types.ListBucketsOutput) => void): Request<S3.Types.ListBucketsOutput, AWSError>;
/**
* This operation lists in-progress multipart uploads.
*/
listMultipartUploads(params: S3.Types.ListMultipartUploadsRequest, callback?: (err: AWSError, data: S3.Types.ListMultipartUploadsOutput) => void): Request<S3.Types.ListMultipartUploadsOutput, AWSError>;
/**
* This operation lists in-progress multipart uploads.
*/
listMultipartUploads(callback?: (err: AWSError, data: S3.Types.ListMultipartUploadsOutput) => void): Request<S3.Types.ListMultipartUploadsOutput, AWSError>;
/**
* Returns metadata about all of the versions of objects in a bucket.
*/
listObjectVersions(params: S3.Types.ListObjectVersionsRequest, callback?: (err: AWSError, data: S3.Types.ListObjectVersionsOutput) => void): Request<S3.Types.ListObjectVersionsOutput, AWSError>;
/**
* Returns metadata about all of the versions of objects in a bucket.
*/
listObjectVersions(callback?: (err: AWSError, data: S3.Types.ListObjectVersionsOutput) => void): Request<S3.Types.ListObjectVersionsOutput, AWSError>;
/**
* 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.
*/
listObjects(params: S3.Types.ListObjectsRequest, callback?: (err: AWSError, data: S3.Types.ListObjectsOutput) => void): Request<S3.Types.ListObjectsOutput, AWSError>;
/**
* 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.
*/
listObjects(callback?: (err: AWSError, data: S3.Types.ListObjectsOutput) => void): Request<S3.Types.ListObjectsOutput, AWSError>;
/**
* 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.
*/
listObjectsV2(params: S3.Types.ListObjectsV2Request, callback?: (err: AWSError, data: S3.Types.ListObjectsV2Output) => void): Request<S3.Types.ListObjectsV2Output, AWSError>;
/**
* 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.
*/
listObjectsV2(callback?: (err: AWSError, data: S3.Types.ListObjectsV2Output) => void): Request<S3.Types.ListObjectsV2Output, AWSError>;
/**
* Lists the parts that have been uploaded for a specific multipart upload.
*/
listParts(params: S3.Types.ListPartsRequest, callback?: (err: AWSError, data: S3.Types.ListPartsOutput) => void): Request<S3.Types.ListPartsOutput, AWSError>;
/**
* Lists the parts that have been uploaded for a specific multipart upload.
*/
listParts(callback?: (err: AWSError, data: S3.Types.ListPartsOutput) => void): Request<S3.Types.ListPartsOutput, AWSError>;
/**
* Sets the accelerate configuration of an existing bucket.
*/
putBucketAccelerateConfiguration(params: S3.Types.PutBucketAccelerateConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the accelerate configuration of an existing bucket.
*/
putBucketAccelerateConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the permissions on a bucket using access control lists (ACL).
*/
putBucketAcl(params: S3.Types.PutBucketAclRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the permissions on a bucket using access control lists (ACL).
*/
putBucketAcl(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
*/
putBucketAnalyticsConfiguration(params: S3.Types.PutBucketAnalyticsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
*/
putBucketAnalyticsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the CORS configuration for a bucket.
*/
putBucketCors(params: S3.Types.PutBucketCorsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the CORS configuration for a bucket.
*/
putBucketCors(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a new server-side encryption configuration (or replaces an existing one, if present).
*/
putBucketEncryption(params: S3.Types.PutBucketEncryptionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a new server-side encryption configuration (or replaces an existing one, if present).
*/
putBucketEncryption(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds an inventory configuration (identified by the inventory ID) from the bucket.
*/
putBucketInventoryConfiguration(params: S3.Types.PutBucketInventoryConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds an inventory configuration (identified by the inventory ID) from the bucket.
*/
putBucketInventoryConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* No longer used, see the PutBucketLifecycleConfiguration operation.
*/
putBucketLifecycle(params: S3.Types.PutBucketLifecycleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* No longer used, see the PutBucketLifecycleConfiguration operation.
*/
putBucketLifecycle(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.
*/
putBucketLifecycleConfiguration(params: S3.Types.PutBucketLifecycleConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.
*/
putBucketLifecycleConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
putBucketLogging(params: S3.Types.PutBucketLoggingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
putBucketLogging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
*/
putBucketMetricsConfiguration(params: S3.Types.PutBucketMetricsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
*/
putBucketMetricsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* No longer used, see the PutBucketNotificationConfiguration operation.
*/
putBucketNotification(params: S3.Types.PutBucketNotificationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* No longer used, see the PutBucketNotificationConfiguration operation.
*/
putBucketNotification(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables notifications of specified events for a bucket.
*/
putBucketNotificationConfiguration(params: S3.Types.PutBucketNotificationConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables notifications of specified events for a bucket.
*/
putBucketNotificationConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.
*/
putBucketPolicy(params: S3.Types.PutBucketPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.
*/
putBucketPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.
*/
putBucketReplication(params: S3.Types.PutBucketReplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.
*/
putBucketReplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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
*/
putBucketRequestPayment(params: S3.Types.PutBucketRequestPaymentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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
*/
putBucketRequestPayment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the tags for a bucket.
*/
putBucketTagging(params: S3.Types.PutBucketTaggingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the tags for a bucket.
*/
putBucketTagging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
*/
putBucketVersioning(params: S3.Types.PutBucketVersioningRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
*/
putBucketVersioning(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Set the website configuration for a bucket.
*/
putBucketWebsite(params: S3.Types.PutBucketWebsiteRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Set the website configuration for a bucket.
*/
putBucketWebsite(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds an object to a bucket.
*/
putObject(params: S3.Types.PutObjectRequest, callback?: (err: AWSError, data: S3.Types.PutObjectOutput) => void): Request<S3.Types.PutObjectOutput, AWSError>;
/**
* Adds an object to a bucket.
*/
putObject(callback?: (err: AWSError, data: S3.Types.PutObjectOutput) => void): Request<S3.Types.PutObjectOutput, AWSError>;
/**
* uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket
*/
putObjectAcl(params: S3.Types.PutObjectAclRequest, callback?: (err: AWSError, data: S3.Types.PutObjectAclOutput) => void): Request<S3.Types.PutObjectAclOutput, AWSError>;
/**
* uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket
*/
putObjectAcl(callback?: (err: AWSError, data: S3.Types.PutObjectAclOutput) => void): Request<S3.Types.PutObjectAclOutput, AWSError>;
/**
* Applies a Legal Hold configuration to the specified object.
*/
putObjectLegalHold(params: S3.Types.PutObjectLegalHoldRequest, callback?: (err: AWSError, data: S3.Types.PutObjectLegalHoldOutput) => void): Request<S3.Types.PutObjectLegalHoldOutput, AWSError>;
/**
* Applies a Legal Hold configuration to the specified object.
*/
putObjectLegalHold(callback?: (err: AWSError, data: S3.Types.PutObjectLegalHoldOutput) => void): Request<S3.Types.PutObjectLegalHoldOutput, AWSError>;
/**
* 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.
*/
putObjectLockConfiguration(params: S3.Types.PutObjectLockConfigurationRequest, callback?: (err: AWSError, data: S3.Types.PutObjectLockConfigurationOutput) => void): Request<S3.Types.PutObjectLockConfigurationOutput, AWSError>;
/**
* 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.
*/
putObjectLockConfiguration(callback?: (err: AWSError, data: S3.Types.PutObjectLockConfigurationOutput) => void): Request<S3.Types.PutObjectLockConfigurationOutput, AWSError>;
/**
* Places an Object Retention configuration on an object.
*/
putObjectRetention(params: S3.Types.PutObjectRetentionRequest, callback?: (err: AWSError, data: S3.Types.PutObjectRetentionOutput) => void): Request<S3.Types.PutObjectRetentionOutput, AWSError>;
/**
* Places an Object Retention configuration on an object.
*/
putObjectRetention(callback?: (err: AWSError, data: S3.Types.PutObjectRetentionOutput) => void): Request<S3.Types.PutObjectRetentionOutput, AWSError>;
/**
* Sets the supplied tag-set to an object that already exists in a bucket
*/
putObjectTagging(params: S3.Types.PutObjectTaggingRequest, callback?: (err: AWSError, data: S3.Types.PutObjectTaggingOutput) => void): Request<S3.Types.PutObjectTaggingOutput, AWSError>;
/**
* Sets the supplied tag-set to an object that already exists in a bucket
*/
putObjectTagging(callback?: (err: AWSError, data: S3.Types.PutObjectTaggingOutput) => void): Request<S3.Types.PutObjectTaggingOutput, AWSError>;
/**
* Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.
*/
putPublicAccessBlock(params: S3.Types.PutPublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.
*/
putPublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Restores an archived copy of an object back into Amazon S3
*/
restoreObject(params: S3.Types.RestoreObjectRequest, callback?: (err: AWSError, data: S3.Types.RestoreObjectOutput) => void): Request<S3.Types.RestoreObjectOutput, AWSError>;
/**
* Restores an archived copy of an object back into Amazon S3
*/
restoreObject(callback?: (err: AWSError, data: S3.Types.RestoreObjectOutput) => void): Request<S3.Types.RestoreObjectOutput, AWSError>;
/**
* 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.
*/
selectObjectContent(params: S3.Types.SelectObjectContentRequest, callback?: (err: AWSError, data: S3.Types.SelectObjectContentOutput) => void): Request<S3.Types.SelectObjectContentOutput, AWSError>;
/**
* 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.
*/
selectObjectContent(callback?: (err: AWSError, data: S3.Types.SelectObjectContentOutput) => void): Request<S3.Types.SelectObjectContentOutput, AWSError>;
/**
* 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.
*/
uploadPart(params: S3.Types.UploadPartRequest, callback?: (err: AWSError, data: S3.Types.UploadPartOutput) => void): Request<S3.Types.UploadPartOutput, AWSError>;
/**
* 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.
*/
uploadPart(callback?: (err: AWSError, data: S3.Types.UploadPartOutput) => void): Request<S3.Types.UploadPartOutput, AWSError>;
/**
* Uploads a part by copying data from an existing object as data source.
*/
uploadPartCopy(params: S3.Types.UploadPartCopyRequest, callback?: (err: AWSError, data: S3.Types.UploadPartCopyOutput) => void): Request<S3.Types.UploadPartCopyOutput, AWSError>;
/**
* Uploads a part by copying data from an existing object as data source.
*/
uploadPartCopy(callback?: (err: AWSError, data: S3.Types.UploadPartCopyOutput) => void): Request<S3.Types.UploadPartCopyOutput, AWSError>;
/**
* Waits for the bucketExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times).
*/
waitFor(state: "bucketExists", params: S3.Types.HeadBucketRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Waits for the bucketExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times).
*/
waitFor(state: "bucketExists", callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Waits for the bucketNotExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times).
*/
waitFor(state: "bucketNotExists", params: S3.Types.HeadBucketRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Waits for the bucketNotExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times).
*/
waitFor(state: "bucketNotExists", callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Waits for the objectExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times).
*/
waitFor(state: "objectExists", params: S3.Types.HeadObjectRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
/**
* Waits for the objectExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times).
*/
waitFor(state: "objectExists", callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
/**
* Waits for the objectNotExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times).
*/
waitFor(state: "objectNotExists", params: S3.Types.HeadObjectRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
/**
* Waits for the objectNotExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times).
*/
waitFor(state: "objectNotExists", callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
}
declare namespace S3 {
export import ManagedUpload = managed_upload;
export import PresignedPost = presigned_post;
}
declare namespace S3 {
export type AbortDate = Date;
export interface AbortIncompleteMultipartUpload {
/**
* Indicates the number of days that must pass since initiation for Lifecycle to abort an Incomplete Multipart Upload.
*/
DaysAfterInitiation?: DaysAfterInitiation;
}
export interface AbortMultipartUploadOutput {
RequestCharged?: RequestCharged;
}
export interface AbortMultipartUploadRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
Key: ObjectKey;
/**
*
*/
UploadId: MultipartUploadId;
RequestPayer?: RequestPayer;
}
export type AbortRuleId = string;
export interface AccelerateConfiguration {
/**
* The accelerate configuration of the bucket.
*/
Status?: BucketAccelerateStatus;
}
export type AcceptRanges = string;
export interface AccessControlPolicy {
/**
* A list of grants.
*/
Grants?: Grants;
/**
*
*/
Owner?: Owner;
}
export interface AccessControlTranslation {
/**
* The override value for the owner of the replica object.
*/
Owner: OwnerOverride;
}
export type AccountId = string;
export type AllowQuotedRecordDelimiter = boolean;
export type AllowedHeader = string;
export type AllowedHeaders = AllowedHeader[];
export type AllowedMethod = string;
export type AllowedMethods = AllowedMethod[];
export type AllowedOrigin = string;
export type AllowedOrigins = AllowedOrigin[];
export interface AnalyticsAndOperator {
/**
* The prefix to use when evaluating an AND predicate.
*/
Prefix?: Prefix;
/**
* The list of tags to use when evaluating an AND predicate.
*/
Tags?: TagSet;
}
export interface AnalyticsConfiguration {
/**
* The identifier used to represent an analytics configuration.
*/
Id: AnalyticsId;
/**
* The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.
*/
Filter?: AnalyticsFilter;
/**
* If present, it indicates that data related to access patterns will be collected and made available to analyze the tradeoffs between different storage classes.
*/
StorageClassAnalysis: StorageClassAnalysis;
}
export type AnalyticsConfigurationList = AnalyticsConfiguration[];
export interface AnalyticsExportDestination {
/**
* A destination signifying output to an S3 bucket.
*/
S3BucketDestination: AnalyticsS3BucketDestination;
}
export interface AnalyticsFilter {
/**
* The prefix to use when evaluating an analytics filter.
*/
Prefix?: Prefix;
/**
* The tag to use when evaluating an analytics filter.
*/
Tag?: Tag;
/**
* A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.
*/
And?: AnalyticsAndOperator;
}
export type AnalyticsId = string;
export interface AnalyticsS3BucketDestination {
/**
* The file format used when exporting data to Amazon S3.
*/
Format: AnalyticsS3ExportFileFormat;
/**
* The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data.
*/
BucketAccountId?: AccountId;
/**
* The Amazon resource name (ARN) of the bucket to which data is exported.
*/
Bucket: BucketName;
/**
* The prefix to use when exporting data. The exported data begins with this prefix.
*/
Prefix?: Prefix;
}
export type AnalyticsS3ExportFileFormat = "CSV"|string;
export type Body = Buffer|Uint8Array|Blob|string|Readable;
export interface Bucket {
/**
* The name of the bucket.
*/
Name?: BucketName;
/**
* Date the bucket was created.
*/
CreationDate?: CreationDate;
}
export type BucketAccelerateStatus = "Enabled"|"Suspended"|string;
export type BucketCannedACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|string;
export interface BucketLifecycleConfiguration {
/**
*
*/
Rules: LifecycleRules;
}
export type BucketLocationConstraint = "EU"|"eu-west-1"|"us-west-1"|"us-west-2"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"sa-east-1"|"cn-north-1"|"eu-central-1"|string;
export interface BucketLoggingStatus {
LoggingEnabled?: LoggingEnabled;
}
export type BucketLogsPermission = "FULL_CONTROL"|"READ"|"WRITE"|string;
export type BucketName = string;
export type BucketVersioningStatus = "Enabled"|"Suspended"|string;
export type Buckets = Bucket[];
export type BypassGovernanceRetention = boolean;
export type BytesProcessed = number;
export type BytesReturned = number;
export type BytesScanned = number;
export interface CORSConfiguration {
/**
*
*/
CORSRules: CORSRules;
}
export interface CORSRule {
/**
* Specifies which headers are allowed in a pre-flight OPTIONS request.
*/
AllowedHeaders?: AllowedHeaders;
/**
* Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.
*/
AllowedMethods: AllowedMethods;
/**
* One or more origins you want customers to be able to access the bucket from.
*/
AllowedOrigins: AllowedOrigins;
/**
* One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
*/
ExposeHeaders?: ExposeHeaders;
/**
* The time in seconds that your browser is to cache the preflight response for the specified resource.
*/
MaxAgeSeconds?: MaxAgeSeconds;
}
export type CORSRules = CORSRule[];
export interface CSVInput {
/**
* Describes the first line of input. Valid values: None, Ignore, Use.
*/
FileHeaderInfo?: FileHeaderInfo;
/**
* The single character used to indicate a row should be ignored when present at the start of a row.
*/
Comments?: Comments;
/**
* The single character used for escaping the quote character inside an already escaped value.
*/
QuoteEscapeCharacter?: QuoteEscapeCharacter;
/**
* The value used to separate individual records.
*/
RecordDelimiter?: RecordDelimiter;
/**
* The value used to separate individual fields in a record.
*/
FieldDelimiter?: FieldDelimiter;
/**
* Value used for escaping where the field delimiter is part of the value.
*/
QuoteCharacter?: QuoteCharacter;
/**
* Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.
*/
AllowQuotedRecordDelimiter?: AllowQuotedRecordDelimiter;
}
export interface CSVOutput {
/**
* Indicates whether or not all output fields should be quoted.
*/
QuoteFields?: QuoteFields;
/**
* Th single character used for escaping the quote character inside an already escaped value.
*/
QuoteEscapeCharacter?: QuoteEscapeCharacter;
/**
* The value used to separate individual records.
*/
RecordDelimiter?: RecordDelimiter;
/**
* The value used to separate individual fields in a record.
*/
FieldDelimiter?: FieldDelimiter;
/**
* The value used for escaping where the field delimiter is part of the value.
*/
QuoteCharacter?: QuoteCharacter;
}
export type CacheControl = string;
export type CloudFunction = string;
export interface CloudFunctionConfiguration {
Id?: NotificationId;
Event?: Event;
/**
*
*/
Events?: EventList;
/**
*
*/
CloudFunction?: CloudFunction;
/**
*
*/
InvocationRole?: CloudFunctionInvocationRole;
}
export type CloudFunctionInvocationRole = string;
export type Code = string;
export type Comments = string;
export interface CommonPrefix {
/**
*
*/
Prefix?: Prefix;
}
export type CommonPrefixList = CommonPrefix[];
export interface CompleteMultipartUploadOutput {
/**
*
*/
Location?: Location;
/**
*
*/
Bucket?: BucketName;
/**
*
*/
Key?: ObjectKey;
/**
* If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.
*/
Expiration?: Expiration;
/**
* Entity tag of the object.
*/
ETag?: ETag;
/**
* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
*/
ServerSideEncryption?: ServerSideEncryption;
/**
* Version of the object.
*/
VersionId?: ObjectVersionId;
/**
* If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
*/
SSEKMSKeyId?: SSEKMSKeyId;
RequestCharged?: RequestCharged;
}
export interface CompleteMultipartUploadRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
Key: ObjectKey;
/**
*
*/
MultipartUpload?: CompletedMultipartUpload;
/**
*
*/
UploadId: MultipartUploadId;
RequestPayer?: RequestPayer;
}
export interface CompletedMultipartUpload {
/**
*
*/
Parts?: CompletedPartList;
}
export interface CompletedPart {
/**
* Entity tag returned when the part was uploaded.
*/
ETag?: ETag;
/**
* Part number that identifies the part. This is a positive integer between 1 and 10,000.
*/
PartNumber?: PartNumber;
}
export type CompletedPartList = CompletedPart[];
export type CompressionType = "NONE"|"GZIP"|"BZIP2"|string;
export interface Condition {
/**
* The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.
*/
HttpErrorCodeReturnedEquals?: HttpErrorCodeReturnedEquals;
/**
* The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.
*/
KeyPrefixEquals?: KeyPrefixEquals;
}
export type ConfirmRemoveSelfBucketAccess = boolean;
export type ContentDisposition = string;
export type ContentEncoding = string;
export type ContentLanguage = string;
export type ContentLength = number;
export type ContentMD5 = string;
export type ContentRange = string;
export type ContentType = string;
export interface ContinuationEvent {
}
export interface CopyObjectOutput {
/**
*
*/
CopyObjectResult?: CopyObjectResult;
/**
* If the object expiration is configured, the response includes this header.
*/
Expiration?: Expiration;
/**
*
*/
CopySourceVersionId?: CopySourceVersionId;
/**
* Version ID of the newly created copy.
*/
VersionId?: ObjectVersionId;
/**
* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
*/
ServerSideEncryption?: ServerSideEncryption;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
*/
SSEKMSKeyId?: SSEKMSKeyId;
RequestCharged?: RequestCharged;
}
export interface CopyObjectRequest {
/**
* The canned ACL to apply to the object.
*/
ACL?: ObjectCannedACL;
/**
*
*/
Bucket: BucketName;
/**
* Specifies caching behavior along the request/reply chain.
*/
CacheControl?: CacheControl;
/**
* Specifies presentational information for the object.
*/
ContentDisposition?: ContentDisposition;
/**
* Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
*/
ContentEncoding?: ContentEncoding;
/**
* The language the content is in.
*/
ContentLanguage?: ContentLanguage;
/**
* A standard MIME type describing the format of the object data.
*/
ContentType?: ContentType;
/**
* The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.
*/
CopySource: CopySource;
/**
* Copies the object if its entity tag (ETag) matches the specified tag.
*/
CopySourceIfMatch?: CopySourceIfMatch;
/**
* Copies the object if it has been modified since the specified time.
*/
CopySourceIfModifiedSince?: CopySourceIfModifiedSince;
/**
* Copies the object if its entity tag (ETag) is different than the specified ETag.
*/
CopySourceIfNoneMatch?: CopySourceIfNoneMatch;
/**
* Copies the object if it hasn't been modified since the specified time.
*/
CopySourceIfUnmodifiedSince?: CopySourceIfUnmodifiedSince;
/**
* The date and time at which the object is no longer cacheable.
*/
Expires?: Expires;
/**
* Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
*/
GrantFullControl?: GrantFullControl;
/**
* Allows grantee to read the object data and its metadata.
*/
GrantRead?: GrantRead;
/**
* Allows grantee to read the object ACL.
*/
GrantReadACP?: GrantReadACP;
/**
* Allows grantee to write the ACL for the applicable object.
*/
GrantWriteACP?: GrantWriteACP;
/**
*
*/
Key: ObjectKey;
/**
* A map of metadata to store with the object in S3.
*/
Metadata?: Metadata;
/**
* Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
*/
MetadataDirective?: MetadataDirective;
/**
* Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
*/
TaggingDirective?: TaggingDirective;
/**
* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
*/
ServerSideEncryption?: ServerSideEncryption;
/**
* The type of storage to use for the object. Defaults to 'STANDARD'.
*/
StorageClass?: StorageClass;
/**
* If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
*/
WebsiteRedirectLocation?: WebsiteRedirectLocation;
/**
* Specifies the algorithm to use to when encrypting the object (e.g., AES256).
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
*/
SSECustomerKey?: SSECustomerKey;
/**
* Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
*/
SSEKMSKeyId?: SSEKMSKeyId;
/**
* Specifies the algorithm to use when decrypting the source object (e.g., AES256).
*/
CopySourceSSECustomerAlgorithm?: CopySourceSSECustomerAlgorithm;
/**
* Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
*/
CopySourceSSECustomerKey?: CopySourceSSECustomerKey;
/**
* Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
*/
CopySourceSSECustomerKeyMD5?: CopySourceSSECustomerKeyMD5;
RequestPayer?: RequestPayer;
/**
* The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters
*/
Tagging?: TaggingHeader;
/**
* The Object Lock mode that you want to apply to the copied object.
*/
ObjectLockMode?: ObjectLockMode;
/**
* The date and time when you want the copied object's Object Lock to expire.
*/
ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
/**
* Specifies whether you want to apply a Legal Hold to the copied object.
*/
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
}
export interface CopyObjectResult {
/**
*
*/
ETag?: ETag;
/**
*
*/
LastModified?: LastModified;
}
export interface CopyPartResult {
/**
* Entity tag of the object.
*/
ETag?: ETag;
/**
* Date and time at which the object was uploaded.
*/
LastModified?: LastModified;
}
export type CopySource = string;
export type CopySourceIfMatch = string;
export type CopySourceIfModifiedSince = Date;
export type CopySourceIfNoneMatch = string;
export type CopySourceIfUnmodifiedSince = Date;
export type CopySourceRange = string;
export type CopySourceSSECustomerAlgorithm = string;
export type CopySourceSSECustomerKey = Buffer|Uint8Array|Blob|string;
export type CopySourceSSECustomerKeyMD5 = string;
export type CopySourceVersionId = string;
export interface CreateBucketConfiguration {
/**
* Specifies the region where the bucket will be created. If you don't specify a region, the bucket is created in US East (N. Virginia) Region (us-east-1).
*/
LocationConstraint?: BucketLocationConstraint;
}
export interface CreateBucketOutput {
/**
*
*/
Location?: Location;
}
export interface CreateBucketRequest {
/**
* The canned ACL to apply to the bucket.
*/
ACL?: BucketCannedACL;
/**
*
*/
Bucket: BucketName;
/**
*
*/
CreateBucketConfiguration?: CreateBucketConfiguration;
/**
* Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
*/
GrantFullControl?: GrantFullControl;
/**
* Allows grantee to list the objects in the bucket.
*/
GrantRead?: GrantRead;
/**
* Allows grantee to read the bucket ACL.
*/
GrantReadACP?: GrantReadACP;
/**
* Allows grantee to create, overwrite, and delete any object in the bucket.
*/
GrantWrite?: GrantWrite;
/**
* Allows grantee to write the ACL for the applicable bucket.
*/
GrantWriteACP?: GrantWriteACP;
/**
* Specifies whether you want S3 Object Lock to be enabled for the new bucket.
*/
ObjectLockEnabledForBucket?: ObjectLockEnabledForBucket;
}
export interface CreateMultipartUploadOutput {
/**
* Date when multipart upload will become eligible for abort operation by lifecycle.
*/
AbortDate?: AbortDate;
/**
* Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
*/
AbortRuleId?: AbortRuleId;
/**
* Name of the bucket to which the multipart upload was initiated.
*/
Bucket?: BucketName;
/**
* Object key for which the multipart upload was initiated.
*/
Key?: ObjectKey;
/**
* ID for the initiated multipart upload.
*/
UploadId?: MultipartUploadId;
/**
* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
*/
ServerSideEncryption?: ServerSideEncryption;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
*/
SSEKMSKeyId?: SSEKMSKeyId;
RequestCharged?: RequestCharged;
}
export interface CreateMultipartUploadRequest {
/**
* The canned ACL to apply to the object.
*/
ACL?: ObjectCannedACL;
/**
*
*/
Bucket: BucketName;
/**
* Specifies caching behavior along the request/reply chain.
*/
CacheControl?: CacheControl;
/**
* Specifies presentational information for the object.
*/
ContentDisposition?: ContentDisposition;
/**
* Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
*/
ContentEncoding?: ContentEncoding;
/**
* The language the content is in.
*/
ContentLanguage?: ContentLanguage;
/**
* A standard MIME type describing the format of the object data.
*/
ContentType?: ContentType;
/**
* The date and time at which the object is no longer cacheable.
*/
Expires?: Expires;
/**
* Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
*/
GrantFullControl?: GrantFullControl;
/**
* Allows grantee to read the object data and its metadata.
*/
GrantRead?: GrantRead;
/**
* Allows grantee to read the object ACL.
*/
GrantReadACP?: GrantReadACP;
/**
* Allows grantee to write the ACL for the applicable object.
*/
GrantWriteACP?: GrantWriteACP;
/**
*
*/
Key: ObjectKey;
/**
* A map of metadata to store with the object in S3.
*/
Metadata?: Metadata;
/**
* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
*/
ServerSideEncryption?: ServerSideEncryption;
/**
* The type of storage to use for the object. Defaults to 'STANDARD'.
*/
StorageClass?: StorageClass;
/**
* If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
*/
WebsiteRedirectLocation?: WebsiteRedirectLocation;
/**
* Specifies the algorithm to use to when encrypting the object (e.g., AES256).
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
*/
SSECustomerKey?: SSECustomerKey;
/**
* Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
*/
SSEKMSKeyId?: SSEKMSKeyId;
RequestPayer?: RequestPayer;
/**
* The tag-set for the object. The tag-set must be encoded as URL Query parameters
*/
Tagging?: TaggingHeader;
/**
* Specifies the Object Lock mode that you want to apply to the uploaded object.
*/
ObjectLockMode?: ObjectLockMode;
/**
* Specifies the date and time when you want the Object Lock to expire.
*/
ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
/**
* Specifies whether you want to apply a Legal Hold to the uploaded object.
*/
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
}
export type CreationDate = Date;
export type _Date = Date;
export type Days = number;
export type DaysAfterInitiation = number;
export interface DefaultRetention {
/**
* The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.
*/
Mode?: ObjectLockRetentionMode;
/**
* The number of days that you want to specify for the default retention period.
*/
Days?: Days;
/**
* The number of years that you want to specify for the default retention period.
*/
Years?: Years;
}
export interface Delete {
/**
*
*/
Objects: ObjectIdentifierList;
/**
* Element to enable quiet mode for the request. When you add this element, you must set its value to true.
*/
Quiet?: Quiet;
}
export interface DeleteBucketAnalyticsConfigurationRequest {
/**
* The name of the bucket from which an analytics configuration is deleted.
*/
Bucket: BucketName;
/**
* The identifier used to represent an analytics configuration.
*/
Id: AnalyticsId;
}
export interface DeleteBucketCorsRequest {
/**
*
*/
Bucket: BucketName;
}
export interface DeleteBucketEncryptionRequest {
/**
* The name of the bucket containing the server-side encryption configuration to delete.
*/
Bucket: BucketName;
}
export interface DeleteBucketInventoryConfigurationRequest {
/**
* The name of the bucket containing the inventory configuration to delete.
*/
Bucket: BucketName;
/**
* The ID used to identify the inventory configuration.
*/
Id: InventoryId;
}
export interface DeleteBucketLifecycleRequest {
/**
*
*/
Bucket: BucketName;
}
export interface DeleteBucketMetricsConfigurationRequest {
/**
* The name of the bucket containing the metrics configuration to delete.
*/
Bucket: BucketName;
/**
* The ID used to identify the metrics configuration.
*/
Id: MetricsId;
}
export interface DeleteBucketPolicyRequest {
/**
*
*/
Bucket: BucketName;
}
export interface DeleteBucketReplicationRequest {
/**
* The bucket name. It can take a while to propagate the deletion of a replication configuration to all Amazon S3 systems.
*/
Bucket: BucketName;
}
export interface DeleteBucketRequest {
/**
*
*/
Bucket: BucketName;
}
export interface DeleteBucketTaggingRequest {
/**
*
*/
Bucket: BucketName;
}
export interface DeleteBucketWebsiteRequest {
/**
*
*/
Bucket: BucketName;
}
export type DeleteMarker = boolean;
export interface DeleteMarkerEntry {
/**
*
*/
Owner?: Owner;
/**
* The object key.
*/
Key?: ObjectKey;
/**
* Version ID of an object.
*/
VersionId?: ObjectVersionId;
/**
* Specifies whether the object is (true) or is not (false) the latest version of an object.
*/
IsLatest?: IsLatest;
/**
* Date and time the object was last modified.
*/
LastModified?: LastModified;
}
export interface DeleteMarkerReplication {
/**
* The status of the delete marker replication. In the current implementation, Amazon S3 doesn't replicate the delete markers. The status must be Disabled.
*/
Status?: DeleteMarkerReplicationStatus;
}
export type DeleteMarkerReplicationStatus = "Enabled"|"Disabled"|string;
export type DeleteMarkerVersionId = string;
export type DeleteMarkers = DeleteMarkerEntry[];
export interface DeleteObjectOutput {
/**
* Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.
*/
DeleteMarker?: DeleteMarker;
/**
* Returns the version ID of the delete marker created as a result of the DELETE operation.
*/
VersionId?: ObjectVersionId;
RequestCharged?: RequestCharged;
}
export interface DeleteObjectRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
Key: ObjectKey;
/**
* The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
*/
MFA?: MFA;
/**
* VersionId used to reference a specific version of the object.
*/
VersionId?: ObjectVersionId;
RequestPayer?: RequestPayer;
/**
* Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
*/
BypassGovernanceRetention?: BypassGovernanceRetention;
}
export interface DeleteObjectTaggingOutput {
/**
* The versionId of the object the tag-set was removed from.
*/
VersionId?: ObjectVersionId;
}
export interface DeleteObjectTaggingRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
Key: ObjectKey;
/**
* The versionId of the object that the tag-set will be removed from.
*/
VersionId?: ObjectVersionId;
}
export interface DeleteObjectsOutput {
/**
*
*/
Deleted?: DeletedObjects;
RequestCharged?: RequestCharged;
/**
*
*/
Errors?: Errors;
}
export interface DeleteObjectsRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
Delete: Delete;
/**
* The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
*/
MFA?: MFA;
RequestPayer?: RequestPayer;
/**
* Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.
*/
BypassGovernanceRetention?: BypassGovernanceRetention;
}
export interface DeletePublicAccessBlockRequest {
/**
* The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.
*/
Bucket: BucketName;
}
export interface DeletedObject {
/**
*
*/
Key?: ObjectKey;
/**
*
*/
VersionId?: ObjectVersionId;
/**
*
*/
DeleteMarker?: DeleteMarker;
/**
*
*/
DeleteMarkerVersionId?: DeleteMarkerVersionId;
}
export type DeletedObjects = DeletedObject[];
export type Delimiter = string;
export type Description = string;
export interface Destination {
/**
* The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule. If there are multiple rules in your replication configuration, all rules must specify the same bucket as the destination. A replication configuration can replicate objects to only one destination bucket.
*/
Bucket: BucketName;
/**
* The account ID of the destination bucket. Currently, Amazon S3 verifies this value only if Access Control Translation is enabled. In a cross-account scenario, if you change replica ownership to the AWS account that owns the destination bucket by adding the AccessControlTranslation element, this is the account ID of the owner of the destination bucket.
*/
Account?: AccountId;
/**
* The class of storage used to store the object. By default Amazon S3 uses storage class of the source object when creating a replica.
*/
StorageClass?: StorageClass;
/**
* A container for information about access control for replicas. Use this element only in a cross-account scenario where source and destination bucket owners are not the same to change replica ownership to the AWS account that owns the destination bucket. If you don't add this element to the replication configuration, the replicas are owned by same AWS account that owns the source object.
*/
AccessControlTranslation?: AccessControlTranslation;
/**
* A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.
*/
EncryptionConfiguration?: EncryptionConfiguration;
}
export type DisplayName = string;
export type ETag = string;
export type EmailAddress = string;
export type EnableRequestProgress = boolean;
export type EncodingType = "url"|string;
export interface Encryption {
/**
* The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms).
*/
EncryptionType: ServerSideEncryption;
/**
* If the encryption type is aws:kms, this optional value specifies the AWS KMS key ID to use for encryption of job results.
*/
KMSKeyId?: SSEKMSKeyId;
/**
* If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.
*/
KMSContext?: KMSContext;
}
export interface EncryptionConfiguration {
/**
* The ID of the AWS KMS key for the AWS Region where the destination bucket resides. Amazon S3 uses this key to encrypt the replica object.
*/
ReplicaKmsKeyID?: ReplicaKmsKeyID;
}
export interface EndEvent {
}
export interface Error {
/**
*
*/
Key?: ObjectKey;
/**
*
*/
VersionId?: ObjectVersionId;
/**
*
*/
Code?: Code;
/**
*
*/
Message?: Message;
}
export interface ErrorDocument {
/**
* The object key name to use when a 4XX class error occurs.
*/
Key: ObjectKey;
}
export type Errors = Error[];
export type Event = "s3:ReducedRedundancyLostObject"|"s3:ObjectCreated:*"|"s3:ObjectCreated:Put"|"s3:ObjectCreated:Post"|"s3:ObjectCreated:Copy"|"s3:ObjectCreated:CompleteMultipartUpload"|"s3:ObjectRemoved:*"|"s3:ObjectRemoved:Delete"|"s3:ObjectRemoved:DeleteMarkerCreated"|"s3:ObjectRestore:Post"|"s3:ObjectRestore:Completed"|string;
export type EventList = Event[];
export type Expiration = string;
export type ExpirationStatus = "Enabled"|"Disabled"|string;
export type ExpiredObjectDeleteMarker = boolean;
export type Expires = Date;
export type ExposeHeader = string;
export type ExposeHeaders = ExposeHeader[];
export type Expression = string;
export type ExpressionType = "SQL"|string;
export type FetchOwner = boolean;
export type FieldDelimiter = string;
export type FileHeaderInfo = "USE"|"IGNORE"|"NONE"|string;
export interface FilterRule {
/**
* The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum prefix length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
*/
Name?: FilterRuleName;
/**
*
*/
Value?: FilterRuleValue;
}
export type FilterRuleList = FilterRule[];
export type FilterRuleName = "prefix"|"suffix"|string;
export type FilterRuleValue = string;
export interface GetBucketAccelerateConfigurationOutput {
/**
* The accelerate configuration of the bucket.
*/
Status?: BucketAccelerateStatus;
}
export interface GetBucketAccelerateConfigurationRequest {
/**
* Name of the bucket for which the accelerate configuration is retrieved.
*/
Bucket: BucketName;
}
export interface GetBucketAclOutput {
/**
*
*/
Owner?: Owner;
/**
* A list of grants.
*/
Grants?: Grants;
}
export interface GetBucketAclRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetBucketAnalyticsConfigurationOutput {
/**
* The configuration and any analyses for the analytics filter.
*/
AnalyticsConfiguration?: AnalyticsConfiguration;
}
export interface GetBucketAnalyticsConfigurationRequest {
/**
* The name of the bucket from which an analytics configuration is retrieved.
*/
Bucket: BucketName;
/**
* The identifier used to represent an analytics configuration.
*/
Id: AnalyticsId;
}
export interface GetBucketCorsOutput {
/**
*
*/
CORSRules?: CORSRules;
}
export interface GetBucketCorsRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetBucketEncryptionOutput {
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
}
export interface GetBucketEncryptionRequest {
/**
* The name of the bucket from which the server-side encryption configuration is retrieved.
*/
Bucket: BucketName;
}
export interface GetBucketInventoryConfigurationOutput {
/**
* Specifies the inventory configuration.
*/
InventoryConfiguration?: InventoryConfiguration;
}
export interface GetBucketInventoryConfigurationRequest {
/**
* The name of the bucket containing the inventory configuration to retrieve.
*/
Bucket: BucketName;
/**
* The ID used to identify the inventory configuration.
*/
Id: InventoryId;
}
export interface GetBucketLifecycleConfigurationOutput {
/**
*
*/
Rules?: LifecycleRules;
}
export interface GetBucketLifecycleConfigurationRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetBucketLifecycleOutput {
/**
*
*/
Rules?: Rules;
}
export interface GetBucketLifecycleRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetBucketLocationOutput {
/**
*
*/
LocationConstraint?: BucketLocationConstraint;
}
export interface GetBucketLocationRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetBucketLoggingOutput {
LoggingEnabled?: LoggingEnabled;
}
export interface GetBucketLoggingRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetBucketMetricsConfigurationOutput {
/**
* Specifies the metrics configuration.
*/
MetricsConfiguration?: MetricsConfiguration;
}
export interface GetBucketMetricsConfigurationRequest {
/**
* The name of the bucket containing the metrics configuration to retrieve.
*/
Bucket: BucketName;
/**
* The ID used to identify the metrics configuration.
*/
Id: MetricsId;
}
export interface GetBucketNotificationConfigurationRequest {
/**
* Name of the bucket to get the notification configuration for.
*/
Bucket: BucketName;
}
export interface GetBucketPolicyOutput {
/**
* The bucket policy as a JSON document.
*/
Policy?: Policy;
}
export interface GetBucketPolicyRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetBucketPolicyStatusOutput {
/**
* The policy status for the specified bucket.
*/
PolicyStatus?: PolicyStatus;
}
export interface GetBucketPolicyStatusRequest {
/**
* The name of the Amazon S3 bucket whose policy status you want to retrieve.
*/
Bucket: BucketName;
}
export interface GetBucketReplicationOutput {
ReplicationConfiguration?: ReplicationConfiguration;
}
export interface GetBucketReplicationRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetBucketRequestPaymentOutput {
/**
* Specifies who pays for the download and request fees.
*/
Payer?: Payer;
}
export interface GetBucketRequestPaymentRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetBucketTaggingOutput {
/**
*
*/
TagSet: TagSet;
}
export interface GetBucketTaggingRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetBucketVersioningOutput {
/**
* The versioning state of the bucket.
*/
Status?: BucketVersioningStatus;
/**
* Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
*/
MFADelete?: MFADeleteStatus;
}
export interface GetBucketVersioningRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetBucketWebsiteOutput {
/**
*
*/
RedirectAllRequestsTo?: RedirectAllRequestsTo;
/**
*
*/
IndexDocument?: IndexDocument;
/**
*
*/
ErrorDocument?: ErrorDocument;
/**
*
*/
RoutingRules?: RoutingRules;
}
export interface GetBucketWebsiteRequest {
/**
*
*/
Bucket: BucketName;
}
export interface GetObjectAclOutput {
/**
*
*/
Owner?: Owner;
/**
* A list of grants.
*/
Grants?: Grants;
RequestCharged?: RequestCharged;
}
export interface GetObjectAclRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
Key: ObjectKey;
/**
* VersionId used to reference a specific version of the object.
*/
VersionId?: ObjectVersionId;
RequestPayer?: RequestPayer;
}
export interface GetObjectLegalHoldOutput {
/**
* The current Legal Hold status for the specified object.
*/
LegalHold?: ObjectLockLegalHold;
}
export interface GetObjectLegalHoldRequest {
/**
* The bucket containing the object whose Legal Hold status you want to retrieve.
*/
Bucket: BucketName;
/**
* The key name for the object whose Legal Hold status you want to retrieve.
*/
Key: ObjectKey;
/**
* The version ID of the object whose Legal Hold status you want to retrieve.
*/
VersionId?: ObjectVersionId;
RequestPayer?: RequestPayer;
}
export interface GetObjectLockConfigurationOutput {
/**
* The specified bucket's Object Lock configuration.
*/
ObjectLockConfiguration?: ObjectLockConfiguration;
}
export interface GetObjectLockConfigurationRequest {
/**
* The bucket whose Object Lock configuration you want to retrieve.
*/
Bucket: BucketName;
}
export interface GetObjectOutput {
/**
* Object data.
*/
Body?: Body;
/**
* Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
*/
DeleteMarker?: DeleteMarker;
/**
*
*/
AcceptRanges?: AcceptRanges;
/**
* If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.
*/
Expiration?: Expiration;
/**
* Provides information about object restoration operation and expiration time of the restored object copy.
*/
Restore?: Restore;
/**
* Last modified date of the object
*/
LastModified?: LastModified;
/**
* Size of the body in bytes.
*/
ContentLength?: ContentLength;
/**
* An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL
*/
ETag?: ETag;
/**
* This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
*/
MissingMeta?: MissingMeta;
/**
* Version of the object.
*/
VersionId?: ObjectVersionId;
/**
* Specifies caching behavior along the request/reply chain.
*/
CacheControl?: CacheControl;
/**
* Specifies presentational information for the object.
*/
ContentDisposition?: ContentDisposition;
/**
* Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
*/
ContentEncoding?: ContentEncoding;
/**
* The language the content is in.
*/
ContentLanguage?: ContentLanguage;
/**
* The portion of the object returned in the response.
*/
ContentRange?: ContentRange;
/**
* A standard MIME type describing the format of the object data.
*/
ContentType?: ContentType;
/**
* The date and time at which the object is no longer cacheable.
*/
Expires?: Expires;
/**
* If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
*/
WebsiteRedirectLocation?: WebsiteRedirectLocation;
/**
* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
*/
ServerSideEncryption?: ServerSideEncryption;
/**
* A map of metadata to store with the object in S3.
*/
Metadata?: Metadata;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
*/
SSEKMSKeyId?: SSEKMSKeyId;
/**
*
*/
StorageClass?: StorageClass;
RequestCharged?: RequestCharged;
/**
*
*/
ReplicationStatus?: ReplicationStatus;
/**
* The count of parts this object has.
*/
PartsCount?: PartsCount;
/**
* The number of tags, if any, on the object.
*/
TagCount?: TagCount;
/**
* The Object Lock mode currently in place for this object.
*/
ObjectLockMode?: ObjectLockMode;
/**
* The date and time when this object's Object Lock will expire.
*/
ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
/**
* Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.
*/
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
}
export interface GetObjectRequest {
/**
*
*/
Bucket: BucketName;
/**
* Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
*/
IfMatch?: IfMatch;
/**
* Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
*/
IfModifiedSince?: IfModifiedSince;
/**
* Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
*/
IfNoneMatch?: IfNoneMatch;
/**
* Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
*/
IfUnmodifiedSince?: IfUnmodifiedSince;
/**
*
*/
Key: ObjectKey;
/**
* Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
*/
Range?: Range;
/**
* Sets the Cache-Control header of the response.
*/
ResponseCacheControl?: ResponseCacheControl;
/**
* Sets the Content-Disposition header of the response
*/
ResponseContentDisposition?: ResponseContentDisposition;
/**
* Sets the Content-Encoding header of the response.
*/
ResponseContentEncoding?: ResponseContentEncoding;
/**
* Sets the Content-Language header of the response.
*/
ResponseContentLanguage?: ResponseContentLanguage;
/**
* Sets the Content-Type header of the response.
*/
ResponseContentType?: ResponseContentType;
/**
* Sets the Expires header of the response.
*/
ResponseExpires?: ResponseExpires;
/**
* VersionId used to reference a specific version of the object.
*/
VersionId?: ObjectVersionId;
/**
* Specifies the algorithm to use to when encrypting the object (e.g., AES256).
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
*/
SSECustomerKey?: SSECustomerKey;
/**
* Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
RequestPayer?: RequestPayer;
/**
* Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.
*/
PartNumber?: PartNumber;
}
export interface GetObjectRetentionOutput {
/**
* The container element for an object's retention settings.
*/
Retention?: ObjectLockRetention;
}
export interface GetObjectRetentionRequest {
/**
* The bucket containing the object whose retention settings you want to retrieve.
*/
Bucket: BucketName;
/**
* The key name for the object whose retention settings you want to retrieve.
*/
Key: ObjectKey;
/**
* The version ID for the object whose retention settings you want to retrieve.
*/
VersionId?: ObjectVersionId;
RequestPayer?: RequestPayer;
}
export interface GetObjectTaggingOutput {
/**
*
*/
VersionId?: ObjectVersionId;
/**
*
*/
TagSet: TagSet;
}
export interface GetObjectTaggingRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
Key: ObjectKey;
/**
*
*/
VersionId?: ObjectVersionId;
}
export interface GetObjectTorrentOutput {
/**
*
*/
Body?: Body;
RequestCharged?: RequestCharged;
}
export interface GetObjectTorrentRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
Key: ObjectKey;
RequestPayer?: RequestPayer;
}
export interface GetPublicAccessBlockOutput {
/**
* The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.
*/
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
}
export interface GetPublicAccessBlockRequest {
/**
* The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.
*/
Bucket: BucketName;
}
export interface GlacierJobParameters {
/**
* Glacier retrieval tier at which the restore will be processed.
*/
Tier: Tier;
}
export interface Grant {
/**
*
*/
Grantee?: Grantee;
/**
* Specifies the permission given to the grantee.
*/
Permission?: Permission;
}
export type GrantFullControl = string;
export type GrantRead = string;
export type GrantReadACP = string;
export type GrantWrite = string;
export type GrantWriteACP = string;
export interface Grantee {
/**
* Screen name of the grantee.
*/
DisplayName?: DisplayName;
/**
* Email address of the grantee.
*/
EmailAddress?: EmailAddress;
/**
* The canonical user ID of the grantee.
*/
ID?: ID;
/**
* Type of grantee
*/
Type: Type;
/**
* URI of the grantee group.
*/
URI?: URI;
}
export type Grants = Grant[];
export interface HeadBucketRequest {
/**
*
*/
Bucket: BucketName;
}
export interface HeadObjectOutput {
/**
* Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
*/
DeleteMarker?: DeleteMarker;
/**
*
*/
AcceptRanges?: AcceptRanges;
/**
* If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.
*/
Expiration?: Expiration;
/**
* Provides information about object restoration operation and expiration time of the restored object copy.
*/
Restore?: Restore;
/**
* Last modified date of the object
*/
LastModified?: LastModified;
/**
* Size of the body in bytes.
*/
ContentLength?: ContentLength;
/**
* An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL
*/
ETag?: ETag;
/**
* This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
*/
MissingMeta?: MissingMeta;
/**
* Version of the object.
*/
VersionId?: ObjectVersionId;
/**
* Specifies caching behavior along the request/reply chain.
*/
CacheControl?: CacheControl;
/**
* Specifies presentational information for the object.
*/
ContentDisposition?: ContentDisposition;
/**
* Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
*/
ContentEncoding?: ContentEncoding;
/**
* The language the content is in.
*/
ContentLanguage?: ContentLanguage;
/**
* A standard MIME type describing the format of the object data.
*/
ContentType?: ContentType;
/**
* The date and time at which the object is no longer cacheable.
*/
Expires?: Expires;
/**
* If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
*/
WebsiteRedirectLocation?: WebsiteRedirectLocation;
/**
* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
*/
ServerSideEncryption?: ServerSideEncryption;
/**
* A map of metadata to store with the object in S3.
*/
Metadata?: Metadata;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
*/
SSEKMSKeyId?: SSEKMSKeyId;
/**
*
*/
StorageClass?: StorageClass;
RequestCharged?: RequestCharged;
/**
*
*/
ReplicationStatus?: ReplicationStatus;
/**
* The count of parts this object has.
*/
PartsCount?: PartsCount;
/**
* The Object Lock mode currently in place for this object.
*/
ObjectLockMode?: ObjectLockMode;
/**
* The date and time when this object's Object Lock will expire.
*/
ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
/**
* The Legal Hold status for the specified object.
*/
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
}
export interface HeadObjectRequest {
/**
*
*/
Bucket: BucketName;
/**
* Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
*/
IfMatch?: IfMatch;
/**
* Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
*/
IfModifiedSince?: IfModifiedSince;
/**
* Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
*/
IfNoneMatch?: IfNoneMatch;
/**
* Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
*/
IfUnmodifiedSince?: IfUnmodifiedSince;
/**
*
*/
Key: ObjectKey;
/**
* Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
*/
Range?: Range;
/**
* VersionId used to reference a specific version of the object.
*/
VersionId?: ObjectVersionId;
/**
* Specifies the algorithm to use to when encrypting the object (e.g., AES256).
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
*/
SSECustomerKey?: SSECustomerKey;
/**
* Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
RequestPayer?: RequestPayer;
/**
* Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.
*/
PartNumber?: PartNumber;
}
export type HostName = string;
export type HttpErrorCodeReturnedEquals = string;
export type HttpRedirectCode = string;
export type ID = string;
export type IfMatch = string;
export type IfModifiedSince = Date;
export type IfNoneMatch = string;
export type IfUnmodifiedSince = Date;
export interface IndexDocument {
/**
* A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
*/
Suffix: Suffix;
}
export type Initiated = Date;
export interface Initiator {
/**
* If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.
*/
ID?: ID;
/**
* Name of the Principal.
*/
DisplayName?: DisplayName;
}
export interface InputSerialization {
/**
* Describes the serialization of a CSV-encoded object.
*/
CSV?: CSVInput;
/**
* Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.
*/
CompressionType?: CompressionType;
/**
* Specifies JSON as object's input serialization format.
*/
JSON?: JSONInput;
/**
* Specifies Parquet as object's input serialization format.
*/
Parquet?: ParquetInput;
}
export interface InventoryConfiguration {
/**
* Contains information about where to publish the inventory results.
*/
Destination: InventoryDestination;
/**
* Specifies whether the inventory is enabled or disabled.
*/
IsEnabled: IsEnabled;
/**
* Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.
*/
Filter?: InventoryFilter;
/**
* The ID used to identify the inventory configuration.
*/
Id: InventoryId;
/**
* Specifies which object version(s) to included in the inventory results.
*/
IncludedObjectVersions: InventoryIncludedObjectVersions;
/**
* Contains the optional fields that are included in the inventory results.
*/
OptionalFields?: InventoryOptionalFields;
/**
* Specifies the schedule for generating inventory results.
*/
Schedule: InventorySchedule;
}
export type InventoryConfigurationList = InventoryConfiguration[];
export interface InventoryDestination {
/**
* Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.
*/
S3BucketDestination: InventoryS3BucketDestination;
}
export interface InventoryEncryption {
/**
* Specifies the use of SSE-S3 to encrypt delivered Inventory reports.
*/
SSES3?: SSES3;
/**
* Specifies the use of SSE-KMS to encrypt delivered Inventory reports.
*/
SSEKMS?: SSEKMS;
}
export interface InventoryFilter {
/**
* The prefix that an object must have to be included in the inventory results.
*/
Prefix: Prefix;
}
export type InventoryFormat = "CSV"|"ORC"|"Parquet"|string;
export type InventoryFrequency = "Daily"|"Weekly"|string;
export type InventoryId = string;
export type InventoryIncludedObjectVersions = "All"|"Current"|string;
export type InventoryOptionalField = "Size"|"LastModifiedDate"|"StorageClass"|"ETag"|"IsMultipartUploaded"|"ReplicationStatus"|"EncryptionStatus"|"ObjectLockRetainUntilDate"|"ObjectLockMode"|"ObjectLockLegalHoldStatus"|string;
export type InventoryOptionalFields = InventoryOptionalField[];
export interface InventoryS3BucketDestination {
/**
* The ID of the account that owns the destination bucket.
*/
AccountId?: AccountId;
/**
* The Amazon resource name (ARN) of the bucket where inventory results will be published.
*/
Bucket: BucketName;
/**
* Specifies the output format of the inventory results.
*/
Format: InventoryFormat;
/**
* The prefix that is prepended to all inventory results.
*/
Prefix?: Prefix;
/**
* Contains the type of server-side encryption used to encrypt the inventory results.
*/
Encryption?: InventoryEncryption;
}
export interface InventorySchedule {
/**
* Specifies how frequently inventory results are produced.
*/
Frequency: InventoryFrequency;
}
export type IsEnabled = boolean;
export type IsLatest = boolean;
export type IsPublic = boolean;
export type IsTruncated = boolean;
export interface JSONInput {
/**
* The type of JSON. Valid values: Document, Lines.
*/
Type?: JSONType;
}
export interface JSONOutput {
/**
* The value used to separate individual records in the output.
*/
RecordDelimiter?: RecordDelimiter;
}
export type JSONType = "DOCUMENT"|"LINES"|string;
export type KMSContext = string;
export type KeyCount = number;
export type KeyMarker = string;
export type KeyPrefixEquals = string;
export type LambdaFunctionArn = string;
export interface LambdaFunctionConfiguration {
Id?: NotificationId;
/**
* The Amazon Resource Name (ARN) of the Lambda cloud function that Amazon S3 can invoke when it detects events of the specified type.
*/
LambdaFunctionArn: LambdaFunctionArn;
/**
*
*/
Events: EventList;
Filter?: NotificationConfigurationFilter;
}
export type LambdaFunctionConfigurationList = LambdaFunctionConfiguration[];
export type LastModified = Date;
export interface LifecycleConfiguration {
/**
*
*/
Rules: Rules;
}
export interface LifecycleExpiration {
/**
* Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
*/
Date?: _Date;
/**
* Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
*/
Days?: Days;
/**
* Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
*/
ExpiredObjectDeleteMarker?: ExpiredObjectDeleteMarker;
}
export interface LifecycleRule {
/**
*
*/
Expiration?: LifecycleExpiration;
/**
* Unique identifier for the rule. The value cannot be longer than 255 characters.
*/
ID?: ID;
/**
* Prefix identifying one or more objects to which the rule applies. This is No longer used; use Filter instead.
*/
Prefix?: Prefix;
Filter?: LifecycleRuleFilter;
/**
* If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
*/
Status: ExpirationStatus;
/**
*
*/
Transitions?: TransitionList;
/**
*
*/
NoncurrentVersionTransitions?: NoncurrentVersionTransitionList;
NoncurrentVersionExpiration?: NoncurrentVersionExpiration;
AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload;
}
export interface LifecycleRuleAndOperator {
/**
*
*/
Prefix?: Prefix;
/**
* All of these tags must exist in the object's tag set in order for the rule to apply.
*/
Tags?: TagSet;
}
export interface LifecycleRuleFilter {
/**
* Prefix identifying one or more objects to which the rule applies.
*/
Prefix?: Prefix;
/**
* This tag must exist in the object's tag set in order for the rule to apply.
*/
Tag?: Tag;
And?: LifecycleRuleAndOperator;
}
export type LifecycleRules = LifecycleRule[];
export interface ListBucketAnalyticsConfigurationsOutput {
/**
* Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
*/
IsTruncated?: IsTruncated;
/**
* The ContinuationToken that represents where this request began.
*/
ContinuationToken?: Token;
/**
* NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.
*/
NextContinuationToken?: NextToken;
/**
* The list of analytics configurations for a bucket.
*/
AnalyticsConfigurationList?: AnalyticsConfigurationList;
}
export interface ListBucketAnalyticsConfigurationsRequest {
/**
* The name of the bucket from which analytics configurations are retrieved.
*/
Bucket: BucketName;
/**
* The ContinuationToken that represents a placeholder from where this request should begin.
*/
ContinuationToken?: Token;
}
export interface ListBucketInventoryConfigurationsOutput {
/**
* If sent in the request, the marker that is used as a starting point for this inventory configuration list response.
*/
ContinuationToken?: Token;
/**
* The list of inventory configurations for a bucket.
*/
InventoryConfigurationList?: InventoryConfigurationList;
/**
* Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated.
*/
IsTruncated?: IsTruncated;
/**
* The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.
*/
NextContinuationToken?: NextToken;
}
export interface ListBucketInventoryConfigurationsRequest {
/**
* The name of the bucket containing the inventory configurations to retrieve.
*/
Bucket: BucketName;
/**
* The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.
*/
ContinuationToken?: Token;
}
export interface ListBucketMetricsConfigurationsOutput {
/**
* Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
*/
IsTruncated?: IsTruncated;
/**
* The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.
*/
ContinuationToken?: Token;
/**
* The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.
*/
NextContinuationToken?: NextToken;
/**
* The list of metrics configurations for a bucket.
*/
MetricsConfigurationList?: MetricsConfigurationList;
}
export interface ListBucketMetricsConfigurationsRequest {
/**
* The name of the bucket containing the metrics configurations to retrieve.
*/
Bucket: BucketName;
/**
* The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.
*/
ContinuationToken?: Token;
}
export interface ListBucketsOutput {
/**
*
*/
Buckets?: Buckets;
/**
*
*/
Owner?: Owner;
}
export interface ListMultipartUploadsOutput {
/**
* Name of the bucket to which the multipart upload was initiated.
*/
Bucket?: BucketName;
/**
* The key at or after which the listing began.
*/
KeyMarker?: KeyMarker;
/**
* Upload ID after which listing began.
*/
UploadIdMarker?: UploadIdMarker;
/**
* When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.
*/
NextKeyMarker?: NextKeyMarker;
/**
* When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.
*/
Prefix?: Prefix;
/**
*
*/
Delimiter?: Delimiter;
/**
* When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.
*/
NextUploadIdMarker?: NextUploadIdMarker;
/**
* Maximum number of multipart uploads that could have been included in the response.
*/
MaxUploads?: MaxUploads;
/**
* Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.
*/
IsTruncated?: IsTruncated;
/**
*
*/
Uploads?: MultipartUploadList;
/**
*
*/
CommonPrefixes?: CommonPrefixList;
/**
* Encoding type used by Amazon S3 to encode object keys in the response.
*/
EncodingType?: EncodingType;
}
export interface ListMultipartUploadsRequest {
/**
*
*/
Bucket: BucketName;
/**
* Character you use to group keys.
*/
Delimiter?: Delimiter;
EncodingType?: EncodingType;
/**
* Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.
*/
KeyMarker?: KeyMarker;
/**
* Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
*/
MaxUploads?: MaxUploads;
/**
* Lists in-progress uploads only for those keys that begin with the specified prefix.
*/
Prefix?: Prefix;
/**
* Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored.
*/
UploadIdMarker?: UploadIdMarker;
}
export interface ListObjectVersionsOutput {
/**
* A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.
*/
IsTruncated?: IsTruncated;
/**
* Marks the last Key returned in a truncated response.
*/
KeyMarker?: KeyMarker;
/**
*
*/
VersionIdMarker?: VersionIdMarker;
/**
* Use this value for the key marker request parameter in a subsequent request.
*/
NextKeyMarker?: NextKeyMarker;
/**
* Use this value for the next version id marker parameter in a subsequent request.
*/
NextVersionIdMarker?: NextVersionIdMarker;
/**
*
*/
Versions?: ObjectVersionList;
/**
*
*/
DeleteMarkers?: DeleteMarkers;
/**
*
*/
Name?: BucketName;
/**
*
*/
Prefix?: Prefix;
/**
*
*/
Delimiter?: Delimiter;
/**
*
*/
MaxKeys?: MaxKeys;
/**
*
*/
CommonPrefixes?: CommonPrefixList;
/**
* Encoding type used by Amazon S3 to encode object keys in the response.
*/
EncodingType?: EncodingType;
}
export interface ListObjectVersionsRequest {
/**
*
*/
Bucket: BucketName;
/**
* A delimiter is a character you use to group keys.
*/
Delimiter?: Delimiter;
EncodingType?: EncodingType;
/**
* Specifies the key to start with when listing objects in a bucket.
*/
KeyMarker?: KeyMarker;
/**
* Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
*/
MaxKeys?: MaxKeys;
/**
* Limits the response to keys that begin with the specified prefix.
*/
Prefix?: Prefix;
/**
* Specifies the object version you want to start listing from.
*/
VersionIdMarker?: VersionIdMarker;
}
export interface ListObjectsOutput {
/**
* A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
*/
IsTruncated?: IsTruncated;
/**
*
*/
Marker?: Marker;
/**
* When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.
*/
NextMarker?: NextMarker;
/**
*
*/
Contents?: ObjectList;
/**
*
*/
Name?: BucketName;
/**
*
*/
Prefix?: Prefix;
/**
*
*/
Delimiter?: Delimiter;
/**
*
*/
MaxKeys?: MaxKeys;
/**
*
*/
CommonPrefixes?: CommonPrefixList;
/**
* Encoding type used by Amazon S3 to encode object keys in the response.
*/
EncodingType?: EncodingType;
}
export interface ListObjectsRequest {
/**
*
*/
Bucket: BucketName;
/**
* A delimiter is a character you use to group keys.
*/
Delimiter?: Delimiter;
EncodingType?: EncodingType;
/**
* Specifies the key to start with when listing objects in a bucket.
*/
Marker?: Marker;
/**
* Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
*/
MaxKeys?: MaxKeys;
/**
* Limits the response to keys that begin with the specified prefix.
*/
Prefix?: Prefix;
/**
* Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.
*/
RequestPayer?: RequestPayer;
}
export interface ListObjectsV2Output {
/**
* A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
*/
IsTruncated?: IsTruncated;
/**
* Metadata about each object returned.
*/
Contents?: ObjectList;
/**
* Name of the bucket to list.
*/
Name?: BucketName;
/**
* Limits the response to keys that begin with the specified prefix.
*/
Prefix?: Prefix;
/**
* A delimiter is a character you use to group keys.
*/
Delimiter?: Delimiter;
/**
* Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
*/
MaxKeys?: MaxKeys;
/**
* CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter
*/
CommonPrefixes?: CommonPrefixList;
/**
* Encoding type used by Amazon S3 to encode object keys in the response.
*/
EncodingType?: EncodingType;
/**
* KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
*/
KeyCount?: KeyCount;
/**
* ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key
*/
ContinuationToken?: Token;
/**
* NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key
*/
NextContinuationToken?: NextToken;
/**
* StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket
*/
StartAfter?: StartAfter;
}
export interface ListObjectsV2Request {
/**
* Name of the bucket to list.
*/
Bucket: BucketName;
/**
* A delimiter is a character you use to group keys.
*/
Delimiter?: Delimiter;
/**
* Encoding type used by Amazon S3 to encode object keys in the response.
*/
EncodingType?: EncodingType;
/**
* Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
*/
MaxKeys?: MaxKeys;
/**
* Limits the response to keys that begin with the specified prefix.
*/
Prefix?: Prefix;
/**
* ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key
*/
ContinuationToken?: Token;
/**
* The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true
*/
FetchOwner?: FetchOwner;
/**
* StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket
*/
StartAfter?: StartAfter;
/**
* Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
*/
RequestPayer?: RequestPayer;
}
export interface ListPartsOutput {
/**
* Date when multipart upload will become eligible for abort operation by lifecycle.
*/
AbortDate?: AbortDate;
/**
* Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
*/
AbortRuleId?: AbortRuleId;
/**
* Name of the bucket to which the multipart upload was initiated.
*/
Bucket?: BucketName;
/**
* Object key for which the multipart upload was initiated.
*/
Key?: ObjectKey;
/**
* Upload ID identifying the multipart upload whose parts are being listed.
*/
UploadId?: MultipartUploadId;
/**
* Part number after which listing begins.
*/
PartNumberMarker?: PartNumberMarker;
/**
* When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
*/
NextPartNumberMarker?: NextPartNumberMarker;
/**
* Maximum number of parts that were allowed in the response.
*/
MaxParts?: MaxParts;
/**
* Indicates whether the returned list of parts is truncated.
*/
IsTruncated?: IsTruncated;
/**
*
*/
Parts?: Parts;
/**
* Identifies who initiated the multipart upload.
*/
Initiator?: Initiator;
/**
*
*/
Owner?: Owner;
/**
* The class of storage used to store the object.
*/
StorageClass?: StorageClass;
RequestCharged?: RequestCharged;
}
export interface ListPartsRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
Key: ObjectKey;
/**
* Sets the maximum number of parts to return.
*/
MaxParts?: MaxParts;
/**
* Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
*/
PartNumberMarker?: PartNumberMarker;
/**
* Upload ID identifying the multipart upload whose parts are being listed.
*/
UploadId: MultipartUploadId;
RequestPayer?: RequestPayer;
}
export type Location = string;
export type LocationPrefix = string;
export interface LoggingEnabled {
/**
* Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.
*/
TargetBucket: TargetBucket;
/**
*
*/
TargetGrants?: TargetGrants;
/**
* This element lets you specify a prefix for the keys that the log files will be stored under.
*/
TargetPrefix: TargetPrefix;
}
export type MFA = string;
export type MFADelete = "Enabled"|"Disabled"|string;
export type MFADeleteStatus = "Enabled"|"Disabled"|string;
export type Marker = string;
export type MaxAgeSeconds = number;
export type MaxKeys = number;
export type MaxParts = number;
export type MaxUploads = number;
export type Message = string;
export type Metadata = {[key: string]: MetadataValue};
export type MetadataDirective = "COPY"|"REPLACE"|string;
export interface MetadataEntry {
/**
*
*/
Name?: MetadataKey;
/**
*
*/
Value?: MetadataValue;
}
export type MetadataKey = string;
export type MetadataValue = string;
export interface MetricsAndOperator {
/**
* The prefix used when evaluating an AND predicate.
*/
Prefix?: Prefix;
/**
* The list of tags used when evaluating an AND predicate.
*/
Tags?: TagSet;
}
export interface MetricsConfiguration {
/**
* The ID used to identify the metrics configuration.
*/
Id: MetricsId;
/**
* Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).
*/
Filter?: MetricsFilter;
}
export type MetricsConfigurationList = MetricsConfiguration[];
export interface MetricsFilter {
/**
* The prefix used when evaluating a metrics filter.
*/
Prefix?: Prefix;
/**
* The tag used when evaluating a metrics filter.
*/
Tag?: Tag;
/**
* A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
*/
And?: MetricsAndOperator;
}
export type MetricsId = string;
export type MissingMeta = number;
export interface MultipartUpload {
/**
* Upload ID that identifies the multipart upload.
*/
UploadId?: MultipartUploadId;
/**
* Key of the object for which the multipart upload was initiated.
*/
Key?: ObjectKey;
/**
* Date and time at which the multipart upload was initiated.
*/
Initiated?: Initiated;
/**
* The class of storage used to store the object.
*/
StorageClass?: StorageClass;
/**
*
*/
Owner?: Owner;
/**
* Identifies who initiated the multipart upload.
*/
Initiator?: Initiator;
}
export type MultipartUploadId = string;
export type MultipartUploadList = MultipartUpload[];
export type NextKeyMarker = string;
export type NextMarker = string;
export type NextPartNumberMarker = number;
export type NextToken = string;
export type NextUploadIdMarker = string;
export type NextVersionIdMarker = string;
export interface NoncurrentVersionExpiration {
/**
* Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
*/
NoncurrentDays?: Days;
}
export interface NoncurrentVersionTransition {
/**
* Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
*/
NoncurrentDays?: Days;
/**
* The class of storage used to store the object.
*/
StorageClass?: TransitionStorageClass;
}
export type NoncurrentVersionTransitionList = NoncurrentVersionTransition[];
export interface NotificationConfiguration {
/**
*
*/
TopicConfigurations?: TopicConfigurationList;
/**
*
*/
QueueConfigurations?: QueueConfigurationList;
/**
*
*/
LambdaFunctionConfigurations?: LambdaFunctionConfigurationList;
}
export interface NotificationConfigurationDeprecated {
/**
*
*/
TopicConfiguration?: TopicConfigurationDeprecated;
/**
*
*/
QueueConfiguration?: QueueConfigurationDeprecated;
/**
*
*/
CloudFunctionConfiguration?: CloudFunctionConfiguration;
}
export interface NotificationConfigurationFilter {
Key?: S3KeyFilter;
}
export type NotificationId = string;
export interface Object {
/**
*
*/
Key?: ObjectKey;
/**
*
*/
LastModified?: LastModified;
/**
*
*/
ETag?: ETag;
/**
*
*/
Size?: Size;
/**
* The class of storage used to store the object.
*/
StorageClass?: ObjectStorageClass;
/**
*
*/
Owner?: Owner;
}
export type ObjectCannedACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|"aws-exec-read"|"bucket-owner-read"|"bucket-owner-full-control"|string;
export interface ObjectIdentifier {
/**
* Key name of the object to delete.
*/
Key: ObjectKey;
/**
* VersionId for the specific version of the object to delete.
*/
VersionId?: ObjectVersionId;
}
export type ObjectIdentifierList = ObjectIdentifier[];
export type ObjectKey = string;
export type ObjectList = Object[];
export interface ObjectLockConfiguration {
/**
* Indicates whether this bucket has an Object Lock configuration enabled.
*/
ObjectLockEnabled?: ObjectLockEnabled;
/**
* The Object Lock rule in place for the specified object.
*/
Rule?: ObjectLockRule;
}
export type ObjectLockEnabled = "Enabled"|string;
export type ObjectLockEnabledForBucket = boolean;
export interface ObjectLockLegalHold {
/**
* Indicates whether the specified object has a Legal Hold in place.
*/
Status?: ObjectLockLegalHoldStatus;
}
export type ObjectLockLegalHoldStatus = "ON"|"OFF"|string;
export type ObjectLockMode = "GOVERNANCE"|"COMPLIANCE"|string;
export type ObjectLockRetainUntilDate = Date;
export interface ObjectLockRetention {
/**
* Indicates the Retention mode for the specified object.
*/
Mode?: ObjectLockRetentionMode;
/**
* The date on which this Object Lock Retention will expire.
*/
RetainUntilDate?: _Date;
}
export type ObjectLockRetentionMode = "GOVERNANCE"|"COMPLIANCE"|string;
export interface ObjectLockRule {
/**
* The default retention period that you want to apply to new objects placed in the specified bucket.
*/
DefaultRetention?: DefaultRetention;
}
export type ObjectLockToken = string;
export type ObjectStorageClass = "STANDARD"|"REDUCED_REDUNDANCY"|"GLACIER"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|string;
export interface ObjectVersion {
/**
*
*/
ETag?: ETag;
/**
* Size in bytes of the object.
*/
Size?: Size;
/**
* The class of storage used to store the object.
*/
StorageClass?: ObjectVersionStorageClass;
/**
* The object key.
*/
Key?: ObjectKey;
/**
* Version ID of an object.
*/
VersionId?: ObjectVersionId;
/**
* Specifies whether the object is (true) or is not (false) the latest version of an object.
*/
IsLatest?: IsLatest;
/**
* Date and time the object was last modified.
*/
LastModified?: LastModified;
/**
*
*/
Owner?: Owner;
}
export type ObjectVersionId = string;
export type ObjectVersionList = ObjectVersion[];
export type ObjectVersionStorageClass = "STANDARD"|string;
export interface OutputLocation {
/**
* Describes an S3 location that will receive the results of the restore request.
*/
S3?: S3Location;
}
export interface OutputSerialization {
/**
* Describes the serialization of CSV-encoded Select results.
*/
CSV?: CSVOutput;
/**
* Specifies JSON as request's output serialization format.
*/
JSON?: JSONOutput;
}
export interface Owner {
/**
*
*/
DisplayName?: DisplayName;
/**
*
*/
ID?: ID;
}
export type OwnerOverride = "Destination"|string;
export interface ParquetInput {
}
export interface Part {
/**
* Part number identifying the part. This is a positive integer between 1 and 10,000.
*/
PartNumber?: PartNumber;
/**
* Date and time at which the part was uploaded.
*/
LastModified?: LastModified;
/**
* Entity tag returned when the part was uploaded.
*/
ETag?: ETag;
/**
* Size in bytes of the uploaded part data.
*/
Size?: Size;
}
export type PartNumber = number;
export type PartNumberMarker = number;
export type Parts = Part[];
export type PartsCount = number;
export type Payer = "Requester"|"BucketOwner"|string;
export type Permission = "FULL_CONTROL"|"WRITE"|"WRITE_ACP"|"READ"|"READ_ACP"|string;
export type Policy = string;
export interface PolicyStatus {
/**
* The policy status for this bucket. TRUE indicates that this bucket is public. FALSE indicates that the bucket is not public.
*/
IsPublic?: IsPublic;
}
export type Prefix = string;
export type Priority = number;
export interface Progress {
/**
* The current number of object bytes scanned.
*/
BytesScanned?: BytesScanned;
/**
* The current number of uncompressed object bytes processed.
*/
BytesProcessed?: BytesProcessed;
/**
* The current number of bytes of records payload data returned.
*/
BytesReturned?: BytesReturned;
}
export interface ProgressEvent {
/**
* The Progress event details.
*/
Details?: Progress;
}
export type Protocol = "http"|"https"|string;
export interface PublicAccessBlockConfiguration {
/**
* Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior: PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. PUT Object calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.
*/
BlockPublicAcls?: Setting;
/**
* Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
*/
IgnorePublicAcls?: Setting;
/**
* Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.
*/
BlockPublicPolicy?: Setting;
/**
* Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
*/
RestrictPublicBuckets?: Setting;
}
export interface PutBucketAccelerateConfigurationRequest {
/**
* Name of the bucket for which the accelerate configuration is set.
*/
Bucket: BucketName;
/**
* Specifies the Accelerate Configuration you want to set for the bucket.
*/
AccelerateConfiguration: AccelerateConfiguration;
}
export interface PutBucketAclRequest {
/**
* The canned ACL to apply to the bucket.
*/
ACL?: BucketCannedACL;
/**
*
*/
AccessControlPolicy?: AccessControlPolicy;
/**
*
*/
Bucket: BucketName;
/**
*
*/
ContentMD5?: ContentMD5;
/**
* Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
*/
GrantFullControl?: GrantFullControl;
/**
* Allows grantee to list the objects in the bucket.
*/
GrantRead?: GrantRead;
/**
* Allows grantee to read the bucket ACL.
*/
GrantReadACP?: GrantReadACP;
/**
* Allows grantee to create, overwrite, and delete any object in the bucket.
*/
GrantWrite?: GrantWrite;
/**
* Allows grantee to write the ACL for the applicable bucket.
*/
GrantWriteACP?: GrantWriteACP;
}
export interface PutBucketAnalyticsConfigurationRequest {
/**
* The name of the bucket to which an analytics configuration is stored.
*/
Bucket: BucketName;
/**
* The identifier used to represent an analytics configuration.
*/
Id: AnalyticsId;
/**
* The configuration and any analyses for the analytics filter.
*/
AnalyticsConfiguration: AnalyticsConfiguration;
}
export interface PutBucketCorsRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
CORSConfiguration: CORSConfiguration;
/**
*
*/
ContentMD5?: ContentMD5;
}
export interface PutBucketEncryptionRequest {
/**
* The name of the bucket for which the server-side encryption configuration is set.
*/
Bucket: BucketName;
/**
* The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. This parameter is auto-populated when using the command from the CLI
*/
ContentMD5?: ContentMD5;
ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration;
}
export interface PutBucketInventoryConfigurationRequest {
/**
* The name of the bucket where the inventory configuration will be stored.
*/
Bucket: BucketName;
/**
* The ID used to identify the inventory configuration.
*/
Id: InventoryId;
/**
* Specifies the inventory configuration.
*/
InventoryConfiguration: InventoryConfiguration;
}
export interface PutBucketLifecycleConfigurationRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
LifecycleConfiguration?: BucketLifecycleConfiguration;
}
export interface PutBucketLifecycleRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
ContentMD5?: ContentMD5;
/**
*
*/
LifecycleConfiguration?: LifecycleConfiguration;
}
export interface PutBucketLoggingRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
BucketLoggingStatus: BucketLoggingStatus;
/**
*
*/
ContentMD5?: ContentMD5;
}
export interface PutBucketMetricsConfigurationRequest {
/**
* The name of the bucket for which the metrics configuration is set.
*/
Bucket: BucketName;
/**
* The ID used to identify the metrics configuration.
*/
Id: MetricsId;
/**
* Specifies the metrics configuration.
*/
MetricsConfiguration: MetricsConfiguration;
}
export interface PutBucketNotificationConfigurationRequest {
/**
*
*/
Bucket: BucketName;
NotificationConfiguration: NotificationConfiguration;
}
export interface PutBucketNotificationRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
ContentMD5?: ContentMD5;
/**
*
*/
NotificationConfiguration: NotificationConfigurationDeprecated;
}
export interface PutBucketPolicyRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
ContentMD5?: ContentMD5;
/**
* Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
*/
ConfirmRemoveSelfBucketAccess?: ConfirmRemoveSelfBucketAccess;
/**
* The bucket policy as a JSON document.
*/
Policy: Policy;
}
export interface PutBucketReplicationRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
ContentMD5?: ContentMD5;
ReplicationConfiguration: ReplicationConfiguration;
}
export interface PutBucketRequestPaymentRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
ContentMD5?: ContentMD5;
/**
*
*/
RequestPaymentConfiguration: RequestPaymentConfiguration;
}
export interface PutBucketTaggingRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
ContentMD5?: ContentMD5;
/**
*
*/
Tagging: Tagging;
}
export interface PutBucketVersioningRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
ContentMD5?: ContentMD5;
/**
* The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
*/
MFA?: MFA;
/**
*
*/
VersioningConfiguration: VersioningConfiguration;
}
export interface PutBucketWebsiteRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
ContentMD5?: ContentMD5;
/**
*
*/
WebsiteConfiguration: WebsiteConfiguration;
}
export interface PutObjectAclOutput {
RequestCharged?: RequestCharged;
}
export interface PutObjectAclRequest {
/**
* The canned ACL to apply to the object.
*/
ACL?: ObjectCannedACL;
/**
*
*/
AccessControlPolicy?: AccessControlPolicy;
/**
*
*/
Bucket: BucketName;
/**
*
*/
ContentMD5?: ContentMD5;
/**
* Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
*/
GrantFullControl?: GrantFullControl;
/**
* Allows grantee to list the objects in the bucket.
*/
GrantRead?: GrantRead;
/**
* Allows grantee to read the bucket ACL.
*/
GrantReadACP?: GrantReadACP;
/**
* Allows grantee to create, overwrite, and delete any object in the bucket.
*/
GrantWrite?: GrantWrite;
/**
* Allows grantee to write the ACL for the applicable bucket.
*/
GrantWriteACP?: GrantWriteACP;
/**
*
*/
Key: ObjectKey;
RequestPayer?: RequestPayer;
/**
* VersionId used to reference a specific version of the object.
*/
VersionId?: ObjectVersionId;
}
export interface PutObjectLegalHoldOutput {
RequestCharged?: RequestCharged;
}
export interface PutObjectLegalHoldRequest {
/**
* The bucket containing the object that you want to place a Legal Hold on.
*/
Bucket: BucketName;
/**
* The key name for the object that you want to place a Legal Hold on.
*/
Key: ObjectKey;
/**
* Container element for the Legal Hold configuration you want to apply to the specified object.
*/
LegalHold?: ObjectLockLegalHold;
RequestPayer?: RequestPayer;
/**
* The version ID of the object that you want to place a Legal Hold on.
*/
VersionId?: ObjectVersionId;
/**
* The MD5 hash for the request body.
*/
ContentMD5?: ContentMD5;
}
export interface PutObjectLockConfigurationOutput {
RequestCharged?: RequestCharged;
}
export interface PutObjectLockConfigurationRequest {
/**
* The bucket whose Object Lock configuration you want to create or replace.
*/
Bucket: BucketName;
/**
* The Object Lock configuration that you want to apply to the specified bucket.
*/
ObjectLockConfiguration?: ObjectLockConfiguration;
RequestPayer?: RequestPayer;
/**
* A token to allow Object Lock to be enabled for an existing bucket.
*/
Token?: ObjectLockToken;
/**
* The MD5 hash for the request body.
*/
ContentMD5?: ContentMD5;
}
export interface PutObjectOutput {
/**
* If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.
*/
Expiration?: Expiration;
/**
* Entity tag for the uploaded object.
*/
ETag?: ETag;
/**
* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
*/
ServerSideEncryption?: ServerSideEncryption;
/**
* Version of the object.
*/
VersionId?: ObjectVersionId;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
*/
SSEKMSKeyId?: SSEKMSKeyId;
RequestCharged?: RequestCharged;
}
export interface PutObjectRequest {
/**
* The canned ACL to apply to the object.
*/
ACL?: ObjectCannedACL;
/**
* Object data.
*/
Body?: Body;
/**
* Name of the bucket to which the PUT operation was initiated.
*/
Bucket: BucketName;
/**
* Specifies caching behavior along the request/reply chain.
*/
CacheControl?: CacheControl;
/**
* Specifies presentational information for the object.
*/
ContentDisposition?: ContentDisposition;
/**
* Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
*/
ContentEncoding?: ContentEncoding;
/**
* The language the content is in.
*/
ContentLanguage?: ContentLanguage;
/**
* Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
*/
ContentLength?: ContentLength;
/**
* The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI
*/
ContentMD5?: ContentMD5;
/**
* A standard MIME type describing the format of the object data.
*/
ContentType?: ContentType;
/**
* The date and time at which the object is no longer cacheable.
*/
Expires?: Expires;
/**
* Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
*/
GrantFullControl?: GrantFullControl;
/**
* Allows grantee to read the object data and its metadata.
*/
GrantRead?: GrantRead;
/**
* Allows grantee to read the object ACL.
*/
GrantReadACP?: GrantReadACP;
/**
* Allows grantee to write the ACL for the applicable object.
*/
GrantWriteACP?: GrantWriteACP;
/**
* Object key for which the PUT operation was initiated.
*/
Key: ObjectKey;
/**
* A map of metadata to store with the object in S3.
*/
Metadata?: Metadata;
/**
* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
*/
ServerSideEncryption?: ServerSideEncryption;
/**
* The type of storage to use for the object. Defaults to 'STANDARD'.
*/
StorageClass?: StorageClass;
/**
* If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
*/
WebsiteRedirectLocation?: WebsiteRedirectLocation;
/**
* Specifies the algorithm to use to when encrypting the object (e.g., AES256).
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
*/
SSECustomerKey?: SSECustomerKey;
/**
* Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
*/
SSEKMSKeyId?: SSEKMSKeyId;
RequestPayer?: RequestPayer;
/**
* The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
*/
Tagging?: TaggingHeader;
/**
* The Object Lock mode that you want to apply to this object.
*/
ObjectLockMode?: ObjectLockMode;
/**
* The date and time when you want this object's Object Lock to expire.
*/
ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
/**
* The Legal Hold status that you want to apply to the specified object.
*/
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
}
export interface PutObjectRetentionOutput {
RequestCharged?: RequestCharged;
}
export interface PutObjectRetentionRequest {
/**
* The bucket that contains the object you want to apply this Object Retention configuration to.
*/
Bucket: BucketName;
/**
* The key name for the object that you want to apply this Object Retention configuration to.
*/
Key: ObjectKey;
/**
* The container element for the Object Retention configuration.
*/
Retention?: ObjectLockRetention;
RequestPayer?: RequestPayer;
/**
* The version ID for the object that you want to apply this Object Retention configuration to.
*/
VersionId?: ObjectVersionId;
/**
* Indicates whether this operation should bypass Governance-mode restrictions.j
*/
BypassGovernanceRetention?: BypassGovernanceRetention;
/**
* The MD5 hash for the request body.
*/
ContentMD5?: ContentMD5;
}
export interface PutObjectTaggingOutput {
/**
*
*/
VersionId?: ObjectVersionId;
}
export interface PutObjectTaggingRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
Key: ObjectKey;
/**
*
*/
VersionId?: ObjectVersionId;
/**
*
*/
ContentMD5?: ContentMD5;
/**
*
*/
Tagging: Tagging;
}
export interface PutPublicAccessBlockRequest {
/**
* The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.
*/
Bucket: BucketName;
/**
* The MD5 hash of the PutPublicAccessBlock request body.
*/
ContentMD5?: ContentMD5;
/**
* The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide.
*/
PublicAccessBlockConfiguration: PublicAccessBlockConfiguration;
}
export type QueueArn = string;
export interface QueueConfiguration {
Id?: NotificationId;
/**
* The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 will publish a message when it detects events of the specified type.
*/
QueueArn: QueueArn;
/**
*
*/
Events: EventList;
Filter?: NotificationConfigurationFilter;
}
export interface QueueConfigurationDeprecated {
Id?: NotificationId;
Event?: Event;
/**
*
*/
Events?: EventList;
/**
*
*/
Queue?: QueueArn;
}
export type QueueConfigurationList = QueueConfiguration[];
export type Quiet = boolean;
export type QuoteCharacter = string;
export type QuoteEscapeCharacter = string;
export type QuoteFields = "ALWAYS"|"ASNEEDED"|string;
export type Range = string;
export type RecordDelimiter = string;
export interface RecordsEvent {
/**
* The byte array of partial, one or more result records.
*/
Payload?: Buffer;
}
export interface Redirect {
/**
* The host name to use in the redirect request.
*/
HostName?: HostName;
/**
* The HTTP redirect code to use on the response. Not required if one of the siblings is present.
*/
HttpRedirectCode?: HttpRedirectCode;
/**
* Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.
*/
Protocol?: Protocol;
/**
* The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.
*/
ReplaceKeyPrefixWith?: ReplaceKeyPrefixWith;
/**
* The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.
*/
ReplaceKeyWith?: ReplaceKeyWith;
}
export interface RedirectAllRequestsTo {
/**
* Name of the host where requests will be redirected.
*/
HostName: HostName;
/**
* Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.
*/
Protocol?: Protocol;
}
export type ReplaceKeyPrefixWith = string;
export type ReplaceKeyWith = string;
export type ReplicaKmsKeyID = string;
export interface ReplicationConfiguration {
/**
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 can assume when replicating the objects.
*/
Role: Role;
/**
* A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.
*/
Rules: ReplicationRules;
}
export interface ReplicationRule {
/**
* A unique identifier for the rule. The maximum value is 255 characters.
*/
ID?: ID;
/**
* The priority associated with the rule. If you specify multiple rules in a replication configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or more rules identify the same object based on a specified filter, the rule with higher priority takes precedence. For example: Same object quality prefix based filter criteria If prefixes you specified in multiple rules overlap Same object qualify tag based filter criteria specified in multiple rules For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.
*/
Priority?: Priority;
/**
* An object keyname prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters.
*/
Prefix?: Prefix;
Filter?: ReplicationRuleFilter;
/**
* If status isn't enabled, the rule is ignored.
*/
Status: ReplicationRuleStatus;
/**
* A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key (SSE-KMS). If you want Amazon S3 to replicate objects created with server-side encryption using AWS KMS-Managed Keys.
*/
SourceSelectionCriteria?: SourceSelectionCriteria;
/**
* A container for information about the replication destination.
*/
Destination: Destination;
DeleteMarkerReplication?: DeleteMarkerReplication;
}
export interface ReplicationRuleAndOperator {
/**
*
*/
Prefix?: Prefix;
/**
*
*/
Tags?: TagSet;
}
export interface ReplicationRuleFilter {
/**
* An object keyname prefix that identifies the subset of objects to which the rule applies.
*/
Prefix?: Prefix;
/**
* A container for specifying a tag key and value. The rule applies only to objects that have the tag in their tag set.
*/
Tag?: Tag;
/**
* A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: If you specify both a Prefix and a Tag filter, wrap these filters in an And tag. If you specify a filter based on multiple tags, wrap the Tag elements in an And tag.
*/
And?: ReplicationRuleAndOperator;
}
export type ReplicationRuleStatus = "Enabled"|"Disabled"|string;
export type ReplicationRules = ReplicationRule[];
export type ReplicationStatus = "COMPLETE"|"PENDING"|"FAILED"|"REPLICA"|string;
export type RequestCharged = "requester"|string;
export type RequestPayer = "requester"|string;
export interface RequestPaymentConfiguration {
/**
* Specifies who pays for the download and request fees.
*/
Payer: Payer;
}
export interface RequestProgress {
/**
* Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.
*/
Enabled?: EnableRequestProgress;
}
export type ResponseCacheControl = string;
export type ResponseContentDisposition = string;
export type ResponseContentEncoding = string;
export type ResponseContentLanguage = string;
export type ResponseContentType = string;
export type ResponseExpires = Date;
export type Restore = string;
export interface RestoreObjectOutput {
RequestCharged?: RequestCharged;
/**
* Indicates the path in the provided S3 output location where Select results will be restored to.
*/
RestoreOutputPath?: RestoreOutputPath;
}
export interface RestoreObjectRequest {
/**
*
*/
Bucket: BucketName;
/**
*
*/
Key: ObjectKey;
/**
*
*/
VersionId?: ObjectVersionId;
RestoreRequest?: RestoreRequest;
RequestPayer?: RequestPayer;
}
export type RestoreOutputPath = string;
export interface RestoreRequest {
/**
* Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.
*/
Days?: Days;
/**
* Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.
*/
GlacierJobParameters?: GlacierJobParameters;
/**
* Type of restore request.
*/
Type?: RestoreRequestType;
/**
* Glacier retrieval tier at which the restore will be processed.
*/
Tier?: Tier;
/**
* The optional description for the job.
*/
Description?: Description;
/**
* Describes the parameters for Select job types.
*/
SelectParameters?: SelectParameters;
/**
* Describes the location where the restore job's output is stored.
*/
OutputLocation?: OutputLocation;
}
export type RestoreRequestType = "SELECT"|string;
export type Role = string;
export interface RoutingRule {
/**
* A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
*/
Condition?: Condition;
/**
* Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.
*/
Redirect: Redirect;
}
export type RoutingRules = RoutingRule[];
export interface Rule {
/**
*
*/
Expiration?: LifecycleExpiration;
/**
* Unique identifier for the rule. The value cannot be longer than 255 characters.
*/
ID?: ID;
/**
* Prefix identifying one or more objects to which the rule applies.
*/
Prefix: Prefix;
/**
* If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
*/
Status: ExpirationStatus;
/**
*
*/
Transition?: Transition;
NoncurrentVersionTransition?: NoncurrentVersionTransition;
NoncurrentVersionExpiration?: NoncurrentVersionExpiration;
AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload;
}
export type Rules = Rule[];
export interface S3KeyFilter {
FilterRules?: FilterRuleList;
}
export interface S3Location {
/**
* The name of the bucket where the restore results will be placed.
*/
BucketName: BucketName;
/**
* The prefix that is prepended to the restore results for this request.
*/
Prefix: LocationPrefix;
Encryption?: Encryption;
/**
* The canned ACL to apply to the restore results.
*/
CannedACL?: ObjectCannedACL;
/**
* A list of grants that control access to the staged results.
*/
AccessControlList?: Grants;
/**
* The tag-set that is applied to the restore results.
*/
Tagging?: Tagging;
/**
* A list of metadata to store with the restore results in S3.
*/
UserMetadata?: UserMetadata;
/**
* The class of storage used to store the restore results.
*/
StorageClass?: StorageClass;
}
export type SSECustomerAlgorithm = string;
export type SSECustomerKey = Buffer|Uint8Array|Blob|string;
export type SSECustomerKeyMD5 = string;
export interface SSEKMS {
/**
* Specifies the ID of the AWS Key Management Service (KMS) master encryption key to use for encrypting Inventory reports.
*/
KeyId: SSEKMSKeyId;
}
export type SSEKMSKeyId = string;
export interface SSES3 {
}
export type SelectObjectContentEventStream = EventStream<{Records?:RecordsEvent,Stats?:StatsEvent,Progress?:ProgressEvent,Cont?:ContinuationEvent,End?:EndEvent}>;
export interface SelectObjectContentOutput {
/**
*
*/
Payload?: SelectObjectContentEventStream;
}
export interface SelectObjectContentRequest {
/**
* The S3 bucket.
*/
Bucket: BucketName;
/**
* The object key.
*/
Key: ObjectKey;
/**
* The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
*/
SSECustomerKey?: SSECustomerKey;
/**
* The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* The expression that is used to query the object.
*/
Expression: Expression;
/**
* The type of the provided expression (for example., SQL).
*/
ExpressionType: ExpressionType;
/**
* Specifies if periodic request progress information should be enabled.
*/
RequestProgress?: RequestProgress;
/**
* Describes the format of the data in the object that is being queried.
*/
InputSerialization: InputSerialization;
/**
* Describes the format of the data that you want Amazon S3 to return in response.
*/
OutputSerialization: OutputSerialization;
}
export interface SelectParameters {
/**
* Describes the serialization format of the object.
*/
InputSerialization: InputSerialization;
/**
* The type of the provided expression (e.g., SQL).
*/
ExpressionType: ExpressionType;
/**
* The expression that is used to query the object.
*/
Expression: Expression;
/**
* Describes how the results of the Select job are serialized.
*/
OutputSerialization: OutputSerialization;
}
export type ServerSideEncryption = "AES256"|"aws:kms"|string;
export interface ServerSideEncryptionByDefault {
/**
* Server-side encryption algorithm to use for the default encryption.
*/
SSEAlgorithm: ServerSideEncryption;
/**
* KMS master key ID to use for the default encryption. This parameter is allowed if SSEAlgorithm is aws:kms.
*/
KMSMasterKeyID?: SSEKMSKeyId;
}
export interface ServerSideEncryptionConfiguration {
/**
* Container for information about a particular server-side encryption configuration rule.
*/
Rules: ServerSideEncryptionRules;
}
export interface ServerSideEncryptionRule {
/**
* Describes the default server-side encryption to apply to new objects in the bucket. If Put Object request does not specify any server-side encryption, this default encryption will be applied.
*/
ApplyServerSideEncryptionByDefault?: ServerSideEncryptionByDefault;
}
export type ServerSideEncryptionRules = ServerSideEncryptionRule[];
export type Setting = boolean;
export type Size = number;
export interface SourceSelectionCriteria {
/**
* A container for filter information for the selection of S3 objects encrypted with AWS KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required.
*/
SseKmsEncryptedObjects?: SseKmsEncryptedObjects;
}
export interface SseKmsEncryptedObjects {
/**
* If the status is not Enabled, replication for S3 objects encrypted with AWS KMS is disabled.
*/
Status: SseKmsEncryptedObjectsStatus;
}
export type SseKmsEncryptedObjectsStatus = "Enabled"|"Disabled"|string;
export type StartAfter = string;
export interface Stats {
/**
* The total number of object bytes scanned.
*/
BytesScanned?: BytesScanned;
/**
* The total number of uncompressed object bytes processed.
*/
BytesProcessed?: BytesProcessed;
/**
* The total number of bytes of records payload data returned.
*/
BytesReturned?: BytesReturned;
}
export interface StatsEvent {
/**
* The Stats event details.
*/
Details?: Stats;
}
export type StorageClass = "STANDARD"|"REDUCED_REDUNDANCY"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"GLACIER"|"DEEP_ARCHIVE"|string;
export interface StorageClassAnalysis {
/**
* A container used to describe how data related to the storage class analysis should be exported.
*/
DataExport?: StorageClassAnalysisDataExport;
}
export interface StorageClassAnalysisDataExport {
/**
* The version of the output schema to use when exporting data. Must be V_1.
*/
OutputSchemaVersion: StorageClassAnalysisSchemaVersion;
/**
* The place to store the data for an analysis.
*/
Destination: AnalyticsExportDestination;
}
export type StorageClassAnalysisSchemaVersion = "V_1"|string;
export type Suffix = string;
export interface Tag {
/**
* Name of the tag.
*/
Key: ObjectKey;
/**
* Value of the tag.
*/
Value: Value;
}
export type TagCount = number;
export type TagSet = Tag[];
export interface Tagging {
/**
*
*/
TagSet: TagSet;
}
export type TaggingDirective = "COPY"|"REPLACE"|string;
export type TaggingHeader = string;
export type TargetBucket = string;
export interface TargetGrant {
/**
*
*/
Grantee?: Grantee;
/**
* Logging permissions assigned to the Grantee for the bucket.
*/
Permission?: BucketLogsPermission;
}
export type TargetGrants = TargetGrant[];
export type TargetPrefix = string;
export type Tier = "Standard"|"Bulk"|"Expedited"|string;
export type Token = string;
export type TopicArn = string;
export interface TopicConfiguration {
Id?: NotificationId;
/**
* The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 will publish a message when it detects events of the specified type.
*/
TopicArn: TopicArn;
/**
*
*/
Events: EventList;
Filter?: NotificationConfigurationFilter;
}
export interface TopicConfigurationDeprecated {
Id?: NotificationId;
/**
*
*/
Events?: EventList;
/**
* Bucket event for which to send notifications.
*/
Event?: Event;
/**
* Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.
*/
Topic?: TopicArn;
}
export type TopicConfigurationList = TopicConfiguration[];
export interface Transition {
/**
* Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
*/
Date?: _Date;
/**
* Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
*/
Days?: Days;
/**
* The class of storage used to store the object.
*/
StorageClass?: TransitionStorageClass;
}
export type TransitionList = Transition[];
export type TransitionStorageClass = "GLACIER"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|string;
export type Type = "CanonicalUser"|"AmazonCustomerByEmail"|"Group"|string;
export type URI = string;
export type UploadIdMarker = string;
export interface UploadPartCopyOutput {
/**
* The version of the source object that was copied, if you have enabled versioning on the source bucket.
*/
CopySourceVersionId?: CopySourceVersionId;
/**
*
*/
CopyPartResult?: CopyPartResult;
/**
* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
*/
ServerSideEncryption?: ServerSideEncryption;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
*/
SSEKMSKeyId?: SSEKMSKeyId;
RequestCharged?: RequestCharged;
}
export interface UploadPartCopyRequest {
/**
*
*/
Bucket: BucketName;
/**
* The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.
*/
CopySource: CopySource;
/**
* Copies the object if its entity tag (ETag) matches the specified tag.
*/
CopySourceIfMatch?: CopySourceIfMatch;
/**
* Copies the object if it has been modified since the specified time.
*/
CopySourceIfModifiedSince?: CopySourceIfModifiedSince;
/**
* Copies the object if its entity tag (ETag) is different than the specified ETag.
*/
CopySourceIfNoneMatch?: CopySourceIfNoneMatch;
/**
* Copies the object if it hasn't been modified since the specified time.
*/
CopySourceIfUnmodifiedSince?: CopySourceIfUnmodifiedSince;
/**
* The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 MB.
*/
CopySourceRange?: CopySourceRange;
/**
*
*/
Key: ObjectKey;
/**
* Part number of part being copied. This is a positive integer between 1 and 10,000.
*/
PartNumber: PartNumber;
/**
* Upload ID identifying the multipart upload whose part is being copied.
*/
UploadId: MultipartUploadId;
/**
* Specifies the algorithm to use to when encrypting the object (e.g., AES256).
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.
*/
SSECustomerKey?: SSECustomerKey;
/**
* Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* Specifies the algorithm to use when decrypting the source object (e.g., AES256).
*/
CopySourceSSECustomerAlgorithm?: CopySourceSSECustomerAlgorithm;
/**
* Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
*/
CopySourceSSECustomerKey?: CopySourceSSECustomerKey;
/**
* Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
*/
CopySourceSSECustomerKeyMD5?: CopySourceSSECustomerKeyMD5;
RequestPayer?: RequestPayer;
}
export interface UploadPartOutput {
/**
* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
*/
ServerSideEncryption?: ServerSideEncryption;
/**
* Entity tag for the uploaded object.
*/
ETag?: ETag;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
/**
* If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
*/
SSEKMSKeyId?: SSEKMSKeyId;
RequestCharged?: RequestCharged;
}
export interface UploadPartRequest {
/**
* Object data.
*/
Body?: Body;
/**
* Name of the bucket to which the multipart upload was initiated.
*/
Bucket: BucketName;
/**
* Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
*/
ContentLength?: ContentLength;
/**
* The base64-encoded 128-bit MD5 digest of the part data.
*/
ContentMD5?: ContentMD5;
/**
* Object key for which the multipart upload was initiated.
*/
Key: ObjectKey;
/**
* Part number of part being uploaded. This is a positive integer between 1 and 10,000.
*/
PartNumber: PartNumber;
/**
* Upload ID identifying the multipart upload whose part is being uploaded.
*/
UploadId: MultipartUploadId;
/**
* Specifies the algorithm to use to when encrypting the object (e.g., AES256).
*/
SSECustomerAlgorithm?: SSECustomerAlgorithm;
/**
* Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.
*/
SSECustomerKey?: SSECustomerKey;
/**
* Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
*/
SSECustomerKeyMD5?: SSECustomerKeyMD5;
RequestPayer?: RequestPayer;
}
export type UserMetadata = MetadataEntry[];
export type Value = string;
export type VersionIdMarker = string;
export interface VersioningConfiguration {
/**
* Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
*/
MFADelete?: MFADelete;
/**
* The versioning state of the bucket.
*/
Status?: BucketVersioningStatus;
}
export interface WebsiteConfiguration {
/**
*
*/
ErrorDocument?: ErrorDocument;
/**
*
*/
IndexDocument?: IndexDocument;
/**
*
*/
RedirectAllRequestsTo?: RedirectAllRequestsTo;
/**
*
*/
RoutingRules?: RoutingRules;
}
export type WebsiteRedirectLocation = string;
export type Years = number;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2006-03-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & UseDualstackConfigOptions & ClientApiVersions;
/**
* Contains interfaces for use with the S3 client.
*/
export import Types = S3;
}
export = S3;