| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.S3
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- AbortMultipartUpload
- CompleteMultipartUpload
- CopyObject
- CreateBucket
- CreateMultipartUpload
- DeleteBucket
- DeleteBucketAnalyticsConfiguration
- DeleteBucketCors
- DeleteBucketEncryption
- DeleteBucketIntelligentTieringConfiguration
- DeleteBucketInventoryConfiguration
- DeleteBucketLifecycle
- DeleteBucketMetricsConfiguration
- DeleteBucketOwnershipControls
- DeleteBucketPolicy
- DeleteBucketReplication
- DeleteBucketTagging
- DeleteBucketWebsite
- DeleteObject
- DeleteObjectTagging
- DeleteObjects
- DeletePublicAccessBlock
- GetBucketAccelerateConfiguration
- GetBucketAcl
- GetBucketAnalyticsConfiguration
- GetBucketCors
- GetBucketEncryption
- GetBucketIntelligentTieringConfiguration
- GetBucketInventoryConfiguration
- GetBucketLifecycleConfiguration
- GetBucketLocation
- GetBucketLogging
- GetBucketMetricsConfiguration
- GetBucketNotificationConfiguration
- GetBucketOwnershipControls
- GetBucketPolicy
- GetBucketPolicyStatus
- GetBucketReplication
- GetBucketRequestPayment
- GetBucketTagging
- GetBucketVersioning
- GetBucketWebsite
- GetObject
- GetObjectAcl
- GetObjectAttributes
- GetObjectLegalHold
- GetObjectLockConfiguration
- GetObjectRetention
- GetObjectTagging
- GetObjectTorrent
- GetPublicAccessBlock
- HeadBucket
- HeadObject
- ListBucketAnalyticsConfigurations
- ListBucketIntelligentTieringConfigurations
- ListBucketInventoryConfigurations
- ListBucketMetricsConfigurations
- ListBuckets
- ListMultipartUploads (Paginated)
- ListObjectVersions (Paginated)
- ListObjects (Paginated)
- ListObjectsV2 (Paginated)
- ListParts (Paginated)
- PutBucketAccelerateConfiguration
- PutBucketAcl
- PutBucketAnalyticsConfiguration
- PutBucketCors
- PutBucketEncryption
- PutBucketIntelligentTieringConfiguration
- PutBucketInventoryConfiguration
- PutBucketLifecycleConfiguration
- PutBucketLogging
- PutBucketMetricsConfiguration
- PutBucketNotificationConfiguration
- PutBucketOwnershipControls
- PutBucketPolicy
- PutBucketReplication
- PutBucketRequestPayment
- PutBucketTagging
- PutBucketVersioning
- PutBucketWebsite
- PutObject
- PutObjectAcl
- PutObjectLegalHold
- PutObjectLockConfiguration
- PutObjectRetention
- PutObjectTagging
- PutPublicAccessBlock
- RestoreObject
- SelectObjectContent
- UploadPart
- UploadPartCopy
- WriteGetObjectResponse
- Types
- Common
- AnalyticsS3ExportFileFormat
- ArchiveStatus
- BucketAccelerateStatus
- BucketCannedACL
- BucketLogsPermission
- BucketVersioningStatus
- ChecksumAlgorithm
- ChecksumMode
- CompressionType
- DeleteMarkerReplicationStatus
- EncodingType
- Event
- ExistingObjectReplicationStatus
- ExpirationStatus
- ExpressionType
- FileHeaderInfo
- FilterRuleName
- IntelligentTieringAccessTier
- IntelligentTieringStatus
- InventoryFormat
- InventoryFrequency
- InventoryIncludedObjectVersions
- InventoryOptionalField
- JSONType
- MFADelete
- MFADeleteStatus
- MetadataDirective
- MetricsStatus
- ObjectAttributes
- ObjectCannedACL
- ObjectLockEnabled
- ObjectLockLegalHoldStatus
- ObjectLockMode
- ObjectLockRetentionMode
- ObjectOwnership
- ObjectStorageClass
- ObjectVersionStorageClass
- OwnerOverride
- Payer
- Permission
- Protocol
- QuoteFields
- ReplicaModificationsStatus
- ReplicationRuleStatus
- ReplicationStatus
- ReplicationTimeStatus
- RequestCharged
- RequestPayer
- RestoreRequestType
- ServerSideEncryption
- SseKmsEncryptedObjectsStatus
- StorageClass
- StorageClassAnalysisSchemaVersion
- TaggingDirective
- Tier
- TransitionStorageClass
- Type
- AbortIncompleteMultipartUpload
- AccelerateConfiguration
- AccessControlPolicy
- AccessControlTranslation
- AnalyticsAndOperator
- AnalyticsConfiguration
- AnalyticsExportDestination
- AnalyticsFilter
- AnalyticsS3BucketDestination
- Bucket
- BucketLifecycleConfiguration
- BucketLoggingStatus
- CORSConfiguration
- CORSRule
- CSVInput
- CSVOutput
- Checksum
- CommonPrefix
- CompletedMultipartUpload
- CompletedPart
- Condition
- ContinuationEvent
- CopyObjectResult
- CopyPartResult
- CreateBucketConfiguration
- DefaultRetention
- Delete
- DeleteMarkerEntry
- DeleteMarkerReplication
- DeletedObject
- Destination
- Encryption
- EncryptionConfiguration
- EndEvent
- ErrorDocument
- EventBridgeConfiguration
- ExistingObjectReplication
- FilterRule
- GetObjectAttributesParts
- GlacierJobParameters
- Grant
- Grantee
- IndexDocument
- Initiator
- InputSerialization
- IntelligentTieringAndOperator
- IntelligentTieringConfiguration
- IntelligentTieringFilter
- InventoryConfiguration
- InventoryDestination
- InventoryEncryption
- InventoryFilter
- InventoryS3BucketDestination
- InventorySchedule
- JSONInput
- JSONOutput
- LambdaFunctionConfiguration
- LifecycleExpiration
- LifecycleRule
- LifecycleRuleAndOperator
- LifecycleRuleFilter
- LoggingEnabled
- MetadataEntry
- Metrics
- MetricsAndOperator
- MetricsConfiguration
- MetricsFilter
- MultipartUpload
- NoncurrentVersionExpiration
- NoncurrentVersionTransition
- NotificationConfiguration
- NotificationConfigurationFilter
- Object
- ObjectIdentifier
- ObjectLockConfiguration
- ObjectLockLegalHold
- ObjectLockRetention
- ObjectLockRule
- ObjectPart
- ObjectVersion
- OutputLocation
- OutputSerialization
- Owner
- OwnershipControls
- OwnershipControlsRule
- ParquetInput
- Part
- PolicyStatus
- Progress
- ProgressEvent
- PublicAccessBlockConfiguration
- QueueConfiguration
- RecordsEvent
- Redirect
- RedirectAllRequestsTo
- ReplicaModifications
- ReplicationConfiguration
- ReplicationRule
- ReplicationRuleAndOperator
- ReplicationRuleFilter
- ReplicationTime
- ReplicationTimeValue
- RequestPaymentConfiguration
- RequestProgress
- RestoreRequest
- RoutingRule
- S3KeyFilter
- S3Location
- S3ServiceError
- SSEKMS
- SSES3
- ScanRange
- SelectObjectContentEventStream
- SelectParameters
- ServerSideEncryptionByDefault
- ServerSideEncryptionConfiguration
- ServerSideEncryptionRule
- SourceSelectionCriteria
- SseKmsEncryptedObjects
- Stats
- StatsEvent
- StorageClassAnalysis
- StorageClassAnalysisDataExport
- Tag
- Tagging
- TargetGrant
- Tiering
- TopicConfiguration
- Transition
- VersioningConfiguration
- WebsiteConfiguration
Description
Derived from API version 2006-03-01 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Simple Storage Service is storage for the Internet. Amazon S3 has a simple web services interface that you can use to store and retrieve any amount of data, at any time, from anywhere on the web. It gives any developer access to the same highly scalable, reliable, fast, inexpensive data storage infrastructure that Amazon uses to run its own global network of web sites. The service aims to maximize benefits of scale and to pass those benefits on to developers.
Synopsis
- defaultService :: Service
- _BucketAlreadyExists :: AsError a => Fold a ServiceError
- _BucketAlreadyOwnedByYou :: AsError a => Fold a ServiceError
- _InvalidObjectState :: AsError a => Fold a ServiceError
- _NoSuchBucket :: AsError a => Fold a ServiceError
- _NoSuchKey :: AsError a => Fold a ServiceError
- _NoSuchUpload :: AsError a => Fold a ServiceError
- _ObjectAlreadyInActiveTierError :: AsError a => Fold a ServiceError
- _ObjectNotInActiveTierError :: AsError a => Fold a ServiceError
- newBucketExists :: Wait HeadBucket
- newBucketNotExists :: Wait HeadBucket
- newObjectExists :: Wait HeadObject
- newObjectNotExists :: Wait HeadObject
- data AbortMultipartUpload = AbortMultipartUpload' (Maybe Text) (Maybe RequestPayer) BucketName ObjectKey Text
- newAbortMultipartUpload :: BucketName -> ObjectKey -> Text -> AbortMultipartUpload
- data AbortMultipartUploadResponse = AbortMultipartUploadResponse' (Maybe RequestCharged) Int
- newAbortMultipartUploadResponse :: Int -> AbortMultipartUploadResponse
- data CompleteMultipartUpload = CompleteMultipartUpload' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CompletedMultipartUpload) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) BucketName ObjectKey Text
- newCompleteMultipartUpload :: BucketName -> ObjectKey -> Text -> CompleteMultipartUpload
- data CompleteMultipartUploadResponse = CompleteMultipartUploadResponse' (Maybe BucketName) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe Text) (Maybe ObjectKey) (Maybe Text) (Maybe RequestCharged) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe ObjectVersionId) Int
- newCompleteMultipartUploadResponse :: Int -> CompleteMultipartUploadResponse
- data CopyObject = CopyObject' (Maybe ObjectCannedACL) (Maybe Bool) (Maybe Text) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (HashMap Text Text) (Maybe MetadataDirective) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe StorageClass) (Maybe Text) (Maybe TaggingDirective) (Maybe Text) BucketName Text ObjectKey
- newCopyObject :: BucketName -> Text -> ObjectKey -> CopyObject
- data CopyObjectResponse = CopyObjectResponse' (Maybe Bool) (Maybe CopyObjectResult) (Maybe Text) (Maybe Text) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe ObjectVersionId) Int
- newCopyObjectResponse :: Int -> CopyObjectResponse
- data CreateBucket = CreateBucket' (Maybe BucketCannedACL) (Maybe CreateBucketConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ObjectOwnership) BucketName
- newCreateBucket :: BucketName -> CreateBucket
- data CreateBucketResponse = CreateBucketResponse' (Maybe Text) Int
- newCreateBucketResponse :: Int -> CreateBucketResponse
- data CreateMultipartUpload = CreateMultipartUpload' (Maybe ObjectCannedACL) (Maybe Bool) (Maybe Text) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (HashMap Text Text) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe StorageClass) (Maybe Text) (Maybe Text) BucketName ObjectKey
- newCreateMultipartUpload :: BucketName -> ObjectKey -> CreateMultipartUpload
- data CreateMultipartUploadResponse = CreateMultipartUploadResponse' (Maybe RFC822) (Maybe Text) (Maybe BucketName) (Maybe Bool) (Maybe ChecksumAlgorithm) (Maybe ObjectKey) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) Int Text
- newCreateMultipartUploadResponse :: Int -> Text -> CreateMultipartUploadResponse
- data DeleteBucket = DeleteBucket' (Maybe Text) BucketName
- newDeleteBucket :: BucketName -> DeleteBucket
- data DeleteBucketResponse = DeleteBucketResponse' {
- newDeleteBucketResponse :: DeleteBucketResponse
- data DeleteBucketAnalyticsConfiguration = DeleteBucketAnalyticsConfiguration' (Maybe Text) BucketName Text
- newDeleteBucketAnalyticsConfiguration :: BucketName -> Text -> DeleteBucketAnalyticsConfiguration
- data DeleteBucketAnalyticsConfigurationResponse = DeleteBucketAnalyticsConfigurationResponse' {
- newDeleteBucketAnalyticsConfigurationResponse :: DeleteBucketAnalyticsConfigurationResponse
- data DeleteBucketCors = DeleteBucketCors' (Maybe Text) BucketName
- newDeleteBucketCors :: BucketName -> DeleteBucketCors
- data DeleteBucketCorsResponse = DeleteBucketCorsResponse' {
- newDeleteBucketCorsResponse :: DeleteBucketCorsResponse
- data DeleteBucketEncryption = DeleteBucketEncryption' (Maybe Text) BucketName
- newDeleteBucketEncryption :: BucketName -> DeleteBucketEncryption
- data DeleteBucketEncryptionResponse = DeleteBucketEncryptionResponse' {
- newDeleteBucketEncryptionResponse :: DeleteBucketEncryptionResponse
- data DeleteBucketIntelligentTieringConfiguration = DeleteBucketIntelligentTieringConfiguration' BucketName Text
- newDeleteBucketIntelligentTieringConfiguration :: BucketName -> Text -> DeleteBucketIntelligentTieringConfiguration
- data DeleteBucketIntelligentTieringConfigurationResponse = DeleteBucketIntelligentTieringConfigurationResponse' {
- newDeleteBucketIntelligentTieringConfigurationResponse :: DeleteBucketIntelligentTieringConfigurationResponse
- data DeleteBucketInventoryConfiguration = DeleteBucketInventoryConfiguration' (Maybe Text) BucketName Text
- newDeleteBucketInventoryConfiguration :: BucketName -> Text -> DeleteBucketInventoryConfiguration
- data DeleteBucketInventoryConfigurationResponse = DeleteBucketInventoryConfigurationResponse' {
- newDeleteBucketInventoryConfigurationResponse :: DeleteBucketInventoryConfigurationResponse
- data DeleteBucketLifecycle = DeleteBucketLifecycle' (Maybe Text) BucketName
- newDeleteBucketLifecycle :: BucketName -> DeleteBucketLifecycle
- data DeleteBucketLifecycleResponse = DeleteBucketLifecycleResponse' {
- newDeleteBucketLifecycleResponse :: DeleteBucketLifecycleResponse
- data DeleteBucketMetricsConfiguration = DeleteBucketMetricsConfiguration' (Maybe Text) BucketName Text
- newDeleteBucketMetricsConfiguration :: BucketName -> Text -> DeleteBucketMetricsConfiguration
- data DeleteBucketMetricsConfigurationResponse = DeleteBucketMetricsConfigurationResponse' {
- newDeleteBucketMetricsConfigurationResponse :: DeleteBucketMetricsConfigurationResponse
- data DeleteBucketOwnershipControls = DeleteBucketOwnershipControls' (Maybe Text) BucketName
- newDeleteBucketOwnershipControls :: BucketName -> DeleteBucketOwnershipControls
- data DeleteBucketOwnershipControlsResponse = DeleteBucketOwnershipControlsResponse' {
- newDeleteBucketOwnershipControlsResponse :: DeleteBucketOwnershipControlsResponse
- data DeleteBucketPolicy = DeleteBucketPolicy' (Maybe Text) BucketName
- newDeleteBucketPolicy :: BucketName -> DeleteBucketPolicy
- data DeleteBucketPolicyResponse = DeleteBucketPolicyResponse' {
- newDeleteBucketPolicyResponse :: DeleteBucketPolicyResponse
- data DeleteBucketReplication = DeleteBucketReplication' (Maybe Text) BucketName
- newDeleteBucketReplication :: BucketName -> DeleteBucketReplication
- data DeleteBucketReplicationResponse = DeleteBucketReplicationResponse' {
- newDeleteBucketReplicationResponse :: DeleteBucketReplicationResponse
- data DeleteBucketTagging = DeleteBucketTagging' (Maybe Text) BucketName
- newDeleteBucketTagging :: BucketName -> DeleteBucketTagging
- data DeleteBucketTaggingResponse = DeleteBucketTaggingResponse' {
- newDeleteBucketTaggingResponse :: DeleteBucketTaggingResponse
- data DeleteBucketWebsite = DeleteBucketWebsite' (Maybe Text) BucketName
- newDeleteBucketWebsite :: BucketName -> DeleteBucketWebsite
- data DeleteBucketWebsiteResponse = DeleteBucketWebsiteResponse' {
- newDeleteBucketWebsiteResponse :: DeleteBucketWebsiteResponse
- data DeleteObject = DeleteObject' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey
- newDeleteObject :: BucketName -> ObjectKey -> DeleteObject
- data DeleteObjectResponse = DeleteObjectResponse' (Maybe Bool) (Maybe RequestCharged) (Maybe ObjectVersionId) Int
- newDeleteObjectResponse :: Int -> DeleteObjectResponse
- data DeleteObjectTagging = DeleteObjectTagging' (Maybe Text) (Maybe ObjectVersionId) BucketName ObjectKey
- newDeleteObjectTagging :: BucketName -> ObjectKey -> DeleteObjectTagging
- data DeleteObjectTaggingResponse = DeleteObjectTaggingResponse' (Maybe ObjectVersionId) Int
- newDeleteObjectTaggingResponse :: Int -> DeleteObjectTaggingResponse
- data DeleteObjects = DeleteObjects' (Maybe Bool) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe RequestPayer) BucketName Delete
- newDeleteObjects :: BucketName -> Delete -> DeleteObjects
- data DeleteObjectsResponse = DeleteObjectsResponse' (Maybe [DeletedObject]) (Maybe [S3ServiceError]) (Maybe RequestCharged) Int
- newDeleteObjectsResponse :: Int -> DeleteObjectsResponse
- data DeletePublicAccessBlock = DeletePublicAccessBlock' (Maybe Text) BucketName
- newDeletePublicAccessBlock :: BucketName -> DeletePublicAccessBlock
- data DeletePublicAccessBlockResponse = DeletePublicAccessBlockResponse' {
- newDeletePublicAccessBlockResponse :: DeletePublicAccessBlockResponse
- data GetBucketAccelerateConfiguration = GetBucketAccelerateConfiguration' (Maybe Text) BucketName
- newGetBucketAccelerateConfiguration :: BucketName -> GetBucketAccelerateConfiguration
- data GetBucketAccelerateConfigurationResponse = GetBucketAccelerateConfigurationResponse' (Maybe BucketAccelerateStatus) Int
- newGetBucketAccelerateConfigurationResponse :: Int -> GetBucketAccelerateConfigurationResponse
- data GetBucketAcl = GetBucketAcl' (Maybe Text) BucketName
- newGetBucketAcl :: BucketName -> GetBucketAcl
- data GetBucketAclResponse = GetBucketAclResponse' (Maybe [Grant]) (Maybe Owner) Int
- newGetBucketAclResponse :: Int -> GetBucketAclResponse
- data GetBucketAnalyticsConfiguration = GetBucketAnalyticsConfiguration' (Maybe Text) BucketName Text
- newGetBucketAnalyticsConfiguration :: BucketName -> Text -> GetBucketAnalyticsConfiguration
- data GetBucketAnalyticsConfigurationResponse = GetBucketAnalyticsConfigurationResponse' (Maybe AnalyticsConfiguration) Int
- newGetBucketAnalyticsConfigurationResponse :: Int -> GetBucketAnalyticsConfigurationResponse
- data GetBucketCors = GetBucketCors' (Maybe Text) BucketName
- newGetBucketCors :: BucketName -> GetBucketCors
- data GetBucketCorsResponse = GetBucketCorsResponse' (Maybe [CORSRule]) Int
- newGetBucketCorsResponse :: Int -> GetBucketCorsResponse
- data GetBucketEncryption = GetBucketEncryption' (Maybe Text) BucketName
- newGetBucketEncryption :: BucketName -> GetBucketEncryption
- data GetBucketEncryptionResponse = GetBucketEncryptionResponse' (Maybe ServerSideEncryptionConfiguration) Int
- newGetBucketEncryptionResponse :: Int -> GetBucketEncryptionResponse
- data GetBucketIntelligentTieringConfiguration = GetBucketIntelligentTieringConfiguration' BucketName Text
- newGetBucketIntelligentTieringConfiguration :: BucketName -> Text -> GetBucketIntelligentTieringConfiguration
- data GetBucketIntelligentTieringConfigurationResponse = GetBucketIntelligentTieringConfigurationResponse' (Maybe IntelligentTieringConfiguration) Int
- newGetBucketIntelligentTieringConfigurationResponse :: Int -> GetBucketIntelligentTieringConfigurationResponse
- data GetBucketInventoryConfiguration = GetBucketInventoryConfiguration' (Maybe Text) BucketName Text
- newGetBucketInventoryConfiguration :: BucketName -> Text -> GetBucketInventoryConfiguration
- data GetBucketInventoryConfigurationResponse = GetBucketInventoryConfigurationResponse' (Maybe InventoryConfiguration) Int
- newGetBucketInventoryConfigurationResponse :: Int -> GetBucketInventoryConfigurationResponse
- data GetBucketLifecycleConfiguration = GetBucketLifecycleConfiguration' (Maybe Text) BucketName
- newGetBucketLifecycleConfiguration :: BucketName -> GetBucketLifecycleConfiguration
- data GetBucketLifecycleConfigurationResponse = GetBucketLifecycleConfigurationResponse' (Maybe [LifecycleRule]) Int
- newGetBucketLifecycleConfigurationResponse :: Int -> GetBucketLifecycleConfigurationResponse
- data GetBucketLocation = GetBucketLocation' (Maybe Text) BucketName
- newGetBucketLocation :: BucketName -> GetBucketLocation
- data GetBucketLocationResponse = GetBucketLocationResponse' Int LocationConstraint
- newGetBucketLocationResponse :: Int -> LocationConstraint -> GetBucketLocationResponse
- data GetBucketLogging = GetBucketLogging' (Maybe Text) BucketName
- newGetBucketLogging :: BucketName -> GetBucketLogging
- data GetBucketLoggingResponse = GetBucketLoggingResponse' (Maybe LoggingEnabled) Int
- newGetBucketLoggingResponse :: Int -> GetBucketLoggingResponse
- data GetBucketMetricsConfiguration = GetBucketMetricsConfiguration' (Maybe Text) BucketName Text
- newGetBucketMetricsConfiguration :: BucketName -> Text -> GetBucketMetricsConfiguration
- data GetBucketMetricsConfigurationResponse = GetBucketMetricsConfigurationResponse' (Maybe MetricsConfiguration) Int
- newGetBucketMetricsConfigurationResponse :: Int -> GetBucketMetricsConfigurationResponse
- data GetBucketNotificationConfiguration = GetBucketNotificationConfiguration' (Maybe Text) BucketName
- newGetBucketNotificationConfiguration :: BucketName -> GetBucketNotificationConfiguration
- data NotificationConfiguration = NotificationConfiguration' (Maybe EventBridgeConfiguration) (Maybe [LambdaFunctionConfiguration]) (Maybe [QueueConfiguration]) (Maybe [TopicConfiguration])
- newNotificationConfiguration :: NotificationConfiguration
- data GetBucketOwnershipControls = GetBucketOwnershipControls' (Maybe Text) BucketName
- newGetBucketOwnershipControls :: BucketName -> GetBucketOwnershipControls
- data GetBucketOwnershipControlsResponse = GetBucketOwnershipControlsResponse' (Maybe OwnershipControls) Int
- newGetBucketOwnershipControlsResponse :: Int -> GetBucketOwnershipControlsResponse
- data GetBucketPolicy = GetBucketPolicy' (Maybe Text) BucketName
- newGetBucketPolicy :: BucketName -> GetBucketPolicy
- data GetBucketPolicyResponse = GetBucketPolicyResponse' Int ByteString
- newGetBucketPolicyResponse :: Int -> ByteString -> GetBucketPolicyResponse
- data GetBucketPolicyStatus = GetBucketPolicyStatus' (Maybe Text) BucketName
- newGetBucketPolicyStatus :: BucketName -> GetBucketPolicyStatus
- data GetBucketPolicyStatusResponse = GetBucketPolicyStatusResponse' (Maybe PolicyStatus) Int
- newGetBucketPolicyStatusResponse :: Int -> GetBucketPolicyStatusResponse
- data GetBucketReplication = GetBucketReplication' (Maybe Text) BucketName
- newGetBucketReplication :: BucketName -> GetBucketReplication
- data GetBucketReplicationResponse = GetBucketReplicationResponse' (Maybe ReplicationConfiguration) Int
- newGetBucketReplicationResponse :: Int -> GetBucketReplicationResponse
- data GetBucketRequestPayment = GetBucketRequestPayment' (Maybe Text) BucketName
- newGetBucketRequestPayment :: BucketName -> GetBucketRequestPayment
- data GetBucketRequestPaymentResponse = GetBucketRequestPaymentResponse' (Maybe Payer) Int
- newGetBucketRequestPaymentResponse :: Int -> GetBucketRequestPaymentResponse
- data GetBucketTagging = GetBucketTagging' (Maybe Text) BucketName
- newGetBucketTagging :: BucketName -> GetBucketTagging
- data GetBucketTaggingResponse = GetBucketTaggingResponse' Int [Tag]
- newGetBucketTaggingResponse :: Int -> GetBucketTaggingResponse
- data GetBucketVersioning = GetBucketVersioning' (Maybe Text) BucketName
- newGetBucketVersioning :: BucketName -> GetBucketVersioning
- data GetBucketVersioningResponse = GetBucketVersioningResponse' (Maybe MFADeleteStatus) (Maybe BucketVersioningStatus) Int
- newGetBucketVersioningResponse :: Int -> GetBucketVersioningResponse
- data GetBucketWebsite = GetBucketWebsite' (Maybe Text) BucketName
- newGetBucketWebsite :: BucketName -> GetBucketWebsite
- data GetBucketWebsiteResponse = GetBucketWebsiteResponse' (Maybe ErrorDocument) (Maybe IndexDocument) (Maybe RedirectAllRequestsTo) (Maybe [RoutingRule]) Int
- newGetBucketWebsiteResponse :: Int -> GetBucketWebsiteResponse
- data GetObject = GetObject' (Maybe ChecksumMode) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe RFC822) (Maybe Int) (Maybe Text) (Maybe RequestPayer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe ObjectVersionId) BucketName ObjectKey
- newGetObject :: BucketName -> ObjectKey -> GetObject
- data GetObjectResponse = GetObjectResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ETag) (Maybe Text) (Maybe RFC822) (Maybe RFC822) (HashMap Text Text) (Maybe Int) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe Int) (Maybe ReplicationStatus) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe StorageClass) (Maybe Int) (Maybe ObjectVersionId) (Maybe Text) Int ResponseBody
- newGetObjectResponse :: Int -> ResponseBody -> GetObjectResponse
- data GetObjectAcl = GetObjectAcl' (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey
- newGetObjectAcl :: BucketName -> ObjectKey -> GetObjectAcl
- data GetObjectAclResponse = GetObjectAclResponse' (Maybe [Grant]) (Maybe Owner) (Maybe RequestCharged) Int
- newGetObjectAclResponse :: Int -> GetObjectAclResponse
- data GetObjectAttributes = GetObjectAttributes' (Maybe Text) (Maybe Int) (Maybe Int) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe ObjectVersionId) BucketName ObjectKey [ObjectAttributes]
- newGetObjectAttributes :: BucketName -> ObjectKey -> GetObjectAttributes
- data GetObjectAttributesResponse = GetObjectAttributesResponse' (Maybe Checksum) (Maybe Bool) (Maybe ETag) (Maybe RFC822) (Maybe GetObjectAttributesParts) (Maybe Integer) (Maybe RequestCharged) (Maybe StorageClass) (Maybe ObjectVersionId) Int
- newGetObjectAttributesResponse :: Int -> GetObjectAttributesResponse
- data GetObjectLegalHold = GetObjectLegalHold' (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey
- newGetObjectLegalHold :: BucketName -> ObjectKey -> GetObjectLegalHold
- data GetObjectLegalHoldResponse = GetObjectLegalHoldResponse' (Maybe ObjectLockLegalHold) Int
- newGetObjectLegalHoldResponse :: Int -> GetObjectLegalHoldResponse
- data GetObjectLockConfiguration = GetObjectLockConfiguration' (Maybe Text) BucketName
- newGetObjectLockConfiguration :: BucketName -> GetObjectLockConfiguration
- data GetObjectLockConfigurationResponse = GetObjectLockConfigurationResponse' (Maybe ObjectLockConfiguration) Int
- newGetObjectLockConfigurationResponse :: Int -> GetObjectLockConfigurationResponse
- data GetObjectRetention = GetObjectRetention' (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey
- newGetObjectRetention :: BucketName -> ObjectKey -> GetObjectRetention
- data GetObjectRetentionResponse = GetObjectRetentionResponse' (Maybe ObjectLockRetention) Int
- newGetObjectRetentionResponse :: Int -> GetObjectRetentionResponse
- data GetObjectTagging = GetObjectTagging' (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey
- newGetObjectTagging :: BucketName -> ObjectKey -> GetObjectTagging
- data GetObjectTaggingResponse = GetObjectTaggingResponse' (Maybe ObjectVersionId) Int [Tag]
- newGetObjectTaggingResponse :: Int -> GetObjectTaggingResponse
- data GetObjectTorrent = GetObjectTorrent' (Maybe Text) (Maybe RequestPayer) BucketName ObjectKey
- newGetObjectTorrent :: BucketName -> ObjectKey -> GetObjectTorrent
- data GetObjectTorrentResponse = GetObjectTorrentResponse' (Maybe RequestCharged) Int ResponseBody
- newGetObjectTorrentResponse :: Int -> ResponseBody -> GetObjectTorrentResponse
- data GetPublicAccessBlock = GetPublicAccessBlock' (Maybe Text) BucketName
- newGetPublicAccessBlock :: BucketName -> GetPublicAccessBlock
- data GetPublicAccessBlockResponse = GetPublicAccessBlockResponse' (Maybe PublicAccessBlockConfiguration) Int
- newGetPublicAccessBlockResponse :: Int -> GetPublicAccessBlockResponse
- data HeadBucket = HeadBucket' (Maybe Text) BucketName
- newHeadBucket :: BucketName -> HeadBucket
- data HeadBucketResponse = HeadBucketResponse' {
- newHeadBucketResponse :: HeadBucketResponse
- data HeadObject = HeadObject' (Maybe ChecksumMode) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe RFC822) (Maybe Int) (Maybe Text) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe ObjectVersionId) BucketName ObjectKey
- newHeadObject :: BucketName -> ObjectKey -> HeadObject
- data HeadObjectResponse = HeadObjectResponse' (Maybe Text) (Maybe ArchiveStatus) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Bool) (Maybe ETag) (Maybe Text) (Maybe RFC822) (Maybe RFC822) (HashMap Text Text) (Maybe Int) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe Int) (Maybe ReplicationStatus) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe StorageClass) (Maybe ObjectVersionId) (Maybe Text) Int
- newHeadObjectResponse :: Int -> HeadObjectResponse
- data ListBucketAnalyticsConfigurations = ListBucketAnalyticsConfigurations' (Maybe Text) (Maybe Text) BucketName
- newListBucketAnalyticsConfigurations :: BucketName -> ListBucketAnalyticsConfigurations
- data ListBucketAnalyticsConfigurationsResponse = ListBucketAnalyticsConfigurationsResponse' (Maybe [AnalyticsConfiguration]) (Maybe Text) (Maybe Bool) (Maybe Text) Int
- newListBucketAnalyticsConfigurationsResponse :: Int -> ListBucketAnalyticsConfigurationsResponse
- data ListBucketIntelligentTieringConfigurations = ListBucketIntelligentTieringConfigurations' (Maybe Text) BucketName
- newListBucketIntelligentTieringConfigurations :: BucketName -> ListBucketIntelligentTieringConfigurations
- data ListBucketIntelligentTieringConfigurationsResponse = ListBucketIntelligentTieringConfigurationsResponse' (Maybe Text) (Maybe [IntelligentTieringConfiguration]) (Maybe Bool) (Maybe Text) Int
- newListBucketIntelligentTieringConfigurationsResponse :: Int -> ListBucketIntelligentTieringConfigurationsResponse
- data ListBucketInventoryConfigurations = ListBucketInventoryConfigurations' (Maybe Text) (Maybe Text) BucketName
- newListBucketInventoryConfigurations :: BucketName -> ListBucketInventoryConfigurations
- data ListBucketInventoryConfigurationsResponse = ListBucketInventoryConfigurationsResponse' (Maybe Text) (Maybe [InventoryConfiguration]) (Maybe Bool) (Maybe Text) Int
- newListBucketInventoryConfigurationsResponse :: Int -> ListBucketInventoryConfigurationsResponse
- data ListBucketMetricsConfigurations = ListBucketMetricsConfigurations' (Maybe Text) (Maybe Text) BucketName
- newListBucketMetricsConfigurations :: BucketName -> ListBucketMetricsConfigurations
- data ListBucketMetricsConfigurationsResponse = ListBucketMetricsConfigurationsResponse' (Maybe Text) (Maybe Bool) (Maybe [MetricsConfiguration]) (Maybe Text) Int
- newListBucketMetricsConfigurationsResponse :: Int -> ListBucketMetricsConfigurationsResponse
- data ListBuckets = ListBuckets' {
- newListBuckets :: ListBuckets
- data ListBucketsResponse = ListBucketsResponse' (Maybe [Bucket]) (Maybe Owner) Int
- newListBucketsResponse :: Int -> ListBucketsResponse
- data ListMultipartUploads = ListMultipartUploads' (Maybe Delimiter) (Maybe EncodingType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) BucketName
- newListMultipartUploads :: BucketName -> ListMultipartUploads
- data ListMultipartUploadsResponse = ListMultipartUploadsResponse' (Maybe BucketName) (Maybe [CommonPrefix]) (Maybe Delimiter) (Maybe EncodingType) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [MultipartUpload]) Int
- newListMultipartUploadsResponse :: Int -> ListMultipartUploadsResponse
- data ListObjectVersions = ListObjectVersions' (Maybe Delimiter) (Maybe EncodingType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) BucketName
- newListObjectVersions :: BucketName -> ListObjectVersions
- data ListObjectVersionsResponse = ListObjectVersionsResponse' (Maybe [CommonPrefix]) (Maybe [DeleteMarkerEntry]) (Maybe Delimiter) (Maybe EncodingType) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe BucketName) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ObjectVersion]) Int
- newListObjectVersionsResponse :: Int -> ListObjectVersionsResponse
- data ListObjects = ListObjects' (Maybe Delimiter) (Maybe EncodingType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe RequestPayer) BucketName
- newListObjects :: BucketName -> ListObjects
- data ListObjectsResponse = ListObjectsResponse' (Maybe [CommonPrefix]) (Maybe [Object]) (Maybe Delimiter) (Maybe EncodingType) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe BucketName) (Maybe Text) (Maybe Text) Int
- newListObjectsResponse :: Int -> ListObjectsResponse
- data ListObjectsV2 = ListObjectsV2' (Maybe Text) (Maybe Delimiter) (Maybe EncodingType) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe RequestPayer) (Maybe Text) BucketName
- newListObjectsV2 :: BucketName -> ListObjectsV2
- data ListObjectsV2Response = ListObjectsV2Response' (Maybe [CommonPrefix]) (Maybe [Object]) (Maybe Text) (Maybe Delimiter) (Maybe EncodingType) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe BucketName) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newListObjectsV2Response :: Int -> ListObjectsV2Response
- data ListParts = ListParts' (Maybe Text) (Maybe Int) (Maybe Int) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) BucketName ObjectKey Text
- newListParts :: BucketName -> ObjectKey -> Text -> ListParts
- data ListPartsResponse = ListPartsResponse' (Maybe RFC822) (Maybe Text) (Maybe BucketName) (Maybe ChecksumAlgorithm) (Maybe Initiator) (Maybe Bool) (Maybe ObjectKey) (Maybe Int) (Maybe Int) (Maybe Owner) (Maybe Int) (Maybe [Part]) (Maybe RequestCharged) (Maybe StorageClass) (Maybe Text) Int
- newListPartsResponse :: Int -> ListPartsResponse
- data PutBucketAccelerateConfiguration = PutBucketAccelerateConfiguration' (Maybe ChecksumAlgorithm) (Maybe Text) BucketName AccelerateConfiguration
- newPutBucketAccelerateConfiguration :: BucketName -> AccelerateConfiguration -> PutBucketAccelerateConfiguration
- data PutBucketAccelerateConfigurationResponse = PutBucketAccelerateConfigurationResponse' {
- newPutBucketAccelerateConfigurationResponse :: PutBucketAccelerateConfigurationResponse
- data PutBucketAcl = PutBucketAcl' (Maybe BucketCannedACL) (Maybe AccessControlPolicy) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) BucketName
- newPutBucketAcl :: BucketName -> PutBucketAcl
- data PutBucketAclResponse = PutBucketAclResponse' {
- newPutBucketAclResponse :: PutBucketAclResponse
- data PutBucketAnalyticsConfiguration = PutBucketAnalyticsConfiguration' (Maybe Text) BucketName Text AnalyticsConfiguration
- newPutBucketAnalyticsConfiguration :: BucketName -> Text -> AnalyticsConfiguration -> PutBucketAnalyticsConfiguration
- data PutBucketAnalyticsConfigurationResponse = PutBucketAnalyticsConfigurationResponse' {
- newPutBucketAnalyticsConfigurationResponse :: PutBucketAnalyticsConfigurationResponse
- data PutBucketCors = PutBucketCors' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName CORSConfiguration
- newPutBucketCors :: BucketName -> CORSConfiguration -> PutBucketCors
- data PutBucketCorsResponse = PutBucketCorsResponse' {
- newPutBucketCorsResponse :: PutBucketCorsResponse
- data PutBucketEncryption = PutBucketEncryption' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName ServerSideEncryptionConfiguration
- newPutBucketEncryption :: BucketName -> ServerSideEncryptionConfiguration -> PutBucketEncryption
- data PutBucketEncryptionResponse = PutBucketEncryptionResponse' {
- newPutBucketEncryptionResponse :: PutBucketEncryptionResponse
- data PutBucketIntelligentTieringConfiguration = PutBucketIntelligentTieringConfiguration' BucketName Text IntelligentTieringConfiguration
- newPutBucketIntelligentTieringConfiguration :: BucketName -> Text -> IntelligentTieringConfiguration -> PutBucketIntelligentTieringConfiguration
- data PutBucketIntelligentTieringConfigurationResponse = PutBucketIntelligentTieringConfigurationResponse' {
- newPutBucketIntelligentTieringConfigurationResponse :: PutBucketIntelligentTieringConfigurationResponse
- data PutBucketInventoryConfiguration = PutBucketInventoryConfiguration' (Maybe Text) BucketName Text InventoryConfiguration
- newPutBucketInventoryConfiguration :: BucketName -> Text -> InventoryConfiguration -> PutBucketInventoryConfiguration
- data PutBucketInventoryConfigurationResponse = PutBucketInventoryConfigurationResponse' {
- newPutBucketInventoryConfigurationResponse :: PutBucketInventoryConfigurationResponse
- data PutBucketLifecycleConfiguration = PutBucketLifecycleConfiguration' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe BucketLifecycleConfiguration) BucketName
- newPutBucketLifecycleConfiguration :: BucketName -> PutBucketLifecycleConfiguration
- data PutBucketLifecycleConfigurationResponse = PutBucketLifecycleConfigurationResponse' {
- newPutBucketLifecycleConfigurationResponse :: PutBucketLifecycleConfigurationResponse
- data PutBucketLogging = PutBucketLogging' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName BucketLoggingStatus
- newPutBucketLogging :: BucketName -> BucketLoggingStatus -> PutBucketLogging
- data PutBucketLoggingResponse = PutBucketLoggingResponse' {
- newPutBucketLoggingResponse :: PutBucketLoggingResponse
- data PutBucketMetricsConfiguration = PutBucketMetricsConfiguration' (Maybe Text) BucketName Text MetricsConfiguration
- newPutBucketMetricsConfiguration :: BucketName -> Text -> MetricsConfiguration -> PutBucketMetricsConfiguration
- data PutBucketMetricsConfigurationResponse = PutBucketMetricsConfigurationResponse' {
- newPutBucketMetricsConfigurationResponse :: PutBucketMetricsConfigurationResponse
- data PutBucketNotificationConfiguration = PutBucketNotificationConfiguration' (Maybe Text) (Maybe Bool) BucketName NotificationConfiguration
- newPutBucketNotificationConfiguration :: BucketName -> NotificationConfiguration -> PutBucketNotificationConfiguration
- data PutBucketNotificationConfigurationResponse = PutBucketNotificationConfigurationResponse' {
- newPutBucketNotificationConfigurationResponse :: PutBucketNotificationConfigurationResponse
- data PutBucketOwnershipControls = PutBucketOwnershipControls' (Maybe Text) (Maybe Text) BucketName OwnershipControls
- newPutBucketOwnershipControls :: BucketName -> OwnershipControls -> PutBucketOwnershipControls
- data PutBucketOwnershipControlsResponse = PutBucketOwnershipControlsResponse' {
- newPutBucketOwnershipControlsResponse :: PutBucketOwnershipControlsResponse
- data PutBucketPolicy = PutBucketPolicy' (Maybe ChecksumAlgorithm) (Maybe Bool) (Maybe Text) (Maybe Text) BucketName ByteString
- newPutBucketPolicy :: BucketName -> ByteString -> PutBucketPolicy
- data PutBucketPolicyResponse = PutBucketPolicyResponse' {
- newPutBucketPolicyResponse :: PutBucketPolicyResponse
- data PutBucketReplication = PutBucketReplication' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) BucketName ReplicationConfiguration
- newPutBucketReplication :: BucketName -> ReplicationConfiguration -> PutBucketReplication
- data PutBucketReplicationResponse = PutBucketReplicationResponse' {
- newPutBucketReplicationResponse :: PutBucketReplicationResponse
- data PutBucketRequestPayment = PutBucketRequestPayment' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName RequestPaymentConfiguration
- newPutBucketRequestPayment :: BucketName -> RequestPaymentConfiguration -> PutBucketRequestPayment
- data PutBucketRequestPaymentResponse = PutBucketRequestPaymentResponse' {
- newPutBucketRequestPaymentResponse :: PutBucketRequestPaymentResponse
- data PutBucketTagging = PutBucketTagging' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName Tagging
- newPutBucketTagging :: BucketName -> Tagging -> PutBucketTagging
- data PutBucketTaggingResponse = PutBucketTaggingResponse' {
- newPutBucketTaggingResponse :: PutBucketTaggingResponse
- data PutBucketVersioning = PutBucketVersioning' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) BucketName VersioningConfiguration
- newPutBucketVersioning :: BucketName -> VersioningConfiguration -> PutBucketVersioning
- data PutBucketVersioningResponse = PutBucketVersioningResponse' {
- newPutBucketVersioningResponse :: PutBucketVersioningResponse
- data PutBucketWebsite = PutBucketWebsite' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName WebsiteConfiguration
- newPutBucketWebsite :: BucketName -> WebsiteConfiguration -> PutBucketWebsite
- data PutBucketWebsiteResponse = PutBucketWebsiteResponse' {
- newPutBucketWebsiteResponse :: PutBucketWebsiteResponse
- data PutObject = PutObject' (Maybe ObjectCannedACL) (Maybe Bool) (Maybe Text) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (HashMap Text Text) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe StorageClass) (Maybe Text) (Maybe Text) BucketName ObjectKey RequestBody
- newPutObject :: BucketName -> ObjectKey -> RequestBody -> PutObject
- data PutObjectResponse = PutObjectResponse' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe Text) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe ObjectVersionId) Int
- newPutObjectResponse :: Int -> PutObjectResponse
- data PutObjectAcl = PutObjectAcl' (Maybe ObjectCannedACL) (Maybe AccessControlPolicy) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey
- newPutObjectAcl :: BucketName -> ObjectKey -> PutObjectAcl
- data PutObjectAclResponse = PutObjectAclResponse' (Maybe RequestCharged) Int
- newPutObjectAclResponse :: Int -> PutObjectAclResponse
- data PutObjectLegalHold = PutObjectLegalHold' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe ObjectLockLegalHold) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey
- newPutObjectLegalHold :: BucketName -> ObjectKey -> PutObjectLegalHold
- data PutObjectLegalHoldResponse = PutObjectLegalHoldResponse' (Maybe RequestCharged) Int
- newPutObjectLegalHoldResponse :: Int -> PutObjectLegalHoldResponse
- data PutObjectLockConfiguration = PutObjectLockConfiguration' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe ObjectLockConfiguration) (Maybe RequestPayer) (Maybe Text) BucketName
- newPutObjectLockConfiguration :: BucketName -> PutObjectLockConfiguration
- data PutObjectLockConfigurationResponse = PutObjectLockConfigurationResponse' (Maybe RequestCharged) Int
- newPutObjectLockConfigurationResponse :: Int -> PutObjectLockConfigurationResponse
- data PutObjectRetention = PutObjectRetention' (Maybe Bool) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe ObjectLockRetention) (Maybe ObjectVersionId) BucketName ObjectKey
- newPutObjectRetention :: BucketName -> ObjectKey -> PutObjectRetention
- data PutObjectRetentionResponse = PutObjectRetentionResponse' (Maybe RequestCharged) Int
- newPutObjectRetentionResponse :: Int -> PutObjectRetentionResponse
- data PutObjectTagging = PutObjectTagging' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey Tagging
- newPutObjectTagging :: BucketName -> ObjectKey -> Tagging -> PutObjectTagging
- data PutObjectTaggingResponse = PutObjectTaggingResponse' (Maybe ObjectVersionId) Int
- newPutObjectTaggingResponse :: Int -> PutObjectTaggingResponse
- data PutPublicAccessBlock = PutPublicAccessBlock' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName PublicAccessBlockConfiguration
- newPutPublicAccessBlock :: BucketName -> PublicAccessBlockConfiguration -> PutPublicAccessBlock
- data PutPublicAccessBlockResponse = PutPublicAccessBlockResponse' {
- newPutPublicAccessBlockResponse :: PutPublicAccessBlockResponse
- data RestoreObject = RestoreObject' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe RequestPayer) (Maybe RestoreRequest) (Maybe ObjectVersionId) BucketName ObjectKey
- newRestoreObject :: BucketName -> ObjectKey -> RestoreObject
- data RestoreObjectResponse = RestoreObjectResponse' (Maybe RequestCharged) (Maybe Text) Int
- newRestoreObjectResponse :: Int -> RestoreObjectResponse
- data SelectObjectContent = SelectObjectContent' (Maybe Text) (Maybe RequestProgress) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe ScanRange) BucketName ObjectKey Text ExpressionType InputSerialization OutputSerialization
- newSelectObjectContent :: BucketName -> ObjectKey -> Text -> ExpressionType -> InputSerialization -> OutputSerialization -> SelectObjectContent
- data SelectObjectContentResponse = SelectObjectContentResponse' (Maybe SelectObjectContentEventStream) Int
- newSelectObjectContentResponse :: Int -> SelectObjectContentResponse
- data UploadPart = UploadPart' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) BucketName ObjectKey Int Text RequestBody
- newUploadPart :: BucketName -> ObjectKey -> Int -> Text -> RequestBody -> UploadPart
- data UploadPartResponse = UploadPartResponse' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) Int
- newUploadPartResponse :: Int -> UploadPartResponse
- data UploadPartCopy = UploadPartCopy' (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) BucketName Text ObjectKey Int Text
- newUploadPartCopy :: BucketName -> Text -> ObjectKey -> Int -> Text -> UploadPartCopy
- data UploadPartCopyResponse = UploadPartCopyResponse' (Maybe Bool) (Maybe CopyPartResult) (Maybe Text) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) Int
- newUploadPartCopyResponse :: Int -> UploadPartCopyResponse
- data WriteGetObjectResponse = WriteGetObjectResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ETag) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe RFC822) (HashMap Text Text) (Maybe Int) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe Int) (Maybe ReplicationStatus) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe Int) (Maybe StorageClass) (Maybe Int) (Maybe ObjectVersionId) Text Text RequestBody
- newWriteGetObjectResponse :: Text -> Text -> RequestBody -> WriteGetObjectResponse
- data WriteGetObjectResponseResponse = WriteGetObjectResponseResponse' {
- newWriteGetObjectResponseResponse :: WriteGetObjectResponseResponse
- module Amazonka.S3.Internal
- newtype AnalyticsS3ExportFileFormat where
- newtype ArchiveStatus where
- ArchiveStatus' { }
- pattern ArchiveStatus_ARCHIVE_ACCESS :: ArchiveStatus
- pattern ArchiveStatus_DEEP_ARCHIVE_ACCESS :: ArchiveStatus
- newtype BucketAccelerateStatus where
- newtype BucketCannedACL where
- BucketCannedACL' { }
- pattern BucketCannedACL_Authenticated_read :: BucketCannedACL
- pattern BucketCannedACL_Private :: BucketCannedACL
- pattern BucketCannedACL_Public_read :: BucketCannedACL
- pattern BucketCannedACL_Public_read_write :: BucketCannedACL
- newtype BucketLogsPermission where
- newtype BucketVersioningStatus where
- newtype ChecksumAlgorithm where
- ChecksumAlgorithm' { }
- pattern ChecksumAlgorithm_CRC32 :: ChecksumAlgorithm
- pattern ChecksumAlgorithm_CRC32C :: ChecksumAlgorithm
- pattern ChecksumAlgorithm_SHA1 :: ChecksumAlgorithm
- pattern ChecksumAlgorithm_SHA256 :: ChecksumAlgorithm
- newtype ChecksumMode where
- ChecksumMode' { }
- pattern ChecksumMode_ENABLED :: ChecksumMode
- newtype CompressionType where
- CompressionType' { }
- pattern CompressionType_BZIP2 :: CompressionType
- pattern CompressionType_GZIP :: CompressionType
- pattern CompressionType_NONE :: CompressionType
- newtype DeleteMarkerReplicationStatus where
- newtype EncodingType where
- EncodingType' { }
- pattern EncodingType_Url :: EncodingType
- newtype Event where
- Event' { }
- pattern Event_S3_IntelligentTiering :: Event
- pattern Event_S3_LifecycleExpiration_Delete :: Event
- pattern Event_S3_LifecycleExpiration_DeleteMarkerCreated :: Event
- pattern Event_S3_LifecycleExpiration__ :: Event
- pattern Event_S3_LifecycleTransition :: Event
- pattern Event_S3_ObjectAcl_Put :: Event
- pattern Event_S3_ObjectCreated_CompleteMultipartUpload :: Event
- pattern Event_S3_ObjectCreated_Copy :: Event
- pattern Event_S3_ObjectCreated_Post :: Event
- pattern Event_S3_ObjectCreated_Put :: Event
- pattern Event_S3_ObjectCreated__ :: Event
- pattern Event_S3_ObjectRemoved_Delete :: Event
- pattern Event_S3_ObjectRemoved_DeleteMarkerCreated :: Event
- pattern Event_S3_ObjectRemoved__ :: Event
- pattern Event_S3_ObjectRestore_Completed :: Event
- pattern Event_S3_ObjectRestore_Delete :: Event
- pattern Event_S3_ObjectRestore_Post :: Event
- pattern Event_S3_ObjectRestore__ :: Event
- pattern Event_S3_ObjectTagging_Delete :: Event
- pattern Event_S3_ObjectTagging_Put :: Event
- pattern Event_S3_ObjectTagging__ :: Event
- pattern Event_S3_ReducedRedundancyLostObject :: Event
- pattern Event_S3_Replication_OperationFailedReplication :: Event
- pattern Event_S3_Replication_OperationMissedThreshold :: Event
- pattern Event_S3_Replication_OperationNotTracked :: Event
- pattern Event_S3_Replication_OperationReplicatedAfterThreshold :: Event
- pattern Event_S3_Replication__ :: Event
- newtype ExistingObjectReplicationStatus where
- newtype ExpirationStatus where
- ExpirationStatus' { }
- pattern ExpirationStatus_Disabled :: ExpirationStatus
- pattern ExpirationStatus_Enabled :: ExpirationStatus
- newtype ExpressionType where
- ExpressionType' { }
- pattern ExpressionType_SQL :: ExpressionType
- newtype FileHeaderInfo where
- FileHeaderInfo' { }
- pattern FileHeaderInfo_IGNORE :: FileHeaderInfo
- pattern FileHeaderInfo_NONE :: FileHeaderInfo
- pattern FileHeaderInfo_USE :: FileHeaderInfo
- newtype FilterRuleName where
- FilterRuleName' { }
- pattern FilterRuleName_Prefix :: FilterRuleName
- pattern FilterRuleName_Suffix :: FilterRuleName
- newtype IntelligentTieringAccessTier where
- newtype IntelligentTieringStatus where
- newtype InventoryFormat where
- InventoryFormat' { }
- pattern InventoryFormat_CSV :: InventoryFormat
- pattern InventoryFormat_ORC :: InventoryFormat
- pattern InventoryFormat_Parquet :: InventoryFormat
- newtype InventoryFrequency where
- InventoryFrequency' { }
- pattern InventoryFrequency_Daily :: InventoryFrequency
- pattern InventoryFrequency_Weekly :: InventoryFrequency
- newtype InventoryIncludedObjectVersions where
- newtype InventoryOptionalField where
- InventoryOptionalField' { }
- pattern InventoryOptionalField_BucketKeyStatus :: InventoryOptionalField
- pattern InventoryOptionalField_ChecksumAlgorithm :: InventoryOptionalField
- pattern InventoryOptionalField_ETag :: InventoryOptionalField
- pattern InventoryOptionalField_EncryptionStatus :: InventoryOptionalField
- pattern InventoryOptionalField_IntelligentTieringAccessTier :: InventoryOptionalField
- pattern InventoryOptionalField_IsMultipartUploaded :: InventoryOptionalField
- pattern InventoryOptionalField_LastModifiedDate :: InventoryOptionalField
- pattern InventoryOptionalField_ObjectLockLegalHoldStatus :: InventoryOptionalField
- pattern InventoryOptionalField_ObjectLockMode :: InventoryOptionalField
- pattern InventoryOptionalField_ObjectLockRetainUntilDate :: InventoryOptionalField
- pattern InventoryOptionalField_ReplicationStatus :: InventoryOptionalField
- pattern InventoryOptionalField_Size :: InventoryOptionalField
- pattern InventoryOptionalField_StorageClass :: InventoryOptionalField
- newtype JSONType where
- JSONType' {
- fromJSONType :: Text
- pattern JSONType_DOCUMENT :: JSONType
- pattern JSONType_LINES :: JSONType
- JSONType' {
- newtype MFADelete where
- MFADelete' { }
- pattern MFADelete_Disabled :: MFADelete
- pattern MFADelete_Enabled :: MFADelete
- newtype MFADeleteStatus where
- MFADeleteStatus' { }
- pattern MFADeleteStatus_Disabled :: MFADeleteStatus
- pattern MFADeleteStatus_Enabled :: MFADeleteStatus
- newtype MetadataDirective where
- MetadataDirective' { }
- pattern MetadataDirective_COPY :: MetadataDirective
- pattern MetadataDirective_REPLACE :: MetadataDirective
- newtype MetricsStatus where
- MetricsStatus' { }
- pattern MetricsStatus_Disabled :: MetricsStatus
- pattern MetricsStatus_Enabled :: MetricsStatus
- newtype ObjectAttributes where
- ObjectAttributes' { }
- pattern ObjectAttributes_Checksum :: ObjectAttributes
- pattern ObjectAttributes_ETag :: ObjectAttributes
- pattern ObjectAttributes_ObjectParts :: ObjectAttributes
- pattern ObjectAttributes_ObjectSize :: ObjectAttributes
- pattern ObjectAttributes_StorageClass :: ObjectAttributes
- newtype ObjectCannedACL where
- ObjectCannedACL' { }
- pattern ObjectCannedACL_Authenticated_read :: ObjectCannedACL
- pattern ObjectCannedACL_Aws_exec_read :: ObjectCannedACL
- pattern ObjectCannedACL_Bucket_owner_full_control :: ObjectCannedACL
- pattern ObjectCannedACL_Bucket_owner_read :: ObjectCannedACL
- pattern ObjectCannedACL_Private :: ObjectCannedACL
- pattern ObjectCannedACL_Public_read :: ObjectCannedACL
- pattern ObjectCannedACL_Public_read_write :: ObjectCannedACL
- newtype ObjectLockEnabled where
- newtype ObjectLockLegalHoldStatus where
- newtype ObjectLockMode where
- ObjectLockMode' { }
- pattern ObjectLockMode_COMPLIANCE :: ObjectLockMode
- pattern ObjectLockMode_GOVERNANCE :: ObjectLockMode
- newtype ObjectLockRetentionMode where
- newtype ObjectOwnership where
- newtype ObjectStorageClass where
- ObjectStorageClass' { }
- pattern ObjectStorageClass_GLACIER :: ObjectStorageClass
- pattern ObjectStorageClass_INTELLIGENT_TIERING :: ObjectStorageClass
- pattern ObjectStorageClass_REDUCED_REDUNDANCY :: ObjectStorageClass
- pattern ObjectStorageClass_STANDARD :: ObjectStorageClass
- pattern ObjectStorageClass_STANDARD_IA :: ObjectStorageClass
- newtype ObjectVersionStorageClass where
- newtype OwnerOverride where
- OwnerOverride' { }
- pattern OwnerOverride_Destination :: OwnerOverride
- newtype Payer where
- Payer' { }
- pattern Payer_BucketOwner :: Payer
- pattern Payer_Requester :: Payer
- newtype Permission where
- Permission' { }
- pattern Permission_FULL_CONTROL :: Permission
- pattern Permission_READ :: Permission
- pattern Permission_READ_ACP :: Permission
- pattern Permission_WRITE :: Permission
- pattern Permission_WRITE_ACP :: Permission
- newtype Protocol where
- Protocol' {
- fromProtocol :: Text
- pattern Protocol_Http :: Protocol
- pattern Protocol_Https :: Protocol
- Protocol' {
- newtype QuoteFields where
- QuoteFields' { }
- pattern QuoteFields_ALWAYS :: QuoteFields
- pattern QuoteFields_ASNEEDED :: QuoteFields
- newtype ReplicaModificationsStatus where
- newtype ReplicationRuleStatus where
- newtype ReplicationStatus where
- ReplicationStatus' { }
- pattern ReplicationStatus_COMPLETED :: ReplicationStatus
- pattern ReplicationStatus_FAILED :: ReplicationStatus
- pattern ReplicationStatus_PENDING :: ReplicationStatus
- pattern ReplicationStatus_REPLICA :: ReplicationStatus
- newtype ReplicationTimeStatus where
- newtype RequestCharged where
- RequestCharged' { }
- pattern RequestCharged_Requester :: RequestCharged
- newtype RequestPayer where
- RequestPayer' { }
- pattern RequestPayer_Requester :: RequestPayer
- newtype RestoreRequestType where
- newtype ServerSideEncryption where
- newtype SseKmsEncryptedObjectsStatus where
- newtype StorageClass where
- StorageClass' { }
- pattern StorageClass_DEEP_ARCHIVE :: StorageClass
- pattern StorageClass_GLACIER :: StorageClass
- pattern StorageClass_GLACIER_IR :: StorageClass
- pattern StorageClass_INTELLIGENT_TIERING :: StorageClass
- pattern StorageClass_ONEZONE_IA :: StorageClass
- pattern StorageClass_OUTPOSTS :: StorageClass
- pattern StorageClass_REDUCED_REDUNDANCY :: StorageClass
- pattern StorageClass_STANDARD :: StorageClass
- pattern StorageClass_STANDARD_IA :: StorageClass
- newtype StorageClassAnalysisSchemaVersion where
- newtype TaggingDirective where
- TaggingDirective' { }
- pattern TaggingDirective_COPY :: TaggingDirective
- pattern TaggingDirective_REPLACE :: TaggingDirective
- newtype Tier where
- Tier' { }
- pattern Tier_Bulk :: Tier
- pattern Tier_Expedited :: Tier
- pattern Tier_Standard :: Tier
- newtype TransitionStorageClass where
- TransitionStorageClass' { }
- pattern TransitionStorageClass_DEEP_ARCHIVE :: TransitionStorageClass
- pattern TransitionStorageClass_GLACIER :: TransitionStorageClass
- pattern TransitionStorageClass_GLACIER_IR :: TransitionStorageClass
- pattern TransitionStorageClass_INTELLIGENT_TIERING :: TransitionStorageClass
- pattern TransitionStorageClass_ONEZONE_IA :: TransitionStorageClass
- pattern TransitionStorageClass_STANDARD_IA :: TransitionStorageClass
- newtype Type where
- Type' { }
- pattern Type_AmazonCustomerByEmail :: Type
- pattern Type_CanonicalUser :: Type
- pattern Type_Group :: Type
- data AbortIncompleteMultipartUpload = AbortIncompleteMultipartUpload' (Maybe Int)
- newAbortIncompleteMultipartUpload :: AbortIncompleteMultipartUpload
- data AccelerateConfiguration = AccelerateConfiguration' (Maybe BucketAccelerateStatus)
- newAccelerateConfiguration :: AccelerateConfiguration
- data AccessControlPolicy = AccessControlPolicy' (Maybe [Grant]) (Maybe Owner)
- newAccessControlPolicy :: AccessControlPolicy
- data AccessControlTranslation = AccessControlTranslation' OwnerOverride
- newAccessControlTranslation :: OwnerOverride -> AccessControlTranslation
- data AnalyticsAndOperator = AnalyticsAndOperator' (Maybe Text) (Maybe [Tag])
- newAnalyticsAndOperator :: AnalyticsAndOperator
- data AnalyticsConfiguration = AnalyticsConfiguration' (Maybe AnalyticsFilter) Text StorageClassAnalysis
- newAnalyticsConfiguration :: Text -> StorageClassAnalysis -> AnalyticsConfiguration
- data AnalyticsExportDestination = AnalyticsExportDestination' AnalyticsS3BucketDestination
- newAnalyticsExportDestination :: AnalyticsS3BucketDestination -> AnalyticsExportDestination
- data AnalyticsFilter = AnalyticsFilter' (Maybe AnalyticsAndOperator) (Maybe Text) (Maybe Tag)
- newAnalyticsFilter :: AnalyticsFilter
- data AnalyticsS3BucketDestination = AnalyticsS3BucketDestination' (Maybe Text) (Maybe Text) AnalyticsS3ExportFileFormat BucketName
- newAnalyticsS3BucketDestination :: AnalyticsS3ExportFileFormat -> BucketName -> AnalyticsS3BucketDestination
- data Bucket = Bucket' ISO8601 BucketName
- newBucket :: UTCTime -> BucketName -> Bucket
- data BucketLifecycleConfiguration = BucketLifecycleConfiguration' [LifecycleRule]
- newBucketLifecycleConfiguration :: BucketLifecycleConfiguration
- data BucketLoggingStatus = BucketLoggingStatus' (Maybe LoggingEnabled)
- newBucketLoggingStatus :: BucketLoggingStatus
- data CORSConfiguration = CORSConfiguration' [CORSRule]
- newCORSConfiguration :: CORSConfiguration
- data CORSRule = CORSRule' (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe Int) [Text] [Text]
- newCORSRule :: CORSRule
- data CSVInput = CSVInput' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe FileHeaderInfo) (Maybe Text) (Maybe Text) (Maybe Text)
- newCSVInput :: CSVInput
- data CSVOutput = CSVOutput' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe QuoteFields) (Maybe Text)
- newCSVOutput :: CSVOutput
- data Checksum = Checksum' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newChecksum :: Checksum
- data CommonPrefix = CommonPrefix' (Maybe Text)
- newCommonPrefix :: CommonPrefix
- data CompletedMultipartUpload = CompletedMultipartUpload' (Maybe (NonEmpty CompletedPart))
- newCompletedMultipartUpload :: CompletedMultipartUpload
- data CompletedPart = CompletedPart' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int ETag
- newCompletedPart :: Int -> ETag -> CompletedPart
- data Condition = Condition' (Maybe Text) (Maybe Text)
- newCondition :: Condition
- data ContinuationEvent = ContinuationEvent' {
- newContinuationEvent :: ContinuationEvent
- data CopyObjectResult = CopyObjectResult' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe RFC822)
- newCopyObjectResult :: CopyObjectResult
- data CopyPartResult = CopyPartResult' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe RFC822)
- newCopyPartResult :: CopyPartResult
- data CreateBucketConfiguration = CreateBucketConfiguration' (Maybe LocationConstraint)
- newCreateBucketConfiguration :: CreateBucketConfiguration
- data DefaultRetention = DefaultRetention' (Maybe Int) (Maybe ObjectLockRetentionMode) (Maybe Int)
- newDefaultRetention :: DefaultRetention
- data Delete = Delete' (Maybe Bool) [ObjectIdentifier]
- newDelete :: Delete
- data DeleteMarkerEntry = DeleteMarkerEntry' (Maybe Bool) (Maybe ObjectKey) (Maybe RFC822) (Maybe Owner) (Maybe ObjectVersionId)
- newDeleteMarkerEntry :: DeleteMarkerEntry
- data DeleteMarkerReplication = DeleteMarkerReplication' (Maybe DeleteMarkerReplicationStatus)
- newDeleteMarkerReplication :: DeleteMarkerReplication
- data DeletedObject = DeletedObject' (Maybe Bool) (Maybe Text) (Maybe ObjectKey) (Maybe ObjectVersionId)
- newDeletedObject :: DeletedObject
- data Destination = Destination' (Maybe AccessControlTranslation) (Maybe Text) (Maybe EncryptionConfiguration) (Maybe Metrics) (Maybe ReplicationTime) (Maybe StorageClass) BucketName
- newDestination :: BucketName -> Destination
- data Encryption = Encryption' (Maybe Text) (Maybe (Sensitive Text)) ServerSideEncryption
- newEncryption :: ServerSideEncryption -> Encryption
- data EncryptionConfiguration = EncryptionConfiguration' (Maybe Text)
- newEncryptionConfiguration :: EncryptionConfiguration
- data EndEvent = EndEvent' {
- newEndEvent :: EndEvent
- data ErrorDocument = ErrorDocument' ObjectKey
- newErrorDocument :: ObjectKey -> ErrorDocument
- data EventBridgeConfiguration = EventBridgeConfiguration' {
- newEventBridgeConfiguration :: EventBridgeConfiguration
- data ExistingObjectReplication = ExistingObjectReplication' ExistingObjectReplicationStatus
- newExistingObjectReplication :: ExistingObjectReplicationStatus -> ExistingObjectReplication
- data FilterRule = FilterRule' (Maybe FilterRuleName) (Maybe Text)
- newFilterRule :: FilterRule
- data GetObjectAttributesParts = GetObjectAttributesParts' (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe [ObjectPart]) (Maybe Int)
- newGetObjectAttributesParts :: GetObjectAttributesParts
- data GlacierJobParameters = GlacierJobParameters' Tier
- newGlacierJobParameters :: Tier -> GlacierJobParameters
- data Grant = Grant' (Maybe Grantee) (Maybe Permission)
- newGrant :: Grant
- data Grantee = Grantee' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Type
- newGrantee :: Type -> Grantee
- data IndexDocument = IndexDocument' Text
- newIndexDocument :: Text -> IndexDocument
- data Initiator = Initiator' (Maybe Text) (Maybe Text)
- newInitiator :: Initiator
- data InputSerialization = InputSerialization' (Maybe CSVInput) (Maybe CompressionType) (Maybe JSONInput) (Maybe ParquetInput)
- newInputSerialization :: InputSerialization
- data IntelligentTieringAndOperator = IntelligentTieringAndOperator' (Maybe Text) (Maybe [Tag])
- newIntelligentTieringAndOperator :: IntelligentTieringAndOperator
- data IntelligentTieringConfiguration = IntelligentTieringConfiguration' (Maybe IntelligentTieringFilter) Text IntelligentTieringStatus [Tiering]
- newIntelligentTieringConfiguration :: Text -> IntelligentTieringStatus -> IntelligentTieringConfiguration
- data IntelligentTieringFilter = IntelligentTieringFilter' (Maybe IntelligentTieringAndOperator) (Maybe Text) (Maybe Tag)
- newIntelligentTieringFilter :: IntelligentTieringFilter
- data InventoryConfiguration = InventoryConfiguration' (Maybe InventoryFilter) (Maybe [InventoryOptionalField]) InventoryDestination Bool Text InventoryIncludedObjectVersions InventorySchedule
- newInventoryConfiguration :: InventoryDestination -> Bool -> Text -> InventoryIncludedObjectVersions -> InventorySchedule -> InventoryConfiguration
- data InventoryDestination = InventoryDestination' InventoryS3BucketDestination
- newInventoryDestination :: InventoryS3BucketDestination -> InventoryDestination
- data InventoryEncryption = InventoryEncryption' (Maybe SSEKMS) (Maybe SSES3)
- newInventoryEncryption :: InventoryEncryption
- data InventoryFilter = InventoryFilter' Text
- newInventoryFilter :: Text -> InventoryFilter
- data InventoryS3BucketDestination = InventoryS3BucketDestination' (Maybe Text) (Maybe InventoryEncryption) (Maybe Text) BucketName InventoryFormat
- newInventoryS3BucketDestination :: BucketName -> InventoryFormat -> InventoryS3BucketDestination
- data InventorySchedule = InventorySchedule' InventoryFrequency
- newInventorySchedule :: InventoryFrequency -> InventorySchedule
- data JSONInput = JSONInput' (Maybe JSONType)
- newJSONInput :: JSONInput
- data JSONOutput = JSONOutput' (Maybe Text)
- newJSONOutput :: JSONOutput
- data LambdaFunctionConfiguration = LambdaFunctionConfiguration' (Maybe NotificationConfigurationFilter) (Maybe Text) Text [Event]
- newLambdaFunctionConfiguration :: Text -> LambdaFunctionConfiguration
- data LifecycleExpiration = LifecycleExpiration' (Maybe ISO8601) (Maybe Int) (Maybe Bool)
- newLifecycleExpiration :: LifecycleExpiration
- data LifecycleRule = LifecycleRule' (Maybe AbortIncompleteMultipartUpload) (Maybe LifecycleExpiration) (Maybe LifecycleRuleFilter) (Maybe Text) (Maybe NoncurrentVersionExpiration) (Maybe [NoncurrentVersionTransition]) (Maybe Text) (Maybe [Transition]) ExpirationStatus
- newLifecycleRule :: ExpirationStatus -> LifecycleRule
- data LifecycleRuleAndOperator = LifecycleRuleAndOperator' (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe [Tag])
- newLifecycleRuleAndOperator :: LifecycleRuleAndOperator
- data LifecycleRuleFilter = LifecycleRuleFilter' (Maybe LifecycleRuleAndOperator) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Tag)
- newLifecycleRuleFilter :: LifecycleRuleFilter
- data LoggingEnabled = LoggingEnabled' (Maybe [TargetGrant]) Text Text
- newLoggingEnabled :: Text -> Text -> LoggingEnabled
- data MetadataEntry = MetadataEntry' (Maybe Text) (Maybe Text)
- newMetadataEntry :: MetadataEntry
- data Metrics = Metrics' (Maybe ReplicationTimeValue) MetricsStatus
- newMetrics :: MetricsStatus -> Metrics
- data MetricsAndOperator = MetricsAndOperator' (Maybe Text) (Maybe Text) (Maybe [Tag])
- newMetricsAndOperator :: MetricsAndOperator
- data MetricsConfiguration = MetricsConfiguration' (Maybe MetricsFilter) Text
- newMetricsConfiguration :: Text -> MetricsConfiguration
- data MetricsFilter = MetricsFilter' (Maybe Text) (Maybe MetricsAndOperator) (Maybe Text) (Maybe Tag)
- newMetricsFilter :: MetricsFilter
- data MultipartUpload = MultipartUpload' (Maybe ChecksumAlgorithm) (Maybe ISO8601) (Maybe Initiator) (Maybe ObjectKey) (Maybe Owner) (Maybe StorageClass) (Maybe Text)
- newMultipartUpload :: MultipartUpload
- data NoncurrentVersionExpiration = NoncurrentVersionExpiration' (Maybe Int) Int
- newNoncurrentVersionExpiration :: Int -> NoncurrentVersionExpiration
- data NoncurrentVersionTransition = NoncurrentVersionTransition' (Maybe Int) Int TransitionStorageClass
- newNoncurrentVersionTransition :: Int -> TransitionStorageClass -> NoncurrentVersionTransition
- data NotificationConfiguration = NotificationConfiguration' (Maybe EventBridgeConfiguration) (Maybe [LambdaFunctionConfiguration]) (Maybe [QueueConfiguration]) (Maybe [TopicConfiguration])
- newNotificationConfiguration :: NotificationConfiguration
- data NotificationConfigurationFilter = NotificationConfigurationFilter' (Maybe S3KeyFilter)
- newNotificationConfigurationFilter :: NotificationConfigurationFilter
- data Object = Object' (Maybe [ChecksumAlgorithm]) (Maybe Owner) ETag Integer ObjectKey ObjectStorageClass RFC822
- newObject :: ETag -> Integer -> ObjectKey -> ObjectStorageClass -> UTCTime -> Object
- data ObjectIdentifier = ObjectIdentifier' (Maybe ObjectVersionId) ObjectKey
- newObjectIdentifier :: ObjectKey -> ObjectIdentifier
- data ObjectLockConfiguration = ObjectLockConfiguration' (Maybe ObjectLockEnabled) (Maybe ObjectLockRule)
- newObjectLockConfiguration :: ObjectLockConfiguration
- data ObjectLockLegalHold = ObjectLockLegalHold' (Maybe ObjectLockLegalHoldStatus)
- newObjectLockLegalHold :: ObjectLockLegalHold
- data ObjectLockRetention = ObjectLockRetention' (Maybe ObjectLockRetentionMode) (Maybe ISO8601)
- newObjectLockRetention :: ObjectLockRetention
- data ObjectLockRule = ObjectLockRule' (Maybe DefaultRetention)
- newObjectLockRule :: ObjectLockRule
- data ObjectPart = ObjectPart' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Integer)
- newObjectPart :: ObjectPart
- data ObjectVersion = ObjectVersion' (Maybe [ChecksumAlgorithm]) (Maybe ETag) (Maybe Bool) (Maybe ObjectKey) (Maybe RFC822) (Maybe Owner) (Maybe Integer) (Maybe ObjectVersionStorageClass) (Maybe ObjectVersionId)
- newObjectVersion :: ObjectVersion
- data OutputLocation = OutputLocation' (Maybe S3Location)
- newOutputLocation :: OutputLocation
- data OutputSerialization = OutputSerialization' (Maybe CSVOutput) (Maybe JSONOutput)
- newOutputSerialization :: OutputSerialization
- data Owner = Owner' (Maybe Text) (Maybe Text)
- newOwner :: Owner
- data OwnershipControls = OwnershipControls' [OwnershipControlsRule]
- newOwnershipControls :: OwnershipControls
- data OwnershipControlsRule = OwnershipControlsRule' ObjectOwnership
- newOwnershipControlsRule :: ObjectOwnership -> OwnershipControlsRule
- data ParquetInput = ParquetInput' {
- newParquetInput :: ParquetInput
- data Part = Part' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe RFC822) (Maybe Int) (Maybe Integer)
- newPart :: Part
- data PolicyStatus = PolicyStatus' (Maybe Bool)
- newPolicyStatus :: PolicyStatus
- data Progress = Progress' (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newProgress :: Progress
- data ProgressEvent = ProgressEvent' (Maybe Progress)
- newProgressEvent :: ProgressEvent
- data PublicAccessBlockConfiguration = PublicAccessBlockConfiguration' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newPublicAccessBlockConfiguration :: PublicAccessBlockConfiguration
- data QueueConfiguration = QueueConfiguration' (Maybe NotificationConfigurationFilter) (Maybe Text) Text [Event]
- newQueueConfiguration :: Text -> QueueConfiguration
- data RecordsEvent = RecordsEvent' (Maybe Base64)
- newRecordsEvent :: RecordsEvent
- data Redirect = Redirect' (Maybe Text) (Maybe Text) (Maybe Protocol) (Maybe Text) (Maybe Text)
- newRedirect :: Redirect
- data RedirectAllRequestsTo = RedirectAllRequestsTo' (Maybe Protocol) Text
- newRedirectAllRequestsTo :: Text -> RedirectAllRequestsTo
- data ReplicaModifications = ReplicaModifications' ReplicaModificationsStatus
- newReplicaModifications :: ReplicaModificationsStatus -> ReplicaModifications
- data ReplicationConfiguration = ReplicationConfiguration' Text [ReplicationRule]
- newReplicationConfiguration :: Text -> ReplicationConfiguration
- data ReplicationRule = ReplicationRule' (Maybe DeleteMarkerReplication) (Maybe ExistingObjectReplication) (Maybe ReplicationRuleFilter) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe SourceSelectionCriteria) ReplicationRuleStatus Destination
- newReplicationRule :: ReplicationRuleStatus -> Destination -> ReplicationRule
- data ReplicationRuleAndOperator = ReplicationRuleAndOperator' (Maybe Text) (Maybe [Tag])
- newReplicationRuleAndOperator :: ReplicationRuleAndOperator
- data ReplicationRuleFilter = ReplicationRuleFilter' (Maybe ReplicationRuleAndOperator) (Maybe Text) (Maybe Tag)
- newReplicationRuleFilter :: ReplicationRuleFilter
- data ReplicationTime = ReplicationTime' ReplicationTimeStatus ReplicationTimeValue
- newReplicationTime :: ReplicationTimeStatus -> ReplicationTimeValue -> ReplicationTime
- data ReplicationTimeValue = ReplicationTimeValue' (Maybe Int)
- newReplicationTimeValue :: ReplicationTimeValue
- data RequestPaymentConfiguration = RequestPaymentConfiguration' Payer
- newRequestPaymentConfiguration :: Payer -> RequestPaymentConfiguration
- data RequestProgress = RequestProgress' (Maybe Bool)
- newRequestProgress :: RequestProgress
- data RestoreRequest = RestoreRequest' (Maybe Int) (Maybe Text) (Maybe GlacierJobParameters) (Maybe OutputLocation) (Maybe SelectParameters) (Maybe Tier) (Maybe RestoreRequestType)
- newRestoreRequest :: RestoreRequest
- data RoutingRule = RoutingRule' (Maybe Condition) Redirect
- newRoutingRule :: Redirect -> RoutingRule
- data S3KeyFilter = S3KeyFilter' (Maybe [FilterRule])
- newS3KeyFilter :: S3KeyFilter
- data S3Location = S3Location' (Maybe [Grant]) (Maybe ObjectCannedACL) (Maybe Encryption) (Maybe StorageClass) (Maybe Tagging) (Maybe [MetadataEntry]) BucketName Text
- newS3Location :: BucketName -> Text -> S3Location
- data S3ServiceError = S3ServiceError' (Maybe Text) (Maybe ObjectKey) (Maybe Text) (Maybe ObjectVersionId)
- newS3ServiceError :: S3ServiceError
- data SSEKMS = SSEKMS' (Sensitive Text)
- newSSEKMS :: Text -> SSEKMS
- data SSES3 = SSES3' {
- newSSES3 :: SSES3
- data ScanRange = ScanRange' (Maybe Integer) (Maybe Integer)
- newScanRange :: ScanRange
- data SelectObjectContentEventStream = SelectObjectContentEventStream' (Maybe ContinuationEvent) (Maybe EndEvent) (Maybe ProgressEvent) (Maybe RecordsEvent) (Maybe StatsEvent)
- newSelectObjectContentEventStream :: SelectObjectContentEventStream
- data SelectParameters = SelectParameters' InputSerialization ExpressionType Text OutputSerialization
- newSelectParameters :: InputSerialization -> ExpressionType -> Text -> OutputSerialization -> SelectParameters
- data ServerSideEncryptionByDefault = ServerSideEncryptionByDefault' (Maybe (Sensitive Text)) ServerSideEncryption
- newServerSideEncryptionByDefault :: ServerSideEncryption -> ServerSideEncryptionByDefault
- data ServerSideEncryptionConfiguration = ServerSideEncryptionConfiguration' [ServerSideEncryptionRule]
- newServerSideEncryptionConfiguration :: ServerSideEncryptionConfiguration
- data ServerSideEncryptionRule = ServerSideEncryptionRule' (Maybe ServerSideEncryptionByDefault) (Maybe Bool)
- newServerSideEncryptionRule :: ServerSideEncryptionRule
- data SourceSelectionCriteria = SourceSelectionCriteria' (Maybe ReplicaModifications) (Maybe SseKmsEncryptedObjects)
- newSourceSelectionCriteria :: SourceSelectionCriteria
- data SseKmsEncryptedObjects = SseKmsEncryptedObjects' SseKmsEncryptedObjectsStatus
- newSseKmsEncryptedObjects :: SseKmsEncryptedObjectsStatus -> SseKmsEncryptedObjects
- data Stats = Stats' (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newStats :: Stats
- data StatsEvent = StatsEvent' (Maybe Stats)
- newStatsEvent :: StatsEvent
- data StorageClassAnalysis = StorageClassAnalysis' (Maybe StorageClassAnalysisDataExport)
- newStorageClassAnalysis :: StorageClassAnalysis
- data StorageClassAnalysisDataExport = StorageClassAnalysisDataExport' StorageClassAnalysisSchemaVersion AnalyticsExportDestination
- newStorageClassAnalysisDataExport :: StorageClassAnalysisSchemaVersion -> AnalyticsExportDestination -> StorageClassAnalysisDataExport
- data Tag = Tag' ObjectKey Text
- newTag :: ObjectKey -> Text -> Tag
- data Tagging = Tagging' [Tag]
- newTagging :: Tagging
- data TargetGrant = TargetGrant' (Maybe Grantee) (Maybe BucketLogsPermission)
- newTargetGrant :: TargetGrant
- data Tiering = Tiering' Int IntelligentTieringAccessTier
- newTiering :: Int -> IntelligentTieringAccessTier -> Tiering
- data TopicConfiguration = TopicConfiguration' (Maybe NotificationConfigurationFilter) (Maybe Text) Text [Event]
- newTopicConfiguration :: Text -> TopicConfiguration
- data Transition = Transition' (Maybe ISO8601) (Maybe Int) (Maybe TransitionStorageClass)
- newTransition :: Transition
- data VersioningConfiguration = VersioningConfiguration' (Maybe MFADelete) (Maybe BucketVersioningStatus)
- newVersioningConfiguration :: VersioningConfiguration
- data WebsiteConfiguration = WebsiteConfiguration' (Maybe ErrorDocument) (Maybe IndexDocument) (Maybe RedirectAllRequestsTo) (Maybe [RoutingRule])
- newWebsiteConfiguration :: WebsiteConfiguration
Service Configuration
defaultService :: Service Source #
API version 2006-03-01 of the Amazon Simple Storage Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by S3.
BucketAlreadyExists
_BucketAlreadyExists :: AsError a => Fold a ServiceError Source #
The requested bucket name is not available. The bucket namespace is shared by all users of the system. Select a different name and try again.
BucketAlreadyOwnedByYou
_BucketAlreadyOwnedByYou :: AsError a => Fold a ServiceError Source #
The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).
InvalidObjectState
_InvalidObjectState :: AsError a => Fold a ServiceError Source #
Object is archived and inaccessible until restored.
NoSuchBucket
_NoSuchBucket :: AsError a => Fold a ServiceError Source #
The specified bucket does not exist.
NoSuchKey
_NoSuchKey :: AsError a => Fold a ServiceError Source #
The specified key does not exist.
NoSuchUpload
_NoSuchUpload :: AsError a => Fold a ServiceError Source #
The specified multipart upload does not exist.
ObjectAlreadyInActiveTierError
_ObjectAlreadyInActiveTierError :: AsError a => Fold a ServiceError Source #
This action is not allowed against this storage tier.
ObjectNotInActiveTierError
_ObjectNotInActiveTierError :: AsError a => Fold a ServiceError Source #
The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
BucketExists
newBucketExists :: Wait HeadBucket Source #
Polls HeadBucket every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.
BucketNotExists
newBucketNotExists :: Wait HeadBucket Source #
Polls HeadBucket every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.
ObjectExists
newObjectExists :: Wait HeadObject Source #
Polls HeadObject every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.
ObjectNotExists
newObjectNotExists :: Wait HeadObject Source #
Polls HeadObject every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AbortMultipartUpload
data AbortMultipartUpload Source #
See: newAbortMultipartUpload smart constructor.
Constructors
| AbortMultipartUpload' (Maybe Text) (Maybe RequestPayer) BucketName ObjectKey Text |
Instances
newAbortMultipartUpload Source #
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> Text | |
| -> AbortMultipartUpload |
Create a value of AbortMultipartUpload with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:AbortMultipartUpload', abortMultipartUpload_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:requestPayer:AbortMultipartUpload', abortMultipartUpload_requestPayer - Undocumented member.
AbortMultipartUpload, abortMultipartUpload_bucket - The bucket name to which the upload was taking place.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
AbortMultipartUpload, abortMultipartUpload_key - Key of the object for which the multipart upload was initiated.
AbortMultipartUpload, abortMultipartUpload_uploadId - Upload ID that identifies the multipart upload.
data AbortMultipartUploadResponse Source #
See: newAbortMultipartUploadResponse smart constructor.
Constructors
| AbortMultipartUploadResponse' (Maybe RequestCharged) Int |
Instances
newAbortMultipartUploadResponse Source #
Create a value of AbortMultipartUploadResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requestCharged:AbortMultipartUploadResponse', abortMultipartUploadResponse_requestCharged - Undocumented member.
$sel:httpStatus:AbortMultipartUploadResponse', abortMultipartUploadResponse_httpStatus - The response's http status code.
CompleteMultipartUpload
data CompleteMultipartUpload Source #
See: newCompleteMultipartUpload smart constructor.
Constructors
| CompleteMultipartUpload' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CompletedMultipartUpload) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) BucketName ObjectKey Text |
Instances
newCompleteMultipartUpload Source #
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> Text | |
| -> CompleteMultipartUpload |
Create a value of CompleteMultipartUpload with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CompleteMultipartUpload, completeMultipartUpload_checksumCRC32 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 32-bit CRC32 checksum of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
CompleteMultipartUpload, completeMultipartUpload_checksumCRC32C - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 32-bit CRC32C checksum of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
CompleteMultipartUpload, completeMultipartUpload_checksumSHA1 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 160-bit SHA-1 digest of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
CompleteMultipartUpload, completeMultipartUpload_checksumSHA256 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 256-bit SHA-256 digest of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:expectedBucketOwner:CompleteMultipartUpload', completeMultipartUpload_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:multipartUpload:CompleteMultipartUpload', completeMultipartUpload_multipartUpload - The container for the multipart upload request information.
$sel:requestPayer:CompleteMultipartUpload', completeMultipartUpload_requestPayer - Undocumented member.
$sel:sSECustomerAlgorithm:CompleteMultipartUpload', completeMultipartUpload_sSECustomerAlgorithm - The server-side encryption (SSE) algorithm used to encrypt the object.
This parameter is needed only when the object was created using a
checksum algorithm. For more information, see
Protecting data using SSE-C keys
in the Amazon S3 User Guide.
$sel:sSECustomerKey:CompleteMultipartUpload', completeMultipartUpload_sSECustomerKey - The server-side encryption (SSE) customer managed key. This parameter is
needed only when the object was created using a checksum algorithm. For
more information, see
Protecting data using SSE-C keys
in the Amazon S3 User Guide.
$sel:sSECustomerKeyMD5:CompleteMultipartUpload', completeMultipartUpload_sSECustomerKeyMD5 - The MD5 server-side encryption (SSE) customer managed key. This
parameter is needed only when the object was created using a checksum
algorithm. For more information, see
Protecting data using SSE-C keys
in the Amazon S3 User Guide.
CompleteMultipartUpload, completeMultipartUpload_bucket - Name of the bucket to which the multipart upload was initiated.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
CompleteMultipartUpload, completeMultipartUpload_key - Object key for which the multipart upload was initiated.
CompleteMultipartUpload, completeMultipartUpload_uploadId - ID for the initiated multipart upload.
data CompleteMultipartUploadResponse Source #
See: newCompleteMultipartUploadResponse smart constructor.
Constructors
| CompleteMultipartUploadResponse' (Maybe BucketName) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe Text) (Maybe ObjectKey) (Maybe Text) (Maybe RequestCharged) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe ObjectVersionId) Int |
Instances
newCompleteMultipartUploadResponse Source #
Create a value of CompleteMultipartUploadResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CompleteMultipartUpload, completeMultipartUploadResponse_bucket - The name of the bucket that contains the newly created object. Does not
return the access point ARN or access point alias if used.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
CompleteMultipartUploadResponse, completeMultipartUploadResponse_bucketKeyEnabled - Indicates whether the multipart upload uses an S3 Bucket Key for
server-side encryption with Amazon Web Services KMS (SSE-KMS).
CompleteMultipartUpload, completeMultipartUploadResponse_checksumCRC32 - The base64-encoded, 32-bit CRC32 checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
CompleteMultipartUpload, completeMultipartUploadResponse_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
CompleteMultipartUpload, completeMultipartUploadResponse_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
CompleteMultipartUpload, completeMultipartUploadResponse_checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
CompleteMultipartUploadResponse, completeMultipartUploadResponse_eTag - Entity tag that identifies the newly created object's data. Objects
with different object data will have different entity tags. The entity
tag is an opaque string. The entity tag may or may not be an MD5 digest
of the object data. If the entity tag is not an MD5 digest of the object
data, it will contain one or more nonhexadecimal characters and/or will
consist of less than 32 or more than 32 hexadecimal digits. For more
information about how the entity tag is calculated, see
Checking object integrity
in the Amazon S3 User Guide.
CompleteMultipartUploadResponse, completeMultipartUploadResponse_expiration - 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.
CompleteMultipartUpload, completeMultipartUploadResponse_key - The object key of the newly created object.
$sel:location:CompleteMultipartUploadResponse', completeMultipartUploadResponse_location - The URI that identifies the newly created object.
$sel:requestCharged:CompleteMultipartUploadResponse', completeMultipartUploadResponse_requestCharged - Undocumented member.
$sel:sSEKMSKeyId:CompleteMultipartUploadResponse', completeMultipartUploadResponse_sSEKMSKeyId - If present, specifies the ID of the Amazon Web Services Key Management
Service (Amazon Web Services KMS) symmetric customer managed key that
was used for the object.
$sel:serverSideEncryption:CompleteMultipartUploadResponse', completeMultipartUploadResponse_serverSideEncryption - If you specified server-side encryption either with an Amazon S3-managed
encryption key or an Amazon Web Services KMS key in your initiate
multipart upload request, the response includes this header. It confirms
the encryption algorithm that Amazon S3 used to encrypt the object.
CompleteMultipartUploadResponse, completeMultipartUploadResponse_versionId - Version ID of the newly created object, in case the bucket has
versioning turned on.
$sel:httpStatus:CompleteMultipartUploadResponse', completeMultipartUploadResponse_httpStatus - The response's http status code.
CopyObject
data CopyObject Source #
See: newCopyObject smart constructor.
Constructors
| CopyObject' (Maybe ObjectCannedACL) (Maybe Bool) (Maybe Text) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (HashMap Text Text) (Maybe MetadataDirective) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe StorageClass) (Maybe Text) (Maybe TaggingDirective) (Maybe Text) BucketName Text ObjectKey |
Instances
Arguments
| :: BucketName | |
| -> Text | |
| -> ObjectKey | |
| -> CopyObject |
Create a value of CopyObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acl:CopyObject', copyObject_acl - The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
CopyObject, copyObject_bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key for object
encryption with server-side encryption using AWS KMS (SSE-KMS). Setting
this header to true causes Amazon S3 to use an S3 Bucket Key for
object encryption with SSE-KMS.
Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.
$sel:cacheControl:CopyObject', copyObject_cacheControl - Specifies caching behavior along the request/reply chain.
CopyObject, copyObject_checksumAlgorithm - Indicates the algorithm you want Amazon S3 to use to create the checksum
for the object. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:contentDisposition:CopyObject', copyObject_contentDisposition - Specifies presentational information for the object.
$sel:contentEncoding:CopyObject', copyObject_contentEncoding - 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.
$sel:contentLanguage:CopyObject', copyObject_contentLanguage - The language the content is in.
$sel:contentType:CopyObject', copyObject_contentType - A standard MIME type describing the format of the object data.
$sel:copySourceIfMatch:CopyObject', copyObject_copySourceIfMatch - Copies the object if its entity tag (ETag) matches the specified tag.
$sel:copySourceIfModifiedSince:CopyObject', copyObject_copySourceIfModifiedSince - Copies the object if it has been modified since the specified time.
$sel:copySourceIfNoneMatch:CopyObject', copyObject_copySourceIfNoneMatch - Copies the object if its entity tag (ETag) is different than the
specified ETag.
$sel:copySourceIfUnmodifiedSince:CopyObject', copyObject_copySourceIfUnmodifiedSince - Copies the object if it hasn't been modified since the specified time.
$sel:copySourceSSECustomerAlgorithm:CopyObject', copyObject_copySourceSSECustomerAlgorithm - Specifies the algorithm to use when decrypting the source object (for
example, AES256).
$sel:copySourceSSECustomerKey:CopyObject', copyObject_copySourceSSECustomerKey - 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.
$sel:copySourceSSECustomerKeyMD5:CopyObject', copyObject_copySourceSSECustomerKeyMD5 - 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
that the encryption key was transmitted without error.
$sel:expectedBucketOwner:CopyObject', copyObject_expectedBucketOwner - The account ID of the expected destination bucket owner. If the
destination bucket is owned by a different account, the request fails
with the HTTP status code 403 Forbidden (access denied).
$sel:expectedSourceBucketOwner:CopyObject', copyObject_expectedSourceBucketOwner - The account ID of the expected source bucket owner. If the source bucket
is owned by a different account, the request fails with the HTTP status
code 403 Forbidden (access denied).
$sel:expires:CopyObject', copyObject_expires - The date and time at which the object is no longer cacheable.
$sel:grantFullControl:CopyObject', copyObject_grantFullControl - Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
object.
This action is not supported by Amazon S3 on Outposts.
$sel:grantRead:CopyObject', copyObject_grantRead - Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
$sel:grantReadACP:CopyObject', copyObject_grantReadACP - Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
$sel:grantWriteACP:CopyObject', copyObject_grantWriteACP - Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
$sel:metadata:CopyObject', copyObject_metadata - A map of metadata to store with the object in S3.
$sel:metadataDirective:CopyObject', copyObject_metadataDirective - Specifies whether the metadata is copied from the source object or
replaced with metadata provided in the request.
$sel:objectLockLegalHoldStatus:CopyObject', copyObject_objectLockLegalHoldStatus - Specifies whether you want to apply a legal hold to the copied object.
$sel:objectLockMode:CopyObject', copyObject_objectLockMode - The Object Lock mode that you want to apply to the copied object.
$sel:objectLockRetainUntilDate:CopyObject', copyObject_objectLockRetainUntilDate - The date and time when you want the copied object's Object Lock to
expire.
$sel:requestPayer:CopyObject', copyObject_requestPayer - Undocumented member.
CopyObject, copyObject_sSECustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (for
example, AES256).
$sel:sSECustomerKey:CopyObject', copyObject_sSECustomerKey - 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 S3 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.
CopyObject, copyObject_sSECustomerKeyMD5 - 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
that the encryption key was transmitted without error.
CopyObject, copyObject_sSEKMSEncryptionContext - Specifies the Amazon Web Services KMS Encryption Context to use for
object encryption. The value of this header is a base64-encoded UTF-8
string holding JSON with the encryption context key-value pairs.
CopyObject, copyObject_sSEKMSKeyId - Specifies the Amazon Web Services KMS key ID to use for object
encryption. All GET and PUT requests for an object protected by Amazon
Web Services KMS will fail if not made via SSL or using SigV4. For
information about configuring using any of the officially supported
Amazon Web Services SDKs and Amazon Web Services CLI, see
Specifying the Signature Version in Request Authentication
in the Amazon S3 User Guide.
CopyObject, copyObject_serverSideEncryption - The server-side encryption algorithm used when storing this object in
Amazon S3 (for example, AES256, aws:kms).
CopyObject, copyObject_storageClass - By default, Amazon S3 uses the STANDARD Storage Class to store newly
created objects. The STANDARD storage class provides high durability and
high availability. Depending on performance needs, you can specify a
different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS
Storage Class. For more information, see
Storage Classes
in the Amazon S3 User Guide.
CopyObject, copyObject_tagging - 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.
$sel:taggingDirective:CopyObject', copyObject_taggingDirective - Specifies whether the object tag-set are copied from the source object
or replaced with tag-set provided in the request.
$sel:websiteRedirectLocation:CopyObject', copyObject_websiteRedirectLocation - 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.
CopyObject, copyObject_bucket - The name of the destination bucket.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
$sel:copySource:CopyObject', copyObject_copySource - Specifies the source object for the copy operation. You specify the
value in one of two formats, depending on whether you want to access the
source object through an
access point:
- For objects not accessed through an access point, specify the name
of the source bucket and the key of the source object, separated by
a slash (/). For example, to copy the object
reports/january.pdffrom the bucketawsexamplebucket, useawsexamplebucket/reports/january.pdf. The value must be URL-encoded. For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format
arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the objectreports/january.pdfthrough access pointmy-access-pointowned by account123456789012in Regionus-west-2, use the URL encoding ofarn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the objectreports/january.pdfthrough outpostmy-outpostowned by account123456789012in Regionus-west-2, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.
To copy a specific version of an object, append
?versionId=<version-id> to the value (for example,
awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).
If you don't specify a version ID, Amazon S3 copies the latest version
of the source object.
CopyObject, copyObject_key - The key of the destination object.
data CopyObjectResponse Source #
See: newCopyObjectResponse smart constructor.
Constructors
| CopyObjectResponse' (Maybe Bool) (Maybe CopyObjectResult) (Maybe Text) (Maybe Text) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe ObjectVersionId) Int |
Instances
newCopyObjectResponse Source #
Arguments
| :: Int | |
| -> CopyObjectResponse |
Create a value of CopyObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CopyObject, copyObjectResponse_bucketKeyEnabled - Indicates whether the copied object uses an S3 Bucket Key for
server-side encryption with Amazon Web Services KMS (SSE-KMS).
$sel:copyObjectResult:CopyObjectResponse', copyObjectResponse_copyObjectResult - Container for all response elements.
$sel:copySourceVersionId:CopyObjectResponse', copyObjectResponse_copySourceVersionId - Version of the copied object in the destination bucket.
CopyObjectResponse, copyObjectResponse_expiration - If the object expiration is configured, the response includes this
header.
$sel:requestCharged:CopyObjectResponse', copyObjectResponse_requestCharged - Undocumented member.
CopyObject, copyObjectResponse_sSECustomerAlgorithm - If server-side encryption with a customer-provided encryption key was
requested, the response will include this header confirming the
encryption algorithm used.
CopyObject, copyObjectResponse_sSECustomerKeyMD5 - 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.
CopyObject, copyObjectResponse_sSEKMSEncryptionContext - If present, specifies the Amazon Web Services KMS Encryption Context to
use for object encryption. The value of this header is a base64-encoded
UTF-8 string holding JSON with the encryption context key-value pairs.
CopyObject, copyObjectResponse_sSEKMSKeyId - If present, specifies the ID of the Amazon Web Services Key Management
Service (Amazon Web Services KMS) symmetric customer managed key that
was used for the object.
CopyObject, copyObjectResponse_serverSideEncryption - The server-side encryption algorithm used when storing this object in
Amazon S3 (for example, AES256, aws:kms).
CopyObjectResponse, copyObjectResponse_versionId - Version ID of the newly created copy.
$sel:httpStatus:CopyObjectResponse', copyObjectResponse_httpStatus - The response's http status code.
CreateBucket
data CreateBucket Source #
See: newCreateBucket smart constructor.
Constructors
| CreateBucket' (Maybe BucketCannedACL) (Maybe CreateBucketConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ObjectOwnership) BucketName |
Instances
Arguments
| :: BucketName | |
| -> CreateBucket |
Create a value of CreateBucket with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acl:CreateBucket', createBucket_acl - The canned ACL to apply to the bucket.
$sel:createBucketConfiguration:CreateBucket', createBucket_createBucketConfiguration - The configuration information for the bucket.
$sel:grantFullControl:CreateBucket', createBucket_grantFullControl - Allows grantee the read, write, read ACP, and write ACP permissions on
the bucket.
$sel:grantRead:CreateBucket', createBucket_grantRead - Allows grantee to list the objects in the bucket.
$sel:grantReadACP:CreateBucket', createBucket_grantReadACP - Allows grantee to read the bucket ACL.
$sel:grantWrite:CreateBucket', createBucket_grantWrite - Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
$sel:grantWriteACP:CreateBucket', createBucket_grantWriteACP - Allows grantee to write the ACL for the applicable bucket.
$sel:objectLockEnabledForBucket:CreateBucket', createBucket_objectLockEnabledForBucket - Specifies whether you want S3 Object Lock to be enabled for the new
bucket.
CreateBucket, createBucket_objectOwnership - Undocumented member.
CreateBucket, createBucket_bucket - The name of the bucket to create.
data CreateBucketResponse Source #
See: newCreateBucketResponse smart constructor.
Constructors
| CreateBucketResponse' (Maybe Text) Int |
Instances
newCreateBucketResponse Source #
Arguments
| :: Int | |
| -> CreateBucketResponse |
Create a value of CreateBucketResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:location:CreateBucketResponse', createBucketResponse_location - A forward slash followed by the name of the bucket.
$sel:httpStatus:CreateBucketResponse', createBucketResponse_httpStatus - The response's http status code.
CreateMultipartUpload
data CreateMultipartUpload Source #
See: newCreateMultipartUpload smart constructor.
Constructors
| CreateMultipartUpload' (Maybe ObjectCannedACL) (Maybe Bool) (Maybe Text) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (HashMap Text Text) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe StorageClass) (Maybe Text) (Maybe Text) BucketName ObjectKey |
Instances
newCreateMultipartUpload Source #
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> CreateMultipartUpload |
Create a value of CreateMultipartUpload with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acl:CreateMultipartUpload', createMultipartUpload_acl - The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
CreateMultipartUpload, createMultipartUpload_bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key for object
encryption with server-side encryption using AWS KMS (SSE-KMS). Setting
this header to true causes Amazon S3 to use an S3 Bucket Key for
object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
$sel:cacheControl:CreateMultipartUpload', createMultipartUpload_cacheControl - Specifies caching behavior along the request/reply chain.
CreateMultipartUpload, createMultipartUpload_checksumAlgorithm - Indicates the algorithm you want Amazon S3 to use to create the checksum
for the object. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:contentDisposition:CreateMultipartUpload', createMultipartUpload_contentDisposition - Specifies presentational information for the object.
$sel:contentEncoding:CreateMultipartUpload', createMultipartUpload_contentEncoding - 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.
$sel:contentLanguage:CreateMultipartUpload', createMultipartUpload_contentLanguage - The language the content is in.
$sel:contentType:CreateMultipartUpload', createMultipartUpload_contentType - A standard MIME type describing the format of the object data.
$sel:expectedBucketOwner:CreateMultipartUpload', createMultipartUpload_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:expires:CreateMultipartUpload', createMultipartUpload_expires - The date and time at which the object is no longer cacheable.
$sel:grantFullControl:CreateMultipartUpload', createMultipartUpload_grantFullControl - Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
object.
This action is not supported by Amazon S3 on Outposts.
$sel:grantRead:CreateMultipartUpload', createMultipartUpload_grantRead - Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
$sel:grantReadACP:CreateMultipartUpload', createMultipartUpload_grantReadACP - Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
$sel:grantWriteACP:CreateMultipartUpload', createMultipartUpload_grantWriteACP - Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
$sel:metadata:CreateMultipartUpload', createMultipartUpload_metadata - A map of metadata to store with the object in S3.
$sel:objectLockLegalHoldStatus:CreateMultipartUpload', createMultipartUpload_objectLockLegalHoldStatus - Specifies whether you want to apply a legal hold to the uploaded object.
$sel:objectLockMode:CreateMultipartUpload', createMultipartUpload_objectLockMode - Specifies the Object Lock mode that you want to apply to the uploaded
object.
$sel:objectLockRetainUntilDate:CreateMultipartUpload', createMultipartUpload_objectLockRetainUntilDate - Specifies the date and time when you want the Object Lock to expire.
$sel:requestPayer:CreateMultipartUpload', createMultipartUpload_requestPayer - Undocumented member.
CreateMultipartUpload, createMultipartUpload_sSECustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (for
example, AES256).
$sel:sSECustomerKey:CreateMultipartUpload', createMultipartUpload_sSECustomerKey - 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 S3 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.
CreateMultipartUpload, createMultipartUpload_sSECustomerKeyMD5 - 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
that the encryption key was transmitted without error.
CreateMultipartUpload, createMultipartUpload_sSEKMSEncryptionContext - Specifies the Amazon Web Services KMS Encryption Context to use for
object encryption. The value of this header is a base64-encoded UTF-8
string holding JSON with the encryption context key-value pairs.
CreateMultipartUpload, createMultipartUpload_sSEKMSKeyId - Specifies the ID of the symmetric customer managed key to use for object
encryption. All GET and PUT requests for an object protected by Amazon
Web Services KMS will fail if not made via SSL or using SigV4. For
information about configuring using any of the officially supported
Amazon Web Services SDKs and Amazon Web Services CLI, see
Specifying the Signature Version in Request Authentication
in the Amazon S3 User Guide.
CreateMultipartUpload, createMultipartUpload_serverSideEncryption - The server-side encryption algorithm used when storing this object in
Amazon S3 (for example, AES256, aws:kms).
CreateMultipartUpload, createMultipartUpload_storageClass - By default, Amazon S3 uses the STANDARD Storage Class to store newly
created objects. The STANDARD storage class provides high durability and
high availability. Depending on performance needs, you can specify a
different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS
Storage Class. For more information, see
Storage Classes
in the Amazon S3 User Guide.
CreateMultipartUpload, createMultipartUpload_tagging - The tag-set for the object. The tag-set must be encoded as URL Query
parameters.
$sel:websiteRedirectLocation:CreateMultipartUpload', createMultipartUpload_websiteRedirectLocation - 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.
CreateMultipartUpload, createMultipartUpload_bucket - The name of the bucket to which to initiate the upload
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
CreateMultipartUpload, createMultipartUpload_key - Object key for which the multipart upload is to be initiated.
data CreateMultipartUploadResponse Source #
See: newCreateMultipartUploadResponse smart constructor.
Constructors
| CreateMultipartUploadResponse' (Maybe RFC822) (Maybe Text) (Maybe BucketName) (Maybe Bool) (Maybe ChecksumAlgorithm) (Maybe ObjectKey) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) Int Text |
Instances
newCreateMultipartUploadResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateMultipartUploadResponse |
Create a value of CreateMultipartUploadResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:abortDate:CreateMultipartUploadResponse', createMultipartUploadResponse_abortDate - If the bucket has a lifecycle rule configured with an action to abort
incomplete multipart uploads and the prefix in the lifecycle rule
matches the object name in the request, the response includes this
header. The header indicates when the initiated multipart upload becomes
eligible for an abort operation. For more information, see
Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
The response also includes the x-amz-abort-rule-id header that
provides the ID of the lifecycle configuration rule that defines this
action.
$sel:abortRuleId:CreateMultipartUploadResponse', createMultipartUploadResponse_abortRuleId - This header is returned along with the x-amz-abort-date header. It
identifies the applicable lifecycle configuration rule that defines the
action to abort incomplete multipart uploads.
CreateMultipartUpload, createMultipartUploadResponse_bucket - The name of the bucket to which the multipart upload was initiated. Does
not return the access point ARN or access point alias if used.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
CreateMultipartUpload, createMultipartUploadResponse_bucketKeyEnabled - Indicates whether the multipart upload uses an S3 Bucket Key for
server-side encryption with Amazon Web Services KMS (SSE-KMS).
CreateMultipartUpload, createMultipartUploadResponse_checksumAlgorithm - The algorithm that was used to create a checksum of the object.
CreateMultipartUpload, createMultipartUploadResponse_key - Object key for which the multipart upload was initiated.
$sel:requestCharged:CreateMultipartUploadResponse', createMultipartUploadResponse_requestCharged - Undocumented member.
CreateMultipartUpload, createMultipartUploadResponse_sSECustomerAlgorithm - If server-side encryption with a customer-provided encryption key was
requested, the response will include this header confirming the
encryption algorithm used.
CreateMultipartUpload, createMultipartUploadResponse_sSECustomerKeyMD5 - 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.
CreateMultipartUpload, createMultipartUploadResponse_sSEKMSEncryptionContext - If present, specifies the Amazon Web Services KMS Encryption Context to
use for object encryption. The value of this header is a base64-encoded
UTF-8 string holding JSON with the encryption context key-value pairs.
CreateMultipartUpload, createMultipartUploadResponse_sSEKMSKeyId - If present, specifies the ID of the Amazon Web Services Key Management
Service (Amazon Web Services KMS) symmetric customer managed key that
was used for the object.
CreateMultipartUpload, createMultipartUploadResponse_serverSideEncryption - The server-side encryption algorithm used when storing this object in
Amazon S3 (for example, AES256, aws:kms).
$sel:httpStatus:CreateMultipartUploadResponse', createMultipartUploadResponse_httpStatus - The response's http status code.
CreateMultipartUploadResponse, createMultipartUploadResponse_uploadId - ID for the initiated multipart upload.
DeleteBucket
data DeleteBucket Source #
See: newDeleteBucket smart constructor.
Constructors
| DeleteBucket' (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> DeleteBucket |
Create a value of DeleteBucket with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucket', deleteBucket_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucket, deleteBucket_bucket - Specifies the bucket being deleted.
data DeleteBucketResponse Source #
See: newDeleteBucketResponse smart constructor.
Constructors
| DeleteBucketResponse' | |
Instances
newDeleteBucketResponse :: DeleteBucketResponse Source #
Create a value of DeleteBucketResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketAnalyticsConfiguration
data DeleteBucketAnalyticsConfiguration Source #
See: newDeleteBucketAnalyticsConfiguration smart constructor.
Constructors
| DeleteBucketAnalyticsConfiguration' (Maybe Text) BucketName Text |
Instances
newDeleteBucketAnalyticsConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> DeleteBucketAnalyticsConfiguration |
Create a value of DeleteBucketAnalyticsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucketAnalyticsConfiguration', deleteBucketAnalyticsConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucketAnalyticsConfiguration, deleteBucketAnalyticsConfiguration_bucket - The name of the bucket from which an analytics configuration is deleted.
DeleteBucketAnalyticsConfiguration, deleteBucketAnalyticsConfiguration_id - The ID that identifies the analytics configuration.
data DeleteBucketAnalyticsConfigurationResponse Source #
See: newDeleteBucketAnalyticsConfigurationResponse smart constructor.
Constructors
| DeleteBucketAnalyticsConfigurationResponse' | |
Instances
| Generic DeleteBucketAnalyticsConfigurationResponse Source # | |
Defined in Amazonka.S3.DeleteBucketAnalyticsConfiguration Associated Types type Rep DeleteBucketAnalyticsConfigurationResponse :: Type -> Type # | |
| Read DeleteBucketAnalyticsConfigurationResponse Source # | |
| Show DeleteBucketAnalyticsConfigurationResponse Source # | |
| NFData DeleteBucketAnalyticsConfigurationResponse Source # | |
Defined in Amazonka.S3.DeleteBucketAnalyticsConfiguration Methods | |
| Eq DeleteBucketAnalyticsConfigurationResponse Source # | |
| type Rep DeleteBucketAnalyticsConfigurationResponse Source # | |
Defined in Amazonka.S3.DeleteBucketAnalyticsConfiguration type Rep DeleteBucketAnalyticsConfigurationResponse = D1 ('MetaData "DeleteBucketAnalyticsConfigurationResponse" "Amazonka.S3.DeleteBucketAnalyticsConfiguration" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "DeleteBucketAnalyticsConfigurationResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) | |
newDeleteBucketAnalyticsConfigurationResponse :: DeleteBucketAnalyticsConfigurationResponse Source #
Create a value of DeleteBucketAnalyticsConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketCors
data DeleteBucketCors Source #
See: newDeleteBucketCors smart constructor.
Constructors
| DeleteBucketCors' (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> DeleteBucketCors |
Create a value of DeleteBucketCors with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucketCors', deleteBucketCors_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucketCors, deleteBucketCors_bucket - Specifies the bucket whose cors configuration is being deleted.
data DeleteBucketCorsResponse Source #
See: newDeleteBucketCorsResponse smart constructor.
Constructors
| DeleteBucketCorsResponse' | |
Instances
newDeleteBucketCorsResponse :: DeleteBucketCorsResponse Source #
Create a value of DeleteBucketCorsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketEncryption
data DeleteBucketEncryption Source #
See: newDeleteBucketEncryption smart constructor.
Constructors
| DeleteBucketEncryption' (Maybe Text) BucketName |
Instances
newDeleteBucketEncryption Source #
Arguments
| :: BucketName | |
| -> DeleteBucketEncryption |
Create a value of DeleteBucketEncryption with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucketEncryption', deleteBucketEncryption_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucketEncryption, deleteBucketEncryption_bucket - The name of the bucket containing the server-side encryption
configuration to delete.
data DeleteBucketEncryptionResponse Source #
See: newDeleteBucketEncryptionResponse smart constructor.
Constructors
| DeleteBucketEncryptionResponse' | |
Instances
| Generic DeleteBucketEncryptionResponse Source # | |
Defined in Amazonka.S3.DeleteBucketEncryption Associated Types type Rep DeleteBucketEncryptionResponse :: Type -> Type # | |
| Read DeleteBucketEncryptionResponse Source # | |
| Show DeleteBucketEncryptionResponse Source # | |
Defined in Amazonka.S3.DeleteBucketEncryption Methods showsPrec :: Int -> DeleteBucketEncryptionResponse -> ShowS # show :: DeleteBucketEncryptionResponse -> String # showList :: [DeleteBucketEncryptionResponse] -> ShowS # | |
| NFData DeleteBucketEncryptionResponse Source # | |
Defined in Amazonka.S3.DeleteBucketEncryption Methods rnf :: DeleteBucketEncryptionResponse -> () # | |
| Eq DeleteBucketEncryptionResponse Source # | |
Defined in Amazonka.S3.DeleteBucketEncryption | |
| type Rep DeleteBucketEncryptionResponse Source # | |
Defined in Amazonka.S3.DeleteBucketEncryption | |
newDeleteBucketEncryptionResponse :: DeleteBucketEncryptionResponse Source #
Create a value of DeleteBucketEncryptionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketIntelligentTieringConfiguration
data DeleteBucketIntelligentTieringConfiguration Source #
See: newDeleteBucketIntelligentTieringConfiguration smart constructor.
Instances
newDeleteBucketIntelligentTieringConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> DeleteBucketIntelligentTieringConfiguration |
Create a value of DeleteBucketIntelligentTieringConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBucketIntelligentTieringConfiguration, deleteBucketIntelligentTieringConfiguration_bucket - The name of the Amazon S3 bucket whose configuration you want to modify
or retrieve.
DeleteBucketIntelligentTieringConfiguration, deleteBucketIntelligentTieringConfiguration_id - The ID used to identify the S3 Intelligent-Tiering configuration.
data DeleteBucketIntelligentTieringConfigurationResponse Source #
See: newDeleteBucketIntelligentTieringConfigurationResponse smart constructor.
Instances
newDeleteBucketIntelligentTieringConfigurationResponse :: DeleteBucketIntelligentTieringConfigurationResponse Source #
Create a value of DeleteBucketIntelligentTieringConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketInventoryConfiguration
data DeleteBucketInventoryConfiguration Source #
See: newDeleteBucketInventoryConfiguration smart constructor.
Constructors
| DeleteBucketInventoryConfiguration' (Maybe Text) BucketName Text |
Instances
newDeleteBucketInventoryConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> DeleteBucketInventoryConfiguration |
Create a value of DeleteBucketInventoryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucketInventoryConfiguration', deleteBucketInventoryConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucketInventoryConfiguration, deleteBucketInventoryConfiguration_bucket - The name of the bucket containing the inventory configuration to delete.
DeleteBucketInventoryConfiguration, deleteBucketInventoryConfiguration_id - The ID used to identify the inventory configuration.
data DeleteBucketInventoryConfigurationResponse Source #
See: newDeleteBucketInventoryConfigurationResponse smart constructor.
Constructors
| DeleteBucketInventoryConfigurationResponse' | |
Instances
| Generic DeleteBucketInventoryConfigurationResponse Source # | |
Defined in Amazonka.S3.DeleteBucketInventoryConfiguration Associated Types type Rep DeleteBucketInventoryConfigurationResponse :: Type -> Type # | |
| Read DeleteBucketInventoryConfigurationResponse Source # | |
| Show DeleteBucketInventoryConfigurationResponse Source # | |
| NFData DeleteBucketInventoryConfigurationResponse Source # | |
Defined in Amazonka.S3.DeleteBucketInventoryConfiguration Methods | |
| Eq DeleteBucketInventoryConfigurationResponse Source # | |
| type Rep DeleteBucketInventoryConfigurationResponse Source # | |
Defined in Amazonka.S3.DeleteBucketInventoryConfiguration type Rep DeleteBucketInventoryConfigurationResponse = D1 ('MetaData "DeleteBucketInventoryConfigurationResponse" "Amazonka.S3.DeleteBucketInventoryConfiguration" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "DeleteBucketInventoryConfigurationResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) | |
newDeleteBucketInventoryConfigurationResponse :: DeleteBucketInventoryConfigurationResponse Source #
Create a value of DeleteBucketInventoryConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketLifecycle
data DeleteBucketLifecycle Source #
See: newDeleteBucketLifecycle smart constructor.
Constructors
| DeleteBucketLifecycle' (Maybe Text) BucketName |
Instances
newDeleteBucketLifecycle Source #
Arguments
| :: BucketName | |
| -> DeleteBucketLifecycle |
Create a value of DeleteBucketLifecycle with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucketLifecycle', deleteBucketLifecycle_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucketLifecycle, deleteBucketLifecycle_bucket - The bucket name of the lifecycle to delete.
data DeleteBucketLifecycleResponse Source #
See: newDeleteBucketLifecycleResponse smart constructor.
Constructors
| DeleteBucketLifecycleResponse' | |
Instances
| Generic DeleteBucketLifecycleResponse Source # | |
Defined in Amazonka.S3.DeleteBucketLifecycle Associated Types type Rep DeleteBucketLifecycleResponse :: Type -> Type # | |
| Read DeleteBucketLifecycleResponse Source # | |
| Show DeleteBucketLifecycleResponse Source # | |
Defined in Amazonka.S3.DeleteBucketLifecycle Methods showsPrec :: Int -> DeleteBucketLifecycleResponse -> ShowS # show :: DeleteBucketLifecycleResponse -> String # showList :: [DeleteBucketLifecycleResponse] -> ShowS # | |
| NFData DeleteBucketLifecycleResponse Source # | |
Defined in Amazonka.S3.DeleteBucketLifecycle Methods rnf :: DeleteBucketLifecycleResponse -> () # | |
| Eq DeleteBucketLifecycleResponse Source # | |
Defined in Amazonka.S3.DeleteBucketLifecycle | |
| type Rep DeleteBucketLifecycleResponse Source # | |
Defined in Amazonka.S3.DeleteBucketLifecycle | |
newDeleteBucketLifecycleResponse :: DeleteBucketLifecycleResponse Source #
Create a value of DeleteBucketLifecycleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketMetricsConfiguration
data DeleteBucketMetricsConfiguration Source #
See: newDeleteBucketMetricsConfiguration smart constructor.
Constructors
| DeleteBucketMetricsConfiguration' (Maybe Text) BucketName Text |
Instances
newDeleteBucketMetricsConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> DeleteBucketMetricsConfiguration |
Create a value of DeleteBucketMetricsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucketMetricsConfiguration', deleteBucketMetricsConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucketMetricsConfiguration, deleteBucketMetricsConfiguration_bucket - The name of the bucket containing the metrics configuration to delete.
DeleteBucketMetricsConfiguration, deleteBucketMetricsConfiguration_id - The ID used to identify the metrics configuration.
data DeleteBucketMetricsConfigurationResponse Source #
See: newDeleteBucketMetricsConfigurationResponse smart constructor.
Constructors
| DeleteBucketMetricsConfigurationResponse' | |
Instances
newDeleteBucketMetricsConfigurationResponse :: DeleteBucketMetricsConfigurationResponse Source #
Create a value of DeleteBucketMetricsConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketOwnershipControls
data DeleteBucketOwnershipControls Source #
See: newDeleteBucketOwnershipControls smart constructor.
Constructors
| DeleteBucketOwnershipControls' (Maybe Text) BucketName |
Instances
newDeleteBucketOwnershipControls Source #
Create a value of DeleteBucketOwnershipControls with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucketOwnershipControls', deleteBucketOwnershipControls_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucketOwnershipControls, deleteBucketOwnershipControls_bucket - The Amazon S3 bucket whose OwnershipControls you want to delete.
data DeleteBucketOwnershipControlsResponse Source #
See: newDeleteBucketOwnershipControlsResponse smart constructor.
Constructors
| DeleteBucketOwnershipControlsResponse' | |
Instances
newDeleteBucketOwnershipControlsResponse :: DeleteBucketOwnershipControlsResponse Source #
Create a value of DeleteBucketOwnershipControlsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketPolicy
data DeleteBucketPolicy Source #
See: newDeleteBucketPolicy smart constructor.
Constructors
| DeleteBucketPolicy' (Maybe Text) BucketName |
Instances
newDeleteBucketPolicy Source #
Arguments
| :: BucketName | |
| -> DeleteBucketPolicy |
Create a value of DeleteBucketPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucketPolicy', deleteBucketPolicy_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucketPolicy, deleteBucketPolicy_bucket - The bucket name.
data DeleteBucketPolicyResponse Source #
See: newDeleteBucketPolicyResponse smart constructor.
Constructors
| DeleteBucketPolicyResponse' | |
Instances
newDeleteBucketPolicyResponse :: DeleteBucketPolicyResponse Source #
Create a value of DeleteBucketPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketReplication
data DeleteBucketReplication Source #
See: newDeleteBucketReplication smart constructor.
Constructors
| DeleteBucketReplication' (Maybe Text) BucketName |
Instances
newDeleteBucketReplication Source #
Arguments
| :: BucketName | |
| -> DeleteBucketReplication |
Create a value of DeleteBucketReplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucketReplication', deleteBucketReplication_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucketReplication, deleteBucketReplication_bucket - The bucket name.
data DeleteBucketReplicationResponse Source #
See: newDeleteBucketReplicationResponse smart constructor.
Constructors
| DeleteBucketReplicationResponse' | |
Instances
| Generic DeleteBucketReplicationResponse Source # | |
Defined in Amazonka.S3.DeleteBucketReplication Associated Types type Rep DeleteBucketReplicationResponse :: Type -> Type # | |
| Read DeleteBucketReplicationResponse Source # | |
| Show DeleteBucketReplicationResponse Source # | |
Defined in Amazonka.S3.DeleteBucketReplication Methods showsPrec :: Int -> DeleteBucketReplicationResponse -> ShowS # | |
| NFData DeleteBucketReplicationResponse Source # | |
Defined in Amazonka.S3.DeleteBucketReplication Methods rnf :: DeleteBucketReplicationResponse -> () # | |
| Eq DeleteBucketReplicationResponse Source # | |
Defined in Amazonka.S3.DeleteBucketReplication | |
| type Rep DeleteBucketReplicationResponse Source # | |
Defined in Amazonka.S3.DeleteBucketReplication | |
newDeleteBucketReplicationResponse :: DeleteBucketReplicationResponse Source #
Create a value of DeleteBucketReplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketTagging
data DeleteBucketTagging Source #
See: newDeleteBucketTagging smart constructor.
Constructors
| DeleteBucketTagging' (Maybe Text) BucketName |
Instances
newDeleteBucketTagging Source #
Arguments
| :: BucketName | |
| -> DeleteBucketTagging |
Create a value of DeleteBucketTagging with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucketTagging', deleteBucketTagging_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucketTagging, deleteBucketTagging_bucket - The bucket that has the tag set to be removed.
data DeleteBucketTaggingResponse Source #
See: newDeleteBucketTaggingResponse smart constructor.
Constructors
| DeleteBucketTaggingResponse' | |
Instances
newDeleteBucketTaggingResponse :: DeleteBucketTaggingResponse Source #
Create a value of DeleteBucketTaggingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBucketWebsite
data DeleteBucketWebsite Source #
See: newDeleteBucketWebsite smart constructor.
Constructors
| DeleteBucketWebsite' (Maybe Text) BucketName |
Instances
newDeleteBucketWebsite Source #
Arguments
| :: BucketName | |
| -> DeleteBucketWebsite |
Create a value of DeleteBucketWebsite with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteBucketWebsite', deleteBucketWebsite_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteBucketWebsite, deleteBucketWebsite_bucket - The bucket name for which you want to remove the website configuration.
data DeleteBucketWebsiteResponse Source #
See: newDeleteBucketWebsiteResponse smart constructor.
Constructors
| DeleteBucketWebsiteResponse' | |
Instances
newDeleteBucketWebsiteResponse :: DeleteBucketWebsiteResponse Source #
Create a value of DeleteBucketWebsiteResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteObject
data DeleteObject Source #
See: newDeleteObject smart constructor.
Constructors
| DeleteObject' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> DeleteObject |
Create a value of DeleteObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bypassGovernanceRetention:DeleteObject', deleteObject_bypassGovernanceRetention - Indicates whether S3 Object Lock should bypass Governance-mode
restrictions to process this operation. To use this header, you must
have the s3:BypassGovernanceRetention permission.
$sel:expectedBucketOwner:DeleteObject', deleteObject_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:mfa:DeleteObject', deleteObject_mfa - The concatenation of the authentication device's serial number, a
space, and the value that is displayed on your authentication device.
Required to permanently delete a versioned object if versioning is
configured with MFA delete enabled.
$sel:requestPayer:DeleteObject', deleteObject_requestPayer - Undocumented member.
DeleteObject, deleteObject_versionId - VersionId used to reference a specific version of the object.
DeleteObject, deleteObject_bucket - The bucket name of the bucket containing the object.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
DeleteObject, deleteObject_key - Key name of the object to delete.
data DeleteObjectResponse Source #
See: newDeleteObjectResponse smart constructor.
Constructors
| DeleteObjectResponse' (Maybe Bool) (Maybe RequestCharged) (Maybe ObjectVersionId) Int |
Instances
newDeleteObjectResponse Source #
Arguments
| :: Int | |
| -> DeleteObjectResponse |
Create a value of DeleteObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteObjectResponse, deleteObjectResponse_deleteMarker - Specifies whether the versioned object that was permanently deleted was
(true) or was not (false) a delete marker.
$sel:requestCharged:DeleteObjectResponse', deleteObjectResponse_requestCharged - Undocumented member.
DeleteObject, deleteObjectResponse_versionId - Returns the version ID of the delete marker created as a result of the
DELETE operation.
$sel:httpStatus:DeleteObjectResponse', deleteObjectResponse_httpStatus - The response's http status code.
DeleteObjectTagging
data DeleteObjectTagging Source #
See: newDeleteObjectTagging smart constructor.
Constructors
| DeleteObjectTagging' (Maybe Text) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
newDeleteObjectTagging Source #
Create a value of DeleteObjectTagging with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeleteObjectTagging', deleteObjectTagging_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeleteObjectTagging, deleteObjectTagging_versionId - The versionId of the object that the tag-set will be removed from.
DeleteObjectTagging, deleteObjectTagging_bucket - The bucket name containing the objects from which to remove the tags.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
DeleteObjectTagging, deleteObjectTagging_key - The key that identifies the object in the bucket from which to remove
all tags.
data DeleteObjectTaggingResponse Source #
See: newDeleteObjectTaggingResponse smart constructor.
Constructors
| DeleteObjectTaggingResponse' (Maybe ObjectVersionId) Int |
Instances
newDeleteObjectTaggingResponse Source #
Create a value of DeleteObjectTaggingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteObjectTagging, deleteObjectTaggingResponse_versionId - The versionId of the object the tag-set was removed from.
$sel:httpStatus:DeleteObjectTaggingResponse', deleteObjectTaggingResponse_httpStatus - The response's http status code.
DeleteObjects
data DeleteObjects Source #
See: newDeleteObjects smart constructor.
Constructors
| DeleteObjects' (Maybe Bool) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe RequestPayer) BucketName Delete |
Instances
Arguments
| :: BucketName | |
| -> Delete | |
| -> DeleteObjects |
Create a value of DeleteObjects with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bypassGovernanceRetention:DeleteObjects', deleteObjects_bypassGovernanceRetention - Specifies whether you want to delete this object even if it has a
Governance-type Object Lock in place. To use this header, you must have
the s3:BypassGovernanceRetention permission.
DeleteObjects, deleteObjects_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
This checksum algorithm must be the same for all parts and it match the
checksum value supplied in the CreateMultipartUpload request.
$sel:expectedBucketOwner:DeleteObjects', deleteObjects_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:mfa:DeleteObjects', deleteObjects_mfa - The concatenation of the authentication device's serial number, a
space, and the value that is displayed on your authentication device.
Required to permanently delete a versioned object if versioning is
configured with MFA delete enabled.
$sel:requestPayer:DeleteObjects', deleteObjects_requestPayer - Undocumented member.
DeleteObjects, deleteObjects_bucket - The bucket name containing the objects to delete.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
$sel:delete':DeleteObjects', deleteObjects_delete - Container for the request.
data DeleteObjectsResponse Source #
See: newDeleteObjectsResponse smart constructor.
Constructors
| DeleteObjectsResponse' (Maybe [DeletedObject]) (Maybe [S3ServiceError]) (Maybe RequestCharged) Int |
Instances
newDeleteObjectsResponse Source #
Create a value of DeleteObjectsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleted:DeleteObjectsResponse', deleteObjectsResponse_deleted - Container element for a successful delete. It identifies the object that
was successfully deleted.
$sel:errors:DeleteObjectsResponse', deleteObjectsResponse_errors - Container for a failed delete action that describes the object that
Amazon S3 attempted to delete and the error it encountered.
$sel:requestCharged:DeleteObjectsResponse', deleteObjectsResponse_requestCharged - Undocumented member.
$sel:httpStatus:DeleteObjectsResponse', deleteObjectsResponse_httpStatus - The response's http status code.
DeletePublicAccessBlock
data DeletePublicAccessBlock Source #
See: newDeletePublicAccessBlock smart constructor.
Constructors
| DeletePublicAccessBlock' (Maybe Text) BucketName |
Instances
newDeletePublicAccessBlock Source #
Arguments
| :: BucketName | |
| -> DeletePublicAccessBlock |
Create a value of DeletePublicAccessBlock with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:DeletePublicAccessBlock', deletePublicAccessBlock_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
DeletePublicAccessBlock, deletePublicAccessBlock_bucket - The Amazon S3 bucket whose PublicAccessBlock configuration you want to
delete.
data DeletePublicAccessBlockResponse Source #
See: newDeletePublicAccessBlockResponse smart constructor.
Constructors
| DeletePublicAccessBlockResponse' | |
Instances
| Generic DeletePublicAccessBlockResponse Source # | |
Defined in Amazonka.S3.DeletePublicAccessBlock Associated Types type Rep DeletePublicAccessBlockResponse :: Type -> Type # | |
| Read DeletePublicAccessBlockResponse Source # | |
| Show DeletePublicAccessBlockResponse Source # | |
Defined in Amazonka.S3.DeletePublicAccessBlock Methods showsPrec :: Int -> DeletePublicAccessBlockResponse -> ShowS # | |
| NFData DeletePublicAccessBlockResponse Source # | |
Defined in Amazonka.S3.DeletePublicAccessBlock Methods rnf :: DeletePublicAccessBlockResponse -> () # | |
| Eq DeletePublicAccessBlockResponse Source # | |
Defined in Amazonka.S3.DeletePublicAccessBlock | |
| type Rep DeletePublicAccessBlockResponse Source # | |
Defined in Amazonka.S3.DeletePublicAccessBlock | |
newDeletePublicAccessBlockResponse :: DeletePublicAccessBlockResponse Source #
Create a value of DeletePublicAccessBlockResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetBucketAccelerateConfiguration
data GetBucketAccelerateConfiguration Source #
See: newGetBucketAccelerateConfiguration smart constructor.
Constructors
| GetBucketAccelerateConfiguration' (Maybe Text) BucketName |
Instances
newGetBucketAccelerateConfiguration Source #
Create a value of GetBucketAccelerateConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketAccelerateConfiguration', getBucketAccelerateConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketAccelerateConfiguration, getBucketAccelerateConfiguration_bucket - The name of the bucket for which the accelerate configuration is
retrieved.
data GetBucketAccelerateConfigurationResponse Source #
See: newGetBucketAccelerateConfigurationResponse smart constructor.
Instances
newGetBucketAccelerateConfigurationResponse Source #
Arguments
| :: Int | |
| -> GetBucketAccelerateConfigurationResponse |
Create a value of GetBucketAccelerateConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBucketAccelerateConfigurationResponse, getBucketAccelerateConfigurationResponse_status - The accelerate configuration of the bucket.
$sel:httpStatus:GetBucketAccelerateConfigurationResponse', getBucketAccelerateConfigurationResponse_httpStatus - The response's http status code.
GetBucketAcl
data GetBucketAcl Source #
See: newGetBucketAcl smart constructor.
Constructors
| GetBucketAcl' (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> GetBucketAcl |
Create a value of GetBucketAcl with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketAcl', getBucketAcl_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketAcl, getBucketAcl_bucket - Specifies the S3 bucket whose ACL is being requested.
data GetBucketAclResponse Source #
See: newGetBucketAclResponse smart constructor.
Instances
newGetBucketAclResponse Source #
Arguments
| :: Int | |
| -> GetBucketAclResponse |
Create a value of GetBucketAclResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBucketAclResponse, getBucketAclResponse_grants - A list of grants.
GetBucketAclResponse, getBucketAclResponse_owner - Container for the bucket owner's display name and ID.
$sel:httpStatus:GetBucketAclResponse', getBucketAclResponse_httpStatus - The response's http status code.
GetBucketAnalyticsConfiguration
data GetBucketAnalyticsConfiguration Source #
See: newGetBucketAnalyticsConfiguration smart constructor.
Constructors
| GetBucketAnalyticsConfiguration' (Maybe Text) BucketName Text |
Instances
newGetBucketAnalyticsConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> GetBucketAnalyticsConfiguration |
Create a value of GetBucketAnalyticsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketAnalyticsConfiguration', getBucketAnalyticsConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketAnalyticsConfiguration, getBucketAnalyticsConfiguration_bucket - The name of the bucket from which an analytics configuration is
retrieved.
GetBucketAnalyticsConfiguration, getBucketAnalyticsConfiguration_id - The ID that identifies the analytics configuration.
data GetBucketAnalyticsConfigurationResponse Source #
See: newGetBucketAnalyticsConfigurationResponse smart constructor.
Instances
newGetBucketAnalyticsConfigurationResponse Source #
Arguments
| :: Int | |
| -> GetBucketAnalyticsConfigurationResponse |
Create a value of GetBucketAnalyticsConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:analyticsConfiguration:GetBucketAnalyticsConfigurationResponse', getBucketAnalyticsConfigurationResponse_analyticsConfiguration - The configuration and any analyses for the analytics filter.
$sel:httpStatus:GetBucketAnalyticsConfigurationResponse', getBucketAnalyticsConfigurationResponse_httpStatus - The response's http status code.
GetBucketCors
data GetBucketCors Source #
See: newGetBucketCors smart constructor.
Constructors
| GetBucketCors' (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> GetBucketCors |
Create a value of GetBucketCors with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketCors', getBucketCors_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketCors, getBucketCors_bucket - The bucket name for which to get the cors configuration.
data GetBucketCorsResponse Source #
See: newGetBucketCorsResponse smart constructor.
Constructors
| GetBucketCorsResponse' (Maybe [CORSRule]) Int |
Instances
newGetBucketCorsResponse Source #
Create a value of GetBucketCorsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBucketCorsResponse, getBucketCorsResponse_cORSRules - A set of origins and methods (cross-origin access that you want to
allow). You can add up to 100 rules to the configuration.
$sel:httpStatus:GetBucketCorsResponse', getBucketCorsResponse_httpStatus - The response's http status code.
GetBucketEncryption
data GetBucketEncryption Source #
See: newGetBucketEncryption smart constructor.
Constructors
| GetBucketEncryption' (Maybe Text) BucketName |
Instances
newGetBucketEncryption Source #
Arguments
| :: BucketName | |
| -> GetBucketEncryption |
Create a value of GetBucketEncryption with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketEncryption', getBucketEncryption_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketEncryption, getBucketEncryption_bucket - The name of the bucket from which the server-side encryption
configuration is retrieved.
data GetBucketEncryptionResponse Source #
See: newGetBucketEncryptionResponse smart constructor.
Instances
newGetBucketEncryptionResponse Source #
Create a value of GetBucketEncryptionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serverSideEncryptionConfiguration:GetBucketEncryptionResponse', getBucketEncryptionResponse_serverSideEncryptionConfiguration - Undocumented member.
$sel:httpStatus:GetBucketEncryptionResponse', getBucketEncryptionResponse_httpStatus - The response's http status code.
GetBucketIntelligentTieringConfiguration
data GetBucketIntelligentTieringConfiguration Source #
See: newGetBucketIntelligentTieringConfiguration smart constructor.
Constructors
| GetBucketIntelligentTieringConfiguration' BucketName Text |
Instances
newGetBucketIntelligentTieringConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> GetBucketIntelligentTieringConfiguration |
Create a value of GetBucketIntelligentTieringConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBucketIntelligentTieringConfiguration, getBucketIntelligentTieringConfiguration_bucket - The name of the Amazon S3 bucket whose configuration you want to modify
or retrieve.
GetBucketIntelligentTieringConfiguration, getBucketIntelligentTieringConfiguration_id - The ID used to identify the S3 Intelligent-Tiering configuration.
data GetBucketIntelligentTieringConfigurationResponse Source #
See: newGetBucketIntelligentTieringConfigurationResponse smart constructor.
Constructors
| GetBucketIntelligentTieringConfigurationResponse' (Maybe IntelligentTieringConfiguration) Int |
Instances
newGetBucketIntelligentTieringConfigurationResponse Source #
Arguments
| :: Int |
|
| -> GetBucketIntelligentTieringConfigurationResponse |
Create a value of GetBucketIntelligentTieringConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:intelligentTieringConfiguration:GetBucketIntelligentTieringConfigurationResponse', getBucketIntelligentTieringConfigurationResponse_intelligentTieringConfiguration - Container for S3 Intelligent-Tiering configuration.
$sel:httpStatus:GetBucketIntelligentTieringConfigurationResponse', getBucketIntelligentTieringConfigurationResponse_httpStatus - The response's http status code.
GetBucketInventoryConfiguration
data GetBucketInventoryConfiguration Source #
See: newGetBucketInventoryConfiguration smart constructor.
Constructors
| GetBucketInventoryConfiguration' (Maybe Text) BucketName Text |
Instances
newGetBucketInventoryConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> GetBucketInventoryConfiguration |
Create a value of GetBucketInventoryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketInventoryConfiguration', getBucketInventoryConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketInventoryConfiguration, getBucketInventoryConfiguration_bucket - The name of the bucket containing the inventory configuration to
retrieve.
GetBucketInventoryConfiguration, getBucketInventoryConfiguration_id - The ID used to identify the inventory configuration.
data GetBucketInventoryConfigurationResponse Source #
See: newGetBucketInventoryConfigurationResponse smart constructor.
Instances
newGetBucketInventoryConfigurationResponse Source #
Arguments
| :: Int | |
| -> GetBucketInventoryConfigurationResponse |
Create a value of GetBucketInventoryConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inventoryConfiguration:GetBucketInventoryConfigurationResponse', getBucketInventoryConfigurationResponse_inventoryConfiguration - Specifies the inventory configuration.
$sel:httpStatus:GetBucketInventoryConfigurationResponse', getBucketInventoryConfigurationResponse_httpStatus - The response's http status code.
GetBucketLifecycleConfiguration
data GetBucketLifecycleConfiguration Source #
See: newGetBucketLifecycleConfiguration smart constructor.
Constructors
| GetBucketLifecycleConfiguration' (Maybe Text) BucketName |
Instances
newGetBucketLifecycleConfiguration Source #
Create a value of GetBucketLifecycleConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketLifecycleConfiguration', getBucketLifecycleConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketLifecycleConfiguration, getBucketLifecycleConfiguration_bucket - The name of the bucket for which to get the lifecycle information.
data GetBucketLifecycleConfigurationResponse Source #
See: newGetBucketLifecycleConfigurationResponse smart constructor.
Constructors
| GetBucketLifecycleConfigurationResponse' (Maybe [LifecycleRule]) Int |
Instances
newGetBucketLifecycleConfigurationResponse Source #
Arguments
| :: Int | |
| -> GetBucketLifecycleConfigurationResponse |
Create a value of GetBucketLifecycleConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBucketLifecycleConfigurationResponse, getBucketLifecycleConfigurationResponse_rules - Container for a lifecycle rule.
$sel:httpStatus:GetBucketLifecycleConfigurationResponse', getBucketLifecycleConfigurationResponse_httpStatus - The response's http status code.
GetBucketLocation
data GetBucketLocation Source #
See: newGetBucketLocation smart constructor.
Constructors
| GetBucketLocation' (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> GetBucketLocation |
Create a value of GetBucketLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketLocation', getBucketLocation_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketLocation, getBucketLocation_bucket - The name of the bucket for which to get the location.
data GetBucketLocationResponse Source #
See: newGetBucketLocationResponse smart constructor.
Constructors
| GetBucketLocationResponse' Int LocationConstraint |
Instances
newGetBucketLocationResponse Source #
Arguments
| :: Int | |
| -> LocationConstraint | |
| -> GetBucketLocationResponse |
Create a value of GetBucketLocationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetBucketLocationResponse', getBucketLocationResponse_httpStatus - The response's http status code.
GetBucketLocationResponse, getBucketLocationResponse_locationConstraint - Specifies the Region where the bucket resides. For a list of all the
Amazon S3 supported location constraints by Region, see
Regions and Endpoints.
Buckets in Region us-east-1 have a LocationConstraint of null.
GetBucketLogging
data GetBucketLogging Source #
See: newGetBucketLogging smart constructor.
Constructors
| GetBucketLogging' (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> GetBucketLogging |
Create a value of GetBucketLogging with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketLogging', getBucketLogging_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketLogging, getBucketLogging_bucket - The bucket name for which to get the logging information.
data GetBucketLoggingResponse Source #
See: newGetBucketLoggingResponse smart constructor.
Constructors
| GetBucketLoggingResponse' (Maybe LoggingEnabled) Int |
Instances
newGetBucketLoggingResponse Source #
Create a value of GetBucketLoggingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBucketLoggingResponse, getBucketLoggingResponse_loggingEnabled - Undocumented member.
$sel:httpStatus:GetBucketLoggingResponse', getBucketLoggingResponse_httpStatus - The response's http status code.
GetBucketMetricsConfiguration
data GetBucketMetricsConfiguration Source #
See: newGetBucketMetricsConfiguration smart constructor.
Constructors
| GetBucketMetricsConfiguration' (Maybe Text) BucketName Text |
Instances
newGetBucketMetricsConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> GetBucketMetricsConfiguration |
Create a value of GetBucketMetricsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketMetricsConfiguration', getBucketMetricsConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketMetricsConfiguration, getBucketMetricsConfiguration_bucket - The name of the bucket containing the metrics configuration to retrieve.
GetBucketMetricsConfiguration, getBucketMetricsConfiguration_id - The ID used to identify the metrics configuration.
data GetBucketMetricsConfigurationResponse Source #
See: newGetBucketMetricsConfigurationResponse smart constructor.
Constructors
| GetBucketMetricsConfigurationResponse' (Maybe MetricsConfiguration) Int |
Instances
newGetBucketMetricsConfigurationResponse Source #
Arguments
| :: Int | |
| -> GetBucketMetricsConfigurationResponse |
Create a value of GetBucketMetricsConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricsConfiguration:GetBucketMetricsConfigurationResponse', getBucketMetricsConfigurationResponse_metricsConfiguration - Specifies the metrics configuration.
$sel:httpStatus:GetBucketMetricsConfigurationResponse', getBucketMetricsConfigurationResponse_httpStatus - The response's http status code.
GetBucketNotificationConfiguration
data GetBucketNotificationConfiguration Source #
See: newGetBucketNotificationConfiguration smart constructor.
Constructors
| GetBucketNotificationConfiguration' (Maybe Text) BucketName |
Instances
newGetBucketNotificationConfiguration Source #
Create a value of GetBucketNotificationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketNotificationConfiguration', getBucketNotificationConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketNotificationConfiguration, getBucketNotificationConfiguration_bucket - The name of the bucket for which to get the notification configuration.
data NotificationConfiguration Source #
A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.
See: newNotificationConfiguration smart constructor.
Constructors
| NotificationConfiguration' (Maybe EventBridgeConfiguration) (Maybe [LambdaFunctionConfiguration]) (Maybe [QueueConfiguration]) (Maybe [TopicConfiguration]) |
Instances
newNotificationConfiguration :: NotificationConfiguration Source #
Create a value of NotificationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventBridgeConfiguration:NotificationConfiguration', notificationConfiguration_eventBridgeConfiguration - Enables delivery of events to Amazon EventBridge.
$sel:lambdaFunctionConfigurations:NotificationConfiguration', notificationConfiguration_lambdaFunctionConfigurations - Describes the Lambda functions to invoke and the events for which to
invoke them.
$sel:queueConfigurations:NotificationConfiguration', notificationConfiguration_queueConfigurations - The Amazon Simple Queue Service queues to publish messages to and the
events for which to publish messages.
$sel:topicConfigurations:NotificationConfiguration', notificationConfiguration_topicConfigurations - The topic to which notifications are sent and the events for which
notifications are generated.
GetBucketOwnershipControls
data GetBucketOwnershipControls Source #
See: newGetBucketOwnershipControls smart constructor.
Constructors
| GetBucketOwnershipControls' (Maybe Text) BucketName |
Instances
newGetBucketOwnershipControls Source #
Create a value of GetBucketOwnershipControls with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketOwnershipControls', getBucketOwnershipControls_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketOwnershipControls, getBucketOwnershipControls_bucket - The name of the Amazon S3 bucket whose OwnershipControls you want to
retrieve.
data GetBucketOwnershipControlsResponse Source #
See: newGetBucketOwnershipControlsResponse smart constructor.
Constructors
| GetBucketOwnershipControlsResponse' (Maybe OwnershipControls) Int |
Instances
newGetBucketOwnershipControlsResponse Source #
Arguments
| :: Int | |
| -> GetBucketOwnershipControlsResponse |
Create a value of GetBucketOwnershipControlsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ownershipControls:GetBucketOwnershipControlsResponse', getBucketOwnershipControlsResponse_ownershipControls - The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or
ObjectWriter) currently in effect for this Amazon S3 bucket.
$sel:httpStatus:GetBucketOwnershipControlsResponse', getBucketOwnershipControlsResponse_httpStatus - The response's http status code.
GetBucketPolicy
data GetBucketPolicy Source #
See: newGetBucketPolicy smart constructor.
Constructors
| GetBucketPolicy' (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> GetBucketPolicy |
Create a value of GetBucketPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketPolicy', getBucketPolicy_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketPolicy, getBucketPolicy_bucket - The bucket name for which to get the bucket policy.
data GetBucketPolicyResponse Source #
See: newGetBucketPolicyResponse smart constructor.
Constructors
| GetBucketPolicyResponse' Int ByteString |
Instances
newGetBucketPolicyResponse Source #
Arguments
| :: Int | |
| -> ByteString | |
| -> GetBucketPolicyResponse |
Create a value of GetBucketPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetBucketPolicyResponse', getBucketPolicyResponse_httpStatus - The response's http status code.
$sel:policy:GetBucketPolicyResponse', getBucketPolicyResponse_policy - The bucket policy as a JSON document.
GetBucketPolicyStatus
data GetBucketPolicyStatus Source #
See: newGetBucketPolicyStatus smart constructor.
Constructors
| GetBucketPolicyStatus' (Maybe Text) BucketName |
Instances
newGetBucketPolicyStatus Source #
Arguments
| :: BucketName | |
| -> GetBucketPolicyStatus |
Create a value of GetBucketPolicyStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketPolicyStatus', getBucketPolicyStatus_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketPolicyStatus, getBucketPolicyStatus_bucket - The name of the Amazon S3 bucket whose policy status you want to
retrieve.
data GetBucketPolicyStatusResponse Source #
See: newGetBucketPolicyStatusResponse smart constructor.
Constructors
| GetBucketPolicyStatusResponse' (Maybe PolicyStatus) Int |
Instances
newGetBucketPolicyStatusResponse Source #
Create a value of GetBucketPolicyStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyStatus:GetBucketPolicyStatusResponse', getBucketPolicyStatusResponse_policyStatus - The policy status for the specified bucket.
$sel:httpStatus:GetBucketPolicyStatusResponse', getBucketPolicyStatusResponse_httpStatus - The response's http status code.
GetBucketReplication
data GetBucketReplication Source #
See: newGetBucketReplication smart constructor.
Constructors
| GetBucketReplication' (Maybe Text) BucketName |
Instances
newGetBucketReplication Source #
Arguments
| :: BucketName | |
| -> GetBucketReplication |
Create a value of GetBucketReplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketReplication', getBucketReplication_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketReplication, getBucketReplication_bucket - The bucket name for which to get the replication information.
data GetBucketReplicationResponse Source #
See: newGetBucketReplicationResponse smart constructor.
Constructors
| GetBucketReplicationResponse' (Maybe ReplicationConfiguration) Int |
Instances
newGetBucketReplicationResponse Source #
Create a value of GetBucketReplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replicationConfiguration:GetBucketReplicationResponse', getBucketReplicationResponse_replicationConfiguration - Undocumented member.
$sel:httpStatus:GetBucketReplicationResponse', getBucketReplicationResponse_httpStatus - The response's http status code.
GetBucketRequestPayment
data GetBucketRequestPayment Source #
See: newGetBucketRequestPayment smart constructor.
Constructors
| GetBucketRequestPayment' (Maybe Text) BucketName |
Instances
newGetBucketRequestPayment Source #
Arguments
| :: BucketName | |
| -> GetBucketRequestPayment |
Create a value of GetBucketRequestPayment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketRequestPayment', getBucketRequestPayment_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketRequestPayment, getBucketRequestPayment_bucket - The name of the bucket for which to get the payment request
configuration
data GetBucketRequestPaymentResponse Source #
See: newGetBucketRequestPaymentResponse smart constructor.
Constructors
| GetBucketRequestPaymentResponse' (Maybe Payer) Int |
Instances
newGetBucketRequestPaymentResponse Source #
Create a value of GetBucketRequestPaymentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBucketRequestPaymentResponse, getBucketRequestPaymentResponse_payer - Specifies who pays for the download and request fees.
$sel:httpStatus:GetBucketRequestPaymentResponse', getBucketRequestPaymentResponse_httpStatus - The response's http status code.
GetBucketTagging
data GetBucketTagging Source #
See: newGetBucketTagging smart constructor.
Constructors
| GetBucketTagging' (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> GetBucketTagging |
Create a value of GetBucketTagging with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketTagging', getBucketTagging_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketTagging, getBucketTagging_bucket - The name of the bucket for which to get the tagging information.
data GetBucketTaggingResponse Source #
See: newGetBucketTaggingResponse smart constructor.
Constructors
| GetBucketTaggingResponse' Int [Tag] |
Instances
newGetBucketTaggingResponse Source #
Create a value of GetBucketTaggingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetBucketTaggingResponse', getBucketTaggingResponse_httpStatus - The response's http status code.
GetBucketTaggingResponse, getBucketTaggingResponse_tagSet - Contains the tag set.
GetBucketVersioning
data GetBucketVersioning Source #
See: newGetBucketVersioning smart constructor.
Constructors
| GetBucketVersioning' (Maybe Text) BucketName |
Instances
newGetBucketVersioning Source #
Arguments
| :: BucketName | |
| -> GetBucketVersioning |
Create a value of GetBucketVersioning with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketVersioning', getBucketVersioning_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketVersioning, getBucketVersioning_bucket - The name of the bucket for which to get the versioning information.
data GetBucketVersioningResponse Source #
See: newGetBucketVersioningResponse smart constructor.
Constructors
| GetBucketVersioningResponse' (Maybe MFADeleteStatus) (Maybe BucketVersioningStatus) Int |
Instances
newGetBucketVersioningResponse Source #
Create a value of GetBucketVersioningResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBucketVersioningResponse, getBucketVersioningResponse_mfaDelete - 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.
GetBucketVersioningResponse, getBucketVersioningResponse_status - The versioning state of the bucket.
$sel:httpStatus:GetBucketVersioningResponse', getBucketVersioningResponse_httpStatus - The response's http status code.
GetBucketWebsite
data GetBucketWebsite Source #
See: newGetBucketWebsite smart constructor.
Constructors
| GetBucketWebsite' (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> GetBucketWebsite |
Create a value of GetBucketWebsite with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketWebsite', getBucketWebsite_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetBucketWebsite, getBucketWebsite_bucket - The bucket name for which to get the website configuration.
data GetBucketWebsiteResponse Source #
See: newGetBucketWebsiteResponse smart constructor.
Constructors
| GetBucketWebsiteResponse' (Maybe ErrorDocument) (Maybe IndexDocument) (Maybe RedirectAllRequestsTo) (Maybe [RoutingRule]) Int |
Instances
newGetBucketWebsiteResponse Source #
Create a value of GetBucketWebsiteResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBucketWebsiteResponse, getBucketWebsiteResponse_errorDocument - The object key name of the website error document to use for 4XX class
errors.
GetBucketWebsiteResponse, getBucketWebsiteResponse_indexDocument - The name of the index document for the website (for example
index.html).
GetBucketWebsiteResponse, getBucketWebsiteResponse_redirectAllRequestsTo - Specifies the redirect behavior of all requests to a website endpoint of
an Amazon S3 bucket.
GetBucketWebsiteResponse, getBucketWebsiteResponse_routingRules - Rules that define when a redirect is applied and the redirect behavior.
$sel:httpStatus:GetBucketWebsiteResponse', getBucketWebsiteResponse_httpStatus - The response's http status code.
GetObject
See: newGetObject smart constructor.
Constructors
| GetObject' (Maybe ChecksumMode) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe RFC822) (Maybe Int) (Maybe Text) (Maybe RequestPayer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> GetObject |
Create a value of GetObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumMode:GetObject', getObject_checksumMode - To retrieve the checksum, this mode must be enabled.
$sel:expectedBucketOwner:GetObject', getObject_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:ifMatch:GetObject', getObject_ifMatch - Return the object only if its entity tag (ETag) is the same as the one
specified; otherwise, return a 412 (precondition failed) error.
$sel:ifModifiedSince:GetObject', getObject_ifModifiedSince - Return the object only if it has been modified since the specified time;
otherwise, return a 304 (not modified) error.
$sel:ifNoneMatch:GetObject', getObject_ifNoneMatch - Return the object only if its entity tag (ETag) is different from the
one specified; otherwise, return a 304 (not modified) error.
$sel:ifUnmodifiedSince:GetObject', getObject_ifUnmodifiedSince - Return the object only if it has not been modified since the specified
time; otherwise, return a 412 (precondition failed) error.
GetObject, getObject_partNumber - 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.
$sel:range:GetObject', getObject_range - Downloads the specified range bytes of an object. For more information
about the HTTP Range header, see
https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
Amazon S3 doesn't support retrieving multiple ranges of data per GET
request.
$sel:requestPayer:GetObject', getObject_requestPayer - Undocumented member.
$sel:responseCacheControl:GetObject', getObject_responseCacheControl - Sets the Cache-Control header of the response.
$sel:responseContentDisposition:GetObject', getObject_responseContentDisposition - Sets the Content-Disposition header of the response
$sel:responseContentEncoding:GetObject', getObject_responseContentEncoding - Sets the Content-Encoding header of the response.
$sel:responseContentLanguage:GetObject', getObject_responseContentLanguage - Sets the Content-Language header of the response.
$sel:responseContentType:GetObject', getObject_responseContentType - Sets the Content-Type header of the response.
$sel:responseExpires:GetObject', getObject_responseExpires - Sets the Expires header of the response.
GetObject, getObject_sSECustomerAlgorithm - Specifies the algorithm to use to when decrypting the object (for
example, AES256).
$sel:sSECustomerKey:GetObject', getObject_sSECustomerKey - Specifies the customer-provided encryption key for Amazon S3 used to
encrypt the data. This value is used to decrypt the object when
recovering it and must match the one used when storing the data. The key
must be appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm header.
GetObject, getObject_sSECustomerKeyMD5 - 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
that the encryption key was transmitted without error.
GetObject, getObject_versionId - VersionId used to reference a specific version of the object.
GetObject, getObject_bucket - The bucket name containing the object.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
GetObject, getObject_key - Key of the object to get.
data GetObjectResponse Source #
See: newGetObjectResponse smart constructor.
Constructors
| GetObjectResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ETag) (Maybe Text) (Maybe RFC822) (Maybe RFC822) (HashMap Text Text) (Maybe Int) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe Int) (Maybe ReplicationStatus) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe StorageClass) (Maybe Int) (Maybe ObjectVersionId) (Maybe Text) Int ResponseBody |
Instances
Arguments
| :: Int | |
| -> ResponseBody | |
| -> GetObjectResponse |
Create a value of GetObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceptRanges:GetObjectResponse', getObjectResponse_acceptRanges - Indicates that a range of bytes was specified.
GetObjectResponse, getObjectResponse_bucketKeyEnabled - Indicates whether the object uses an S3 Bucket Key for server-side
encryption with Amazon Web Services KMS (SSE-KMS).
$sel:cacheControl:GetObjectResponse', getObjectResponse_cacheControl - Specifies caching behavior along the request/reply chain.
GetObjectResponse, getObjectResponse_checksumCRC32 - The base64-encoded, 32-bit CRC32 checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
GetObjectResponse, getObjectResponse_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
GetObjectResponse, getObjectResponse_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
GetObjectResponse, getObjectResponse_checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:contentDisposition:GetObjectResponse', getObjectResponse_contentDisposition - Specifies presentational information for the object.
$sel:contentEncoding:GetObjectResponse', getObjectResponse_contentEncoding - 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.
$sel:contentLanguage:GetObjectResponse', getObjectResponse_contentLanguage - The language the content is in.
$sel:contentLength:GetObjectResponse', getObjectResponse_contentLength - Size of the body in bytes.
$sel:contentRange:GetObjectResponse', getObjectResponse_contentRange - The portion of the object returned in the response.
$sel:contentType:GetObjectResponse', getObjectResponse_contentType - A standard MIME type describing the format of the object data.
GetObjectResponse, getObjectResponse_deleteMarker - 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.
GetObjectResponse, getObjectResponse_eTag - An entity tag (ETag) is an opaque identifier assigned by a web server to
a specific version of a resource found at a URL.
GetObjectResponse, getObjectResponse_expiration - 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.
$sel:expires:GetObjectResponse', getObjectResponse_expires - The date and time at which the object is no longer cacheable.
GetObjectResponse, getObjectResponse_lastModified - Creation date of the object.
$sel:metadata:GetObjectResponse', getObjectResponse_metadata - A map of metadata to store with the object in S3.
$sel:missingMeta:GetObjectResponse', getObjectResponse_missingMeta - 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.
$sel:objectLockLegalHoldStatus:GetObjectResponse', getObjectResponse_objectLockLegalHoldStatus - 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.
$sel:objectLockMode:GetObjectResponse', getObjectResponse_objectLockMode - The Object Lock mode currently in place for this object.
$sel:objectLockRetainUntilDate:GetObjectResponse', getObjectResponse_objectLockRetainUntilDate - The date and time when this object's Object Lock will expire.
$sel:partsCount:GetObjectResponse', getObjectResponse_partsCount - The count of parts this object has. This value is only returned if you
specify partNumber in your request and the object was uploaded as a
multipart upload.
$sel:replicationStatus:GetObjectResponse', getObjectResponse_replicationStatus - Amazon S3 can return this if your request involves a bucket that is
either a source or destination in a replication rule.
$sel:requestCharged:GetObjectResponse', getObjectResponse_requestCharged - Undocumented member.
$sel:restore:GetObjectResponse', getObjectResponse_restore - Provides information about object restoration action and expiration time
of the restored object copy.
GetObject, getObjectResponse_sSECustomerAlgorithm - If server-side encryption with a customer-provided encryption key was
requested, the response will include this header confirming the
encryption algorithm used.
GetObject, getObjectResponse_sSECustomerKeyMD5 - 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.
$sel:sSEKMSKeyId:GetObjectResponse', getObjectResponse_sSEKMSKeyId - If present, specifies the ID of the Amazon Web Services Key Management
Service (Amazon Web Services KMS) symmetric customer managed key that
was used for the object.
$sel:serverSideEncryption:GetObjectResponse', getObjectResponse_serverSideEncryption - The server-side encryption algorithm used when storing this object in
Amazon S3 (for example, AES256, aws:kms).
GetObjectResponse, getObjectResponse_storageClass - Provides storage class information of the object. Amazon S3 returns this
header for all objects except for S3 Standard storage class objects.
$sel:tagCount:GetObjectResponse', getObjectResponse_tagCount - The number of tags, if any, on the object.
GetObject, getObjectResponse_versionId - Version of the object.
$sel:websiteRedirectLocation:GetObjectResponse', getObjectResponse_websiteRedirectLocation - 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.
$sel:httpStatus:GetObjectResponse', getObjectResponse_httpStatus - The response's http status code.
$sel:body:GetObjectResponse', getObjectResponse_body - Object data.
GetObjectAcl
data GetObjectAcl Source #
See: newGetObjectAcl smart constructor.
Constructors
| GetObjectAcl' (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> GetObjectAcl |
Create a value of GetObjectAcl with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetObjectAcl', getObjectAcl_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:requestPayer:GetObjectAcl', getObjectAcl_requestPayer - Undocumented member.
GetObjectAcl, getObjectAcl_versionId - VersionId used to reference a specific version of the object.
GetObjectAcl, getObjectAcl_bucket - The bucket name that contains the object for which to get the ACL
information.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
GetObjectAcl, getObjectAcl_key - The key of the object for which to get the ACL information.
data GetObjectAclResponse Source #
See: newGetObjectAclResponse smart constructor.
Constructors
| GetObjectAclResponse' (Maybe [Grant]) (Maybe Owner) (Maybe RequestCharged) Int |
Instances
newGetObjectAclResponse Source #
Arguments
| :: Int | |
| -> GetObjectAclResponse |
Create a value of GetObjectAclResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetObjectAclResponse, getObjectAclResponse_grants - A list of grants.
GetObjectAclResponse, getObjectAclResponse_owner - Container for the bucket owner's display name and ID.
$sel:requestCharged:GetObjectAclResponse', getObjectAclResponse_requestCharged - Undocumented member.
$sel:httpStatus:GetObjectAclResponse', getObjectAclResponse_httpStatus - The response's http status code.
GetObjectAttributes
data GetObjectAttributes Source #
See: newGetObjectAttributes smart constructor.
Constructors
| GetObjectAttributes' (Maybe Text) (Maybe Int) (Maybe Int) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe ObjectVersionId) BucketName ObjectKey [ObjectAttributes] |
Instances
newGetObjectAttributes Source #
Create a value of GetObjectAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetObjectAttributes', getObjectAttributes_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetObjectAttributes, getObjectAttributes_maxParts - Sets the maximum number of parts to return.
GetObjectAttributes, getObjectAttributes_partNumberMarker - Specifies the part after which listing should begin. Only parts with
higher part numbers will be listed.
$sel:requestPayer:GetObjectAttributes', getObjectAttributes_requestPayer - Undocumented member.
$sel:sSECustomerAlgorithm:GetObjectAttributes', getObjectAttributes_sSECustomerAlgorithm - Specifies the algorithm to use when encrypting the object (for example,
AES256).
$sel:sSECustomerKey:GetObjectAttributes', getObjectAttributes_sSECustomerKey - 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 S3 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.
$sel:sSECustomerKeyMD5:GetObjectAttributes', getObjectAttributes_sSECustomerKeyMD5 - 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
that the encryption key was transmitted without error.
GetObjectAttributes, getObjectAttributes_versionId - The version ID used to reference a specific version of the object.
GetObjectAttributes, getObjectAttributes_bucket - The name of the bucket that contains the object.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
GetObjectAttributes, getObjectAttributes_key - The object key.
$sel:objectAttributes:GetObjectAttributes', getObjectAttributes_objectAttributes - An XML header that specifies the fields at the root level that you want
returned in the response. Fields that you do not specify are not
returned.
data GetObjectAttributesResponse Source #
See: newGetObjectAttributesResponse smart constructor.
Constructors
Instances
newGetObjectAttributesResponse Source #
Create a value of GetObjectAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksum:GetObjectAttributesResponse', getObjectAttributesResponse_checksum - The checksum or digest of the object.
GetObjectAttributesResponse, getObjectAttributesResponse_deleteMarker - 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.
GetObjectAttributesResponse, getObjectAttributesResponse_eTag - An ETag is an opaque identifier assigned by a web server to a specific
version of a resource found at a URL.
GetObjectAttributesResponse, getObjectAttributesResponse_lastModified - The creation date of the object.
$sel:objectParts:GetObjectAttributesResponse', getObjectAttributesResponse_objectParts - A collection of parts associated with a multipart upload.
$sel:objectSize:GetObjectAttributesResponse', getObjectAttributesResponse_objectSize - The size of the object in bytes.
$sel:requestCharged:GetObjectAttributesResponse', getObjectAttributesResponse_requestCharged - Undocumented member.
GetObjectAttributesResponse, getObjectAttributesResponse_storageClass - Provides the storage class information of the object. Amazon S3 returns
this header for all objects except for S3 Standard storage class
objects.
For more information, see Storage Classes.
GetObjectAttributes, getObjectAttributesResponse_versionId - The version ID of the object.
$sel:httpStatus:GetObjectAttributesResponse', getObjectAttributesResponse_httpStatus - The response's http status code.
GetObjectLegalHold
data GetObjectLegalHold Source #
See: newGetObjectLegalHold smart constructor.
Constructors
| GetObjectLegalHold' (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
newGetObjectLegalHold Source #
Create a value of GetObjectLegalHold with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetObjectLegalHold', getObjectLegalHold_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:requestPayer:GetObjectLegalHold', getObjectLegalHold_requestPayer - Undocumented member.
GetObjectLegalHold, getObjectLegalHold_versionId - The version ID of the object whose legal hold status you want to
retrieve.
GetObjectLegalHold, getObjectLegalHold_bucket - The bucket name containing the object whose legal hold status you want
to retrieve.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
GetObjectLegalHold, getObjectLegalHold_key - The key name for the object whose legal hold status you want to
retrieve.
data GetObjectLegalHoldResponse Source #
See: newGetObjectLegalHoldResponse smart constructor.
Constructors
| GetObjectLegalHoldResponse' (Maybe ObjectLockLegalHold) Int |
Instances
newGetObjectLegalHoldResponse Source #
Create a value of GetObjectLegalHoldResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:legalHold:GetObjectLegalHoldResponse', getObjectLegalHoldResponse_legalHold - The current legal hold status for the specified object.
$sel:httpStatus:GetObjectLegalHoldResponse', getObjectLegalHoldResponse_httpStatus - The response's http status code.
GetObjectLockConfiguration
data GetObjectLockConfiguration Source #
See: newGetObjectLockConfiguration smart constructor.
Constructors
| GetObjectLockConfiguration' (Maybe Text) BucketName |
Instances
newGetObjectLockConfiguration Source #
Create a value of GetObjectLockConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetObjectLockConfiguration', getObjectLockConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetObjectLockConfiguration, getObjectLockConfiguration_bucket - The bucket whose Object Lock configuration you want to retrieve.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
data GetObjectLockConfigurationResponse Source #
See: newGetObjectLockConfigurationResponse smart constructor.
Constructors
| GetObjectLockConfigurationResponse' (Maybe ObjectLockConfiguration) Int |
Instances
newGetObjectLockConfigurationResponse Source #
Arguments
| :: Int | |
| -> GetObjectLockConfigurationResponse |
Create a value of GetObjectLockConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectLockConfiguration:GetObjectLockConfigurationResponse', getObjectLockConfigurationResponse_objectLockConfiguration - The specified bucket's Object Lock configuration.
$sel:httpStatus:GetObjectLockConfigurationResponse', getObjectLockConfigurationResponse_httpStatus - The response's http status code.
GetObjectRetention
data GetObjectRetention Source #
See: newGetObjectRetention smart constructor.
Constructors
| GetObjectRetention' (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
newGetObjectRetention Source #
Create a value of GetObjectRetention with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetObjectRetention', getObjectRetention_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:requestPayer:GetObjectRetention', getObjectRetention_requestPayer - Undocumented member.
GetObjectRetention, getObjectRetention_versionId - The version ID for the object whose retention settings you want to
retrieve.
GetObjectRetention, getObjectRetention_bucket - The bucket name containing the object whose retention settings you want
to retrieve.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
GetObjectRetention, getObjectRetention_key - The key name for the object whose retention settings you want to
retrieve.
data GetObjectRetentionResponse Source #
See: newGetObjectRetentionResponse smart constructor.
Constructors
| GetObjectRetentionResponse' (Maybe ObjectLockRetention) Int |
Instances
newGetObjectRetentionResponse Source #
Create a value of GetObjectRetentionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:retention:GetObjectRetentionResponse', getObjectRetentionResponse_retention - The container element for an object's retention settings.
$sel:httpStatus:GetObjectRetentionResponse', getObjectRetentionResponse_httpStatus - The response's http status code.
GetObjectTagging
data GetObjectTagging Source #
See: newGetObjectTagging smart constructor.
Constructors
| GetObjectTagging' (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> GetObjectTagging |
Create a value of GetObjectTagging with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetObjectTagging', getObjectTagging_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:requestPayer:GetObjectTagging', getObjectTagging_requestPayer - Undocumented member.
GetObjectTagging, getObjectTagging_versionId - The versionId of the object for which to get the tagging information.
GetObjectTagging, getObjectTagging_bucket - The bucket name containing the object for which to get the tagging
information.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
GetObjectTagging, getObjectTagging_key - Object key for which to get the tagging information.
data GetObjectTaggingResponse Source #
See: newGetObjectTaggingResponse smart constructor.
Constructors
| GetObjectTaggingResponse' (Maybe ObjectVersionId) Int [Tag] |
Instances
newGetObjectTaggingResponse Source #
Create a value of GetObjectTaggingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetObjectTagging, getObjectTaggingResponse_versionId - The versionId of the object for which you got the tagging information.
$sel:httpStatus:GetObjectTaggingResponse', getObjectTaggingResponse_httpStatus - The response's http status code.
GetObjectTaggingResponse, getObjectTaggingResponse_tagSet - Contains the tag set.
GetObjectTorrent
data GetObjectTorrent Source #
See: newGetObjectTorrent smart constructor.
Constructors
| GetObjectTorrent' (Maybe Text) (Maybe RequestPayer) BucketName ObjectKey |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> GetObjectTorrent |
Create a value of GetObjectTorrent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetObjectTorrent', getObjectTorrent_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:requestPayer:GetObjectTorrent', getObjectTorrent_requestPayer - Undocumented member.
GetObjectTorrent, getObjectTorrent_bucket - The name of the bucket containing the object for which to get the
torrent files.
GetObjectTorrent, getObjectTorrent_key - The object key for which to get the information.
data GetObjectTorrentResponse Source #
See: newGetObjectTorrentResponse smart constructor.
Constructors
| GetObjectTorrentResponse' (Maybe RequestCharged) Int ResponseBody |
Instances
newGetObjectTorrentResponse Source #
Arguments
| :: Int | |
| -> ResponseBody | |
| -> GetObjectTorrentResponse |
Create a value of GetObjectTorrentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requestCharged:GetObjectTorrentResponse', getObjectTorrentResponse_requestCharged - Undocumented member.
$sel:httpStatus:GetObjectTorrentResponse', getObjectTorrentResponse_httpStatus - The response's http status code.
$sel:body:GetObjectTorrentResponse', getObjectTorrentResponse_body - A Bencoded dictionary as defined by the BitTorrent specification
GetPublicAccessBlock
data GetPublicAccessBlock Source #
See: newGetPublicAccessBlock smart constructor.
Constructors
| GetPublicAccessBlock' (Maybe Text) BucketName |
Instances
newGetPublicAccessBlock Source #
Arguments
| :: BucketName | |
| -> GetPublicAccessBlock |
Create a value of GetPublicAccessBlock with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetPublicAccessBlock', getPublicAccessBlock_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetPublicAccessBlock, getPublicAccessBlock_bucket - The name of the Amazon S3 bucket whose PublicAccessBlock configuration
you want to retrieve.
data GetPublicAccessBlockResponse Source #
See: newGetPublicAccessBlockResponse smart constructor.
Constructors
| GetPublicAccessBlockResponse' (Maybe PublicAccessBlockConfiguration) Int |
Instances
newGetPublicAccessBlockResponse Source #
Create a value of GetPublicAccessBlockResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:publicAccessBlockConfiguration:GetPublicAccessBlockResponse', getPublicAccessBlockResponse_publicAccessBlockConfiguration - The PublicAccessBlock configuration currently in effect for this
Amazon S3 bucket.
$sel:httpStatus:GetPublicAccessBlockResponse', getPublicAccessBlockResponse_httpStatus - The response's http status code.
HeadBucket
data HeadBucket Source #
See: newHeadBucket smart constructor.
Constructors
| HeadBucket' (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> HeadBucket |
Create a value of HeadBucket with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:HeadBucket', headBucket_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
HeadBucket, headBucket_bucket - The bucket name.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
data HeadBucketResponse Source #
See: newHeadBucketResponse smart constructor.
Constructors
| HeadBucketResponse' | |
Instances
| Generic HeadBucketResponse Source # | |
Defined in Amazonka.S3.HeadBucket Associated Types type Rep HeadBucketResponse :: Type -> Type # Methods from :: HeadBucketResponse -> Rep HeadBucketResponse x # to :: Rep HeadBucketResponse x -> HeadBucketResponse # | |
| Read HeadBucketResponse Source # | |
Defined in Amazonka.S3.HeadBucket Methods readsPrec :: Int -> ReadS HeadBucketResponse # readList :: ReadS [HeadBucketResponse] # | |
| Show HeadBucketResponse Source # | |
Defined in Amazonka.S3.HeadBucket Methods showsPrec :: Int -> HeadBucketResponse -> ShowS # show :: HeadBucketResponse -> String # showList :: [HeadBucketResponse] -> ShowS # | |
| NFData HeadBucketResponse Source # | |
Defined in Amazonka.S3.HeadBucket Methods rnf :: HeadBucketResponse -> () # | |
| Eq HeadBucketResponse Source # | |
Defined in Amazonka.S3.HeadBucket Methods (==) :: HeadBucketResponse -> HeadBucketResponse -> Bool # (/=) :: HeadBucketResponse -> HeadBucketResponse -> Bool # | |
| type Rep HeadBucketResponse Source # | |
newHeadBucketResponse :: HeadBucketResponse Source #
Create a value of HeadBucketResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
HeadObject
data HeadObject Source #
See: newHeadObject smart constructor.
Constructors
| HeadObject' (Maybe ChecksumMode) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe RFC822) (Maybe Int) (Maybe Text) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> HeadObject |
Create a value of HeadObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumMode:HeadObject', headObject_checksumMode - To retrieve the checksum, this parameter must be enabled.
In addition, if you enable ChecksumMode and the object is encrypted
with Amazon Web Services Key Management Service (Amazon Web Services
KMS), you must have permission to use the kms:Decrypt action for the
request to succeed.
$sel:expectedBucketOwner:HeadObject', headObject_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:ifMatch:HeadObject', headObject_ifMatch - Return the object only if its entity tag (ETag) is the same as the one
specified; otherwise, return a 412 (precondition failed) error.
$sel:ifModifiedSince:HeadObject', headObject_ifModifiedSince - Return the object only if it has been modified since the specified time;
otherwise, return a 304 (not modified) error.
$sel:ifNoneMatch:HeadObject', headObject_ifNoneMatch - Return the object only if its entity tag (ETag) is different from the
one specified; otherwise, return a 304 (not modified) error.
$sel:ifUnmodifiedSince:HeadObject', headObject_ifUnmodifiedSince - Return the object only if it has not been modified since the specified
time; otherwise, return a 412 (precondition failed) error.
HeadObject, headObject_partNumber - 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.
$sel:range:HeadObject', headObject_range - Because HeadObject returns only the metadata for an object, this
parameter has no effect.
$sel:requestPayer:HeadObject', headObject_requestPayer - Undocumented member.
HeadObject, headObject_sSECustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (for
example, AES256).
$sel:sSECustomerKey:HeadObject', headObject_sSECustomerKey - 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 S3 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.
HeadObject, headObject_sSECustomerKeyMD5 - 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
that the encryption key was transmitted without error.
HeadObject, headObject_versionId - VersionId used to reference a specific version of the object.
HeadObject, headObject_bucket - The name of the bucket containing the object.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
HeadObject, headObject_key - The object key.
data HeadObjectResponse Source #
See: newHeadObjectResponse smart constructor.
Constructors
| HeadObjectResponse' (Maybe Text) (Maybe ArchiveStatus) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Bool) (Maybe ETag) (Maybe Text) (Maybe RFC822) (Maybe RFC822) (HashMap Text Text) (Maybe Int) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe Int) (Maybe ReplicationStatus) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe StorageClass) (Maybe ObjectVersionId) (Maybe Text) Int |
Instances
newHeadObjectResponse Source #
Arguments
| :: Int | |
| -> HeadObjectResponse |
Create a value of HeadObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceptRanges:HeadObjectResponse', headObjectResponse_acceptRanges - Indicates that a range of bytes was specified.
$sel:archiveStatus:HeadObjectResponse', headObjectResponse_archiveStatus - The archive state of the head object.
HeadObjectResponse, headObjectResponse_bucketKeyEnabled - Indicates whether the object uses an S3 Bucket Key for server-side
encryption with Amazon Web Services KMS (SSE-KMS).
$sel:cacheControl:HeadObjectResponse', headObjectResponse_cacheControl - Specifies caching behavior along the request/reply chain.
HeadObjectResponse, headObjectResponse_checksumCRC32 - The base64-encoded, 32-bit CRC32 checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
HeadObjectResponse, headObjectResponse_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
HeadObjectResponse, headObjectResponse_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
HeadObjectResponse, headObjectResponse_checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:contentDisposition:HeadObjectResponse', headObjectResponse_contentDisposition - Specifies presentational information for the object.
$sel:contentEncoding:HeadObjectResponse', headObjectResponse_contentEncoding - 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.
$sel:contentLanguage:HeadObjectResponse', headObjectResponse_contentLanguage - The language the content is in.
$sel:contentLength:HeadObjectResponse', headObjectResponse_contentLength - Size of the body in bytes.
$sel:contentType:HeadObjectResponse', headObjectResponse_contentType - A standard MIME type describing the format of the object data.
HeadObjectResponse, headObjectResponse_deleteMarker - 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.
HeadObjectResponse, headObjectResponse_eTag - An entity tag (ETag) is an opaque identifier assigned by a web server to
a specific version of a resource found at a URL.
HeadObjectResponse, headObjectResponse_expiration - 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.
$sel:expires:HeadObjectResponse', headObjectResponse_expires - The date and time at which the object is no longer cacheable.
HeadObjectResponse, headObjectResponse_lastModified - Creation date of the object.
$sel:metadata:HeadObjectResponse', headObjectResponse_metadata - A map of metadata to store with the object in S3.
$sel:missingMeta:HeadObjectResponse', headObjectResponse_missingMeta - 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.
$sel:objectLockLegalHoldStatus:HeadObjectResponse', headObjectResponse_objectLockLegalHoldStatus - Specifies whether a legal hold is in effect for this object. This header
is only returned if the requester has the s3:GetObjectLegalHold
permission. This header is not returned if the specified version of this
object has never had a legal hold applied. For more information about S3
Object Lock, see
Object Lock.
$sel:objectLockMode:HeadObjectResponse', headObjectResponse_objectLockMode - The Object Lock mode, if any, that's in effect for this object. This
header is only returned if the requester has the s3:GetObjectRetention
permission. For more information about S3 Object Lock, see
Object Lock.
$sel:objectLockRetainUntilDate:HeadObjectResponse', headObjectResponse_objectLockRetainUntilDate - The date and time when the Object Lock retention period expires. This
header is only returned if the requester has the s3:GetObjectRetention
permission.
$sel:partsCount:HeadObjectResponse', headObjectResponse_partsCount - The count of parts this object has. This value is only returned if you
specify partNumber in your request and the object was uploaded as a
multipart upload.
$sel:replicationStatus:HeadObjectResponse', headObjectResponse_replicationStatus - Amazon S3 can return this header if your request involves a bucket that
is either a source or a destination in a replication rule.
In replication, you have a source bucket on which you configure
replication and destination bucket or buckets where Amazon S3 stores
object replicas. When you request an object (GetObject) or object
metadata (HeadObject) from these buckets, Amazon S3 will return the
x-amz-replication-status header in the response as follows:
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-statusheader if the object in your request is eligible for replication.For example, suppose that in your replication configuration, you specify object prefix
TaxDocsrequesting Amazon S3 to replicate objects with key prefixTaxDocs. Any objects you upload with this key name prefix, for exampleTaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return thex-amz-replication-statusheader with value PENDING, COMPLETED or FAILED indicating object replication status.- If requesting an object from a destination bucket, Amazon S3
will return the
x-amz-replication-statusheader with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress. - When replicating objects to multiple destination buckets, the
x-amz-replication-statusheader acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.
For more information, see Replication.
$sel:requestCharged:HeadObjectResponse', headObjectResponse_requestCharged - Undocumented member.
$sel:restore:HeadObjectResponse', headObjectResponse_restore - If the object is an archived object (an object whose storage class is
GLACIER), the response includes this header if either the archive
restoration is in progress (see
RestoreObject
or an archive copy is already restored.
If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:
x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"
If the object restoration is in progress, the header returns the value
ongoing-request="true".
For more information about archiving objects, see Transitioning Objects: General Considerations.
HeadObject, headObjectResponse_sSECustomerAlgorithm - If server-side encryption with a customer-provided encryption key was
requested, the response will include this header confirming the
encryption algorithm used.
HeadObject, headObjectResponse_sSECustomerKeyMD5 - 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.
$sel:sSEKMSKeyId:HeadObjectResponse', headObjectResponse_sSEKMSKeyId - If present, specifies the ID of the Amazon Web Services Key Management
Service (Amazon Web Services KMS) symmetric customer managed key that
was used for the object.
$sel:serverSideEncryption:HeadObjectResponse', headObjectResponse_serverSideEncryption - If the object is stored using server-side encryption either with an
Amazon Web Services KMS key or an Amazon S3-managed encryption key, the
response includes this header with the value of the server-side
encryption algorithm used when storing this object in Amazon S3 (for
example, AES256, aws:kms).
HeadObjectResponse, headObjectResponse_storageClass - Provides storage class information of the object. Amazon S3 returns this
header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
HeadObject, headObjectResponse_versionId - Version of the object.
$sel:websiteRedirectLocation:HeadObjectResponse', headObjectResponse_websiteRedirectLocation - 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.
$sel:httpStatus:HeadObjectResponse', headObjectResponse_httpStatus - The response's http status code.
ListBucketAnalyticsConfigurations
data ListBucketAnalyticsConfigurations Source #
See: newListBucketAnalyticsConfigurations smart constructor.
Constructors
| ListBucketAnalyticsConfigurations' (Maybe Text) (Maybe Text) BucketName |
Instances
newListBucketAnalyticsConfigurations Source #
Create a value of ListBucketAnalyticsConfigurations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListBucketAnalyticsConfigurations, listBucketAnalyticsConfigurations_continuationToken - The ContinuationToken that represents a placeholder from where this
request should begin.
$sel:expectedBucketOwner:ListBucketAnalyticsConfigurations', listBucketAnalyticsConfigurations_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
ListBucketAnalyticsConfigurations, listBucketAnalyticsConfigurations_bucket - The name of the bucket from which analytics configurations are
retrieved.
data ListBucketAnalyticsConfigurationsResponse Source #
See: newListBucketAnalyticsConfigurationsResponse smart constructor.
Constructors
| ListBucketAnalyticsConfigurationsResponse' (Maybe [AnalyticsConfiguration]) (Maybe Text) (Maybe Bool) (Maybe Text) Int |
Instances
newListBucketAnalyticsConfigurationsResponse Source #
Arguments
| :: Int | |
| -> ListBucketAnalyticsConfigurationsResponse |
Create a value of ListBucketAnalyticsConfigurationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:analyticsConfigurationList:ListBucketAnalyticsConfigurationsResponse', listBucketAnalyticsConfigurationsResponse_analyticsConfigurationList - The list of analytics configurations for a bucket.
ListBucketAnalyticsConfigurations, listBucketAnalyticsConfigurationsResponse_continuationToken - The marker that is used as a starting point for this analytics
configuration list response. This value is present if it was sent in the
request.
ListBucketAnalyticsConfigurationsResponse, listBucketAnalyticsConfigurationsResponse_isTruncated - 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.
$sel:nextContinuationToken:ListBucketAnalyticsConfigurationsResponse', listBucketAnalyticsConfigurationsResponse_nextContinuationToken - 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.
$sel:httpStatus:ListBucketAnalyticsConfigurationsResponse', listBucketAnalyticsConfigurationsResponse_httpStatus - The response's http status code.
ListBucketIntelligentTieringConfigurations
data ListBucketIntelligentTieringConfigurations Source #
See: newListBucketIntelligentTieringConfigurations smart constructor.
Constructors
| ListBucketIntelligentTieringConfigurations' (Maybe Text) BucketName |
Instances
newListBucketIntelligentTieringConfigurations Source #
Arguments
| :: BucketName | |
| -> ListBucketIntelligentTieringConfigurations |
Create a value of ListBucketIntelligentTieringConfigurations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListBucketIntelligentTieringConfigurations, listBucketIntelligentTieringConfigurations_continuationToken - The ContinuationToken that represents a placeholder from where this
request should begin.
ListBucketIntelligentTieringConfigurations, listBucketIntelligentTieringConfigurations_bucket - The name of the Amazon S3 bucket whose configuration you want to modify
or retrieve.
data ListBucketIntelligentTieringConfigurationsResponse Source #
See: newListBucketIntelligentTieringConfigurationsResponse smart constructor.
Constructors
| ListBucketIntelligentTieringConfigurationsResponse' (Maybe Text) (Maybe [IntelligentTieringConfiguration]) (Maybe Bool) (Maybe Text) Int |
Instances
newListBucketIntelligentTieringConfigurationsResponse Source #
Arguments
| :: Int |
|
| -> ListBucketIntelligentTieringConfigurationsResponse |
Create a value of ListBucketIntelligentTieringConfigurationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListBucketIntelligentTieringConfigurations, listBucketIntelligentTieringConfigurationsResponse_continuationToken - The ContinuationToken that represents a placeholder from where this
request should begin.
$sel:intelligentTieringConfigurationList:ListBucketIntelligentTieringConfigurationsResponse', listBucketIntelligentTieringConfigurationsResponse_intelligentTieringConfigurationList - The list of S3 Intelligent-Tiering configurations for a bucket.
ListBucketIntelligentTieringConfigurationsResponse, listBucketIntelligentTieringConfigurationsResponse_isTruncated - 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.
$sel:nextContinuationToken:ListBucketIntelligentTieringConfigurationsResponse', listBucketIntelligentTieringConfigurationsResponse_nextContinuationToken - 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.
$sel:httpStatus:ListBucketIntelligentTieringConfigurationsResponse', listBucketIntelligentTieringConfigurationsResponse_httpStatus - The response's http status code.
ListBucketInventoryConfigurations
data ListBucketInventoryConfigurations Source #
See: newListBucketInventoryConfigurations smart constructor.
Constructors
| ListBucketInventoryConfigurations' (Maybe Text) (Maybe Text) BucketName |
Instances
newListBucketInventoryConfigurations Source #
Create a value of ListBucketInventoryConfigurations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListBucketInventoryConfigurations, listBucketInventoryConfigurations_continuationToken - 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.
$sel:expectedBucketOwner:ListBucketInventoryConfigurations', listBucketInventoryConfigurations_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
ListBucketInventoryConfigurations, listBucketInventoryConfigurations_bucket - The name of the bucket containing the inventory configurations to
retrieve.
data ListBucketInventoryConfigurationsResponse Source #
See: newListBucketInventoryConfigurationsResponse smart constructor.
Constructors
| ListBucketInventoryConfigurationsResponse' (Maybe Text) (Maybe [InventoryConfiguration]) (Maybe Bool) (Maybe Text) Int |
Instances
newListBucketInventoryConfigurationsResponse Source #
Arguments
| :: Int | |
| -> ListBucketInventoryConfigurationsResponse |
Create a value of ListBucketInventoryConfigurationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListBucketInventoryConfigurations, listBucketInventoryConfigurationsResponse_continuationToken - If sent in the request, the marker that is used as a starting point for
this inventory configuration list response.
$sel:inventoryConfigurationList:ListBucketInventoryConfigurationsResponse', listBucketInventoryConfigurationsResponse_inventoryConfigurationList - The list of inventory configurations for a bucket.
ListBucketInventoryConfigurationsResponse, listBucketInventoryConfigurationsResponse_isTruncated - Tells whether the returned list of inventory configurations is complete.
A value of true indicates that the list is not complete and the
NextContinuationToken is provided for a subsequent request.
$sel:nextContinuationToken:ListBucketInventoryConfigurationsResponse', listBucketInventoryConfigurationsResponse_nextContinuationToken - 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.
$sel:httpStatus:ListBucketInventoryConfigurationsResponse', listBucketInventoryConfigurationsResponse_httpStatus - The response's http status code.
ListBucketMetricsConfigurations
data ListBucketMetricsConfigurations Source #
See: newListBucketMetricsConfigurations smart constructor.
Constructors
| ListBucketMetricsConfigurations' (Maybe Text) (Maybe Text) BucketName |
Instances
newListBucketMetricsConfigurations Source #
Create a value of ListBucketMetricsConfigurations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListBucketMetricsConfigurations, listBucketMetricsConfigurations_continuationToken - 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.
$sel:expectedBucketOwner:ListBucketMetricsConfigurations', listBucketMetricsConfigurations_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
ListBucketMetricsConfigurations, listBucketMetricsConfigurations_bucket - The name of the bucket containing the metrics configurations to
retrieve.
data ListBucketMetricsConfigurationsResponse Source #
See: newListBucketMetricsConfigurationsResponse smart constructor.
Constructors
| ListBucketMetricsConfigurationsResponse' (Maybe Text) (Maybe Bool) (Maybe [MetricsConfiguration]) (Maybe Text) Int |
Instances
newListBucketMetricsConfigurationsResponse Source #
Arguments
| :: Int | |
| -> ListBucketMetricsConfigurationsResponse |
Create a value of ListBucketMetricsConfigurationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListBucketMetricsConfigurations, listBucketMetricsConfigurationsResponse_continuationToken - 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.
ListBucketMetricsConfigurationsResponse, listBucketMetricsConfigurationsResponse_isTruncated - 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.
$sel:metricsConfigurationList:ListBucketMetricsConfigurationsResponse', listBucketMetricsConfigurationsResponse_metricsConfigurationList - The list of metrics configurations for a bucket.
$sel:nextContinuationToken:ListBucketMetricsConfigurationsResponse', listBucketMetricsConfigurationsResponse_nextContinuationToken - 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.
$sel:httpStatus:ListBucketMetricsConfigurationsResponse', listBucketMetricsConfigurationsResponse_httpStatus - The response's http status code.
ListBuckets
data ListBuckets Source #
See: newListBuckets smart constructor.
Constructors
| ListBuckets' | |
Instances
newListBuckets :: ListBuckets Source #
Create a value of ListBuckets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data ListBucketsResponse Source #
See: newListBucketsResponse smart constructor.
Instances
newListBucketsResponse Source #
Arguments
| :: Int | |
| -> ListBucketsResponse |
Create a value of ListBucketsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:buckets:ListBucketsResponse', listBucketsResponse_buckets - The list of buckets owned by the requester.
ListBucketsResponse, listBucketsResponse_owner - The owner of the buckets listed.
$sel:httpStatus:ListBucketsResponse', listBucketsResponse_httpStatus - The response's http status code.
ListMultipartUploads (Paginated)
data ListMultipartUploads Source #
See: newListMultipartUploads smart constructor.
Constructors
| ListMultipartUploads' (Maybe Delimiter) (Maybe EncodingType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) BucketName |
Instances
newListMultipartUploads Source #
Arguments
| :: BucketName | |
| -> ListMultipartUploads |
Create a value of ListMultipartUploads with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListMultipartUploads, listMultipartUploads_delimiter - Character you use to group keys.
All keys that contain the same string between the prefix, if specified,
and the first occurrence of the delimiter after the prefix are grouped
under a single result element, CommonPrefixes. If you don't specify
the prefix parameter, then the substring starts at the beginning of the
key. The keys that are grouped under CommonPrefixes result element are
not returned elsewhere in the response.
ListMultipartUploads, listMultipartUploads_encodingType - Undocumented member.
$sel:expectedBucketOwner:ListMultipartUploads', listMultipartUploads_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
ListMultipartUploads, listMultipartUploads_keyMarker - Together with upload-id-marker, this parameter specifies the multipart
upload after which listing should begin.
If upload-id-marker is not specified, only the keys lexicographically
greater than the specified key-marker will be included in the list.
If upload-id-marker is specified, any multipart uploads for a key
equal to the key-marker might also be included, provided those
multipart uploads have upload IDs lexicographically greater than the
specified upload-id-marker.
ListMultipartUploads, listMultipartUploads_maxUploads - 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.
ListMultipartUploads, listMultipartUploads_prefix - Lists in-progress uploads only for those keys that begin with the
specified prefix. You can use prefixes to separate a bucket into
different grouping of keys. (You can think of using prefix to make
groups in the same way you'd use a folder in a file system.)
ListMultipartUploads, listMultipartUploads_uploadIdMarker - 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. Otherwise, any multipart uploads
for a key equal to the key-marker might be included in the list only if
they have an upload ID lexicographically greater than the specified
upload-id-marker.
ListMultipartUploads, listMultipartUploads_bucket - The name of the bucket to which the multipart upload was initiated.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
data ListMultipartUploadsResponse Source #
See: newListMultipartUploadsResponse smart constructor.
Constructors
| ListMultipartUploadsResponse' (Maybe BucketName) (Maybe [CommonPrefix]) (Maybe Delimiter) (Maybe EncodingType) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [MultipartUpload]) Int |
Instances
newListMultipartUploadsResponse Source #
Create a value of ListMultipartUploadsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListMultipartUploads, listMultipartUploadsResponse_bucket - The name of the bucket to which the multipart upload was initiated. Does
not return the access point ARN or access point alias if used.
$sel:commonPrefixes:ListMultipartUploadsResponse', listMultipartUploadsResponse_commonPrefixes - If you specify a delimiter in the request, then the result returns each
distinct key prefix containing the delimiter in a CommonPrefixes
element. The distinct key prefixes are returned in the Prefix child
element.
ListMultipartUploads, listMultipartUploadsResponse_delimiter - Contains the delimiter you specified in the request. If you don't
specify a delimiter in your request, this element is absent from the
response.
ListMultipartUploads, listMultipartUploadsResponse_encodingType - Encoding type used by Amazon S3 to encode object keys in the response.
If you specify encoding-type request parameter, Amazon S3 includes
this element in the response, and returns encoded key name values in the
following response elements:
Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.
ListMultipartUploadsResponse, listMultipartUploadsResponse_isTruncated - 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.
ListMultipartUploads, listMultipartUploadsResponse_keyMarker - The key at or after which the listing began.
ListMultipartUploads, listMultipartUploadsResponse_maxUploads - Maximum number of multipart uploads that could have been included in the
response.
$sel:nextKeyMarker:ListMultipartUploadsResponse', listMultipartUploadsResponse_nextKeyMarker - When a list is truncated, this element specifies the value that should
be used for the key-marker request parameter in a subsequent request.
$sel:nextUploadIdMarker:ListMultipartUploadsResponse', listMultipartUploadsResponse_nextUploadIdMarker - 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.
ListMultipartUploads, listMultipartUploadsResponse_prefix - When a prefix is provided in the request, this field contains the
specified prefix. The result contains only keys starting with the
specified prefix.
ListMultipartUploads, listMultipartUploadsResponse_uploadIdMarker - Upload ID after which listing began.
$sel:uploads:ListMultipartUploadsResponse', listMultipartUploadsResponse_uploads - Container for elements related to a particular multipart upload. A
response can contain zero or more Upload elements.
$sel:httpStatus:ListMultipartUploadsResponse', listMultipartUploadsResponse_httpStatus - The response's http status code.
ListObjectVersions (Paginated)
data ListObjectVersions Source #
See: newListObjectVersions smart constructor.
Constructors
| ListObjectVersions' (Maybe Delimiter) (Maybe EncodingType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) BucketName |
Instances
newListObjectVersions Source #
Arguments
| :: BucketName | |
| -> ListObjectVersions |
Create a value of ListObjectVersions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListObjectVersions, listObjectVersions_delimiter - A delimiter is a character that you specify to group keys. All keys that
contain the same string between the prefix and the first occurrence of
the delimiter are grouped under a single result element in
CommonPrefixes. These groups are counted as one result against the
max-keys limitation. These keys are not returned elsewhere in the
response.
ListObjectVersions, listObjectVersions_encodingType - Undocumented member.
$sel:expectedBucketOwner:ListObjectVersions', listObjectVersions_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
ListObjectVersions, listObjectVersions_keyMarker - Specifies the key to start with when listing objects in a bucket.
ListObjectVersions, listObjectVersions_maxKeys - Sets the maximum number of keys returned in the response. By default the
action returns up to 1,000 key names. The response might contain fewer
keys but will never contain more. If additional keys satisfy the search
criteria, but were not returned because max-keys was exceeded, the
response contains <isTruncated>true</isTruncated>. To return the
additional keys, see key-marker and version-id-marker.
ListObjectVersions, listObjectVersions_prefix - Use this parameter to select only those keys that begin with the
specified prefix. You can use prefixes to separate a bucket into
different groupings of keys. (You can think of using prefix to make
groups in the same way you'd use a folder in a file system.) You can
use prefix with delimiter to roll up numerous objects into a single
result under CommonPrefixes.
ListObjectVersions, listObjectVersions_versionIdMarker - Specifies the object version you want to start listing from.
ListObjectVersions, listObjectVersions_bucket - The bucket name that contains the objects.
data ListObjectVersionsResponse Source #
See: newListObjectVersionsResponse smart constructor.
Constructors
| ListObjectVersionsResponse' (Maybe [CommonPrefix]) (Maybe [DeleteMarkerEntry]) (Maybe Delimiter) (Maybe EncodingType) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe BucketName) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ObjectVersion]) Int |
Instances
newListObjectVersionsResponse Source #
Create a value of ListObjectVersionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:commonPrefixes:ListObjectVersionsResponse', listObjectVersionsResponse_commonPrefixes - All of the keys rolled up into a common prefix count as a single return
when calculating the number of returns.
$sel:deleteMarkers:ListObjectVersionsResponse', listObjectVersionsResponse_deleteMarkers - Container for an object that is a delete marker.
ListObjectVersions, listObjectVersionsResponse_delimiter - The delimiter grouping the included keys. A delimiter is a character
that you specify to group keys. All keys that contain the same string
between the prefix and the first occurrence of the delimiter are grouped
under a single result element in CommonPrefixes. These groups are
counted as one result against the max-keys limitation. These keys are
not returned elsewhere in the response.
ListObjectVersions, listObjectVersionsResponse_encodingType - Encoding type used by Amazon S3 to encode object key names in the XML
response.
If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.
ListObjectVersionsResponse, listObjectVersionsResponse_isTruncated - A flag that indicates whether 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.
ListObjectVersions, listObjectVersionsResponse_keyMarker - Marks the last key returned in a truncated response.
ListObjectVersions, listObjectVersionsResponse_maxKeys - Specifies the maximum number of objects to return.
ListObjectVersionsResponse, listObjectVersionsResponse_name - The bucket name.
$sel:nextKeyMarker:ListObjectVersionsResponse', listObjectVersionsResponse_nextKeyMarker - When the number of responses exceeds the value of MaxKeys,
NextKeyMarker specifies the first key not returned that satisfies the
search criteria. Use this value for the key-marker request parameter in
a subsequent request.
$sel:nextVersionIdMarker:ListObjectVersionsResponse', listObjectVersionsResponse_nextVersionIdMarker - When the number of responses exceeds the value of MaxKeys,
NextVersionIdMarker specifies the first object version not returned
that satisfies the search criteria. Use this value for the
version-id-marker request parameter in a subsequent request.
ListObjectVersions, listObjectVersionsResponse_prefix - Selects objects that start with the value supplied by this parameter.
ListObjectVersions, listObjectVersionsResponse_versionIdMarker - Marks the last version of the key returned in a truncated response.
$sel:versions:ListObjectVersionsResponse', listObjectVersionsResponse_versions - Container for version information.
$sel:httpStatus:ListObjectVersionsResponse', listObjectVersionsResponse_httpStatus - The response's http status code.
ListObjects (Paginated)
data ListObjects Source #
See: newListObjects smart constructor.
Constructors
| ListObjects' (Maybe Delimiter) (Maybe EncodingType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe RequestPayer) BucketName |
Instances
Arguments
| :: BucketName | |
| -> ListObjects |
Create a value of ListObjects with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListObjects, listObjects_delimiter - A delimiter is a character you use to group keys.
ListObjects, listObjects_encodingType - Undocumented member.
$sel:expectedBucketOwner:ListObjects', listObjects_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
ListObjects, listObjects_marker - Marker is where you want Amazon S3 to start listing from. Amazon S3
starts listing after this specified key. Marker can be any key in the
bucket.
ListObjects, listObjects_maxKeys - Sets the maximum number of keys returned in the response. By default the
action returns up to 1,000 key names. The response might contain fewer
keys but will never contain more.
ListObjects, listObjects_prefix - Limits the response to keys that begin with the specified prefix.
$sel:requestPayer:ListObjects', listObjects_requestPayer - 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.
ListObjects, listObjects_bucket - The name of the bucket containing the objects.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
data ListObjectsResponse Source #
See: newListObjectsResponse smart constructor.
Constructors
| ListObjectsResponse' (Maybe [CommonPrefix]) (Maybe [Object]) (Maybe Delimiter) (Maybe EncodingType) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe BucketName) (Maybe Text) (Maybe Text) Int |
Instances
newListObjectsResponse Source #
Arguments
| :: Int | |
| -> ListObjectsResponse |
Create a value of ListObjectsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:commonPrefixes:ListObjectsResponse', listObjectsResponse_commonPrefixes - All of the keys (up to 1,000) rolled up in a common prefix count as a
single return when calculating the number of returns.
A response can contain CommonPrefixes only if you specify a delimiter.
CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.
CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.
For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
$sel:contents:ListObjectsResponse', listObjectsResponse_contents - Metadata about each object returned.
ListObjects, listObjectsResponse_delimiter - Causes keys that contain the same string between the prefix and the
first occurrence of the delimiter to be rolled up into a single result
element in the CommonPrefixes collection. These rolled-up keys are not
returned elsewhere in the response. Each rolled-up result counts as only
one return against the MaxKeys value.
ListObjects, listObjectsResponse_encodingType - Encoding type used by Amazon S3 to encode object keys in the response.
ListObjectsResponse, listObjectsResponse_isTruncated - A flag that indicates whether Amazon S3 returned all of the results that
satisfied the search criteria.
ListObjects, listObjectsResponse_marker - Indicates where in the bucket listing begins. Marker is included in the
response if it was sent with the request.
ListObjects, listObjectsResponse_maxKeys - The maximum number of keys returned in the response body.
ListObjectsResponse, listObjectsResponse_name - The bucket name.
$sel:nextMarker:ListObjectsResponse', listObjectsResponse_nextMarker - 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 NextMarker 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.
ListObjects, listObjectsResponse_prefix - Keys that begin with the indicated prefix.
$sel:httpStatus:ListObjectsResponse', listObjectsResponse_httpStatus - The response's http status code.
ListObjectsV2 (Paginated)
data ListObjectsV2 Source #
See: newListObjectsV2 smart constructor.
Constructors
| ListObjectsV2' (Maybe Text) (Maybe Delimiter) (Maybe EncodingType) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe RequestPayer) (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> ListObjectsV2 |
Create a value of ListObjectsV2 with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListObjectsV2, listObjectsV2_continuationToken - 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.
ListObjectsV2, listObjectsV2_delimiter - A delimiter is a character you use to group keys.
ListObjectsV2, listObjectsV2_encodingType - Encoding type used by Amazon S3 to encode object keys in the response.
$sel:expectedBucketOwner:ListObjectsV2', listObjectsV2_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:fetchOwner:ListObjectsV2', listObjectsV2_fetchOwner - 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.
ListObjectsV2, listObjectsV2_maxKeys - Sets the maximum number of keys returned in the response. By default the
action returns up to 1,000 key names. The response might contain fewer
keys but will never contain more.
ListObjectsV2, listObjectsV2_prefix - Limits the response to keys that begin with the specified prefix.
$sel:requestPayer:ListObjectsV2', listObjectsV2_requestPayer - 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.
ListObjectsV2, listObjectsV2_startAfter - 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.
ListObjectsV2, listObjectsV2_bucket - Bucket name to list.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
data ListObjectsV2Response Source #
See: newListObjectsV2Response smart constructor.
Constructors
| ListObjectsV2Response' (Maybe [CommonPrefix]) (Maybe [Object]) (Maybe Text) (Maybe Delimiter) (Maybe EncodingType) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe BucketName) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newListObjectsV2Response Source #
Create a value of ListObjectsV2Response with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:commonPrefixes:ListObjectsV2Response', listObjectsV2Response_commonPrefixes - All of the keys (up to 1,000) rolled up into a common prefix count as a
single return when calculating the number of returns.
A response can contain CommonPrefixes only if you specify a delimiter.
CommonPrefixes contains all (if there are any) keys between Prefix
and the next occurrence of the string specified by a delimiter.
CommonPrefixes lists keys that act like subdirectories in the
directory specified by Prefix.
For example, if the prefix is notes/ and the delimiter is a slash
(/) as in notes/summer/july, the common prefix is
notes/summer/. All of the keys that roll up into a common prefix
count as a single return when calculating the number of returns.
$sel:contents:ListObjectsV2Response', listObjectsV2Response_contents - Metadata about each object returned.
ListObjectsV2, listObjectsV2Response_continuationToken - If ContinuationToken was sent with the request, it is included in the
response.
ListObjectsV2, listObjectsV2Response_delimiter - Causes keys that contain the same string between the prefix and the
first occurrence of the delimiter to be rolled up into a single result
element in the CommonPrefixes collection. These rolled-up keys are not
returned elsewhere in the response. Each rolled-up result counts as only
one return against the MaxKeys value.
ListObjectsV2, listObjectsV2Response_encodingType - Encoding type used by Amazon S3 to encode object key names in the XML
response.
If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
Delimiter, Prefix, Key, and StartAfter.
ListObjectsV2Response, listObjectsV2Response_isTruncated - Set to false if all of the results were returned. Set to true if more
keys are available to return. If the number of results exceeds that
specified by MaxKeys, all of the results might not be returned.
$sel:keyCount:ListObjectsV2Response', listObjectsV2Response_keyCount - KeyCount is the number of keys returned with this request. KeyCount will
always be less than or equals to MaxKeys field. Say you ask for 50 keys,
your result will include less than equals 50 keys
ListObjectsV2, listObjectsV2Response_maxKeys - Sets the maximum number of keys returned in the response. By default the
action returns up to 1,000 key names. The response might contain fewer
keys but will never contain more.
ListObjectsV2Response, listObjectsV2Response_name - The bucket name.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
$sel:nextContinuationToken:ListObjectsV2Response', listObjectsV2Response_nextContinuationToken - 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
ListObjectsV2, listObjectsV2Response_prefix - Keys that begin with the indicated prefix.
ListObjectsV2, listObjectsV2Response_startAfter - If StartAfter was sent with the request, it is included in the response.
$sel:httpStatus:ListObjectsV2Response', listObjectsV2Response_httpStatus - The response's http status code.
ListParts (Paginated)
See: newListParts smart constructor.
Constructors
| ListParts' (Maybe Text) (Maybe Int) (Maybe Int) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) BucketName ObjectKey Text |
Instances
Create a value of ListParts with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:ListParts', listParts_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
ListParts, listParts_maxParts - Sets the maximum number of parts to return.
ListParts, listParts_partNumberMarker - Specifies the part after which listing should begin. Only parts with
higher part numbers will be listed.
$sel:requestPayer:ListParts', listParts_requestPayer - Undocumented member.
$sel:sSECustomerAlgorithm:ListParts', listParts_sSECustomerAlgorithm - The server-side encryption (SSE) algorithm used to encrypt the object.
This parameter is needed only when the object was created using a
checksum algorithm. For more information, see
Protecting data using SSE-C keys
in the Amazon S3 User Guide.
$sel:sSECustomerKey:ListParts', listParts_sSECustomerKey - The server-side encryption (SSE) customer managed key. This parameter is
needed only when the object was created using a checksum algorithm. For
more information, see
Protecting data using SSE-C keys
in the Amazon S3 User Guide.
$sel:sSECustomerKeyMD5:ListParts', listParts_sSECustomerKeyMD5 - The MD5 server-side encryption (SSE) customer managed key. This
parameter is needed only when the object was created using a checksum
algorithm. For more information, see
Protecting data using SSE-C keys
in the Amazon S3 User Guide.
ListParts, listParts_bucket - The name of the bucket to which the parts are being uploaded.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
ListParts, listParts_key - Object key for which the multipart upload was initiated.
ListParts, listParts_uploadId - Upload ID identifying the multipart upload whose parts are being listed.
data ListPartsResponse Source #
See: newListPartsResponse smart constructor.
Constructors
| ListPartsResponse' (Maybe RFC822) (Maybe Text) (Maybe BucketName) (Maybe ChecksumAlgorithm) (Maybe Initiator) (Maybe Bool) (Maybe ObjectKey) (Maybe Int) (Maybe Int) (Maybe Owner) (Maybe Int) (Maybe [Part]) (Maybe RequestCharged) (Maybe StorageClass) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> ListPartsResponse |
Create a value of ListPartsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:abortDate:ListPartsResponse', listPartsResponse_abortDate - If the bucket has a lifecycle rule configured with an action to abort
incomplete multipart uploads and the prefix in the lifecycle rule
matches the object name in the request, then the response includes this
header indicating when the initiated multipart upload will become
eligible for abort operation. For more information, see
Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
The response will also include the x-amz-abort-rule-id header that
will provide the ID of the lifecycle configuration rule that defines
this action.
$sel:abortRuleId:ListPartsResponse', listPartsResponse_abortRuleId - This header is returned along with the x-amz-abort-date header. It
identifies applicable lifecycle configuration rule that defines the
action to abort incomplete multipart uploads.
ListParts, listPartsResponse_bucket - The name of the bucket to which the multipart upload was initiated. Does
not return the access point ARN or access point alias if used.
ListPartsResponse, listPartsResponse_checksumAlgorithm - The algorithm that was used to create a checksum of the object.
ListPartsResponse, listPartsResponse_initiator - Container element that identifies who initiated the multipart upload. If
the initiator is an Amazon Web Services account, this element provides
the same information as the Owner element. If the initiator is an IAM
User, this element provides the user ARN and display name.
ListPartsResponse, listPartsResponse_isTruncated - Indicates whether the returned list of parts is truncated. A true value
indicates that the list was truncated. A list can be truncated if the
number of parts exceeds the limit returned in the MaxParts element.
ListParts, listPartsResponse_key - Object key for which the multipart upload was initiated.
ListParts, listPartsResponse_maxParts - Maximum number of parts that were allowed in the response.
ListPartsResponse, listPartsResponse_nextPartNumberMarker - 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.
ListPartsResponse, listPartsResponse_owner - Container element that identifies the object owner, after the object is
created. If multipart upload is initiated by an IAM user, this element
provides the parent account ID and display name.
ListParts, listPartsResponse_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.
ListPartsResponse, listPartsResponse_parts - Container for elements related to a particular part. A response can
contain zero or more Part elements.
$sel:requestCharged:ListPartsResponse', listPartsResponse_requestCharged - Undocumented member.
ListPartsResponse, listPartsResponse_storageClass - Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the
uploaded object.
ListParts, listPartsResponse_uploadId - Upload ID identifying the multipart upload whose parts are being listed.
$sel:httpStatus:ListPartsResponse', listPartsResponse_httpStatus - The response's http status code.
PutBucketAccelerateConfiguration
data PutBucketAccelerateConfiguration Source #
See: newPutBucketAccelerateConfiguration smart constructor.
Constructors
| PutBucketAccelerateConfiguration' (Maybe ChecksumAlgorithm) (Maybe Text) BucketName AccelerateConfiguration |
Instances
newPutBucketAccelerateConfiguration Source #
Arguments
| :: BucketName | |
| -> AccelerateConfiguration |
|
| -> PutBucketAccelerateConfiguration |
Create a value of PutBucketAccelerateConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketAccelerateConfiguration, putBucketAccelerateConfiguration_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:expectedBucketOwner:PutBucketAccelerateConfiguration', putBucketAccelerateConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketAccelerateConfiguration, putBucketAccelerateConfiguration_bucket - The name of the bucket for which the accelerate configuration is set.
$sel:accelerateConfiguration:PutBucketAccelerateConfiguration', putBucketAccelerateConfiguration_accelerateConfiguration - Container for setting the transfer acceleration state.
data PutBucketAccelerateConfigurationResponse Source #
See: newPutBucketAccelerateConfigurationResponse smart constructor.
Constructors
| PutBucketAccelerateConfigurationResponse' | |
Instances
newPutBucketAccelerateConfigurationResponse :: PutBucketAccelerateConfigurationResponse Source #
Create a value of PutBucketAccelerateConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketAcl
data PutBucketAcl Source #
See: newPutBucketAcl smart constructor.
Constructors
| PutBucketAcl' (Maybe BucketCannedACL) (Maybe AccessControlPolicy) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) BucketName |
Instances
Arguments
| :: BucketName | |
| -> PutBucketAcl |
Create a value of PutBucketAcl with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acl:PutBucketAcl', putBucketAcl_acl - The canned ACL to apply to the bucket.
$sel:accessControlPolicy:PutBucketAcl', putBucketAcl_accessControlPolicy - Contains the elements that set the ACL permissions for an object per
grantee.
PutBucketAcl, putBucketAcl_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutBucketAcl', putBucketAcl_contentMD5 - The base64-encoded 128-bit MD5 digest of the data. This header must be
used as a message integrity check to verify that the request body was
not corrupted in transit. For more information, go to
RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketAcl', putBucketAcl_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:grantFullControl:PutBucketAcl', putBucketAcl_grantFullControl - Allows grantee the read, write, read ACP, and write ACP permissions on
the bucket.
$sel:grantRead:PutBucketAcl', putBucketAcl_grantRead - Allows grantee to list the objects in the bucket.
$sel:grantReadACP:PutBucketAcl', putBucketAcl_grantReadACP - Allows grantee to read the bucket ACL.
$sel:grantWrite:PutBucketAcl', putBucketAcl_grantWrite - Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
$sel:grantWriteACP:PutBucketAcl', putBucketAcl_grantWriteACP - Allows grantee to write the ACL for the applicable bucket.
PutBucketAcl, putBucketAcl_bucket - The bucket to which to apply the ACL.
data PutBucketAclResponse Source #
See: newPutBucketAclResponse smart constructor.
Constructors
| PutBucketAclResponse' | |
Instances
newPutBucketAclResponse :: PutBucketAclResponse Source #
Create a value of PutBucketAclResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketAnalyticsConfiguration
data PutBucketAnalyticsConfiguration Source #
See: newPutBucketAnalyticsConfiguration smart constructor.
Instances
newPutBucketAnalyticsConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> AnalyticsConfiguration |
|
| -> PutBucketAnalyticsConfiguration |
Create a value of PutBucketAnalyticsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:PutBucketAnalyticsConfiguration', putBucketAnalyticsConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketAnalyticsConfiguration, putBucketAnalyticsConfiguration_bucket - The name of the bucket to which an analytics configuration is stored.
PutBucketAnalyticsConfiguration, putBucketAnalyticsConfiguration_id - The ID that identifies the analytics configuration.
$sel:analyticsConfiguration:PutBucketAnalyticsConfiguration', putBucketAnalyticsConfiguration_analyticsConfiguration - The configuration and any analyses for the analytics filter.
data PutBucketAnalyticsConfigurationResponse Source #
See: newPutBucketAnalyticsConfigurationResponse smart constructor.
Constructors
| PutBucketAnalyticsConfigurationResponse' | |
Instances
newPutBucketAnalyticsConfigurationResponse :: PutBucketAnalyticsConfigurationResponse Source #
Create a value of PutBucketAnalyticsConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketCors
data PutBucketCors Source #
See: newPutBucketCors smart constructor.
Constructors
| PutBucketCors' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName CORSConfiguration |
Instances
Arguments
| :: BucketName | |
| -> CORSConfiguration | |
| -> PutBucketCors |
Create a value of PutBucketCors with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketCors, putBucketCors_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutBucketCors', putBucketCors_contentMD5 - The base64-encoded 128-bit MD5 digest of the data. This header must be
used as a message integrity check to verify that the request body was
not corrupted in transit. For more information, go to
RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketCors', putBucketCors_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketCors, putBucketCors_bucket - Specifies the bucket impacted by the corsconfiguration.
$sel:cORSConfiguration:PutBucketCors', putBucketCors_cORSConfiguration - Describes the cross-origin access configuration for objects in an Amazon
S3 bucket. For more information, see
Enabling Cross-Origin Resource Sharing
in the Amazon S3 User Guide.
data PutBucketCorsResponse Source #
See: newPutBucketCorsResponse smart constructor.
Constructors
| PutBucketCorsResponse' | |
Instances
newPutBucketCorsResponse :: PutBucketCorsResponse Source #
Create a value of PutBucketCorsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketEncryption
data PutBucketEncryption Source #
See: newPutBucketEncryption smart constructor.
Constructors
| PutBucketEncryption' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName ServerSideEncryptionConfiguration |
Instances
newPutBucketEncryption Source #
Arguments
| :: BucketName | |
| -> ServerSideEncryptionConfiguration | |
| -> PutBucketEncryption |
Create a value of PutBucketEncryption with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketEncryption, putBucketEncryption_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutBucketEncryption', putBucketEncryption_contentMD5 - The base64-encoded 128-bit MD5 digest of the server-side encryption
configuration.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketEncryption', putBucketEncryption_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketEncryption, putBucketEncryption_bucket - Specifies default encryption for a bucket using server-side encryption
with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS).
For information about the Amazon S3 default encryption feature, see
Amazon S3 Default Bucket Encryption
in the Amazon S3 User Guide.
$sel:serverSideEncryptionConfiguration:PutBucketEncryption', putBucketEncryption_serverSideEncryptionConfiguration - Undocumented member.
data PutBucketEncryptionResponse Source #
See: newPutBucketEncryptionResponse smart constructor.
Constructors
| PutBucketEncryptionResponse' | |
Instances
newPutBucketEncryptionResponse :: PutBucketEncryptionResponse Source #
Create a value of PutBucketEncryptionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketIntelligentTieringConfiguration
data PutBucketIntelligentTieringConfiguration Source #
See: newPutBucketIntelligentTieringConfiguration smart constructor.
Constructors
| PutBucketIntelligentTieringConfiguration' BucketName Text IntelligentTieringConfiguration |
Instances
newPutBucketIntelligentTieringConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> IntelligentTieringConfiguration |
|
| -> PutBucketIntelligentTieringConfiguration |
Create a value of PutBucketIntelligentTieringConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketIntelligentTieringConfiguration, putBucketIntelligentTieringConfiguration_bucket - The name of the Amazon S3 bucket whose configuration you want to modify
or retrieve.
PutBucketIntelligentTieringConfiguration, putBucketIntelligentTieringConfiguration_id - The ID used to identify the S3 Intelligent-Tiering configuration.
$sel:intelligentTieringConfiguration:PutBucketIntelligentTieringConfiguration', putBucketIntelligentTieringConfiguration_intelligentTieringConfiguration - Container for S3 Intelligent-Tiering configuration.
data PutBucketIntelligentTieringConfigurationResponse Source #
See: newPutBucketIntelligentTieringConfigurationResponse smart constructor.
Instances
newPutBucketIntelligentTieringConfigurationResponse :: PutBucketIntelligentTieringConfigurationResponse Source #
Create a value of PutBucketIntelligentTieringConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketInventoryConfiguration
data PutBucketInventoryConfiguration Source #
See: newPutBucketInventoryConfiguration smart constructor.
Instances
newPutBucketInventoryConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> InventoryConfiguration |
|
| -> PutBucketInventoryConfiguration |
Create a value of PutBucketInventoryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:PutBucketInventoryConfiguration', putBucketInventoryConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketInventoryConfiguration, putBucketInventoryConfiguration_bucket - The name of the bucket where the inventory configuration will be stored.
PutBucketInventoryConfiguration, putBucketInventoryConfiguration_id - The ID used to identify the inventory configuration.
$sel:inventoryConfiguration:PutBucketInventoryConfiguration', putBucketInventoryConfiguration_inventoryConfiguration - Specifies the inventory configuration.
data PutBucketInventoryConfigurationResponse Source #
See: newPutBucketInventoryConfigurationResponse smart constructor.
Constructors
| PutBucketInventoryConfigurationResponse' | |
Instances
newPutBucketInventoryConfigurationResponse :: PutBucketInventoryConfigurationResponse Source #
Create a value of PutBucketInventoryConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketLifecycleConfiguration
data PutBucketLifecycleConfiguration Source #
See: newPutBucketLifecycleConfiguration smart constructor.
Constructors
| PutBucketLifecycleConfiguration' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe BucketLifecycleConfiguration) BucketName |
Instances
newPutBucketLifecycleConfiguration Source #
Create a value of PutBucketLifecycleConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketLifecycleConfiguration, putBucketLifecycleConfiguration_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:expectedBucketOwner:PutBucketLifecycleConfiguration', putBucketLifecycleConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:lifecycleConfiguration:PutBucketLifecycleConfiguration', putBucketLifecycleConfiguration_lifecycleConfiguration - Container for lifecycle rules. You can add as many as 1,000 rules.
PutBucketLifecycleConfiguration, putBucketLifecycleConfiguration_bucket - The name of the bucket for which to set the configuration.
data PutBucketLifecycleConfigurationResponse Source #
See: newPutBucketLifecycleConfigurationResponse smart constructor.
Constructors
| PutBucketLifecycleConfigurationResponse' | |
Instances
newPutBucketLifecycleConfigurationResponse :: PutBucketLifecycleConfigurationResponse Source #
Create a value of PutBucketLifecycleConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketLogging
data PutBucketLogging Source #
See: newPutBucketLogging smart constructor.
Constructors
| PutBucketLogging' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName BucketLoggingStatus |
Instances
Arguments
| :: BucketName | |
| -> BucketLoggingStatus | |
| -> PutBucketLogging |
Create a value of PutBucketLogging with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketLogging, putBucketLogging_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutBucketLogging', putBucketLogging_contentMD5 - The MD5 hash of the PutBucketLogging request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketLogging', putBucketLogging_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketLogging, putBucketLogging_bucket - The name of the bucket for which to set the logging parameters.
$sel:bucketLoggingStatus:PutBucketLogging', putBucketLogging_bucketLoggingStatus - Container for logging status information.
data PutBucketLoggingResponse Source #
See: newPutBucketLoggingResponse smart constructor.
Constructors
| PutBucketLoggingResponse' | |
Instances
newPutBucketLoggingResponse :: PutBucketLoggingResponse Source #
Create a value of PutBucketLoggingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketMetricsConfiguration
data PutBucketMetricsConfiguration Source #
See: newPutBucketMetricsConfiguration smart constructor.
Constructors
| PutBucketMetricsConfiguration' (Maybe Text) BucketName Text MetricsConfiguration |
Instances
newPutBucketMetricsConfiguration Source #
Arguments
| :: BucketName | |
| -> Text | |
| -> MetricsConfiguration | |
| -> PutBucketMetricsConfiguration |
Create a value of PutBucketMetricsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:PutBucketMetricsConfiguration', putBucketMetricsConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketMetricsConfiguration, putBucketMetricsConfiguration_bucket - The name of the bucket for which the metrics configuration is set.
PutBucketMetricsConfiguration, putBucketMetricsConfiguration_id - The ID used to identify the metrics configuration.
$sel:metricsConfiguration:PutBucketMetricsConfiguration', putBucketMetricsConfiguration_metricsConfiguration - Specifies the metrics configuration.
data PutBucketMetricsConfigurationResponse Source #
See: newPutBucketMetricsConfigurationResponse smart constructor.
Constructors
| PutBucketMetricsConfigurationResponse' | |
Instances
newPutBucketMetricsConfigurationResponse :: PutBucketMetricsConfigurationResponse Source #
Create a value of PutBucketMetricsConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketNotificationConfiguration
data PutBucketNotificationConfiguration Source #
See: newPutBucketNotificationConfiguration smart constructor.
Constructors
| PutBucketNotificationConfiguration' (Maybe Text) (Maybe Bool) BucketName NotificationConfiguration |
Instances
newPutBucketNotificationConfiguration Source #
Arguments
| :: BucketName | |
| -> NotificationConfiguration |
|
| -> PutBucketNotificationConfiguration |
Create a value of PutBucketNotificationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:PutBucketNotificationConfiguration', putBucketNotificationConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:skipDestinationValidation:PutBucketNotificationConfiguration', putBucketNotificationConfiguration_skipDestinationValidation - Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations.
True or false value.
PutBucketNotificationConfiguration, putBucketNotificationConfiguration_bucket - The name of the bucket.
$sel:notificationConfiguration:PutBucketNotificationConfiguration', putBucketNotificationConfiguration_notificationConfiguration - Undocumented member.
data PutBucketNotificationConfigurationResponse Source #
See: newPutBucketNotificationConfigurationResponse smart constructor.
Constructors
| PutBucketNotificationConfigurationResponse' | |
Instances
| Generic PutBucketNotificationConfigurationResponse Source # | |
Defined in Amazonka.S3.PutBucketNotificationConfiguration Associated Types type Rep PutBucketNotificationConfigurationResponse :: Type -> Type # | |
| Read PutBucketNotificationConfigurationResponse Source # | |
| Show PutBucketNotificationConfigurationResponse Source # | |
| NFData PutBucketNotificationConfigurationResponse Source # | |
Defined in Amazonka.S3.PutBucketNotificationConfiguration Methods | |
| Eq PutBucketNotificationConfigurationResponse Source # | |
| type Rep PutBucketNotificationConfigurationResponse Source # | |
Defined in Amazonka.S3.PutBucketNotificationConfiguration type Rep PutBucketNotificationConfigurationResponse = D1 ('MetaData "PutBucketNotificationConfigurationResponse" "Amazonka.S3.PutBucketNotificationConfiguration" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutBucketNotificationConfigurationResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) | |
newPutBucketNotificationConfigurationResponse :: PutBucketNotificationConfigurationResponse Source #
Create a value of PutBucketNotificationConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketOwnershipControls
data PutBucketOwnershipControls Source #
See: newPutBucketOwnershipControls smart constructor.
Constructors
| PutBucketOwnershipControls' (Maybe Text) (Maybe Text) BucketName OwnershipControls |
Instances
newPutBucketOwnershipControls Source #
Arguments
| :: BucketName | |
| -> OwnershipControls | |
| -> PutBucketOwnershipControls |
Create a value of PutBucketOwnershipControls with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentMD5:PutBucketOwnershipControls', putBucketOwnershipControls_contentMD5 - The MD5 hash of the OwnershipControls request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketOwnershipControls', putBucketOwnershipControls_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketOwnershipControls, putBucketOwnershipControls_bucket - The name of the Amazon S3 bucket whose OwnershipControls you want to
set.
$sel:ownershipControls:PutBucketOwnershipControls', putBucketOwnershipControls_ownershipControls - The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or
ObjectWriter) that you want to apply to this Amazon S3 bucket.
data PutBucketOwnershipControlsResponse Source #
See: newPutBucketOwnershipControlsResponse smart constructor.
Constructors
| PutBucketOwnershipControlsResponse' | |
Instances
| Generic PutBucketOwnershipControlsResponse Source # | |
Defined in Amazonka.S3.PutBucketOwnershipControls Associated Types type Rep PutBucketOwnershipControlsResponse :: Type -> Type # | |
| Read PutBucketOwnershipControlsResponse Source # | |
| Show PutBucketOwnershipControlsResponse Source # | |
Defined in Amazonka.S3.PutBucketOwnershipControls Methods showsPrec :: Int -> PutBucketOwnershipControlsResponse -> ShowS # | |
| NFData PutBucketOwnershipControlsResponse Source # | |
Defined in Amazonka.S3.PutBucketOwnershipControls Methods rnf :: PutBucketOwnershipControlsResponse -> () # | |
| Eq PutBucketOwnershipControlsResponse Source # | |
| type Rep PutBucketOwnershipControlsResponse Source # | |
Defined in Amazonka.S3.PutBucketOwnershipControls | |
newPutBucketOwnershipControlsResponse :: PutBucketOwnershipControlsResponse Source #
Create a value of PutBucketOwnershipControlsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketPolicy
data PutBucketPolicy Source #
See: newPutBucketPolicy smart constructor.
Constructors
| PutBucketPolicy' (Maybe ChecksumAlgorithm) (Maybe Bool) (Maybe Text) (Maybe Text) BucketName ByteString |
Instances
Create a value of PutBucketPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketPolicy, putBucketPolicy_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:confirmRemoveSelfBucketAccess:PutBucketPolicy', putBucketPolicy_confirmRemoveSelfBucketAccess - Set this parameter to true to confirm that you want to remove your
permissions to change this bucket policy in the future.
$sel:contentMD5:PutBucketPolicy', putBucketPolicy_contentMD5 - The MD5 hash of the request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketPolicy', putBucketPolicy_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketPolicy, putBucketPolicy_bucket - The name of the bucket.
$sel:policy:PutBucketPolicy', putBucketPolicy_policy - The bucket policy as a JSON document.
data PutBucketPolicyResponse Source #
See: newPutBucketPolicyResponse smart constructor.
Constructors
| PutBucketPolicyResponse' | |
Instances
| Generic PutBucketPolicyResponse Source # | |
Defined in Amazonka.S3.PutBucketPolicy Associated Types type Rep PutBucketPolicyResponse :: Type -> Type # Methods from :: PutBucketPolicyResponse -> Rep PutBucketPolicyResponse x # to :: Rep PutBucketPolicyResponse x -> PutBucketPolicyResponse # | |
| Read PutBucketPolicyResponse Source # | |
Defined in Amazonka.S3.PutBucketPolicy | |
| Show PutBucketPolicyResponse Source # | |
Defined in Amazonka.S3.PutBucketPolicy Methods showsPrec :: Int -> PutBucketPolicyResponse -> ShowS # show :: PutBucketPolicyResponse -> String # showList :: [PutBucketPolicyResponse] -> ShowS # | |
| NFData PutBucketPolicyResponse Source # | |
Defined in Amazonka.S3.PutBucketPolicy Methods rnf :: PutBucketPolicyResponse -> () # | |
| Eq PutBucketPolicyResponse Source # | |
Defined in Amazonka.S3.PutBucketPolicy Methods (==) :: PutBucketPolicyResponse -> PutBucketPolicyResponse -> Bool # (/=) :: PutBucketPolicyResponse -> PutBucketPolicyResponse -> Bool # | |
| type Rep PutBucketPolicyResponse Source # | |
newPutBucketPolicyResponse :: PutBucketPolicyResponse Source #
Create a value of PutBucketPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketReplication
data PutBucketReplication Source #
See: newPutBucketReplication smart constructor.
Constructors
| PutBucketReplication' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) BucketName ReplicationConfiguration |
Instances
newPutBucketReplication Source #
Arguments
| :: BucketName | |
| -> ReplicationConfiguration | |
| -> PutBucketReplication |
Create a value of PutBucketReplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketReplication, putBucketReplication_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutBucketReplication', putBucketReplication_contentMD5 - The base64-encoded 128-bit MD5 digest of the data. You must use this
header as a message integrity check to verify that the request body was
not corrupted in transit. For more information, see
RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketReplication', putBucketReplication_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:token:PutBucketReplication', putBucketReplication_token - A token to allow Object Lock to be enabled for an existing bucket.
PutBucketReplication, putBucketReplication_bucket - The name of the bucket
$sel:replicationConfiguration:PutBucketReplication', putBucketReplication_replicationConfiguration - Undocumented member.
data PutBucketReplicationResponse Source #
See: newPutBucketReplicationResponse smart constructor.
Constructors
| PutBucketReplicationResponse' | |
Instances
| Generic PutBucketReplicationResponse Source # | |
Defined in Amazonka.S3.PutBucketReplication Associated Types type Rep PutBucketReplicationResponse :: Type -> Type # | |
| Read PutBucketReplicationResponse Source # | |
| Show PutBucketReplicationResponse Source # | |
Defined in Amazonka.S3.PutBucketReplication Methods showsPrec :: Int -> PutBucketReplicationResponse -> ShowS # show :: PutBucketReplicationResponse -> String # showList :: [PutBucketReplicationResponse] -> ShowS # | |
| NFData PutBucketReplicationResponse Source # | |
Defined in Amazonka.S3.PutBucketReplication Methods rnf :: PutBucketReplicationResponse -> () # | |
| Eq PutBucketReplicationResponse Source # | |
Defined in Amazonka.S3.PutBucketReplication Methods (==) :: PutBucketReplicationResponse -> PutBucketReplicationResponse -> Bool # (/=) :: PutBucketReplicationResponse -> PutBucketReplicationResponse -> Bool # | |
| type Rep PutBucketReplicationResponse Source # | |
newPutBucketReplicationResponse :: PutBucketReplicationResponse Source #
Create a value of PutBucketReplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketRequestPayment
data PutBucketRequestPayment Source #
See: newPutBucketRequestPayment smart constructor.
Constructors
| PutBucketRequestPayment' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName RequestPaymentConfiguration |
Instances
newPutBucketRequestPayment Source #
Arguments
| :: BucketName | |
| -> RequestPaymentConfiguration | |
| -> PutBucketRequestPayment |
Create a value of PutBucketRequestPayment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketRequestPayment, putBucketRequestPayment_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutBucketRequestPayment', putBucketRequestPayment_contentMD5 - The base64-encoded 128-bit MD5 digest of the data. You must use this
header as a message integrity check to verify that the request body was
not corrupted in transit. For more information, see
RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketRequestPayment', putBucketRequestPayment_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketRequestPayment, putBucketRequestPayment_bucket - The bucket name.
$sel:requestPaymentConfiguration:PutBucketRequestPayment', putBucketRequestPayment_requestPaymentConfiguration - Container for Payer.
data PutBucketRequestPaymentResponse Source #
See: newPutBucketRequestPaymentResponse smart constructor.
Constructors
| PutBucketRequestPaymentResponse' | |
Instances
| Generic PutBucketRequestPaymentResponse Source # | |
Defined in Amazonka.S3.PutBucketRequestPayment Associated Types type Rep PutBucketRequestPaymentResponse :: Type -> Type # | |
| Read PutBucketRequestPaymentResponse Source # | |
| Show PutBucketRequestPaymentResponse Source # | |
Defined in Amazonka.S3.PutBucketRequestPayment Methods showsPrec :: Int -> PutBucketRequestPaymentResponse -> ShowS # | |
| NFData PutBucketRequestPaymentResponse Source # | |
Defined in Amazonka.S3.PutBucketRequestPayment Methods rnf :: PutBucketRequestPaymentResponse -> () # | |
| Eq PutBucketRequestPaymentResponse Source # | |
Defined in Amazonka.S3.PutBucketRequestPayment | |
| type Rep PutBucketRequestPaymentResponse Source # | |
Defined in Amazonka.S3.PutBucketRequestPayment | |
newPutBucketRequestPaymentResponse :: PutBucketRequestPaymentResponse Source #
Create a value of PutBucketRequestPaymentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketTagging
data PutBucketTagging Source #
See: newPutBucketTagging smart constructor.
Constructors
| PutBucketTagging' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName Tagging |
Instances
Arguments
| :: BucketName | |
| -> Tagging | |
| -> PutBucketTagging |
Create a value of PutBucketTagging with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketTagging, putBucketTagging_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutBucketTagging', putBucketTagging_contentMD5 - The base64-encoded 128-bit MD5 digest of the data. You must use this
header as a message integrity check to verify that the request body was
not corrupted in transit. For more information, see
RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketTagging', putBucketTagging_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketTagging, putBucketTagging_bucket - The bucket name.
PutBucketTagging, putBucketTagging_tagging - Container for the TagSet and Tag elements.
data PutBucketTaggingResponse Source #
See: newPutBucketTaggingResponse smart constructor.
Constructors
| PutBucketTaggingResponse' | |
Instances
newPutBucketTaggingResponse :: PutBucketTaggingResponse Source #
Create a value of PutBucketTaggingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketVersioning
data PutBucketVersioning Source #
See: newPutBucketVersioning smart constructor.
Constructors
| PutBucketVersioning' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) BucketName VersioningConfiguration |
Instances
newPutBucketVersioning Source #
Arguments
| :: BucketName | |
| -> VersioningConfiguration | |
| -> PutBucketVersioning |
Create a value of PutBucketVersioning with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketVersioning, putBucketVersioning_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutBucketVersioning', putBucketVersioning_contentMD5 - >The base64-encoded 128-bit MD5 digest of the data. You must use this
header as a message integrity check to verify that the request body was
not corrupted in transit. For more information, see
RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketVersioning', putBucketVersioning_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:mfa:PutBucketVersioning', putBucketVersioning_mfa - The concatenation of the authentication device's serial number, a
space, and the value that is displayed on your authentication device.
PutBucketVersioning, putBucketVersioning_bucket - The bucket name.
$sel:versioningConfiguration:PutBucketVersioning', putBucketVersioning_versioningConfiguration - Container for setting the versioning state.
data PutBucketVersioningResponse Source #
See: newPutBucketVersioningResponse smart constructor.
Constructors
| PutBucketVersioningResponse' | |
Instances
newPutBucketVersioningResponse :: PutBucketVersioningResponse Source #
Create a value of PutBucketVersioningResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBucketWebsite
data PutBucketWebsite Source #
See: newPutBucketWebsite smart constructor.
Constructors
| PutBucketWebsite' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName WebsiteConfiguration |
Instances
Arguments
| :: BucketName | |
| -> WebsiteConfiguration | |
| -> PutBucketWebsite |
Create a value of PutBucketWebsite with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketWebsite, putBucketWebsite_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutBucketWebsite', putBucketWebsite_contentMD5 - The base64-encoded 128-bit MD5 digest of the data. You must use this
header as a message integrity check to verify that the request body was
not corrupted in transit. For more information, see
RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketWebsite', putBucketWebsite_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketWebsite, putBucketWebsite_bucket - The bucket name.
$sel:websiteConfiguration:PutBucketWebsite', putBucketWebsite_websiteConfiguration - Container for the request.
data PutBucketWebsiteResponse Source #
See: newPutBucketWebsiteResponse smart constructor.
Constructors
| PutBucketWebsiteResponse' | |
Instances
newPutBucketWebsiteResponse :: PutBucketWebsiteResponse Source #
Create a value of PutBucketWebsiteResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutObject
See: newPutObject smart constructor.
Constructors
| PutObject' (Maybe ObjectCannedACL) (Maybe Bool) (Maybe Text) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (HashMap Text Text) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe StorageClass) (Maybe Text) (Maybe Text) BucketName ObjectKey RequestBody |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> RequestBody | |
| -> PutObject |
Create a value of PutObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acl:PutObject', putObject_acl - The canned ACL to apply to the object. For more information, see
Canned ACL.
This action is not supported by Amazon S3 on Outposts.
PutObject, putObject_bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key for object
encryption with server-side encryption using AWS KMS (SSE-KMS). Setting
this header to true causes Amazon S3 to use an S3 Bucket Key for
object encryption with SSE-KMS.
Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.
$sel:cacheControl:PutObject', putObject_cacheControl - Can be used to specify caching behavior along the request/reply chain.
For more information, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
PutObject, putObject_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
PutObject, putObject_checksumCRC32 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 32-bit CRC32 checksum of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
PutObject, putObject_checksumCRC32C - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 32-bit CRC32C checksum of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
PutObject, putObject_checksumSHA1 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 160-bit SHA-1 digest of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
PutObject, putObject_checksumSHA256 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 256-bit SHA-256 digest of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:contentDisposition:PutObject', putObject_contentDisposition - Specifies presentational information for the object. For more
information, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
$sel:contentEncoding:PutObject', putObject_contentEncoding - 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. For more information, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
$sel:contentLanguage:PutObject', putObject_contentLanguage - The language the content is in.
$sel:contentLength:PutObject', putObject_contentLength - Size of the body in bytes. This parameter is useful when the size of the
body cannot be determined automatically. For more information, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.
$sel:contentMD5:PutObject', putObject_contentMD5 - The base64-encoded 128-bit MD5 digest of the message (without the
headers) according to RFC 1864. This header can be used as a message
integrity check to verify that the data is the same data that was
originally sent. Although it is optional, we recommend using the
Content-MD5 mechanism as an end-to-end integrity check. For more
information about REST request authentication, see
REST Authentication.
$sel:contentType:PutObject', putObject_contentType - A standard MIME type describing the format of the contents. For more
information, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
$sel:expectedBucketOwner:PutObject', putObject_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:expires:PutObject', putObject_expires - The date and time at which the object is no longer cacheable. For more
information, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
$sel:grantFullControl:PutObject', putObject_grantFullControl - Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
object.
This action is not supported by Amazon S3 on Outposts.
$sel:grantRead:PutObject', putObject_grantRead - Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
$sel:grantReadACP:PutObject', putObject_grantReadACP - Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
$sel:grantWriteACP:PutObject', putObject_grantWriteACP - Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
$sel:metadata:PutObject', putObject_metadata - A map of metadata to store with the object in S3.
$sel:objectLockLegalHoldStatus:PutObject', putObject_objectLockLegalHoldStatus - Specifies whether a legal hold will be applied to this object. For more
information about S3 Object Lock, see
Object Lock.
$sel:objectLockMode:PutObject', putObject_objectLockMode - The Object Lock mode that you want to apply to this object.
$sel:objectLockRetainUntilDate:PutObject', putObject_objectLockRetainUntilDate - The date and time when you want this object's Object Lock to expire.
Must be formatted as a timestamp parameter.
$sel:requestPayer:PutObject', putObject_requestPayer - Undocumented member.
PutObject, putObject_sSECustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (for
example, AES256).
$sel:sSECustomerKey:PutObject', putObject_sSECustomerKey - 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 S3 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.
PutObject, putObject_sSECustomerKeyMD5 - 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
that the encryption key was transmitted without error.
PutObject, putObject_sSEKMSEncryptionContext - Specifies the Amazon Web Services KMS Encryption Context to use for
object encryption. The value of this header is a base64-encoded UTF-8
string holding JSON with the encryption context key-value pairs.
PutObject, putObject_sSEKMSKeyId - If x-amz-server-side-encryption is present and has the value of
aws:kms, this header specifies the ID of the Amazon Web Services Key
Management Service (Amazon Web Services KMS) symmetrical customer
managed key that was used for the object. If you specify
x-amz-server-side-encryption:aws:kms, but do not
provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses
the Amazon Web Services managed key to protect the data. If the KMS key
does not exist in the same account issuing the command, you must use the
full ARN and not just the ID.
PutObject, putObject_serverSideEncryption - The server-side encryption algorithm used when storing this object in
Amazon S3 (for example, AES256, aws:kms).
PutObject, putObject_storageClass - By default, Amazon S3 uses the STANDARD Storage Class to store newly
created objects. The STANDARD storage class provides high durability and
high availability. Depending on performance needs, you can specify a
different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS
Storage Class. For more information, see
Storage Classes
in the Amazon S3 User Guide.
PutObject, putObject_tagging - The tag-set for the object. The tag-set must be encoded as URL Query
parameters. (For example, "Key1=Value1")
$sel:websiteRedirectLocation:PutObject', putObject_websiteRedirectLocation - 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. For
information about object metadata, see
Object Key and Metadata.
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
x-amz-website-redirect-location: /anotherPage.html
In the following example, the request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
PutObject, putObject_bucket - The bucket name to which the PUT action was initiated.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
PutObject, putObject_key - Object key for which the PUT action was initiated.
$sel:body:PutObject', putObject_body - Object data.
data PutObjectResponse Source #
See: newPutObjectResponse smart constructor.
Constructors
| PutObjectResponse' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe Text) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe ObjectVersionId) Int |
Instances
Arguments
| :: Int | |
| -> PutObjectResponse |
Create a value of PutObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutObject, putObjectResponse_bucketKeyEnabled - Indicates whether the uploaded object uses an S3 Bucket Key for
server-side encryption with Amazon Web Services KMS (SSE-KMS).
PutObject, putObjectResponse_checksumCRC32 - The base64-encoded, 32-bit CRC32 checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
PutObject, putObjectResponse_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
PutObject, putObjectResponse_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
PutObject, putObjectResponse_checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
PutObjectResponse, putObjectResponse_eTag - Entity tag for the uploaded object.
PutObjectResponse, putObjectResponse_expiration - If the expiration is configured for the object (see
PutBucketLifecycleConfiguration),
the response includes this header. It includes the expiry-date and
rule-id key-value pairs that provide information about object
expiration. The value of the rule-id is URL-encoded.
$sel:requestCharged:PutObjectResponse', putObjectResponse_requestCharged - Undocumented member.
PutObject, putObjectResponse_sSECustomerAlgorithm - If server-side encryption with a customer-provided encryption key was
requested, the response will include this header confirming the
encryption algorithm used.
PutObject, putObjectResponse_sSECustomerKeyMD5 - 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.
PutObject, putObjectResponse_sSEKMSEncryptionContext - If present, specifies the Amazon Web Services KMS Encryption Context to
use for object encryption. The value of this header is a base64-encoded
UTF-8 string holding JSON with the encryption context key-value pairs.
PutObject, putObjectResponse_sSEKMSKeyId - If x-amz-server-side-encryption is present and has the value of
aws:kms, this header specifies the ID of the Amazon Web Services Key
Management Service (Amazon Web Services KMS) symmetric customer managed
key that was used for the object.
PutObject, putObjectResponse_serverSideEncryption - If you specified server-side encryption either with an Amazon Web
Services KMS key or Amazon S3-managed encryption key in your PUT
request, the response includes this header. It confirms the encryption
algorithm that Amazon S3 used to encrypt the object.
PutObjectResponse, putObjectResponse_versionId - Version of the object.
$sel:httpStatus:PutObjectResponse', putObjectResponse_httpStatus - The response's http status code.
PutObjectAcl
data PutObjectAcl Source #
See: newPutObjectAcl smart constructor.
Constructors
| PutObjectAcl' (Maybe ObjectCannedACL) (Maybe AccessControlPolicy) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> PutObjectAcl |
Create a value of PutObjectAcl with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acl:PutObjectAcl', putObjectAcl_acl - The canned ACL to apply to the object. For more information, see
Canned ACL.
$sel:accessControlPolicy:PutObjectAcl', putObjectAcl_accessControlPolicy - Contains the elements that set the ACL permissions for an object per
grantee.
PutObjectAcl, putObjectAcl_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutObjectAcl', putObjectAcl_contentMD5 - The base64-encoded 128-bit MD5 digest of the data. This header must be
used as a message integrity check to verify that the request body was
not corrupted in transit. For more information, go to
RFC 1864.>
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutObjectAcl', putObjectAcl_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:grantFullControl:PutObjectAcl', putObjectAcl_grantFullControl - Allows grantee the read, write, read ACP, and write ACP permissions on
the bucket.
This action is not supported by Amazon S3 on Outposts.
$sel:grantRead:PutObjectAcl', putObjectAcl_grantRead - Allows grantee to list the objects in the bucket.
This action is not supported by Amazon S3 on Outposts.
$sel:grantReadACP:PutObjectAcl', putObjectAcl_grantReadACP - Allows grantee to read the bucket ACL.
This action is not supported by Amazon S3 on Outposts.
$sel:grantWrite:PutObjectAcl', putObjectAcl_grantWrite - Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
$sel:grantWriteACP:PutObjectAcl', putObjectAcl_grantWriteACP - Allows grantee to write the ACL for the applicable bucket.
This action is not supported by Amazon S3 on Outposts.
$sel:requestPayer:PutObjectAcl', putObjectAcl_requestPayer - Undocumented member.
PutObjectAcl, putObjectAcl_versionId - VersionId used to reference a specific version of the object.
PutObjectAcl, putObjectAcl_bucket - The bucket name that contains the object to which you want to attach the
ACL.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
PutObjectAcl, putObjectAcl_key - Key for which the PUT action was initiated.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
data PutObjectAclResponse Source #
See: newPutObjectAclResponse smart constructor.
Constructors
| PutObjectAclResponse' (Maybe RequestCharged) Int |
Instances
newPutObjectAclResponse Source #
Arguments
| :: Int | |
| -> PutObjectAclResponse |
Create a value of PutObjectAclResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requestCharged:PutObjectAclResponse', putObjectAclResponse_requestCharged - Undocumented member.
$sel:httpStatus:PutObjectAclResponse', putObjectAclResponse_httpStatus - The response's http status code.
PutObjectLegalHold
data PutObjectLegalHold Source #
See: newPutObjectLegalHold smart constructor.
Constructors
| PutObjectLegalHold' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe ObjectLockLegalHold) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
newPutObjectLegalHold Source #
Create a value of PutObjectLegalHold with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutObjectLegalHold, putObjectLegalHold_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutObjectLegalHold', putObjectLegalHold_contentMD5 - The MD5 hash for the request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutObjectLegalHold', putObjectLegalHold_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:legalHold:PutObjectLegalHold', putObjectLegalHold_legalHold - Container element for the legal hold configuration you want to apply to
the specified object.
$sel:requestPayer:PutObjectLegalHold', putObjectLegalHold_requestPayer - Undocumented member.
PutObjectLegalHold, putObjectLegalHold_versionId - The version ID of the object that you want to place a legal hold on.
PutObjectLegalHold, putObjectLegalHold_bucket - The bucket name containing the object that you want to place a legal
hold on.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
PutObjectLegalHold, putObjectLegalHold_key - The key name for the object that you want to place a legal hold on.
data PutObjectLegalHoldResponse Source #
See: newPutObjectLegalHoldResponse smart constructor.
Constructors
| PutObjectLegalHoldResponse' (Maybe RequestCharged) Int |
Instances
newPutObjectLegalHoldResponse Source #
Create a value of PutObjectLegalHoldResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requestCharged:PutObjectLegalHoldResponse', putObjectLegalHoldResponse_requestCharged - Undocumented member.
$sel:httpStatus:PutObjectLegalHoldResponse', putObjectLegalHoldResponse_httpStatus - The response's http status code.
PutObjectLockConfiguration
data PutObjectLockConfiguration Source #
See: newPutObjectLockConfiguration smart constructor.
Constructors
| PutObjectLockConfiguration' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe ObjectLockConfiguration) (Maybe RequestPayer) (Maybe Text) BucketName |
Instances
newPutObjectLockConfiguration Source #
Create a value of PutObjectLockConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutObjectLockConfiguration, putObjectLockConfiguration_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutObjectLockConfiguration', putObjectLockConfiguration_contentMD5 - The MD5 hash for the request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutObjectLockConfiguration', putObjectLockConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:objectLockConfiguration:PutObjectLockConfiguration', putObjectLockConfiguration_objectLockConfiguration - The Object Lock configuration that you want to apply to the specified
bucket.
$sel:requestPayer:PutObjectLockConfiguration', putObjectLockConfiguration_requestPayer - Undocumented member.
$sel:token:PutObjectLockConfiguration', putObjectLockConfiguration_token - A token to allow Object Lock to be enabled for an existing bucket.
PutObjectLockConfiguration, putObjectLockConfiguration_bucket - The bucket whose Object Lock configuration you want to create or
replace.
data PutObjectLockConfigurationResponse Source #
See: newPutObjectLockConfigurationResponse smart constructor.
Constructors
| PutObjectLockConfigurationResponse' (Maybe RequestCharged) Int |
Instances
newPutObjectLockConfigurationResponse Source #
Arguments
| :: Int | |
| -> PutObjectLockConfigurationResponse |
Create a value of PutObjectLockConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requestCharged:PutObjectLockConfigurationResponse', putObjectLockConfigurationResponse_requestCharged - Undocumented member.
$sel:httpStatus:PutObjectLockConfigurationResponse', putObjectLockConfigurationResponse_httpStatus - The response's http status code.
PutObjectRetention
data PutObjectRetention Source #
See: newPutObjectRetention smart constructor.
Constructors
| PutObjectRetention' (Maybe Bool) (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe ObjectLockRetention) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
newPutObjectRetention Source #
Create a value of PutObjectRetention with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bypassGovernanceRetention:PutObjectRetention', putObjectRetention_bypassGovernanceRetention - Indicates whether this action should bypass Governance-mode
restrictions.
PutObjectRetention, putObjectRetention_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutObjectRetention', putObjectRetention_contentMD5 - The MD5 hash for the request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutObjectRetention', putObjectRetention_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:requestPayer:PutObjectRetention', putObjectRetention_requestPayer - Undocumented member.
$sel:retention:PutObjectRetention', putObjectRetention_retention - The container element for the Object Retention configuration.
PutObjectRetention, putObjectRetention_versionId - The version ID for the object that you want to apply this Object
Retention configuration to.
PutObjectRetention, putObjectRetention_bucket - The bucket name that contains the object you want to apply this Object
Retention configuration to.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
PutObjectRetention, putObjectRetention_key - The key name for the object that you want to apply this Object Retention
configuration to.
data PutObjectRetentionResponse Source #
See: newPutObjectRetentionResponse smart constructor.
Constructors
| PutObjectRetentionResponse' (Maybe RequestCharged) Int |
Instances
newPutObjectRetentionResponse Source #
Create a value of PutObjectRetentionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requestCharged:PutObjectRetentionResponse', putObjectRetentionResponse_requestCharged - Undocumented member.
$sel:httpStatus:PutObjectRetentionResponse', putObjectRetentionResponse_httpStatus - The response's http status code.
PutObjectTagging
data PutObjectTagging Source #
See: newPutObjectTagging smart constructor.
Constructors
| PutObjectTagging' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe ObjectVersionId) BucketName ObjectKey Tagging |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> Tagging | |
| -> PutObjectTagging |
Create a value of PutObjectTagging with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutObjectTagging, putObjectTagging_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutObjectTagging', putObjectTagging_contentMD5 - The MD5 hash for the request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutObjectTagging', putObjectTagging_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:requestPayer:PutObjectTagging', putObjectTagging_requestPayer - Undocumented member.
PutObjectTagging, putObjectTagging_versionId - The versionId of the object that the tag-set will be added to.
PutObjectTagging, putObjectTagging_bucket - The bucket name containing the object.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
PutObjectTagging, putObjectTagging_key - Name of the object key.
PutObjectTagging, putObjectTagging_tagging - Container for the TagSet and Tag elements
data PutObjectTaggingResponse Source #
See: newPutObjectTaggingResponse smart constructor.
Constructors
| PutObjectTaggingResponse' (Maybe ObjectVersionId) Int |
Instances
newPutObjectTaggingResponse Source #
Create a value of PutObjectTaggingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutObjectTagging, putObjectTaggingResponse_versionId - The versionId of the object the tag-set was added to.
$sel:httpStatus:PutObjectTaggingResponse', putObjectTaggingResponse_httpStatus - The response's http status code.
PutPublicAccessBlock
data PutPublicAccessBlock Source #
See: newPutPublicAccessBlock smart constructor.
Constructors
| PutPublicAccessBlock' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) BucketName PublicAccessBlockConfiguration |
Instances
newPutPublicAccessBlock Source #
Arguments
| :: BucketName | |
| -> PublicAccessBlockConfiguration | |
| -> PutPublicAccessBlock |
Create a value of PutPublicAccessBlock with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutPublicAccessBlock, putPublicAccessBlock_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:contentMD5:PutPublicAccessBlock', putPublicAccessBlock_contentMD5 - The MD5 hash of the PutPublicAccessBlock request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutPublicAccessBlock', putPublicAccessBlock_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutPublicAccessBlock, putPublicAccessBlock_bucket - The name of the Amazon S3 bucket whose PublicAccessBlock configuration
you want to set.
$sel:publicAccessBlockConfiguration:PutPublicAccessBlock', putPublicAccessBlock_publicAccessBlockConfiguration - 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 S3 User Guide.
data PutPublicAccessBlockResponse Source #
See: newPutPublicAccessBlockResponse smart constructor.
Constructors
| PutPublicAccessBlockResponse' | |
Instances
| Generic PutPublicAccessBlockResponse Source # | |
Defined in Amazonka.S3.PutPublicAccessBlock Associated Types type Rep PutPublicAccessBlockResponse :: Type -> Type # | |
| Read PutPublicAccessBlockResponse Source # | |
| Show PutPublicAccessBlockResponse Source # | |
Defined in Amazonka.S3.PutPublicAccessBlock Methods showsPrec :: Int -> PutPublicAccessBlockResponse -> ShowS # show :: PutPublicAccessBlockResponse -> String # showList :: [PutPublicAccessBlockResponse] -> ShowS # | |
| NFData PutPublicAccessBlockResponse Source # | |
Defined in Amazonka.S3.PutPublicAccessBlock Methods rnf :: PutPublicAccessBlockResponse -> () # | |
| Eq PutPublicAccessBlockResponse Source # | |
Defined in Amazonka.S3.PutPublicAccessBlock Methods (==) :: PutPublicAccessBlockResponse -> PutPublicAccessBlockResponse -> Bool # (/=) :: PutPublicAccessBlockResponse -> PutPublicAccessBlockResponse -> Bool # | |
| type Rep PutPublicAccessBlockResponse Source # | |
newPutPublicAccessBlockResponse :: PutPublicAccessBlockResponse Source #
Create a value of PutPublicAccessBlockResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RestoreObject
data RestoreObject Source #
See: newRestoreObject smart constructor.
Constructors
| RestoreObject' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe RequestPayer) (Maybe RestoreRequest) (Maybe ObjectVersionId) BucketName ObjectKey |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> RestoreObject |
Create a value of RestoreObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RestoreObject, restoreObject_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
$sel:expectedBucketOwner:RestoreObject', restoreObject_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:requestPayer:RestoreObject', restoreObject_requestPayer - Undocumented member.
$sel:restoreRequest:RestoreObject', restoreObject_restoreRequest - Undocumented member.
RestoreObject, restoreObject_versionId - VersionId used to reference a specific version of the object.
RestoreObject, restoreObject_bucket - The bucket name containing the object to restore.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
RestoreObject, restoreObject_key - Object key for which the action was initiated.
data RestoreObjectResponse Source #
See: newRestoreObjectResponse smart constructor.
Constructors
| RestoreObjectResponse' (Maybe RequestCharged) (Maybe Text) Int |
Instances
newRestoreObjectResponse Source #
Create a value of RestoreObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requestCharged:RestoreObjectResponse', restoreObjectResponse_requestCharged - Undocumented member.
$sel:restoreOutputPath:RestoreObjectResponse', restoreObjectResponse_restoreOutputPath - Indicates the path in the provided S3 output location where Select
results will be restored to.
$sel:httpStatus:RestoreObjectResponse', restoreObjectResponse_httpStatus - The response's http status code.
SelectObjectContent
data SelectObjectContent Source #
Request to filter 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 specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, see S3Select API Documentation.
See: newSelectObjectContent smart constructor.
Constructors
Instances
newSelectObjectContent Source #
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> Text | |
| -> ExpressionType | |
| -> InputSerialization | |
| -> OutputSerialization | |
| -> SelectObjectContent |
Create a value of SelectObjectContent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:SelectObjectContent', selectObjectContent_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:requestProgress:SelectObjectContent', selectObjectContent_requestProgress - Specifies if periodic request progress information should be enabled.
$sel:sSECustomerAlgorithm:SelectObjectContent', selectObjectContent_sSECustomerAlgorithm - The server-side encryption (SSE) algorithm used to encrypt the object.
This parameter is needed only when the object was created using a
checksum algorithm. For more information, see
Protecting data using SSE-C keys
in the Amazon S3 User Guide.
$sel:sSECustomerKey:SelectObjectContent', selectObjectContent_sSECustomerKey - The server-side encryption (SSE) customer managed key. This parameter is
needed only when the object was created using a checksum algorithm. For
more information, see
Protecting data using SSE-C keys
in the Amazon S3 User Guide.
$sel:sSECustomerKeyMD5:SelectObjectContent', selectObjectContent_sSECustomerKeyMD5 - The MD5 server-side encryption (SSE) customer managed key. This
parameter is needed only when the object was created using a checksum
algorithm. For more information, see
Protecting data using SSE-C keys
in the Amazon S3 User Guide.
$sel:scanRange:SelectObjectContent', selectObjectContent_scanRange - Specifies the byte range of the object to get the records from. A record
is processed when its first byte is contained by the range. This
parameter is optional, but when specified, it must not be empty. See RFC
2616, Section 14.35.1 about how to specify the start and end of the
range.
ScanRangemay be used in the following ways:
<scanrange><start>50</start><end>100</end></scanrange>- process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)<scanrange><start>50</start></scanrange>- process only the records starting after the byte 50<scanrange><end>50</end></scanrange>- process only the records within the last 50 bytes of the file.
SelectObjectContent, selectObjectContent_bucket - The S3 bucket.
SelectObjectContent, selectObjectContent_key - The object key.
SelectObjectContent, selectObjectContent_expression - The expression that is used to query the object.
SelectObjectContent, selectObjectContent_expressionType - The type of the provided expression (for example, SQL).
SelectObjectContent, selectObjectContent_inputSerialization - Describes the format of the data in the object that is being queried.
SelectObjectContent, selectObjectContent_outputSerialization - Describes the format of the data that you want Amazon S3 to return in
response.
data SelectObjectContentResponse Source #
See: newSelectObjectContentResponse smart constructor.
Constructors
| SelectObjectContentResponse' (Maybe SelectObjectContentEventStream) Int |
Instances
newSelectObjectContentResponse Source #
Create a value of SelectObjectContentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SelectObjectContentResponse, selectObjectContentResponse_payload - The array of results.
$sel:httpStatus:SelectObjectContentResponse', selectObjectContentResponse_httpStatus - The response's http status code.
UploadPart
data UploadPart Source #
See: newUploadPart smart constructor.
Constructors
| UploadPart' (Maybe ChecksumAlgorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) BucketName ObjectKey Int Text RequestBody |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> Int | |
| -> Text | |
| -> RequestBody | |
| -> UploadPart |
Create a value of UploadPart with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UploadPart, uploadPart_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum or x-amz-trailer header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
This checksum algorithm must be the same for all parts and it match the
checksum value supplied in the CreateMultipartUpload request.
UploadPart, uploadPart_checksumCRC32 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 32-bit CRC32 checksum of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
UploadPart, uploadPart_checksumCRC32C - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 32-bit CRC32C checksum of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
UploadPart, uploadPart_checksumSHA1 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 160-bit SHA-1 digest of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
UploadPart, uploadPart_checksumSHA256 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 256-bit SHA-256 digest of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:contentLength:UploadPart', uploadPart_contentLength - Size of the body in bytes. This parameter is useful when the size of the
body cannot be determined automatically.
$sel:contentMD5:UploadPart', uploadPart_contentMD5 - The base64-encoded 128-bit MD5 digest of the part data. This parameter
is auto-populated when using the command from the CLI. This parameter is
required if object lock parameters are specified.
$sel:expectedBucketOwner:UploadPart', uploadPart_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:requestPayer:UploadPart', uploadPart_requestPayer - Undocumented member.
UploadPart, uploadPart_sSECustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (for
example, AES256).
$sel:sSECustomerKey:UploadPart', uploadPart_sSECustomerKey - 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 S3 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.
UploadPart, uploadPart_sSECustomerKeyMD5 - 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
that the encryption key was transmitted without error.
UploadPart, uploadPart_bucket - The name of the bucket to which the multipart upload was initiated.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
UploadPart, uploadPart_key - Object key for which the multipart upload was initiated.
UploadPart, uploadPart_partNumber - Part number of part being uploaded. This is a positive integer between 1
and 10,000.
UploadPart, uploadPart_uploadId - Upload ID identifying the multipart upload whose part is being uploaded.
$sel:body:UploadPart', uploadPart_body - Object data.
data UploadPartResponse Source #
See: newUploadPartResponse smart constructor.
Constructors
| UploadPartResponse' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) Int |
Instances
newUploadPartResponse Source #
Arguments
| :: Int | |
| -> UploadPartResponse |
Create a value of UploadPartResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UploadPartResponse, uploadPartResponse_bucketKeyEnabled - Indicates whether the multipart upload uses an S3 Bucket Key for
server-side encryption with Amazon Web Services KMS (SSE-KMS).
UploadPart, uploadPartResponse_checksumCRC32 - The base64-encoded, 32-bit CRC32 checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
UploadPart, uploadPartResponse_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
UploadPart, uploadPartResponse_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
UploadPart, uploadPartResponse_checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
UploadPartResponse, uploadPartResponse_eTag - Entity tag for the uploaded object.
$sel:requestCharged:UploadPartResponse', uploadPartResponse_requestCharged - Undocumented member.
UploadPart, uploadPartResponse_sSECustomerAlgorithm - If server-side encryption with a customer-provided encryption key was
requested, the response will include this header confirming the
encryption algorithm used.
UploadPart, uploadPartResponse_sSECustomerKeyMD5 - 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.
$sel:sSEKMSKeyId:UploadPartResponse', uploadPartResponse_sSEKMSKeyId - If present, specifies the ID of the Amazon Web Services Key Management
Service (Amazon Web Services KMS) symmetric customer managed key was
used for the object.
$sel:serverSideEncryption:UploadPartResponse', uploadPartResponse_serverSideEncryption - The server-side encryption algorithm used when storing this object in
Amazon S3 (for example, AES256, aws:kms).
$sel:httpStatus:UploadPartResponse', uploadPartResponse_httpStatus - The response's http status code.
UploadPartCopy
data UploadPartCopy Source #
See: newUploadPartCopy smart constructor.
Constructors
| UploadPartCopy' (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe RFC822) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RequestPayer) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) BucketName Text ObjectKey Int Text |
Instances
Arguments
| :: BucketName | |
| -> Text | |
| -> ObjectKey | |
| -> Int | |
| -> Text | |
| -> UploadPartCopy |
Create a value of UploadPartCopy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copySourceIfMatch:UploadPartCopy', uploadPartCopy_copySourceIfMatch - Copies the object if its entity tag (ETag) matches the specified tag.
$sel:copySourceIfModifiedSince:UploadPartCopy', uploadPartCopy_copySourceIfModifiedSince - Copies the object if it has been modified since the specified time.
$sel:copySourceIfNoneMatch:UploadPartCopy', uploadPartCopy_copySourceIfNoneMatch - Copies the object if its entity tag (ETag) is different than the
specified ETag.
$sel:copySourceIfUnmodifiedSince:UploadPartCopy', uploadPartCopy_copySourceIfUnmodifiedSince - Copies the object if it hasn't been modified since the specified time.
$sel:copySourceRange:UploadPartCopy', uploadPartCopy_copySourceRange - 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 10 bytes of the source. You can copy a range
only if the source object is greater than 5 MB.
$sel:copySourceSSECustomerAlgorithm:UploadPartCopy', uploadPartCopy_copySourceSSECustomerAlgorithm - Specifies the algorithm to use when decrypting the source object (for
example, AES256).
$sel:copySourceSSECustomerKey:UploadPartCopy', uploadPartCopy_copySourceSSECustomerKey - 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.
$sel:copySourceSSECustomerKeyMD5:UploadPartCopy', uploadPartCopy_copySourceSSECustomerKeyMD5 - 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
that the encryption key was transmitted without error.
$sel:expectedBucketOwner:UploadPartCopy', uploadPartCopy_expectedBucketOwner - The account ID of the expected destination bucket owner. If the
destination bucket is owned by a different account, the request fails
with the HTTP status code 403 Forbidden (access denied).
$sel:expectedSourceBucketOwner:UploadPartCopy', uploadPartCopy_expectedSourceBucketOwner - The account ID of the expected source bucket owner. If the source bucket
is owned by a different account, the request fails with the HTTP status
code 403 Forbidden (access denied).
$sel:requestPayer:UploadPartCopy', uploadPartCopy_requestPayer - Undocumented member.
UploadPartCopy, uploadPartCopy_sSECustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (for
example, AES256).
$sel:sSECustomerKey:UploadPartCopy', uploadPartCopy_sSECustomerKey - 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 S3 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.
UploadPartCopy, uploadPartCopy_sSECustomerKeyMD5 - 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
that the encryption key was transmitted without error.
UploadPartCopy, uploadPartCopy_bucket - The bucket name.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
$sel:copySource:UploadPartCopy', uploadPartCopy_copySource - Specifies the source object for the copy operation. You specify the
value in one of two formats, depending on whether you want to access the
source object through an
access point:
- For objects not accessed through an access point, specify the name
of the source bucket and key of the source object, separated by a
slash (/). For example, to copy the object
reports/january.pdffrom the bucketawsexamplebucket, useawsexamplebucket/reports/january.pdf. The value must be URL-encoded. For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format
arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the objectreports/january.pdfthrough access pointmy-access-pointowned by account123456789012in Regionus-west-2, use the URL encoding ofarn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the objectreports/january.pdfthrough outpostmy-outpostowned by account123456789012in Regionus-west-2, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.
To copy a specific version of an object, append
?versionId=<version-id> to the value (for example,
awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).
If you don't specify a version ID, Amazon S3 copies the latest version
of the source object.
UploadPartCopy, uploadPartCopy_key - Object key for which the multipart upload was initiated.
UploadPartCopy, uploadPartCopy_partNumber - Part number of part being copied. This is a positive integer between 1
and 10,000.
UploadPartCopy, uploadPartCopy_uploadId - Upload ID identifying the multipart upload whose part is being copied.
data UploadPartCopyResponse Source #
See: newUploadPartCopyResponse smart constructor.
Constructors
| UploadPartCopyResponse' (Maybe Bool) (Maybe CopyPartResult) (Maybe Text) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) Int |
Instances
newUploadPartCopyResponse Source #
Create a value of UploadPartCopyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UploadPartCopyResponse, uploadPartCopyResponse_bucketKeyEnabled - Indicates whether the multipart upload uses an S3 Bucket Key for
server-side encryption with Amazon Web Services KMS (SSE-KMS).
$sel:copyPartResult:UploadPartCopyResponse', uploadPartCopyResponse_copyPartResult - Container for all response elements.
$sel:copySourceVersionId:UploadPartCopyResponse', uploadPartCopyResponse_copySourceVersionId - The version of the source object that was copied, if you have enabled
versioning on the source bucket.
$sel:requestCharged:UploadPartCopyResponse', uploadPartCopyResponse_requestCharged - Undocumented member.
UploadPartCopy, uploadPartCopyResponse_sSECustomerAlgorithm - If server-side encryption with a customer-provided encryption key was
requested, the response will include this header confirming the
encryption algorithm used.
UploadPartCopy, uploadPartCopyResponse_sSECustomerKeyMD5 - 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.
$sel:sSEKMSKeyId:UploadPartCopyResponse', uploadPartCopyResponse_sSEKMSKeyId - If present, specifies the ID of the Amazon Web Services Key Management
Service (Amazon Web Services KMS) symmetric customer managed key that
was used for the object.
$sel:serverSideEncryption:UploadPartCopyResponse', uploadPartCopyResponse_serverSideEncryption - The server-side encryption algorithm used when storing this object in
Amazon S3 (for example, AES256, aws:kms).
$sel:httpStatus:UploadPartCopyResponse', uploadPartCopyResponse_httpStatus - The response's http status code.
WriteGetObjectResponse
data WriteGetObjectResponse Source #
See: newWriteGetObjectResponse smart constructor.
Constructors
| WriteGetObjectResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ETag) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RFC822) (Maybe RFC822) (HashMap Text Text) (Maybe Int) (Maybe ObjectLockLegalHoldStatus) (Maybe ObjectLockMode) (Maybe ISO8601) (Maybe Int) (Maybe ReplicationStatus) (Maybe RequestCharged) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ServerSideEncryption) (Maybe Int) (Maybe StorageClass) (Maybe Int) (Maybe ObjectVersionId) Text Text RequestBody |
Instances
newWriteGetObjectResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> RequestBody | |
| -> WriteGetObjectResponse |
Create a value of WriteGetObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceptRanges:WriteGetObjectResponse', writeGetObjectResponse_acceptRanges - Indicates that a range of bytes was specified.
WriteGetObjectResponse, writeGetObjectResponse_bucketKeyEnabled - Indicates whether the object stored in Amazon S3 uses an S3 bucket key
for server-side encryption with Amazon Web Services KMS (SSE-KMS).
$sel:cacheControl:WriteGetObjectResponse', writeGetObjectResponse_cacheControl - Specifies caching behavior along the request/reply chain.
WriteGetObjectResponse, writeGetObjectResponse_checksumCRC32 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This specifies
the base64-encoded, 32-bit CRC32 checksum of the object returned by the
Object Lambda function. This may not match the checksum for the object
stored in Amazon S3. Amazon S3 will perform validation of the checksum
values only when the original GetObject request required checksum
validation. For more information about checksums, see
Checking object integrity
in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
WriteGetObjectResponse, writeGetObjectResponse_checksumCRC32C - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This specifies
the base64-encoded, 32-bit CRC32C checksum of the object returned by the
Object Lambda function. This may not match the checksum for the object
stored in Amazon S3. Amazon S3 will perform validation of the checksum
values only when the original GetObject request required checksum
validation. For more information about checksums, see
Checking object integrity
in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
WriteGetObjectResponse, writeGetObjectResponse_checksumSHA1 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This specifies
the base64-encoded, 160-bit SHA-1 digest of the object returned by the
Object Lambda function. This may not match the checksum for the object
stored in Amazon S3. Amazon S3 will perform validation of the checksum
values only when the original GetObject request required checksum
validation. For more information about checksums, see
Checking object integrity
in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
WriteGetObjectResponse, writeGetObjectResponse_checksumSHA256 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This specifies
the base64-encoded, 256-bit SHA-256 digest of the object returned by the
Object Lambda function. This may not match the checksum for the object
stored in Amazon S3. Amazon S3 will perform validation of the checksum
values only when the original GetObject request required checksum
validation. For more information about checksums, see
Checking object integrity
in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
$sel:contentDisposition:WriteGetObjectResponse', writeGetObjectResponse_contentDisposition - Specifies presentational information for the object.
$sel:contentEncoding:WriteGetObjectResponse', writeGetObjectResponse_contentEncoding - 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.
$sel:contentLanguage:WriteGetObjectResponse', writeGetObjectResponse_contentLanguage - The language the content is in.
$sel:contentLength:WriteGetObjectResponse', writeGetObjectResponse_contentLength - The size of the content body in bytes.
$sel:contentRange:WriteGetObjectResponse', writeGetObjectResponse_contentRange - The portion of the object returned in the response.
$sel:contentType:WriteGetObjectResponse', writeGetObjectResponse_contentType - A standard MIME type describing the format of the object data.
WriteGetObjectResponse, writeGetObjectResponse_deleteMarker - Specifies whether an object stored in Amazon S3 is (true) or is not
(false) a delete marker.
WriteGetObjectResponse, writeGetObjectResponse_eTag - An opaque identifier assigned by a web server to a specific version of a
resource found at a URL.
$sel:errorCode:WriteGetObjectResponse', writeGetObjectResponse_errorCode - A string that uniquely identifies an error condition. Returned in the
<Code> tag of the error XML response for a corresponding GetObject
call. Cannot be used with a successful StatusCode header or when the
transformed object is provided in the body. All error codes from S3 are
sentence-cased. The regular expression (regex) value is
"^[A-Z][a-zA-Z]+$".
$sel:errorMessage:WriteGetObjectResponse', writeGetObjectResponse_errorMessage - Contains a generic description of the error condition. Returned in the
<Message> tag of the error XML response for a corresponding GetObject
call. Cannot be used with a successful StatusCode header or when the
transformed object is provided in body.
WriteGetObjectResponse, writeGetObjectResponse_expiration - 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 that provide the object expiration
information. The value of the rule-id is URL-encoded.
$sel:expires:WriteGetObjectResponse', writeGetObjectResponse_expires - The date and time at which the object is no longer cacheable.
WriteGetObjectResponse, writeGetObjectResponse_lastModified - The date and time that the object was last modified.
$sel:metadata:WriteGetObjectResponse', writeGetObjectResponse_metadata - A map of metadata to store with the object in S3.
$sel:missingMeta:WriteGetObjectResponse', writeGetObjectResponse_missingMeta - 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.
$sel:objectLockLegalHoldStatus:WriteGetObjectResponse', writeGetObjectResponse_objectLockLegalHoldStatus - Indicates whether an object stored in Amazon S3 has an active legal
hold.
$sel:objectLockMode:WriteGetObjectResponse', writeGetObjectResponse_objectLockMode - Indicates whether an object stored in Amazon S3 has Object Lock enabled.
For more information about S3 Object Lock, see
Object Lock.
$sel:objectLockRetainUntilDate:WriteGetObjectResponse', writeGetObjectResponse_objectLockRetainUntilDate - The date and time when Object Lock is configured to expire.
$sel:partsCount:WriteGetObjectResponse', writeGetObjectResponse_partsCount - The count of parts this object has.
$sel:replicationStatus:WriteGetObjectResponse', writeGetObjectResponse_replicationStatus - Indicates if request involves bucket that is either a source or
destination in a Replication rule. For more information about S3
Replication, see
Replication.
$sel:requestCharged:WriteGetObjectResponse', writeGetObjectResponse_requestCharged - Undocumented member.
$sel:restore:WriteGetObjectResponse', writeGetObjectResponse_restore - Provides information about object restoration operation and expiration
time of the restored object copy.
$sel:sSECustomerAlgorithm:WriteGetObjectResponse', writeGetObjectResponse_sSECustomerAlgorithm - Encryption algorithm used if server-side encryption with a
customer-provided encryption key was specified for object stored in
Amazon S3.
$sel:sSECustomerKeyMD5:WriteGetObjectResponse', writeGetObjectResponse_sSECustomerKeyMD5 - 128-bit MD5 digest of customer-provided encryption key used in Amazon S3
to encrypt data stored in S3. For more information, see
Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).
$sel:sSEKMSKeyId:WriteGetObjectResponse', writeGetObjectResponse_sSEKMSKeyId - If present, specifies the ID of the Amazon Web Services Key Management
Service (Amazon Web Services KMS) symmetric customer managed key that
was used for stored in Amazon S3 object.
$sel:serverSideEncryption:WriteGetObjectResponse', writeGetObjectResponse_serverSideEncryption - The server-side encryption algorithm used when storing requested object
in Amazon S3 (for example, AES256, aws:kms).
$sel:statusCode:WriteGetObjectResponse', writeGetObjectResponse_statusCode - The integer status code for an HTTP response of a corresponding
GetObject request.
Status Codes
200 - OK
206 - Partial Content
304 - Not Modified
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
409 - Conflict
411 - Length Required
412 - Precondition Failed
416 - Range Not Satisfiable
500 - Internal Server Error
503 - Service Unavailable
WriteGetObjectResponse, writeGetObjectResponse_storageClass - Provides storage class information of the object. Amazon S3 returns this
header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
$sel:tagCount:WriteGetObjectResponse', writeGetObjectResponse_tagCount - The number of tags, if any, on the object.
WriteGetObjectResponse, writeGetObjectResponse_versionId - An ID used to reference a specific version of the object.
$sel:requestRoute:WriteGetObjectResponse', writeGetObjectResponse_requestRoute - Route prefix to the HTTP URL generated.
$sel:requestToken:WriteGetObjectResponse', writeGetObjectResponse_requestToken - A single use encrypted token that maps WriteGetObjectResponse to the
end user GetObject request.
$sel:body:WriteGetObjectResponse', writeGetObjectResponse_body - The object data.
data WriteGetObjectResponseResponse Source #
See: newWriteGetObjectResponseResponse smart constructor.
Constructors
| WriteGetObjectResponseResponse' | |
Instances
| Generic WriteGetObjectResponseResponse Source # | |
Defined in Amazonka.S3.WriteGetObjectResponse Associated Types type Rep WriteGetObjectResponseResponse :: Type -> Type # | |
| Read WriteGetObjectResponseResponse Source # | |
| Show WriteGetObjectResponseResponse Source # | |
Defined in Amazonka.S3.WriteGetObjectResponse Methods showsPrec :: Int -> WriteGetObjectResponseResponse -> ShowS # show :: WriteGetObjectResponseResponse -> String # showList :: [WriteGetObjectResponseResponse] -> ShowS # | |
| NFData WriteGetObjectResponseResponse Source # | |
Defined in Amazonka.S3.WriteGetObjectResponse Methods rnf :: WriteGetObjectResponseResponse -> () # | |
| Eq WriteGetObjectResponseResponse Source # | |
Defined in Amazonka.S3.WriteGetObjectResponse | |
| type Rep WriteGetObjectResponseResponse Source # | |
Defined in Amazonka.S3.WriteGetObjectResponse | |
newWriteGetObjectResponseResponse :: WriteGetObjectResponseResponse Source #
Create a value of WriteGetObjectResponseResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
Common
module Amazonka.S3.Internal
AnalyticsS3ExportFileFormat
newtype AnalyticsS3ExportFileFormat Source #
Constructors
| AnalyticsS3ExportFileFormat' | |
Fields | |
Bundled Patterns
| pattern AnalyticsS3ExportFileFormat_CSV :: AnalyticsS3ExportFileFormat |
Instances
ArchiveStatus
newtype ArchiveStatus Source #
Constructors
| ArchiveStatus' | |
Fields | |
Bundled Patterns
| pattern ArchiveStatus_ARCHIVE_ACCESS :: ArchiveStatus | |
| pattern ArchiveStatus_DEEP_ARCHIVE_ACCESS :: ArchiveStatus |
Instances
BucketAccelerateStatus
newtype BucketAccelerateStatus Source #
Constructors
| BucketAccelerateStatus' | |
Fields | |
Bundled Patterns
| pattern BucketAccelerateStatus_Enabled :: BucketAccelerateStatus | |
| pattern BucketAccelerateStatus_Suspended :: BucketAccelerateStatus |
Instances
BucketCannedACL
newtype BucketCannedACL Source #
Constructors
| BucketCannedACL' | |
Fields | |
Bundled Patterns
| pattern BucketCannedACL_Authenticated_read :: BucketCannedACL | |
| pattern BucketCannedACL_Private :: BucketCannedACL | |
| pattern BucketCannedACL_Public_read :: BucketCannedACL | |
| pattern BucketCannedACL_Public_read_write :: BucketCannedACL |
Instances
BucketLogsPermission
newtype BucketLogsPermission Source #
Constructors
| BucketLogsPermission' | |
Fields | |
Bundled Patterns
| pattern BucketLogsPermission_FULL_CONTROL :: BucketLogsPermission | |
| pattern BucketLogsPermission_READ :: BucketLogsPermission | |
| pattern BucketLogsPermission_WRITE :: BucketLogsPermission |
Instances
BucketVersioningStatus
newtype BucketVersioningStatus Source #
Constructors
| BucketVersioningStatus' | |
Fields | |
Bundled Patterns
| pattern BucketVersioningStatus_Enabled :: BucketVersioningStatus | |
| pattern BucketVersioningStatus_Suspended :: BucketVersioningStatus |
Instances
ChecksumAlgorithm
newtype ChecksumAlgorithm Source #
Constructors
| ChecksumAlgorithm' | |
Fields | |
Bundled Patterns
| pattern ChecksumAlgorithm_CRC32 :: ChecksumAlgorithm | |
| pattern ChecksumAlgorithm_CRC32C :: ChecksumAlgorithm | |
| pattern ChecksumAlgorithm_SHA1 :: ChecksumAlgorithm | |
| pattern ChecksumAlgorithm_SHA256 :: ChecksumAlgorithm |
Instances
ChecksumMode
newtype ChecksumMode Source #
Constructors
| ChecksumMode' | |
Fields | |
Bundled Patterns
| pattern ChecksumMode_ENABLED :: ChecksumMode |
Instances
CompressionType
newtype CompressionType Source #
Constructors
| CompressionType' | |
Fields | |
Bundled Patterns
| pattern CompressionType_BZIP2 :: CompressionType | |
| pattern CompressionType_GZIP :: CompressionType | |
| pattern CompressionType_NONE :: CompressionType |
Instances
DeleteMarkerReplicationStatus
newtype DeleteMarkerReplicationStatus Source #
Constructors
| DeleteMarkerReplicationStatus' | |
Fields | |
Bundled Patterns
| pattern DeleteMarkerReplicationStatus_Disabled :: DeleteMarkerReplicationStatus | |
| pattern DeleteMarkerReplicationStatus_Enabled :: DeleteMarkerReplicationStatus |
Instances
EncodingType
newtype EncodingType Source #
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
Constructors
| EncodingType' | |
Fields | |
Bundled Patterns
| pattern EncodingType_Url :: EncodingType |
Instances
Event
The bucket event for which to send notifications.
Bundled Patterns
Instances
ExistingObjectReplicationStatus
newtype ExistingObjectReplicationStatus Source #
Constructors
| ExistingObjectReplicationStatus' | |
Fields | |
Bundled Patterns
| pattern ExistingObjectReplicationStatus_Disabled :: ExistingObjectReplicationStatus | |
| pattern ExistingObjectReplicationStatus_Enabled :: ExistingObjectReplicationStatus |
Instances
ExpirationStatus
newtype ExpirationStatus Source #
Constructors
| ExpirationStatus' | |
Fields | |
Bundled Patterns
| pattern ExpirationStatus_Disabled :: ExpirationStatus | |
| pattern ExpirationStatus_Enabled :: ExpirationStatus |
Instances
ExpressionType
newtype ExpressionType Source #
Constructors
| ExpressionType' | |
Fields | |
Bundled Patterns
| pattern ExpressionType_SQL :: ExpressionType |
Instances
FileHeaderInfo
newtype FileHeaderInfo Source #
Constructors
| FileHeaderInfo' | |
Fields | |
Bundled Patterns
| pattern FileHeaderInfo_IGNORE :: FileHeaderInfo | |
| pattern FileHeaderInfo_NONE :: FileHeaderInfo | |
| pattern FileHeaderInfo_USE :: FileHeaderInfo |
Instances
FilterRuleName
newtype FilterRuleName Source #
Constructors
| FilterRuleName' | |
Fields | |
Bundled Patterns
| pattern FilterRuleName_Prefix :: FilterRuleName | |
| pattern FilterRuleName_Suffix :: FilterRuleName |
Instances
IntelligentTieringAccessTier
newtype IntelligentTieringAccessTier Source #
Constructors
| IntelligentTieringAccessTier' | |
Fields | |
Bundled Patterns
| pattern IntelligentTieringAccessTier_ARCHIVE_ACCESS :: IntelligentTieringAccessTier | |
| pattern IntelligentTieringAccessTier_DEEP_ARCHIVE_ACCESS :: IntelligentTieringAccessTier |
Instances
IntelligentTieringStatus
newtype IntelligentTieringStatus Source #
Constructors
| IntelligentTieringStatus' | |
Fields | |
Bundled Patterns
| pattern IntelligentTieringStatus_Disabled :: IntelligentTieringStatus | |
| pattern IntelligentTieringStatus_Enabled :: IntelligentTieringStatus |
Instances
InventoryFormat
newtype InventoryFormat Source #
Constructors
| InventoryFormat' | |
Fields | |
Bundled Patterns
| pattern InventoryFormat_CSV :: InventoryFormat | |
| pattern InventoryFormat_ORC :: InventoryFormat | |
| pattern InventoryFormat_Parquet :: InventoryFormat |
Instances
InventoryFrequency
newtype InventoryFrequency Source #
Constructors
| InventoryFrequency' | |
Fields | |
Bundled Patterns
| pattern InventoryFrequency_Daily :: InventoryFrequency | |
| pattern InventoryFrequency_Weekly :: InventoryFrequency |
Instances
InventoryIncludedObjectVersions
newtype InventoryIncludedObjectVersions Source #
Constructors
| InventoryIncludedObjectVersions' | |
Fields | |
Bundled Patterns
| pattern InventoryIncludedObjectVersions_All :: InventoryIncludedObjectVersions | |
| pattern InventoryIncludedObjectVersions_Current :: InventoryIncludedObjectVersions |
Instances
InventoryOptionalField
newtype InventoryOptionalField Source #
Constructors
| InventoryOptionalField' | |
Fields | |
Bundled Patterns
Instances
JSONType
Constructors
| JSONType' | |
Fields
| |
Bundled Patterns
| pattern JSONType_DOCUMENT :: JSONType | |
| pattern JSONType_LINES :: JSONType |
Instances
MFADelete
Constructors
| MFADelete' | |
Fields | |
Bundled Patterns
| pattern MFADelete_Disabled :: MFADelete | |
| pattern MFADelete_Enabled :: MFADelete |
Instances
MFADeleteStatus
newtype MFADeleteStatus Source #
Constructors
| MFADeleteStatus' | |
Fields | |
Bundled Patterns
| pattern MFADeleteStatus_Disabled :: MFADeleteStatus | |
| pattern MFADeleteStatus_Enabled :: MFADeleteStatus |
Instances
MetadataDirective
newtype MetadataDirective Source #
Constructors
| MetadataDirective' | |
Fields | |
Bundled Patterns
| pattern MetadataDirective_COPY :: MetadataDirective | |
| pattern MetadataDirective_REPLACE :: MetadataDirective |
Instances
MetricsStatus
newtype MetricsStatus Source #
Constructors
| MetricsStatus' | |
Fields | |
Bundled Patterns
| pattern MetricsStatus_Disabled :: MetricsStatus | |
| pattern MetricsStatus_Enabled :: MetricsStatus |
Instances
ObjectAttributes
newtype ObjectAttributes Source #
Constructors
| ObjectAttributes' | |
Fields | |
Bundled Patterns
| pattern ObjectAttributes_Checksum :: ObjectAttributes | |
| pattern ObjectAttributes_ETag :: ObjectAttributes | |
| pattern ObjectAttributes_ObjectParts :: ObjectAttributes | |
| pattern ObjectAttributes_ObjectSize :: ObjectAttributes | |
| pattern ObjectAttributes_StorageClass :: ObjectAttributes |
Instances
ObjectCannedACL
newtype ObjectCannedACL Source #
Constructors
| ObjectCannedACL' | |
Fields | |
Bundled Patterns
| pattern ObjectCannedACL_Authenticated_read :: ObjectCannedACL | |
| pattern ObjectCannedACL_Aws_exec_read :: ObjectCannedACL | |
| pattern ObjectCannedACL_Bucket_owner_full_control :: ObjectCannedACL | |
| pattern ObjectCannedACL_Bucket_owner_read :: ObjectCannedACL | |
| pattern ObjectCannedACL_Private :: ObjectCannedACL | |
| pattern ObjectCannedACL_Public_read :: ObjectCannedACL | |
| pattern ObjectCannedACL_Public_read_write :: ObjectCannedACL |
Instances
ObjectLockEnabled
newtype ObjectLockEnabled Source #
Constructors
| ObjectLockEnabled' | |
Fields | |
Bundled Patterns
| pattern ObjectLockEnabled_Enabled :: ObjectLockEnabled |
Instances
ObjectLockLegalHoldStatus
newtype ObjectLockLegalHoldStatus Source #
Constructors
| ObjectLockLegalHoldStatus' | |
Fields | |
Bundled Patterns
| pattern ObjectLockLegalHoldStatus_OFF :: ObjectLockLegalHoldStatus | |
| pattern ObjectLockLegalHoldStatus_ON :: ObjectLockLegalHoldStatus |
Instances
ObjectLockMode
newtype ObjectLockMode Source #
Constructors
| ObjectLockMode' | |
Fields | |
Bundled Patterns
| pattern ObjectLockMode_COMPLIANCE :: ObjectLockMode | |
| pattern ObjectLockMode_GOVERNANCE :: ObjectLockMode |
Instances
ObjectLockRetentionMode
newtype ObjectLockRetentionMode Source #
Constructors
| ObjectLockRetentionMode' | |
Fields | |
Bundled Patterns
| pattern ObjectLockRetentionMode_COMPLIANCE :: ObjectLockRetentionMode | |
| pattern ObjectLockRetentionMode_GOVERNANCE :: ObjectLockRetentionMode |
Instances
ObjectOwnership
newtype ObjectOwnership Source #
The container element for object ownership for a bucket's ownership controls.
BucketOwnerPreferred - Objects uploaded to the bucket change ownership
to the bucket owner if the objects are uploaded with the
bucket-owner-full-control canned ACL.
ObjectWriter - The uploading account will own the object if the object
is uploaded with the bucket-owner-full-control canned ACL.
BucketOwnerEnforced - Access control lists (ACLs) are disabled and no
longer affect permissions. The bucket owner automatically owns and has
full control over every object in the bucket. The bucket only accepts
PUT requests that don't specify an ACL or bucket owner full control
ACLs, such as the bucket-owner-full-control canned ACL or an
equivalent form of this ACL expressed in the XML format.
Constructors
| ObjectOwnership' | |
Fields | |
Bundled Patterns
| pattern ObjectOwnership_BucketOwnerEnforced :: ObjectOwnership | |
| pattern ObjectOwnership_BucketOwnerPreferred :: ObjectOwnership | |
| pattern ObjectOwnership_ObjectWriter :: ObjectOwnership |
Instances
ObjectStorageClass
newtype ObjectStorageClass Source #
Constructors
| ObjectStorageClass' | |
Fields | |
Bundled Patterns
| pattern ObjectStorageClass_GLACIER :: ObjectStorageClass | |
| pattern ObjectStorageClass_INTELLIGENT_TIERING :: ObjectStorageClass | |
| pattern ObjectStorageClass_REDUCED_REDUNDANCY :: ObjectStorageClass | |
| pattern ObjectStorageClass_STANDARD :: ObjectStorageClass | |
| pattern ObjectStorageClass_STANDARD_IA :: ObjectStorageClass |
Instances
ObjectVersionStorageClass
newtype ObjectVersionStorageClass Source #
Constructors
| ObjectVersionStorageClass' | |
Fields | |
Bundled Patterns
| pattern ObjectVersionStorageClass_STANDARD :: ObjectVersionStorageClass |
Instances
OwnerOverride
newtype OwnerOverride Source #
Constructors
| OwnerOverride' | |
Fields | |
Bundled Patterns
| pattern OwnerOverride_Destination :: OwnerOverride |
Instances
Payer
Bundled Patterns
| pattern Payer_BucketOwner :: Payer | |
| pattern Payer_Requester :: Payer |
Instances
Permission
newtype Permission Source #
Constructors
| Permission' | |
Fields | |
Bundled Patterns
| pattern Permission_FULL_CONTROL :: Permission | |
| pattern Permission_READ :: Permission | |
| pattern Permission_READ_ACP :: Permission | |
| pattern Permission_WRITE :: Permission | |
| pattern Permission_WRITE_ACP :: Permission |
Instances
Protocol
Constructors
| Protocol' | |
Fields
| |
Bundled Patterns
| pattern Protocol_Http :: Protocol | |
| pattern Protocol_Https :: Protocol |
Instances
QuoteFields
newtype QuoteFields Source #
Constructors
| QuoteFields' | |
Fields | |
Bundled Patterns
| pattern QuoteFields_ALWAYS :: QuoteFields | |
| pattern QuoteFields_ASNEEDED :: QuoteFields |
Instances
ReplicaModificationsStatus
newtype ReplicaModificationsStatus Source #
Constructors
| ReplicaModificationsStatus' | |
Fields | |
Bundled Patterns
| pattern ReplicaModificationsStatus_Disabled :: ReplicaModificationsStatus | |
| pattern ReplicaModificationsStatus_Enabled :: ReplicaModificationsStatus |
Instances
ReplicationRuleStatus
newtype ReplicationRuleStatus Source #
Constructors
| ReplicationRuleStatus' | |
Fields | |
Bundled Patterns
| pattern ReplicationRuleStatus_Disabled :: ReplicationRuleStatus | |
| pattern ReplicationRuleStatus_Enabled :: ReplicationRuleStatus |
Instances
ReplicationStatus
newtype ReplicationStatus Source #
Constructors
| ReplicationStatus' | |
Fields | |
Bundled Patterns
| pattern ReplicationStatus_COMPLETED :: ReplicationStatus | |
| pattern ReplicationStatus_FAILED :: ReplicationStatus | |
| pattern ReplicationStatus_PENDING :: ReplicationStatus | |
| pattern ReplicationStatus_REPLICA :: ReplicationStatus |
Instances
ReplicationTimeStatus
newtype ReplicationTimeStatus Source #
Constructors
| ReplicationTimeStatus' | |
Fields | |
Bundled Patterns
| pattern ReplicationTimeStatus_Disabled :: ReplicationTimeStatus | |
| pattern ReplicationTimeStatus_Enabled :: ReplicationTimeStatus |
Instances
RequestCharged
newtype RequestCharged Source #
If present, indicates that the requester was successfully charged for the request.
Constructors
| RequestCharged' | |
Fields | |
Bundled Patterns
| pattern RequestCharged_Requester :: RequestCharged |
Instances
RequestPayer
newtype RequestPayer Source #
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
Constructors
| RequestPayer' | |
Fields | |
Bundled Patterns
| pattern RequestPayer_Requester :: RequestPayer |
Instances
RestoreRequestType
newtype RestoreRequestType Source #
Constructors
| RestoreRequestType' | |
Fields | |
Bundled Patterns
| pattern RestoreRequestType_SELECT :: RestoreRequestType |
Instances
ServerSideEncryption
newtype ServerSideEncryption Source #
Constructors
| ServerSideEncryption' | |
Fields | |
Bundled Patterns
| pattern ServerSideEncryption_AES256 :: ServerSideEncryption | |
| pattern ServerSideEncryption_Aws_kms :: ServerSideEncryption |
Instances
SseKmsEncryptedObjectsStatus
newtype SseKmsEncryptedObjectsStatus Source #
Constructors
| SseKmsEncryptedObjectsStatus' | |
Fields | |
Bundled Patterns
| pattern SseKmsEncryptedObjectsStatus_Disabled :: SseKmsEncryptedObjectsStatus | |
| pattern SseKmsEncryptedObjectsStatus_Enabled :: SseKmsEncryptedObjectsStatus |
Instances
StorageClass
newtype StorageClass Source #
Constructors
| StorageClass' | |
Fields | |
Bundled Patterns
| pattern StorageClass_DEEP_ARCHIVE :: StorageClass | |
| pattern StorageClass_GLACIER :: StorageClass | |
| pattern StorageClass_GLACIER_IR :: StorageClass | |
| pattern StorageClass_INTELLIGENT_TIERING :: StorageClass | |
| pattern StorageClass_ONEZONE_IA :: StorageClass | |
| pattern StorageClass_OUTPOSTS :: StorageClass | |
| pattern StorageClass_REDUCED_REDUNDANCY :: StorageClass | |
| pattern StorageClass_STANDARD :: StorageClass | |
| pattern StorageClass_STANDARD_IA :: StorageClass |
Instances
StorageClassAnalysisSchemaVersion
newtype StorageClassAnalysisSchemaVersion Source #
Constructors
| StorageClassAnalysisSchemaVersion' | |
Bundled Patterns
| pattern StorageClassAnalysisSchemaVersion_V_1 :: StorageClassAnalysisSchemaVersion |
Instances
TaggingDirective
newtype TaggingDirective Source #
Constructors
| TaggingDirective' | |
Fields | |
Bundled Patterns
| pattern TaggingDirective_COPY :: TaggingDirective | |
| pattern TaggingDirective_REPLACE :: TaggingDirective |
Instances
Tier
Bundled Patterns
| pattern Tier_Bulk :: Tier | |
| pattern Tier_Expedited :: Tier | |
| pattern Tier_Standard :: Tier |
Instances
TransitionStorageClass
newtype TransitionStorageClass Source #
Constructors
| TransitionStorageClass' | |
Fields | |
Bundled Patterns
Instances
Type
Bundled Patterns
| pattern Type_AmazonCustomerByEmail :: Type | |
| pattern Type_CanonicalUser :: Type | |
| pattern Type_Group :: Type |
Instances
AbortIncompleteMultipartUpload
data AbortIncompleteMultipartUpload Source #
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.
See: newAbortIncompleteMultipartUpload smart constructor.
Constructors
| AbortIncompleteMultipartUpload' (Maybe Int) |
Instances
newAbortIncompleteMultipartUpload :: AbortIncompleteMultipartUpload Source #
Create a value of AbortIncompleteMultipartUpload with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:daysAfterInitiation:AbortIncompleteMultipartUpload', abortIncompleteMultipartUpload_daysAfterInitiation - Specifies the number of days after which Amazon S3 aborts an incomplete
multipart upload.
AccelerateConfiguration
data AccelerateConfiguration Source #
Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide.
See: newAccelerateConfiguration smart constructor.
Constructors
| AccelerateConfiguration' (Maybe BucketAccelerateStatus) |
Instances
newAccelerateConfiguration :: AccelerateConfiguration Source #
Create a value of AccelerateConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:AccelerateConfiguration', accelerateConfiguration_status - Specifies the transfer acceleration status of the bucket.
AccessControlPolicy
data AccessControlPolicy Source #
Contains the elements that set the ACL permissions for an object per grantee.
See: newAccessControlPolicy smart constructor.
Constructors
| AccessControlPolicy' (Maybe [Grant]) (Maybe Owner) |
Instances
newAccessControlPolicy :: AccessControlPolicy Source #
Create a value of AccessControlPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:grants:AccessControlPolicy', accessControlPolicy_grants - A list of grants.
$sel:owner:AccessControlPolicy', accessControlPolicy_owner - Container for the bucket owner's display name and ID.
AccessControlTranslation
data AccessControlTranslation Source #
A container for information about access control for replicas.
See: newAccessControlTranslation smart constructor.
Constructors
| AccessControlTranslation' OwnerOverride |
Instances
newAccessControlTranslation Source #
Create a value of AccessControlTranslation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:owner:AccessControlTranslation', accessControlTranslation_owner - Specifies the replica ownership. For default and valid values, see
PUT bucket replication
in the Amazon S3 API Reference.
AnalyticsAndOperator
data AnalyticsAndOperator Source #
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and an object must match all of the predicates for the filter to apply.
See: newAnalyticsAndOperator smart constructor.
Constructors
| AnalyticsAndOperator' (Maybe Text) (Maybe [Tag]) |
Instances
newAnalyticsAndOperator :: AnalyticsAndOperator Source #
Create a value of AnalyticsAndOperator with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:prefix:AnalyticsAndOperator', analyticsAndOperator_prefix - The prefix to use when evaluating an AND predicate: The prefix that an
object must have to be included in the metrics results.
$sel:tags:AnalyticsAndOperator', analyticsAndOperator_tags - The list of tags to use when evaluating an AND predicate.
AnalyticsConfiguration
data AnalyticsConfiguration Source #
Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
See: newAnalyticsConfiguration smart constructor.
Constructors
| AnalyticsConfiguration' (Maybe AnalyticsFilter) Text StorageClassAnalysis |
Instances
newAnalyticsConfiguration Source #
Arguments
| :: Text | |
| -> StorageClassAnalysis | |
| -> AnalyticsConfiguration |
Create a value of AnalyticsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':AnalyticsConfiguration', analyticsConfiguration_filter - 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.
$sel:id:AnalyticsConfiguration', analyticsConfiguration_id - The ID that identifies the analytics configuration.
$sel:storageClassAnalysis:AnalyticsConfiguration', analyticsConfiguration_storageClassAnalysis - Contains data related to access patterns to be collected and made
available to analyze the tradeoffs between different storage classes.
AnalyticsExportDestination
data AnalyticsExportDestination Source #
Where to publish the analytics results.
See: newAnalyticsExportDestination smart constructor.
Instances
newAnalyticsExportDestination Source #
Arguments
| :: AnalyticsS3BucketDestination | |
| -> AnalyticsExportDestination |
Create a value of AnalyticsExportDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3BucketDestination:AnalyticsExportDestination', analyticsExportDestination_s3BucketDestination - A destination signifying output to an S3 bucket.
AnalyticsFilter
data AnalyticsFilter Source #
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.
See: newAnalyticsFilter smart constructor.
Constructors
| AnalyticsFilter' (Maybe AnalyticsAndOperator) (Maybe Text) (Maybe Tag) |
Instances
newAnalyticsFilter :: AnalyticsFilter Source #
Create a value of AnalyticsFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:and:AnalyticsFilter', analyticsFilter_and - A conjunction (logical AND) of predicates, which is used in evaluating
an analytics filter. The operator must have at least two predicates.
AnalyticsFilter, analyticsFilter_prefix - The prefix to use when evaluating an analytics filter.
$sel:tag:AnalyticsFilter', analyticsFilter_tag - The tag to use when evaluating an analytics filter.
AnalyticsS3BucketDestination
data AnalyticsS3BucketDestination Source #
Contains information about where to publish the analytics results.
See: newAnalyticsS3BucketDestination smart constructor.
Constructors
| AnalyticsS3BucketDestination' (Maybe Text) (Maybe Text) AnalyticsS3ExportFileFormat BucketName |
Instances
newAnalyticsS3BucketDestination Source #
Arguments
| :: AnalyticsS3ExportFileFormat | |
| -> BucketName | |
| -> AnalyticsS3BucketDestination |
Create a value of AnalyticsS3BucketDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucketAccountId:AnalyticsS3BucketDestination', analyticsS3BucketDestination_bucketAccountId - The account ID that owns the destination S3 bucket. If no account ID is
provided, the owner is not validated before exporting data.
Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
$sel:prefix:AnalyticsS3BucketDestination', analyticsS3BucketDestination_prefix - The prefix to use when exporting data. The prefix is prepended to all
results.
$sel:format:AnalyticsS3BucketDestination', analyticsS3BucketDestination_format - Specifies the file format used when exporting data to Amazon S3.
$sel:bucket:AnalyticsS3BucketDestination', analyticsS3BucketDestination_bucket - The Amazon Resource Name (ARN) of the bucket to which data is exported.
Bucket
In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally unique, and the namespace is shared by all Amazon Web Services accounts.
See: newBucket smart constructor.
Constructors
| Bucket' ISO8601 BucketName |
Instances
| FromXML Bucket Source # | |
| Generic Bucket Source # | |
| Read Bucket Source # | |
| Show Bucket Source # | |
| NFData Bucket Source # | |
Defined in Amazonka.S3.Types.Bucket | |
| Eq Bucket Source # | |
| Hashable Bucket Source # | |
Defined in Amazonka.S3.Types.Bucket | |
| type Rep Bucket Source # | |
Defined in Amazonka.S3.Types.Bucket type Rep Bucket = D1 ('MetaData "Bucket" "Amazonka.S3.Types.Bucket" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Bucket'" 'PrefixI 'True) (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName))) | |
Arguments
| :: UTCTime | |
| -> BucketName | |
| -> Bucket |
Create a value of Bucket with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationDate:Bucket', bucket_creationDate - Date the bucket was created. This date can change when making changes to
your bucket, such as editing its bucket policy.
$sel:name:Bucket', bucket_name - The name of the bucket.
BucketLifecycleConfiguration
data BucketLifecycleConfiguration Source #
Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon S3 User Guide.
See: newBucketLifecycleConfiguration smart constructor.
Constructors
| BucketLifecycleConfiguration' [LifecycleRule] |
Instances
newBucketLifecycleConfiguration :: BucketLifecycleConfiguration Source #
Create a value of BucketLifecycleConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rules:BucketLifecycleConfiguration', bucketLifecycleConfiguration_rules - A lifecycle rule for individual objects in an Amazon S3 bucket.
BucketLoggingStatus
data BucketLoggingStatus Source #
Container for logging status information.
See: newBucketLoggingStatus smart constructor.
Constructors
| BucketLoggingStatus' (Maybe LoggingEnabled) |
Instances
newBucketLoggingStatus :: BucketLoggingStatus Source #
Create a value of BucketLoggingStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:loggingEnabled:BucketLoggingStatus', bucketLoggingStatus_loggingEnabled - Undocumented member.
CORSConfiguration
data CORSConfiguration Source #
Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.
See: newCORSConfiguration smart constructor.
Constructors
| CORSConfiguration' [CORSRule] |
Instances
newCORSConfiguration :: CORSConfiguration Source #
Create a value of CORSConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cORSRules:CORSConfiguration', cORSConfiguration_cORSRules - A set of origins and methods (cross-origin access that you want to
allow). You can add up to 100 rules to the configuration.
CORSRule
Specifies a cross-origin access rule for an Amazon S3 bucket.
See: newCORSRule smart constructor.
Instances
newCORSRule :: CORSRule Source #
Create a value of CORSRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowedHeaders:CORSRule', cORSRule_allowedHeaders - Headers that are specified in the Access-Control-Request-Headers
header. These headers are allowed in a preflight OPTIONS request. In
response to any preflight OPTIONS request, Amazon S3 returns any
requested headers that are allowed.
$sel:exposeHeaders:CORSRule', cORSRule_exposeHeaders - 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).
$sel:id:CORSRule', cORSRule_id - Unique identifier for the rule. The value cannot be longer than 255
characters.
$sel:maxAgeSeconds:CORSRule', cORSRule_maxAgeSeconds - The time in seconds that your browser is to cache the preflight response
for the specified resource.
$sel:allowedMethods:CORSRule', cORSRule_allowedMethods - An HTTP method that you allow the origin to execute. Valid values are
GET, PUT, HEAD, POST, and DELETE.
$sel:allowedOrigins:CORSRule', cORSRule_allowedOrigins - One or more origins you want customers to be able to access the bucket
from.
CSVInput
Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.
See: newCSVInput smart constructor.
Constructors
| CSVInput' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe FileHeaderInfo) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newCSVInput :: CSVInput Source #
Create a value of CSVInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowQuotedRecordDelimiter:CSVInput', cSVInput_allowQuotedRecordDelimiter - 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.
$sel:comments:CSVInput', cSVInput_comments - A single character used to indicate that a row should be ignored when
the character is present at the start of that row. You can specify any
character to indicate a comment line.
$sel:fieldDelimiter:CSVInput', cSVInput_fieldDelimiter - A single character used to separate individual fields in a record. You
can specify an arbitrary delimiter.
$sel:fileHeaderInfo:CSVInput', cSVInput_fileHeaderInfo - Describes the first line of input. Valid values are:
NONE: First line is not a header.IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s).Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).
$sel:quoteCharacter:CSVInput', cSVInput_quoteCharacter - A single character used for escaping when the field delimiter is part of
the value. For example, if the value is a, b, Amazon S3 wraps this
field value in quotation marks, as follows: " a , b ".
Type: String
Default: "
Ancestors: CSV
$sel:quoteEscapeCharacter:CSVInput', cSVInput_quoteEscapeCharacter - A single character used for escaping the quotation mark character inside
an already escaped value. For example, the value """ a , b """
is parsed as " a , b ".
$sel:recordDelimiter:CSVInput', cSVInput_recordDelimiter - A single character used to separate individual records in the input.
Instead of the default value, you can specify an arbitrary delimiter.
CSVOutput
Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.
See: newCSVOutput smart constructor.
Instances
newCSVOutput :: CSVOutput Source #
Create a value of CSVOutput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fieldDelimiter:CSVOutput', cSVOutput_fieldDelimiter - The value used to separate individual fields in a record. You can
specify an arbitrary delimiter.
$sel:quoteCharacter:CSVOutput', cSVOutput_quoteCharacter - A single character used for escaping when the field delimiter is part of
the value. For example, if the value is a, b, Amazon S3 wraps this
field value in quotation marks, as follows: " a , b ".
$sel:quoteEscapeCharacter:CSVOutput', cSVOutput_quoteEscapeCharacter - The single character used for escaping the quote character inside an
already escaped value.
$sel:quoteFields:CSVOutput', cSVOutput_quoteFields - Indicates whether to use quotation marks around output fields.
ALWAYS: Always use quotation marks for output fields.ASNEEDED: Use quotation marks for output fields when needed.
$sel:recordDelimiter:CSVOutput', cSVOutput_recordDelimiter - A single character used to separate individual records in the output.
Instead of the default value, you can specify an arbitrary delimiter.
Checksum
Contains all the possible checksum or digest values for an object.
See: newChecksum smart constructor.
Instances
| FromXML Checksum Source # | |
| Generic Checksum Source # | |
| Read Checksum Source # | |
| Show Checksum Source # | |
| NFData Checksum Source # | |
Defined in Amazonka.S3.Types.Checksum | |
| Eq Checksum Source # | |
| Hashable Checksum Source # | |
Defined in Amazonka.S3.Types.Checksum | |
| type Rep Checksum Source # | |
Defined in Amazonka.S3.Types.Checksum type Rep Checksum = D1 ('MetaData "Checksum" "Amazonka.S3.Types.Checksum" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Checksum'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "checksumCRC32") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "checksumCRC32C") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "checksumSHA1") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "checksumSHA256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newChecksum :: Checksum Source #
Create a value of Checksum with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumCRC32:Checksum', checksum_checksumCRC32 - The base64-encoded, 32-bit CRC32 checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumCRC32C:Checksum', checksum_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA1:Checksum', checksum_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA256:Checksum', checksum_checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
CommonPrefix
data CommonPrefix Source #
Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.
See: newCommonPrefix smart constructor.
Constructors
| CommonPrefix' (Maybe Text) |
Instances
newCommonPrefix :: CommonPrefix Source #
Create a value of CommonPrefix with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:prefix:CommonPrefix', commonPrefix_prefix - Container for the specified common prefix.
CompletedMultipartUpload
data CompletedMultipartUpload Source #
The container for the completed multipart upload details.
See: newCompletedMultipartUpload smart constructor.
Constructors
| CompletedMultipartUpload' (Maybe (NonEmpty CompletedPart)) |
Instances
newCompletedMultipartUpload :: CompletedMultipartUpload Source #
Create a value of CompletedMultipartUpload with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parts:CompletedMultipartUpload', completedMultipartUpload_parts - Array of CompletedPart data types.
If you do not supply a valid Part with your request, the service sends
back an HTTP 400 response.
CompletedPart
data CompletedPart Source #
Details of the parts that were uploaded.
See: newCompletedPart smart constructor.
Instances
Create a value of CompletedPart with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumCRC32:CompletedPart', completedPart_checksumCRC32 - The base64-encoded, 32-bit CRC32 checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumCRC32C:CompletedPart', completedPart_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA1:CompletedPart', completedPart_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA256:CompletedPart', completedPart_checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:partNumber:CompletedPart', completedPart_partNumber - Part number that identifies the part. This is a positive integer between
1 and 10,000.
$sel:eTag:CompletedPart', completedPart_eTag - Entity tag returned when the part was uploaded.
Condition
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.
See: newCondition smart constructor.
Constructors
| Condition' (Maybe Text) (Maybe Text) |
Instances
| FromXML Condition Source # | |
| ToXML Condition Source # | |
Defined in Amazonka.S3.Types.Condition | |
| Generic Condition Source # | |
| Read Condition Source # | |
| Show Condition Source # | |
| NFData Condition Source # | |
Defined in Amazonka.S3.Types.Condition | |
| Eq Condition Source # | |
| Hashable Condition Source # | |
Defined in Amazonka.S3.Types.Condition | |
| type Rep Condition Source # | |
Defined in Amazonka.S3.Types.Condition type Rep Condition = D1 ('MetaData "Condition" "Amazonka.S3.Types.Condition" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Condition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpErrorCodeReturnedEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyPrefixEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newCondition :: Condition Source #
Create a value of Condition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpErrorCodeReturnedEquals:Condition', condition_httpErrorCodeReturnedEquals - 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.
$sel:keyPrefixEquals:Condition', condition_keyPrefixEquals - 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.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
ContinuationEvent
data ContinuationEvent Source #
See: newContinuationEvent smart constructor.
Constructors
| ContinuationEvent' | |
Instances
newContinuationEvent :: ContinuationEvent Source #
Create a value of ContinuationEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CopyObjectResult
data CopyObjectResult Source #
Container for all response elements.
See: newCopyObjectResult smart constructor.
Constructors
| CopyObjectResult' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe RFC822) |
Instances
newCopyObjectResult :: CopyObjectResult Source #
Create a value of CopyObjectResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumCRC32:CopyObjectResult', copyObjectResult_checksumCRC32 - The base64-encoded, 32-bit CRC32 checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumCRC32C:CopyObjectResult', copyObjectResult_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA1:CopyObjectResult', copyObjectResult_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA256:CopyObjectResult', copyObjectResult_checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:eTag:CopyObjectResult', copyObjectResult_eTag - Returns the ETag of the new object. The ETag reflects only changes to
the contents of an object, not its metadata.
$sel:lastModified:CopyObjectResult', copyObjectResult_lastModified - Creation date of the object.
CopyPartResult
data CopyPartResult Source #
Container for all response elements.
See: newCopyPartResult smart constructor.
Constructors
| CopyPartResult' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe RFC822) |
Instances
newCopyPartResult :: CopyPartResult Source #
Create a value of CopyPartResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumCRC32:CopyPartResult', copyPartResult_checksumCRC32 - The base64-encoded, 32-bit CRC32 checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumCRC32C:CopyPartResult', copyPartResult_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA1:CopyPartResult', copyPartResult_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA256:CopyPartResult', copyPartResult_checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:eTag:CopyPartResult', copyPartResult_eTag - Entity tag of the object.
$sel:lastModified:CopyPartResult', copyPartResult_lastModified - Date and time at which the object was uploaded.
CreateBucketConfiguration
data CreateBucketConfiguration Source #
The configuration information for the bucket.
See: newCreateBucketConfiguration smart constructor.
Constructors
| CreateBucketConfiguration' (Maybe LocationConstraint) |
Instances
newCreateBucketConfiguration :: CreateBucketConfiguration Source #
Create a value of CreateBucketConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:locationConstraint:CreateBucketConfiguration', createBucketConfiguration_locationConstraint - Specifies the Region where the bucket will be created. If you don't
specify a Region, the bucket is created in the US East (N. Virginia)
Region (us-east-1).
DefaultRetention
data DefaultRetention Source #
The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.
- The
DefaultRetentionsettings require both a mode and a period. - The
DefaultRetentionperiod can be eitherDaysorYearsbut you must select one. You cannot specifyDaysandYearsat the same time.
See: newDefaultRetention smart constructor.
Constructors
| DefaultRetention' (Maybe Int) (Maybe ObjectLockRetentionMode) (Maybe Int) |
Instances
newDefaultRetention :: DefaultRetention Source #
Create a value of DefaultRetention with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:days:DefaultRetention', defaultRetention_days - The number of days that you want to specify for the default retention
period. Must be used with Mode.
$sel:mode:DefaultRetention', defaultRetention_mode - The default Object Lock retention mode you want to apply to new objects
placed in the specified bucket. Must be used with either Days or
Years.
$sel:years:DefaultRetention', defaultRetention_years - The number of years that you want to specify for the default retention
period. Must be used with Mode.
Delete
Container for the objects to delete.
See: newDelete smart constructor.
Constructors
| Delete' (Maybe Bool) [ObjectIdentifier] |
Instances
| ToXML Delete Source # | |
Defined in Amazonka.S3.Types.Delete | |
| Generic Delete Source # | |
| Read Delete Source # | |
| Show Delete Source # | |
| NFData Delete Source # | |
Defined in Amazonka.S3.Types.Delete | |
| Eq Delete Source # | |
| Hashable Delete Source # | |
Defined in Amazonka.S3.Types.Delete | |
| type Rep Delete Source # | |
Defined in Amazonka.S3.Types.Delete type Rep Delete = D1 ('MetaData "Delete" "Amazonka.S3.Types.Delete" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Delete'" 'PrefixI 'True) (S1 ('MetaSel ('Just "quiet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "objects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ObjectIdentifier]))) | |
Create a value of Delete with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:quiet:Delete', delete_quiet - Element to enable quiet mode for the request. When you add this element,
you must set its value to true.
$sel:objects:Delete', delete_objects - The objects to delete.
DeleteMarkerEntry
data DeleteMarkerEntry Source #
Information about the delete marker.
See: newDeleteMarkerEntry smart constructor.
Constructors
| DeleteMarkerEntry' (Maybe Bool) (Maybe ObjectKey) (Maybe RFC822) (Maybe Owner) (Maybe ObjectVersionId) |
Instances
newDeleteMarkerEntry :: DeleteMarkerEntry Source #
Create a value of DeleteMarkerEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isLatest:DeleteMarkerEntry', deleteMarkerEntry_isLatest - Specifies whether the object is (true) or is not (false) the latest
version of an object.
$sel:key:DeleteMarkerEntry', deleteMarkerEntry_key - The object key.
$sel:lastModified:DeleteMarkerEntry', deleteMarkerEntry_lastModified - Date and time the object was last modified.
$sel:owner:DeleteMarkerEntry', deleteMarkerEntry_owner - The account that created the delete marker.>
$sel:versionId:DeleteMarkerEntry', deleteMarkerEntry_versionId - Version ID of an object.
DeleteMarkerReplication
data DeleteMarkerReplication Source #
Specifies whether Amazon S3 replicates delete markers. If you specify a
Filter in your replication configuration, you must also include a
DeleteMarkerReplication element. If your Filter includes a Tag
element, the DeleteMarkerReplication Status must be set to Disabled,
because Amazon S3 does not support replicating delete markers for
tag-based rules. For an example configuration, see
Basic Rule Configuration.
For more information about delete marker replication, see Basic Rule Configuration.
If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.
See: newDeleteMarkerReplication smart constructor.
Constructors
| DeleteMarkerReplication' (Maybe DeleteMarkerReplicationStatus) |
Instances
newDeleteMarkerReplication :: DeleteMarkerReplication Source #
Create a value of DeleteMarkerReplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DeleteMarkerReplication', deleteMarkerReplication_status - Indicates whether to replicate delete markers.
Indicates whether to replicate delete markers.
DeletedObject
data DeletedObject Source #
Information about the deleted object.
See: newDeletedObject smart constructor.
Constructors
| DeletedObject' (Maybe Bool) (Maybe Text) (Maybe ObjectKey) (Maybe ObjectVersionId) |
Instances
newDeletedObject :: DeletedObject Source #
Create a value of DeletedObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteMarker:DeletedObject', deletedObject_deleteMarker - Specifies whether the versioned object that was permanently deleted was
(true) or was not (false) a delete marker. In a simple DELETE, this
header indicates whether (true) or not (false) a delete marker was
created.
$sel:deleteMarkerVersionId:DeletedObject', deletedObject_deleteMarkerVersionId - The version ID of the delete marker created as a result of the DELETE
operation. If you delete a specific object version, the value returned
by this header is the version ID of the object version deleted.
$sel:key:DeletedObject', deletedObject_key - The name of the deleted object.
$sel:versionId:DeletedObject', deletedObject_versionId - The version ID of the deleted object.
Destination
data Destination Source #
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
See: newDestination smart constructor.
Constructors
| Destination' (Maybe AccessControlTranslation) (Maybe Text) (Maybe EncryptionConfiguration) (Maybe Metrics) (Maybe ReplicationTime) (Maybe StorageClass) BucketName |
Instances
Arguments
| :: BucketName | |
| -> Destination |
Create a value of Destination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessControlTranslation:Destination', destination_accessControlTranslation - Specify this only in a cross-account scenario (where source and
destination bucket owners are not the same), and you want to change
replica ownership to the Amazon Web Services account that owns the
destination bucket. If this is not specified in the replication
configuration, the replicas are owned by same Amazon Web Services
account that owns the source object.
$sel:account:Destination', destination_account - Destination bucket owner account ID. In a cross-account scenario, if you
direct Amazon S3 to change replica ownership to the Amazon Web Services
account that owns the destination bucket by specifying the
AccessControlTranslation property, this is the account ID of the
destination bucket owner. For more information, see
Replication Additional Configuration: Changing the Replica Owner
in the Amazon S3 User Guide.
$sel:encryptionConfiguration:Destination', destination_encryptionConfiguration - A container that provides information about encryption. If
SourceSelectionCriteria is specified, you must specify this element.
$sel:metrics:Destination', destination_metrics - A container specifying replication metrics-related settings enabling
replication metrics and events.
$sel:replicationTime:Destination', destination_replicationTime - A container specifying S3 Replication Time Control (S3 RTC), including
whether S3 RTC is enabled and the time when all objects and operations
on objects must be replicated. Must be specified together with a
Metrics block.
$sel:storageClass:Destination', destination_storageClass - The storage class to use when replicating objects, such as S3 Standard
or reduced redundancy. By default, Amazon S3 uses the storage class of
the source object to create the object replica.
For valid values, see the StorageClass element of the
PUT Bucket replication
action in the Amazon S3 API Reference.
$sel:bucket:Destination', destination_bucket - The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to
store the results.
Encryption
data Encryption Source #
Contains the type of server-side encryption used.
See: newEncryption smart constructor.
Constructors
| Encryption' (Maybe Text) (Maybe (Sensitive Text)) ServerSideEncryption |
Instances
Create a value of Encryption with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsContext:Encryption', encryption_kmsContext - If the encryption type is aws:kms, this optional value can be used to
specify the encryption context for the restore results.
$sel:kmsKeyId:Encryption', encryption_kmsKeyId - If the encryption type is aws:kms, this optional value specifies the
ID of the symmetric customer managed key to use for encryption of job
results. Amazon S3 only supports symmetric keys. For more information,
see
Using symmetric and asymmetric keys
in the Amazon Web Services Key Management Service Developer Guide.
$sel:encryptionType:Encryption', encryption_encryptionType - The server-side encryption algorithm used when storing job results in
Amazon S3 (for example, AES256, aws:kms).
EncryptionConfiguration
data EncryptionConfiguration Source #
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
See: newEncryptionConfiguration smart constructor.
Constructors
| EncryptionConfiguration' (Maybe Text) |
Instances
newEncryptionConfiguration :: EncryptionConfiguration Source #
Create a value of EncryptionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replicaKmsKeyID:EncryptionConfiguration', encryptionConfiguration_replicaKmsKeyID - Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon
Web Services KMS key stored in Amazon Web Services Key Management
Service (KMS) for the destination bucket. Amazon S3 uses this key to
encrypt replica objects. Amazon S3 only supports symmetric, customer
managed KMS keys. For more information, see
Using symmetric and asymmetric keys
in the Amazon Web Services Key Management Service Developer Guide.
EndEvent
A message that indicates the request is complete and no more messages
will be sent. You should not assume that the request is complete until
the client receives an EndEvent.
See: newEndEvent smart constructor.
Constructors
| EndEvent' | |
newEndEvent :: EndEvent Source #
Create a value of EndEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ErrorDocument
data ErrorDocument Source #
The error information.
See: newErrorDocument smart constructor.
Constructors
| ErrorDocument' ObjectKey |
Instances
Arguments
| :: ObjectKey | |
| -> ErrorDocument |
Create a value of ErrorDocument with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:ErrorDocument', errorDocument_key - The object key name to use when a 4XX class error occurs.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
EventBridgeConfiguration
data EventBridgeConfiguration Source #
A container for specifying the configuration for Amazon EventBridge.
See: newEventBridgeConfiguration smart constructor.
Constructors
| EventBridgeConfiguration' | |
Instances
newEventBridgeConfiguration :: EventBridgeConfiguration Source #
Create a value of EventBridgeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ExistingObjectReplication
data ExistingObjectReplication Source #
Optional configuration to replicate existing source bucket objects. For more information, see Replicating Existing Objects in the Amazon S3 User Guide.
See: newExistingObjectReplication smart constructor.
Instances
newExistingObjectReplication Source #
Arguments
| :: ExistingObjectReplicationStatus | |
| -> ExistingObjectReplication |
Create a value of ExistingObjectReplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ExistingObjectReplication', existingObjectReplication_status -
FilterRule
data FilterRule Source #
Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.
See: newFilterRule smart constructor.
Constructors
| FilterRule' (Maybe FilterRuleName) (Maybe Text) |
Instances
newFilterRule :: FilterRule Source #
Create a value of FilterRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:FilterRule', filterRule_name - The object key name prefix or suffix identifying one or more objects to
which the filtering rule applies. The maximum length is 1,024
characters. Overlapping prefixes and suffixes are not supported. For
more information, see
Configuring Event Notifications
in the Amazon S3 User Guide.
$sel:value:FilterRule', filterRule_value - The value that the filter searches for in object key names.
GetObjectAttributesParts
data GetObjectAttributesParts Source #
A collection of parts associated with a multipart upload.
See: newGetObjectAttributesParts smart constructor.
Constructors
| GetObjectAttributesParts' (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe [ObjectPart]) (Maybe Int) |
Instances
newGetObjectAttributesParts :: GetObjectAttributesParts Source #
Create a value of GetObjectAttributesParts with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isTruncated:GetObjectAttributesParts', getObjectAttributesParts_isTruncated - Indicates whether the returned list of parts is truncated. A value of
true indicates that the list was truncated. A list can be truncated if
the number of parts exceeds the limit returned in the MaxParts
element.
$sel:maxParts:GetObjectAttributesParts', getObjectAttributesParts_maxParts - The maximum number of parts allowed in the response.
$sel:nextPartNumberMarker:GetObjectAttributesParts', getObjectAttributesParts_nextPartNumberMarker - When a list is truncated, this element specifies the last part in the
list, as well as the value to use for the PartNumberMarker request
parameter in a subsequent request.
$sel:partNumberMarker:GetObjectAttributesParts', getObjectAttributesParts_partNumberMarker - The marker for the current part.
$sel:parts:GetObjectAttributesParts', getObjectAttributesParts_parts - A container for elements related to a particular part. A response can
contain zero or more Parts elements.
$sel:totalPartsCount:GetObjectAttributesParts', getObjectAttributesParts_totalPartsCount - The total number of parts.
GlacierJobParameters
data GlacierJobParameters Source #
Container for S3 Glacier job parameters.
See: newGlacierJobParameters smart constructor.
Constructors
| GlacierJobParameters' Tier |
Instances
newGlacierJobParameters Source #
Arguments
| :: Tier | |
| -> GlacierJobParameters |
Create a value of GlacierJobParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tier:GlacierJobParameters', glacierJobParameters_tier - Retrieval tier at which the restore will be processed.
Grant
Container for grant information.
See: newGrant smart constructor.
Constructors
| Grant' (Maybe Grantee) (Maybe Permission) |
Instances
| FromXML Grant Source # | |
| ToXML Grant Source # | |
Defined in Amazonka.S3.Types.Grant | |
| Generic Grant Source # | |
| Read Grant Source # | |
| Show Grant Source # | |
| NFData Grant Source # | |
Defined in Amazonka.S3.Types.Grant | |
| Eq Grant Source # | |
| Hashable Grant Source # | |
Defined in Amazonka.S3.Types.Grant | |
| type Rep Grant Source # | |
Defined in Amazonka.S3.Types.Grant type Rep Grant = D1 ('MetaData "Grant" "Amazonka.S3.Types.Grant" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Grant'" 'PrefixI 'True) (S1 ('MetaSel ('Just "grantee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Grantee)) :*: S1 ('MetaSel ('Just "permission") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Permission)))) | |
Create a value of Grant with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:grantee:Grant', grant_grantee - The person being granted permissions.
$sel:permission:Grant', grant_permission - Specifies the permission given to the grantee.
Grantee
Container for the person being granted permissions.
See: newGrantee smart constructor.
Instances
Create a value of Grantee with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:displayName:Grantee', grantee_displayName - Screen name of the grantee.
$sel:emailAddress:Grantee', grantee_emailAddress - Email address of the grantee.
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
- US East (N. Virginia)
- US West (N. California)
- US West (Oregon)
- Asia Pacific (Singapore)
- Asia Pacific (Sydney)
- Asia Pacific (Tokyo)
- Europe (Ireland)
- South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
$sel:id:Grantee', grantee_id - The canonical user ID of the grantee.
$sel:uri:Grantee', grantee_uri - URI of the grantee group.
$sel:type':Grantee', grantee_type - Type of grantee
IndexDocument
data IndexDocument Source #
Container for the Suffix element.
See: newIndexDocument smart constructor.
Constructors
| IndexDocument' Text |
Instances
Arguments
| :: Text | |
| -> IndexDocument |
Create a value of IndexDocument with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:suffix:IndexDocument', indexDocument_suffix - A suffix that is appended to a request that is for a directory on the
website endpoint (for example,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.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
Initiator
Container element that identifies who initiated the multipart upload.
See: newInitiator smart constructor.
Constructors
| Initiator' (Maybe Text) (Maybe Text) |
Instances
| FromXML Initiator Source # | |
| Generic Initiator Source # | |
| Read Initiator Source # | |
| Show Initiator Source # | |
| NFData Initiator Source # | |
Defined in Amazonka.S3.Types.Initiator | |
| Eq Initiator Source # | |
| Hashable Initiator Source # | |
Defined in Amazonka.S3.Types.Initiator | |
| type Rep Initiator Source # | |
Defined in Amazonka.S3.Types.Initiator type Rep Initiator = D1 ('MetaData "Initiator" "Amazonka.S3.Types.Initiator" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Initiator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newInitiator :: Initiator Source #
Create a value of Initiator with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:displayName:Initiator', initiator_displayName - Name of the Principal.
$sel:id:Initiator', initiator_id - If the principal is an Amazon Web Services account, it provides the
Canonical User ID. If the principal is an IAM User, it provides a user
ARN value.
InputSerialization
data InputSerialization Source #
Describes the serialization format of the object.
See: newInputSerialization smart constructor.
Constructors
| InputSerialization' (Maybe CSVInput) (Maybe CompressionType) (Maybe JSONInput) (Maybe ParquetInput) |
Instances
newInputSerialization :: InputSerialization Source #
Create a value of InputSerialization with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:csv:InputSerialization', inputSerialization_csv - Describes the serialization of a CSV-encoded object.
$sel:compressionType:InputSerialization', inputSerialization_compressionType - Specifies object's compression format. Valid values: NONE, GZIP, BZIP2.
Default Value: NONE.
$sel:json:InputSerialization', inputSerialization_json - Specifies JSON as object's input serialization format.
$sel:parquet:InputSerialization', inputSerialization_parquet - Specifies Parquet as object's input serialization format.
IntelligentTieringAndOperator
data IntelligentTieringAndOperator Source #
A container for specifying S3 Intelligent-Tiering filters. The filters determine the subset of objects to which the rule applies.
See: newIntelligentTieringAndOperator smart constructor.
Constructors
| IntelligentTieringAndOperator' (Maybe Text) (Maybe [Tag]) |
Instances
newIntelligentTieringAndOperator :: IntelligentTieringAndOperator Source #
Create a value of IntelligentTieringAndOperator with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:prefix:IntelligentTieringAndOperator', intelligentTieringAndOperator_prefix - An object key name prefix that identifies the subset of objects to which
the configuration applies.
$sel:tags:IntelligentTieringAndOperator', intelligentTieringAndOperator_tags - All of these tags must exist in the object's tag set in order for the
configuration to apply.
IntelligentTieringConfiguration
data IntelligentTieringConfiguration Source #
Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
For information about the S3 Intelligent-Tiering storage class, see Storage class for automatically optimizing frequently and infrequently accessed objects.
See: newIntelligentTieringConfiguration smart constructor.
Constructors
| IntelligentTieringConfiguration' (Maybe IntelligentTieringFilter) Text IntelligentTieringStatus [Tiering] |
Instances
newIntelligentTieringConfiguration Source #
Arguments
| :: Text | |
| -> IntelligentTieringStatus | |
| -> IntelligentTieringConfiguration |
Create a value of IntelligentTieringConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':IntelligentTieringConfiguration', intelligentTieringConfiguration_filter - Specifies a bucket filter. The configuration only includes objects that
meet the filter's criteria.
$sel:id:IntelligentTieringConfiguration', intelligentTieringConfiguration_id - The ID used to identify the S3 Intelligent-Tiering configuration.
$sel:status:IntelligentTieringConfiguration', intelligentTieringConfiguration_status - Specifies the status of the configuration.
$sel:tierings:IntelligentTieringConfiguration', intelligentTieringConfiguration_tierings - Specifies the S3 Intelligent-Tiering storage class tier of the
configuration.
IntelligentTieringFilter
data IntelligentTieringFilter Source #
The Filter is used to identify objects that the S3 Intelligent-Tiering
configuration applies to.
See: newIntelligentTieringFilter smart constructor.
Constructors
| IntelligentTieringFilter' (Maybe IntelligentTieringAndOperator) (Maybe Text) (Maybe Tag) |
Instances
newIntelligentTieringFilter :: IntelligentTieringFilter Source #
Create a value of IntelligentTieringFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:and:IntelligentTieringFilter', intelligentTieringFilter_and - 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.
IntelligentTieringFilter, intelligentTieringFilter_prefix - An object key name prefix that identifies the subset of objects to which
the rule applies.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
$sel:tag:IntelligentTieringFilter', intelligentTieringFilter_tag - Undocumented member.
InventoryConfiguration
data InventoryConfiguration Source #
Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.
See: newInventoryConfiguration smart constructor.
Constructors
| InventoryConfiguration' (Maybe InventoryFilter) (Maybe [InventoryOptionalField]) InventoryDestination Bool Text InventoryIncludedObjectVersions InventorySchedule |
Instances
newInventoryConfiguration Source #
Arguments
| :: InventoryDestination | |
| -> Bool | |
| -> Text | |
| -> InventoryIncludedObjectVersions | |
| -> InventorySchedule | |
| -> InventoryConfiguration |
Create a value of InventoryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':InventoryConfiguration', inventoryConfiguration_filter - Specifies an inventory filter. The inventory only includes objects that
meet the filter's criteria.
$sel:optionalFields:InventoryConfiguration', inventoryConfiguration_optionalFields - Contains the optional fields that are included in the inventory results.
$sel:destination:InventoryConfiguration', inventoryConfiguration_destination - Contains information about where to publish the inventory results.
$sel:isEnabled:InventoryConfiguration', inventoryConfiguration_isEnabled - Specifies whether the inventory is enabled or disabled. If set to
True, an inventory list is generated. If set to False, no inventory
list is generated.
$sel:id:InventoryConfiguration', inventoryConfiguration_id - The ID used to identify the inventory configuration.
$sel:includedObjectVersions:InventoryConfiguration', inventoryConfiguration_includedObjectVersions - Object versions to include in the inventory list. If set to All, the
list includes all the object versions, which adds the version-related
fields VersionId, IsLatest, and DeleteMarker to the list. If set
to Current, the list does not contain these version-related fields.
$sel:schedule:InventoryConfiguration', inventoryConfiguration_schedule - Specifies the schedule for generating inventory results.
InventoryDestination
data InventoryDestination Source #
Specifies the inventory configuration for an Amazon S3 bucket.
See: newInventoryDestination smart constructor.
Constructors
| InventoryDestination' InventoryS3BucketDestination |
Instances
newInventoryDestination Source #
Arguments
| :: InventoryS3BucketDestination | |
| -> InventoryDestination |
Create a value of InventoryDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3BucketDestination:InventoryDestination', inventoryDestination_s3BucketDestination - Contains the bucket name, file format, bucket owner (optional), and
prefix (optional) where inventory results are published.
InventoryEncryption
data InventoryEncryption Source #
Contains the type of server-side encryption used to encrypt the inventory results.
See: newInventoryEncryption smart constructor.
Constructors
| InventoryEncryption' (Maybe SSEKMS) (Maybe SSES3) |
Instances
newInventoryEncryption :: InventoryEncryption Source #
Create a value of InventoryEncryption with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ssekms:InventoryEncryption', inventoryEncryption_ssekms - Specifies the use of SSE-KMS to encrypt delivered inventory reports.
$sel:sses3:InventoryEncryption', inventoryEncryption_sses3 - Specifies the use of SSE-S3 to encrypt delivered inventory reports.
InventoryFilter
data InventoryFilter Source #
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.
See: newInventoryFilter smart constructor.
Constructors
| InventoryFilter' Text |
Instances
Arguments
| :: Text | |
| -> InventoryFilter |
Create a value of InventoryFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:prefix:InventoryFilter', inventoryFilter_prefix - The prefix that an object must have to be included in the inventory
results.
InventoryS3BucketDestination
data InventoryS3BucketDestination Source #
Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.
See: newInventoryS3BucketDestination smart constructor.
Constructors
| InventoryS3BucketDestination' (Maybe Text) (Maybe InventoryEncryption) (Maybe Text) BucketName InventoryFormat |
Instances
newInventoryS3BucketDestination Source #
Arguments
| :: BucketName | |
| -> InventoryFormat | |
| -> InventoryS3BucketDestination |
Create a value of InventoryS3BucketDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:InventoryS3BucketDestination', inventoryS3BucketDestination_accountId - The account ID that owns the destination S3 bucket. If no account ID is
provided, the owner is not validated before exporting data.
Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
$sel:encryption:InventoryS3BucketDestination', inventoryS3BucketDestination_encryption - Contains the type of server-side encryption used to encrypt the
inventory results.
$sel:prefix:InventoryS3BucketDestination', inventoryS3BucketDestination_prefix - The prefix that is prepended to all inventory results.
$sel:bucket:InventoryS3BucketDestination', inventoryS3BucketDestination_bucket - The Amazon Resource Name (ARN) of the bucket where inventory results
will be published.
$sel:format:InventoryS3BucketDestination', inventoryS3BucketDestination_format - Specifies the output format of the inventory results.
InventorySchedule
data InventorySchedule Source #
Specifies the schedule for generating inventory results.
See: newInventorySchedule smart constructor.
Constructors
| InventorySchedule' InventoryFrequency |
Instances
Create a value of InventorySchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:frequency:InventorySchedule', inventorySchedule_frequency - Specifies how frequently inventory results are produced.
JSONInput
Specifies JSON as object's input serialization format.
See: newJSONInput smart constructor.
Constructors
| JSONInput' (Maybe JSONType) |
Instances
| ToXML JSONInput Source # | |
Defined in Amazonka.S3.Types.JSONInput | |
| Generic JSONInput Source # | |
| Read JSONInput Source # | |
| Show JSONInput Source # | |
| NFData JSONInput Source # | |
Defined in Amazonka.S3.Types.JSONInput | |
| Eq JSONInput Source # | |
| Hashable JSONInput Source # | |
Defined in Amazonka.S3.Types.JSONInput | |
| type Rep JSONInput Source # | |
Defined in Amazonka.S3.Types.JSONInput | |
newJSONInput :: JSONInput Source #
Create a value of JSONInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':JSONInput', jSONInput_type - The type of JSON. Valid values: Document, Lines.
JSONOutput
data JSONOutput Source #
Specifies JSON as request's output serialization format.
See: newJSONOutput smart constructor.
Constructors
| JSONOutput' (Maybe Text) |
Instances
newJSONOutput :: JSONOutput Source #
Create a value of JSONOutput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recordDelimiter:JSONOutput', jSONOutput_recordDelimiter - The value used to separate individual records in the output. If no value
is specified, Amazon S3 uses a newline character ('\n').
LambdaFunctionConfiguration
data LambdaFunctionConfiguration Source #
A container for specifying the configuration for Lambda notifications.
See: newLambdaFunctionConfiguration smart constructor.
Constructors
| LambdaFunctionConfiguration' (Maybe NotificationConfigurationFilter) (Maybe Text) Text [Event] |
Instances
newLambdaFunctionConfiguration Source #
Create a value of LambdaFunctionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':LambdaFunctionConfiguration', lambdaFunctionConfiguration_filter - Undocumented member.
$sel:id:LambdaFunctionConfiguration', lambdaFunctionConfiguration_id - Undocumented member.
$sel:lambdaFunctionArn:LambdaFunctionConfiguration', lambdaFunctionConfiguration_lambdaFunctionArn - The Amazon Resource Name (ARN) of the Lambda function that Amazon S3
invokes when the specified event type occurs.
$sel:events:LambdaFunctionConfiguration', lambdaFunctionConfiguration_events - The Amazon S3 bucket event for which to invoke the Lambda function. For
more information, see
Supported Event Types
in the Amazon S3 User Guide.
LifecycleExpiration
data LifecycleExpiration Source #
Container for the expiration for the lifecycle of the object.
See: newLifecycleExpiration smart constructor.
Instances
newLifecycleExpiration :: LifecycleExpiration Source #
Create a value of LifecycleExpiration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:date:LifecycleExpiration', lifecycleExpiration_date - Indicates at what date the object is to be moved or deleted. Should be
in GMT ISO 8601 Format.
$sel:days:LifecycleExpiration', lifecycleExpiration_days - Indicates the lifetime, in days, of the objects that are subject to the
rule. The value must be a non-zero positive integer.
$sel:expiredObjectDeleteMarker:LifecycleExpiration', lifecycleExpiration_expiredObjectDeleteMarker - 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.
LifecycleRule
data LifecycleRule Source #
A lifecycle rule for individual objects in an Amazon S3 bucket.
See: newLifecycleRule smart constructor.
Constructors
Instances
Arguments
| :: ExpirationStatus | |
| -> LifecycleRule |
Create a value of LifecycleRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:abortIncompleteMultipartUpload:LifecycleRule', lifecycleRule_abortIncompleteMultipartUpload - Undocumented member.
$sel:expiration:LifecycleRule', lifecycleRule_expiration - Specifies the expiration for the lifecycle of the object in the form of
date, days and, whether the object has a delete marker.
$sel:filter':LifecycleRule', lifecycleRule_filter - The Filter is used to identify objects that a Lifecycle Rule applies
to. A Filter must have exactly one of Prefix, Tag, or And
specified. Filter is required if the LifecycleRule does not contain
a Prefix element.
$sel:id:LifecycleRule', lifecycleRule_id - Unique identifier for the rule. The value cannot be longer than 255
characters.
$sel:noncurrentVersionExpiration:LifecycleRule', lifecycleRule_noncurrentVersionExpiration - Undocumented member.
$sel:noncurrentVersionTransitions:LifecycleRule', lifecycleRule_noncurrentVersionTransitions - Specifies the transition rule for the lifecycle rule that describes when
noncurrent objects transition to a specific storage class. If your
bucket is versioning-enabled (or versioning is suspended), you can set
this action to request that Amazon S3 transition noncurrent object
versions to a specific storage class at a set period in the object's
lifetime.
LifecycleRule, lifecycleRule_prefix - Prefix identifying one or more objects to which the rule applies. This
is no longer used; use Filter instead.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
$sel:transitions:LifecycleRule', lifecycleRule_transitions - Specifies when an Amazon S3 object transitions to a specified storage
class.
$sel:status:LifecycleRule', lifecycleRule_status - If 'Enabled', the rule is currently being applied. If 'Disabled',
the rule is not currently being applied.
LifecycleRuleAndOperator
data LifecycleRuleAndOperator Source #
This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.
See: newLifecycleRuleAndOperator smart constructor.
Instances
newLifecycleRuleAndOperator :: LifecycleRuleAndOperator Source #
Create a value of LifecycleRuleAndOperator with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectSizeGreaterThan:LifecycleRuleAndOperator', lifecycleRuleAndOperator_objectSizeGreaterThan - Minimum object size to which the rule applies.
$sel:objectSizeLessThan:LifecycleRuleAndOperator', lifecycleRuleAndOperator_objectSizeLessThan - Maximum object size to which the rule applies.
$sel:prefix:LifecycleRuleAndOperator', lifecycleRuleAndOperator_prefix - Prefix identifying one or more objects to which the rule applies.
$sel:tags:LifecycleRuleAndOperator', lifecycleRuleAndOperator_tags - All of these tags must exist in the object's tag set in order for the
rule to apply.
LifecycleRuleFilter
data LifecycleRuleFilter Source #
The Filter is used to identify objects that a Lifecycle Rule applies
to. A Filter must have exactly one of Prefix, Tag, or And
specified.
See: newLifecycleRuleFilter smart constructor.
Constructors
| LifecycleRuleFilter' (Maybe LifecycleRuleAndOperator) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Tag) |
Instances
newLifecycleRuleFilter :: LifecycleRuleFilter Source #
Create a value of LifecycleRuleFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:and:LifecycleRuleFilter', lifecycleRuleFilter_and - Undocumented member.
LifecycleRuleFilter, lifecycleRuleFilter_objectSizeGreaterThan - Minimum object size to which the rule applies.
LifecycleRuleFilter, lifecycleRuleFilter_objectSizeLessThan - Maximum object size to which the rule applies.
LifecycleRuleFilter, lifecycleRuleFilter_prefix - Prefix identifying one or more objects to which the rule applies.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
$sel:tag:LifecycleRuleFilter', lifecycleRuleFilter_tag - This tag must exist in the object's tag set in order for the rule to
apply.
LoggingEnabled
data LoggingEnabled Source #
Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.
See: newLoggingEnabled smart constructor.
Constructors
| LoggingEnabled' (Maybe [TargetGrant]) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> LoggingEnabled |
Create a value of LoggingEnabled with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetGrants:LoggingEnabled', loggingEnabled_targetGrants - Container for granting information.
Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.
$sel:targetBucket:LoggingEnabled', loggingEnabled_targetBucket - 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.
$sel:targetPrefix:LoggingEnabled', loggingEnabled_targetPrefix - A prefix for all log object keys. If you store log files from multiple
Amazon S3 buckets in a single bucket, you can use a prefix to
distinguish which log files came from which bucket.
MetadataEntry
data MetadataEntry Source #
A metadata key-value pair to store with an object.
See: newMetadataEntry smart constructor.
Constructors
| MetadataEntry' (Maybe Text) (Maybe Text) |
Instances
newMetadataEntry :: MetadataEntry Source #
Create a value of MetadataEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:MetadataEntry', metadataEntry_name - Name of the Object.
$sel:value:MetadataEntry', metadataEntry_value - Value of the Object.
Metrics
A container specifying replication metrics-related settings enabling replication metrics and events.
See: newMetrics smart constructor.
Constructors
| Metrics' (Maybe ReplicationTimeValue) MetricsStatus |
Instances
| FromXML Metrics Source # | |
| ToXML Metrics Source # | |
Defined in Amazonka.S3.Types.Metrics | |
| Generic Metrics Source # | |
| Read Metrics Source # | |
| Show Metrics Source # | |
| NFData Metrics Source # | |
Defined in Amazonka.S3.Types.Metrics | |
| Eq Metrics Source # | |
| Hashable Metrics Source # | |
Defined in Amazonka.S3.Types.Metrics | |
| type Rep Metrics Source # | |
Defined in Amazonka.S3.Types.Metrics type Rep Metrics = D1 ('MetaData "Metrics" "Amazonka.S3.Types.Metrics" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Metrics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationTimeValue)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricsStatus))) | |
Arguments
| :: MetricsStatus | |
| -> Metrics |
Create a value of Metrics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventThreshold:Metrics', metrics_eventThreshold - A container specifying the time threshold for emitting the
s3:Replication:OperationMissedThreshold event.
$sel:status:Metrics', metrics_status - Specifies whether the replication metrics are enabled.
MetricsAndOperator
data MetricsAndOperator Source #
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.
See: newMetricsAndOperator smart constructor.
Instances
newMetricsAndOperator :: MetricsAndOperator Source #
Create a value of MetricsAndOperator with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessPointArn:MetricsAndOperator', metricsAndOperator_accessPointArn - The access point ARN used when evaluating an AND predicate.
$sel:prefix:MetricsAndOperator', metricsAndOperator_prefix - The prefix used when evaluating an AND predicate.
$sel:tags:MetricsAndOperator', metricsAndOperator_tags - The list of tags used when evaluating an AND predicate.
MetricsConfiguration
data MetricsConfiguration Source #
Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration.
See: newMetricsConfiguration smart constructor.
Constructors
| MetricsConfiguration' (Maybe MetricsFilter) Text |
Instances
newMetricsConfiguration Source #
Arguments
| :: Text | |
| -> MetricsConfiguration |
Create a value of MetricsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':MetricsConfiguration', metricsConfiguration_filter - Specifies a metrics configuration filter. The metrics configuration will
only include objects that meet the filter's criteria. A filter must be
a prefix, an object tag, an access point ARN, or a conjunction
(MetricsAndOperator).
$sel:id:MetricsConfiguration', metricsConfiguration_id - The ID used to identify the metrics configuration.
MetricsFilter
data MetricsFilter Source #
Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.
See: newMetricsFilter smart constructor.
Constructors
| MetricsFilter' (Maybe Text) (Maybe MetricsAndOperator) (Maybe Text) (Maybe Tag) |
Instances
newMetricsFilter :: MetricsFilter Source #
Create a value of MetricsFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
MetricsFilter, metricsFilter_accessPointArn - The access point ARN used when evaluating a metrics filter.
$sel:and:MetricsFilter', metricsFilter_and - 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.
MetricsFilter, metricsFilter_prefix - The prefix used when evaluating a metrics filter.
$sel:tag:MetricsFilter', metricsFilter_tag - The tag used when evaluating a metrics filter.
MultipartUpload
data MultipartUpload Source #
Container for the MultipartUpload for the Amazon S3 object.
See: newMultipartUpload smart constructor.
Constructors
| MultipartUpload' (Maybe ChecksumAlgorithm) (Maybe ISO8601) (Maybe Initiator) (Maybe ObjectKey) (Maybe Owner) (Maybe StorageClass) (Maybe Text) |
Instances
newMultipartUpload :: MultipartUpload Source #
Create a value of MultipartUpload with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumAlgorithm:MultipartUpload', multipartUpload_checksumAlgorithm - The algorithm that was used to create a checksum of the object.
$sel:initiated:MultipartUpload', multipartUpload_initiated - Date and time at which the multipart upload was initiated.
$sel:initiator:MultipartUpload', multipartUpload_initiator - Identifies who initiated the multipart upload.
$sel:key:MultipartUpload', multipartUpload_key - Key of the object for which the multipart upload was initiated.
$sel:owner:MultipartUpload', multipartUpload_owner - Specifies the owner of the object that is part of the multipart upload.
$sel:storageClass:MultipartUpload', multipartUpload_storageClass - The class of storage used to store the object.
$sel:uploadId:MultipartUpload', multipartUpload_uploadId - Upload ID that identifies the multipart upload.
NoncurrentVersionExpiration
data NoncurrentVersionExpiration Source #
Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
See: newNoncurrentVersionExpiration smart constructor.
Constructors
| NoncurrentVersionExpiration' (Maybe Int) Int |
Instances
newNoncurrentVersionExpiration Source #
Create a value of NoncurrentVersionExpiration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:newerNoncurrentVersions':NoncurrentVersionExpiration', noncurrentVersionExpiration_newerNoncurrentVersions - Specifies how many noncurrent versions Amazon S3 will retain. If there
are this many more recent noncurrent versions, Amazon S3 will take the
associated action. For more information about noncurrent versions, see
Lifecycle configuration elements
in the Amazon S3 User Guide.
$sel:noncurrentDays:NoncurrentVersionExpiration', noncurrentVersionExpiration_noncurrentDays - Specifies the number of days an object is noncurrent before Amazon S3
can perform the associated action. The value must be a non-zero positive
integer. For information about the noncurrent days calculations, see
How Amazon S3 Calculates When an Object Became Noncurrent
in the Amazon S3 User Guide.
NoncurrentVersionTransition
data NoncurrentVersionTransition Source #
Container for the transition rule that describes when noncurrent objects
transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING,
GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class. If your bucket
is versioning-enabled (or versioning is suspended), you can set this
action to request that Amazon S3 transition noncurrent object versions
to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR,
GLACIER, or DEEP_ARCHIVE storage class at a specific period in the
object's lifetime.
See: newNoncurrentVersionTransition smart constructor.
Constructors
| NoncurrentVersionTransition' (Maybe Int) Int TransitionStorageClass |
Instances
newNoncurrentVersionTransition Source #
Arguments
| :: Int | |
| -> TransitionStorageClass | |
| -> NoncurrentVersionTransition |
Create a value of NoncurrentVersionTransition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:newerNoncurrentVersions':NoncurrentVersionTransition', noncurrentVersionTransition_newerNoncurrentVersions - Specifies how many noncurrent versions Amazon S3 will retain. If there
are this many more recent noncurrent versions, Amazon S3 will take the
associated action. For more information about noncurrent versions, see
Lifecycle configuration elements
in the Amazon S3 User Guide.
$sel:noncurrentDays:NoncurrentVersionTransition', noncurrentVersionTransition_noncurrentDays - 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 How Long an Object Has Been Noncurrent
in the Amazon S3 User Guide.
$sel:storageClass:NoncurrentVersionTransition', noncurrentVersionTransition_storageClass - The class of storage used to store the object.
NotificationConfiguration
data NotificationConfiguration Source #
A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.
See: newNotificationConfiguration smart constructor.
Constructors
| NotificationConfiguration' (Maybe EventBridgeConfiguration) (Maybe [LambdaFunctionConfiguration]) (Maybe [QueueConfiguration]) (Maybe [TopicConfiguration]) |
Instances
newNotificationConfiguration :: NotificationConfiguration Source #
Create a value of NotificationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventBridgeConfiguration:NotificationConfiguration', notificationConfiguration_eventBridgeConfiguration - Enables delivery of events to Amazon EventBridge.
$sel:lambdaFunctionConfigurations:NotificationConfiguration', notificationConfiguration_lambdaFunctionConfigurations - Describes the Lambda functions to invoke and the events for which to
invoke them.
$sel:queueConfigurations:NotificationConfiguration', notificationConfiguration_queueConfigurations - The Amazon Simple Queue Service queues to publish messages to and the
events for which to publish messages.
$sel:topicConfigurations:NotificationConfiguration', notificationConfiguration_topicConfigurations - The topic to which notifications are sent and the events for which
notifications are generated.
NotificationConfigurationFilter
data NotificationConfigurationFilter Source #
Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon S3 User Guide.
See: newNotificationConfigurationFilter smart constructor.
Constructors
| NotificationConfigurationFilter' (Maybe S3KeyFilter) |
Instances
newNotificationConfigurationFilter :: NotificationConfigurationFilter Source #
Create a value of NotificationConfigurationFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:NotificationConfigurationFilter', notificationConfigurationFilter_key - Undocumented member.
Object
An object consists of data and its descriptive metadata.
See: newObject smart constructor.
Constructors
| Object' (Maybe [ChecksumAlgorithm]) (Maybe Owner) ETag Integer ObjectKey ObjectStorageClass RFC822 |
Instances
Create a value of Object with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumAlgorithm:Object', object_checksumAlgorithm - The algorithm that was used to create a checksum of the object.
$sel:owner:Object', object_owner - The owner of the object
$sel:eTag:Object', object_eTag - The entity tag is a hash of the object. The ETag reflects changes only
to the contents of an object, not its metadata. The ETag may or may not
be an MD5 digest of the object data. Whether or not it is depends on how
the object was created and how it is encrypted as described below:
- Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.
- Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.
- If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.
$sel:size:Object', object_size - Size in bytes of the object
$sel:key:Object', object_key - The name that you assign to an object. You use the object key to
retrieve the object.
$sel:storageClass:Object', object_storageClass - The class of storage used to store the object.
$sel:lastModified:Object', object_lastModified - Creation date of the object.
ObjectIdentifier
data ObjectIdentifier Source #
Object Identifier is unique value to identify objects.
See: newObjectIdentifier smart constructor.
Constructors
| ObjectIdentifier' (Maybe ObjectVersionId) ObjectKey |
Instances
Arguments
| :: ObjectKey | |
| -> ObjectIdentifier |
Create a value of ObjectIdentifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versionId:ObjectIdentifier', objectIdentifier_versionId - VersionId for the specific version of the object to delete.
$sel:key:ObjectIdentifier', objectIdentifier_key - Key name of the object.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
ObjectLockConfiguration
data ObjectLockConfiguration Source #
The container element for Object Lock configuration parameters.
See: newObjectLockConfiguration smart constructor.
Constructors
| ObjectLockConfiguration' (Maybe ObjectLockEnabled) (Maybe ObjectLockRule) |
Instances
newObjectLockConfiguration :: ObjectLockConfiguration Source #
Create a value of ObjectLockConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectLockEnabled:ObjectLockConfiguration', objectLockConfiguration_objectLockEnabled - Indicates whether this bucket has an Object Lock configuration enabled.
Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a
bucket.
$sel:rule:ObjectLockConfiguration', objectLockConfiguration_rule - Specifies the Object Lock rule for the specified object. Enable the this
rule when you apply ObjectLockConfiguration to a bucket. Bucket
settings require both a mode and a period. The period can be either
Days or Years but you must select one. You cannot specify Days and
Years at the same time.
ObjectLockLegalHold
data ObjectLockLegalHold Source #
A legal hold configuration for an object.
See: newObjectLockLegalHold smart constructor.
Constructors
| ObjectLockLegalHold' (Maybe ObjectLockLegalHoldStatus) |
Instances
newObjectLockLegalHold :: ObjectLockLegalHold Source #
Create a value of ObjectLockLegalHold with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ObjectLockLegalHold', objectLockLegalHold_status - Indicates whether the specified object has a legal hold in place.
ObjectLockRetention
data ObjectLockRetention Source #
A Retention configuration for an object.
See: newObjectLockRetention smart constructor.
Constructors
| ObjectLockRetention' (Maybe ObjectLockRetentionMode) (Maybe ISO8601) |
Instances
newObjectLockRetention :: ObjectLockRetention Source #
Create a value of ObjectLockRetention with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mode:ObjectLockRetention', objectLockRetention_mode - Indicates the Retention mode for the specified object.
$sel:retainUntilDate:ObjectLockRetention', objectLockRetention_retainUntilDate - The date on which this Object Lock Retention will expire.
ObjectLockRule
data ObjectLockRule Source #
The container element for an Object Lock rule.
See: newObjectLockRule smart constructor.
Constructors
| ObjectLockRule' (Maybe DefaultRetention) |
Instances
newObjectLockRule :: ObjectLockRule Source #
Create a value of ObjectLockRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultRetention:ObjectLockRule', objectLockRule_defaultRetention - The default Object Lock retention mode and period that you want to apply
to new objects placed in the specified bucket. Bucket settings require
both a mode and a period. The period can be either Days or Years but
you must select one. You cannot specify Days and Years at the same
time.
ObjectPart
data ObjectPart Source #
A container for elements related to an individual part.
See: newObjectPart smart constructor.
Constructors
| ObjectPart' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Integer) |
Instances
newObjectPart :: ObjectPart Source #
Create a value of ObjectPart with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumCRC32:ObjectPart', objectPart_checksumCRC32 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 32-bit CRC32 checksum of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumCRC32C:ObjectPart', objectPart_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA1:ObjectPart', objectPart_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA256:ObjectPart', objectPart_checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:partNumber:ObjectPart', objectPart_partNumber - The part number identifying the part. This value is a positive integer
between 1 and 10,000.
$sel:size:ObjectPart', objectPart_size - The size of the uploaded part in bytes.
ObjectVersion
data ObjectVersion Source #
The version of an object.
See: newObjectVersion smart constructor.
Constructors
| ObjectVersion' (Maybe [ChecksumAlgorithm]) (Maybe ETag) (Maybe Bool) (Maybe ObjectKey) (Maybe RFC822) (Maybe Owner) (Maybe Integer) (Maybe ObjectVersionStorageClass) (Maybe ObjectVersionId) |
Instances
newObjectVersion :: ObjectVersion Source #
Create a value of ObjectVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumAlgorithm:ObjectVersion', objectVersion_checksumAlgorithm - The algorithm that was used to create a checksum of the object.
$sel:eTag:ObjectVersion', objectVersion_eTag - The entity tag is an MD5 hash of that version of the object.
$sel:isLatest:ObjectVersion', objectVersion_isLatest - Specifies whether the object is (true) or is not (false) the latest
version of an object.
$sel:key:ObjectVersion', objectVersion_key - The object key.
$sel:lastModified:ObjectVersion', objectVersion_lastModified - Date and time the object was last modified.
$sel:owner:ObjectVersion', objectVersion_owner - Specifies the owner of the object.
$sel:size:ObjectVersion', objectVersion_size - Size in bytes of the object.
$sel:storageClass:ObjectVersion', objectVersion_storageClass - The class of storage used to store the object.
$sel:versionId:ObjectVersion', objectVersion_versionId - Version ID of an object.
OutputLocation
data OutputLocation Source #
Describes the location where the restore job's output is stored.
See: newOutputLocation smart constructor.
Constructors
| OutputLocation' (Maybe S3Location) |
Instances
newOutputLocation :: OutputLocation Source #
Create a value of OutputLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3:OutputLocation', outputLocation_s3 - Describes an S3 location that will receive the results of the restore
request.
OutputSerialization
data OutputSerialization Source #
Describes how results of the Select job are serialized.
See: newOutputSerialization smart constructor.
Constructors
| OutputSerialization' (Maybe CSVOutput) (Maybe JSONOutput) |
Instances
newOutputSerialization :: OutputSerialization Source #
Create a value of OutputSerialization with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:csv:OutputSerialization', outputSerialization_csv - Describes the serialization of CSV-encoded Select results.
$sel:json:OutputSerialization', outputSerialization_json - Specifies JSON as request's output serialization format.
Owner
Container for the owner's display name and ID.
See: newOwner smart constructor.
Instances
| FromXML Owner Source # | |
| ToXML Owner Source # | |
Defined in Amazonka.S3.Types.Owner | |
| Generic Owner Source # | |
| Read Owner Source # | |
| Show Owner Source # | |
| NFData Owner Source # | |
Defined in Amazonka.S3.Types.Owner | |
| Eq Owner Source # | |
| Hashable Owner Source # | |
Defined in Amazonka.S3.Types.Owner | |
| type Rep Owner Source # | |
Defined in Amazonka.S3.Types.Owner type Rep Owner = D1 ('MetaData "Owner" "Amazonka.S3.Types.Owner" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Owner'" 'PrefixI 'True) (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Owner with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:displayName:Owner', owner_displayName - Container for the display name of the owner.
$sel:id:Owner', owner_id - Container for the ID of the owner.
OwnershipControls
data OwnershipControls Source #
The container element for a bucket's ownership controls.
See: newOwnershipControls smart constructor.
Constructors
| OwnershipControls' [OwnershipControlsRule] |
Instances
newOwnershipControls :: OwnershipControls Source #
Create a value of OwnershipControls with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rules:OwnershipControls', ownershipControls_rules - The container element for an ownership control rule.
OwnershipControlsRule
data OwnershipControlsRule Source #
The container element for an ownership control rule.
See: newOwnershipControlsRule smart constructor.
Constructors
| OwnershipControlsRule' ObjectOwnership |
Instances
newOwnershipControlsRule Source #
Create a value of OwnershipControlsRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectOwnership:OwnershipControlsRule', ownershipControlsRule_objectOwnership - Undocumented member.
ParquetInput
data ParquetInput Source #
Container for Parquet.
See: newParquetInput smart constructor.
Constructors
| ParquetInput' | |
Instances
| ToXML ParquetInput Source # | |
Defined in Amazonka.S3.Types.ParquetInput Methods toXML :: ParquetInput -> XML # | |
| Generic ParquetInput Source # | |
Defined in Amazonka.S3.Types.ParquetInput Associated Types type Rep ParquetInput :: Type -> Type # | |
| Read ParquetInput Source # | |
Defined in Amazonka.S3.Types.ParquetInput Methods readsPrec :: Int -> ReadS ParquetInput # readList :: ReadS [ParquetInput] # | |
| Show ParquetInput Source # | |
Defined in Amazonka.S3.Types.ParquetInput Methods showsPrec :: Int -> ParquetInput -> ShowS # show :: ParquetInput -> String # showList :: [ParquetInput] -> ShowS # | |
| NFData ParquetInput Source # | |
Defined in Amazonka.S3.Types.ParquetInput Methods rnf :: ParquetInput -> () # | |
| Eq ParquetInput Source # | |
Defined in Amazonka.S3.Types.ParquetInput | |
| Hashable ParquetInput Source # | |
Defined in Amazonka.S3.Types.ParquetInput | |
| type Rep ParquetInput Source # | |
newParquetInput :: ParquetInput Source #
Create a value of ParquetInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Part
Container for elements related to a part.
See: newPart smart constructor.
Constructors
| Part' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ETag) (Maybe RFC822) (Maybe Int) (Maybe Integer) |
Instances
Create a value of Part with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumCRC32:Part', part_checksumCRC32 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 32-bit CRC32 checksum of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumCRC32C:Part', part_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA1:Part', part_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only
be present if it was uploaded with the object. With multipart uploads,
this may not be a checksum value of the object. For more information
about how checksums are calculated with multipart uploads, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:checksumSHA256:Part', part_checksumSHA256 - This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the base64-encoded, 256-bit SHA-256 digest of the object. For
more information, see
Checking object integrity
in the Amazon S3 User Guide.
$sel:eTag:Part', part_eTag - Entity tag returned when the part was uploaded.
$sel:lastModified:Part', part_lastModified - Date and time at which the part was uploaded.
$sel:partNumber:Part', part_partNumber - Part number identifying the part. This is a positive integer between 1
and 10,000.
$sel:size:Part', part_size - Size in bytes of the uploaded part data.
PolicyStatus
data PolicyStatus Source #
The container element for a bucket's policy status.
See: newPolicyStatus smart constructor.
Constructors
| PolicyStatus' (Maybe Bool) |
Instances
newPolicyStatus :: PolicyStatus Source #
Create a value of PolicyStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isPublic:PolicyStatus', policyStatus_isPublic - The policy status for this bucket. TRUE indicates that this bucket is
public. FALSE indicates that the bucket is not public.
Progress
This data type contains information about progress of an operation.
See: newProgress smart constructor.
Instances
| FromXML Progress Source # | |
| Generic Progress Source # | |
| Read Progress Source # | |
| Show Progress Source # | |
| NFData Progress Source # | |
Defined in Amazonka.S3.Types.Progress | |
| Eq Progress Source # | |
| Hashable Progress Source # | |
Defined in Amazonka.S3.Types.Progress | |
| type Rep Progress Source # | |
Defined in Amazonka.S3.Types.Progress type Rep Progress = D1 ('MetaData "Progress" "Amazonka.S3.Types.Progress" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Progress'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bytesProcessed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "bytesReturned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "bytesScanned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) | |
newProgress :: Progress Source #
Create a value of Progress with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bytesProcessed:Progress', progress_bytesProcessed - The current number of uncompressed object bytes processed.
$sel:bytesReturned:Progress', progress_bytesReturned - The current number of bytes of records payload data returned.
$sel:bytesScanned:Progress', progress_bytesScanned - The current number of object bytes scanned.
ProgressEvent
data ProgressEvent Source #
This data type contains information about the progress event of an operation.
See: newProgressEvent smart constructor.
Constructors
| ProgressEvent' (Maybe Progress) |
Instances
newProgressEvent :: ProgressEvent Source #
Create a value of ProgressEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:details:ProgressEvent', progressEvent_details - The Progress event details.
PublicAccessBlockConfiguration
data PublicAccessBlockConfiguration Source #
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 S3 User Guide.
See: newPublicAccessBlockConfiguration smart constructor.
Instances
newPublicAccessBlockConfiguration :: PublicAccessBlockConfiguration Source #
Create a value of PublicAccessBlockConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockPublicAcls:PublicAccessBlockConfiguration', publicAccessBlockConfiguration_blockPublicAcls - 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.
- PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.
$sel:blockPublicPolicy:PublicAccessBlockConfiguration', publicAccessBlockConfiguration_blockPublicPolicy - 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.
$sel:ignorePublicAcls:PublicAccessBlockConfiguration', publicAccessBlockConfiguration_ignorePublicAcls - 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.
$sel:restrictPublicBuckets:PublicAccessBlockConfiguration', publicAccessBlockConfiguration_restrictPublicBuckets - Specifies whether Amazon S3 should restrict public bucket policies for
this bucket. Setting this element to TRUE restricts access to this
bucket to only Amazon Web Service principals 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.
QueueConfiguration
data QueueConfiguration Source #
Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
See: newQueueConfiguration smart constructor.
Constructors
| QueueConfiguration' (Maybe NotificationConfigurationFilter) (Maybe Text) Text [Event] |
Instances
newQueueConfiguration Source #
Arguments
| :: Text | |
| -> QueueConfiguration |
Create a value of QueueConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':QueueConfiguration', queueConfiguration_filter - Undocumented member.
$sel:id:QueueConfiguration', queueConfiguration_id - Undocumented member.
$sel:queueArn:QueueConfiguration', queueConfiguration_queueArn - The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon
S3 publishes a message when it detects events of the specified type.
$sel:events:QueueConfiguration', queueConfiguration_events - A collection of bucket events for which to send notifications
RecordsEvent
data RecordsEvent Source #
The container for the records event.
See: newRecordsEvent smart constructor.
Constructors
| RecordsEvent' (Maybe Base64) |
Instances
newRecordsEvent :: RecordsEvent Source #
Create a value of RecordsEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:payload:RecordsEvent', recordsEvent_payload - The byte array of partial, one or more result records.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
Redirect
Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.
See: newRedirect smart constructor.
Instances
newRedirect :: Redirect Source #
Create a value of Redirect with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostName:Redirect', redirect_hostName - The host name to use in the redirect request.
$sel:httpRedirectCode:Redirect', redirect_httpRedirectCode - The HTTP redirect code to use on the response. Not required if one of
the siblings is present.
$sel:protocol:Redirect', redirect_protocol - Protocol to use when redirecting requests. The default is the protocol
that is used in the original request.
$sel:replaceKeyPrefixWith:Redirect', redirect_replaceKeyPrefixWith - 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.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
$sel:replaceKeyWith:Redirect', redirect_replaceKeyWith - The specific object key to use in the redirect request. For example,
redirect request to error.html. Not required if one of the siblings is
present. Can be present only if ReplaceKeyPrefixWith is not provided.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
RedirectAllRequestsTo
data RedirectAllRequestsTo Source #
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
See: newRedirectAllRequestsTo smart constructor.
Constructors
| RedirectAllRequestsTo' (Maybe Protocol) Text |
Instances
newRedirectAllRequestsTo Source #
Create a value of RedirectAllRequestsTo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protocol:RedirectAllRequestsTo', redirectAllRequestsTo_protocol - Protocol to use when redirecting requests. The default is the protocol
that is used in the original request.
$sel:hostName:RedirectAllRequestsTo', redirectAllRequestsTo_hostName - Name of the host where requests are redirected.
ReplicaModifications
data ReplicaModifications Source #
A filter that you can specify for selection for modifications on
replicas. Amazon S3 doesn't replicate replica modifications by default.
In the latest version of replication configuration (when Filter is
specified), you can specify this element and set the status to Enabled
to replicate modifications on replicas.
If you don't specify the Filter element, Amazon S3 assumes that the
replication configuration is the earlier version, V1. In the earlier
version, this element is not allowed.
See: newReplicaModifications smart constructor.
Constructors
| ReplicaModifications' ReplicaModificationsStatus |
Instances
newReplicaModifications Source #
Create a value of ReplicaModifications with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ReplicaModifications', replicaModifications_status - Specifies whether Amazon S3 replicates modifications on replicas.
ReplicationConfiguration
data ReplicationConfiguration Source #
A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.
See: newReplicationConfiguration smart constructor.
Constructors
| ReplicationConfiguration' Text [ReplicationRule] |
Instances
newReplicationConfiguration Source #
Create a value of ReplicationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:role':ReplicationConfiguration', replicationConfiguration_role - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that Amazon S3 assumes when replicating objects. For more
information, see
How to Set Up Replication
in the Amazon S3 User Guide.
$sel:rules:ReplicationConfiguration', replicationConfiguration_rules - 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.
ReplicationRule
data ReplicationRule Source #
Specifies which Amazon S3 objects to replicate and where to store the replicas.
See: newReplicationRule smart constructor.
Constructors
Instances
Arguments
| :: ReplicationRuleStatus | |
| -> Destination | |
| -> ReplicationRule |
Create a value of ReplicationRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteMarkerReplication:ReplicationRule', replicationRule_deleteMarkerReplication - Undocumented member.
$sel:existingObjectReplication:ReplicationRule', replicationRule_existingObjectReplication -
$sel:filter':ReplicationRule', replicationRule_filter - Undocumented member.
$sel:id:ReplicationRule', replicationRule_id - A unique identifier for the rule. The maximum value is 255 characters.
ReplicationRule, replicationRule_prefix - An object key name prefix that identifies the object or objects to which
the rule applies. The maximum prefix length is 1,024 characters. To
include all objects in a bucket, specify an empty string.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
$sel:priority:ReplicationRule', replicationRule_priority - The priority indicates which rule has precedence whenever two or more
replication rules conflict. Amazon S3 will attempt to replicate objects
according to all replication rules. However, if there are two or more
rules with the same destination bucket, then objects will be replicated
according to the rule with the highest priority. The higher the number,
the higher the priority.
For more information, see Replication in the Amazon S3 User Guide.
$sel:sourceSelectionCriteria:ReplicationRule', replicationRule_sourceSelectionCriteria - 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 a customer managed key stored in Amazon Web Services
Key Management Service (SSE-KMS).
ReplicationRule, replicationRule_status - Specifies whether the rule is enabled.
$sel:destination:ReplicationRule', replicationRule_destination - A container for information about the replication destination and its
configurations including enabling the S3 Replication Time Control (S3
RTC).
ReplicationRuleAndOperator
data ReplicationRuleAndOperator Source #
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
Prefixand aTagfilter, wrap these filters in anAndtag. - If you specify a filter based on multiple tags, wrap the
Tagelements in anAndtag.
See: newReplicationRuleAndOperator smart constructor.
Constructors
| ReplicationRuleAndOperator' (Maybe Text) (Maybe [Tag]) |
Instances
newReplicationRuleAndOperator :: ReplicationRuleAndOperator Source #
Create a value of ReplicationRuleAndOperator with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:prefix:ReplicationRuleAndOperator', replicationRuleAndOperator_prefix - An object key name prefix that identifies the subset of objects to which
the rule applies.
$sel:tags:ReplicationRuleAndOperator', replicationRuleAndOperator_tags - An array of tags containing key and value pairs.
ReplicationRuleFilter
data ReplicationRuleFilter Source #
A filter that identifies the subset of objects to which the replication
rule applies. A Filter must specify exactly one Prefix, Tag, or an
And child element.
See: newReplicationRuleFilter smart constructor.
Constructors
| ReplicationRuleFilter' (Maybe ReplicationRuleAndOperator) (Maybe Text) (Maybe Tag) |
Instances
newReplicationRuleFilter :: ReplicationRuleFilter Source #
Create a value of ReplicationRuleFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:and:ReplicationRuleFilter', replicationRuleFilter_and - 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
Prefixand aTagfilter, wrap these filters in anAndtag. - If you specify a filter based on multiple tags, wrap the
Tagelements in anAndtag.
ReplicationRuleFilter, replicationRuleFilter_prefix - An object key name prefix that identifies the subset of objects to which
the rule applies.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
$sel:tag:ReplicationRuleFilter', replicationRuleFilter_tag - A container for specifying a tag key and value.
The rule applies only to objects that have the tag in their tag set.
ReplicationTime
data ReplicationTime Source #
A container specifying S3 Replication Time Control (S3 RTC) related
information, including whether S3 RTC is enabled and the time when all
objects and operations on objects must be replicated. Must be specified
together with a Metrics block.
See: newReplicationTime smart constructor.
Instances
Arguments
| :: ReplicationTimeStatus | |
| -> ReplicationTimeValue | |
| -> ReplicationTime |
Create a value of ReplicationTime with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ReplicationTime', replicationTime_status - Specifies whether the replication time is enabled.
$sel:time:ReplicationTime', replicationTime_time - A container specifying the time by which replication should be complete
for all objects and operations on objects.
ReplicationTimeValue
data ReplicationTimeValue Source #
A container specifying the time value for S3 Replication Time Control
(S3 RTC) and replication metrics EventThreshold.
See: newReplicationTimeValue smart constructor.
Constructors
| ReplicationTimeValue' (Maybe Int) |
Instances
newReplicationTimeValue :: ReplicationTimeValue Source #
Create a value of ReplicationTimeValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minutes:ReplicationTimeValue', replicationTimeValue_minutes - Contains an integer specifying time in minutes.
Valid value: 15
RequestPaymentConfiguration
data RequestPaymentConfiguration Source #
Container for Payer.
See: newRequestPaymentConfiguration smart constructor.
Constructors
| RequestPaymentConfiguration' Payer |
Instances
newRequestPaymentConfiguration Source #
Create a value of RequestPaymentConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:payer:RequestPaymentConfiguration', requestPaymentConfiguration_payer - Specifies who pays for the download and request fees.
RequestProgress
data RequestProgress Source #
Container for specifying if periodic QueryProgress messages should be
sent.
See: newRequestProgress smart constructor.
Constructors
| RequestProgress' (Maybe Bool) |
Instances
newRequestProgress :: RequestProgress Source #
Create a value of RequestProgress with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:RequestProgress', requestProgress_enabled - Specifies whether periodic QueryProgress frames should be sent. Valid
values: TRUE, FALSE. Default value: FALSE.
RestoreRequest
data RestoreRequest Source #
Container for restore job parameters.
See: newRestoreRequest smart constructor.
Constructors
| RestoreRequest' (Maybe Int) (Maybe Text) (Maybe GlacierJobParameters) (Maybe OutputLocation) (Maybe SelectParameters) (Maybe Tier) (Maybe RestoreRequestType) |
Instances
newRestoreRequest :: RestoreRequest Source #
Create a value of RestoreRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:days:RestoreRequest', restoreRequest_days - Lifetime of the active copy in days. Do not use with restores that
specify OutputLocation.
The Days element is required for regular restores, and must not be provided for select requests.
$sel:description:RestoreRequest', restoreRequest_description - The optional description for the job.
$sel:glacierJobParameters:RestoreRequest', restoreRequest_glacierJobParameters - S3 Glacier related parameters pertaining to this job. Do not use with
restores that specify OutputLocation.
$sel:outputLocation:RestoreRequest', restoreRequest_outputLocation - Describes the location where the restore job's output is stored.
$sel:selectParameters:RestoreRequest', restoreRequest_selectParameters - Describes the parameters for Select job types.
RestoreRequest, restoreRequest_tier - Retrieval tier at which the restore will be processed.
$sel:type':RestoreRequest', restoreRequest_type - Type of restore request.
RoutingRule
data RoutingRule Source #
Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see Configuring advanced conditional redirects in the Amazon S3 User Guide.
See: newRoutingRule smart constructor.
Constructors
| RoutingRule' (Maybe Condition) Redirect |
Instances
Arguments
| :: Redirect | |
| -> RoutingRule |
Create a value of RoutingRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:condition:RoutingRule', routingRule_condition - 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.
$sel:redirect:RoutingRule', routingRule_redirect - 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.
S3KeyFilter
data S3KeyFilter Source #
A container for object key name prefix and suffix filtering rules.
See: newS3KeyFilter smart constructor.
Constructors
| S3KeyFilter' (Maybe [FilterRule]) |
Instances
newS3KeyFilter :: S3KeyFilter Source #
Create a value of S3KeyFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filterRules:S3KeyFilter', s3KeyFilter_filterRules - Undocumented member.
S3Location
data S3Location Source #
Describes an Amazon S3 location that will receive the results of the restore request.
See: newS3Location smart constructor.
Constructors
| S3Location' (Maybe [Grant]) (Maybe ObjectCannedACL) (Maybe Encryption) (Maybe StorageClass) (Maybe Tagging) (Maybe [MetadataEntry]) BucketName Text |
Instances
Create a value of S3Location with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessControlList:S3Location', s3Location_accessControlList - A list of grants that control access to the staged results.
$sel:cannedACL:S3Location', s3Location_cannedACL - The canned ACL to apply to the restore results.
$sel:encryption:S3Location', s3Location_encryption - Undocumented member.
$sel:storageClass:S3Location', s3Location_storageClass - The class of storage used to store the restore results.
$sel:tagging:S3Location', s3Location_tagging - The tag-set that is applied to the restore results.
$sel:userMetadata:S3Location', s3Location_userMetadata - A list of metadata to store with the restore results in S3.
$sel:bucketName:S3Location', s3Location_bucketName - The name of the bucket where the restore results will be placed.
$sel:prefix:S3Location', s3Location_prefix - The prefix that is prepended to the restore results for this request.
S3ServiceError
data S3ServiceError Source #
Container for all error elements.
See: newS3ServiceError smart constructor.
Constructors
| S3ServiceError' (Maybe Text) (Maybe ObjectKey) (Maybe Text) (Maybe ObjectVersionId) |
Instances
newS3ServiceError :: S3ServiceError Source #
Create a value of S3ServiceError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:S3ServiceError', s3ServiceError_code - The error code is a string that uniquely identifies an error condition.
It is meant to be read and understood by programs that detect and handle
errors by type.
Amazon S3 error codes
- Code: AccessDenied
- Description: Access Denied
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: AccountProblem
- Description: There is a problem with your Amazon Web Services account that prevents the action from completing successfully. Contact Amazon Web Services Support for further assistance.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: AllAccessDisabled
- Description: All access to this Amazon S3 resource has been disabled. Contact Amazon Web Services Support for further assistance.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: AmbiguousGrantByEmailAddress
- Description: The email address you provided is associated with more than one account.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: AuthorizationHeaderMalformed
- Description: The authorization header you provided is invalid.
- HTTP Status Code: 400 Bad Request
- HTTP Status Code: N/A
- Code: BadDigest
- Description: The Content-MD5 you specified did not match what we received.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: BucketAlreadyExists
- Description: The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.
- HTTP Status Code: 409 Conflict
- SOAP Fault Code Prefix: Client
- Code: BucketAlreadyOwnedByYou
- Description: The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).
- Code: 409 Conflict (in all Regions except the North Virginia Region)
- SOAP Fault Code Prefix: Client
- Code: BucketNotEmpty
- Description: The bucket you tried to delete is not empty.
- HTTP Status Code: 409 Conflict
- SOAP Fault Code Prefix: Client
- Code: CredentialsNotSupported
- Description: This request does not support credentials.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: CrossLocationLoggingProhibited
- Description: Cross-location logging not allowed. Buckets in one geographic location cannot log information to a bucket in another location.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: EntityTooSmall
- Description: Your proposed upload is smaller than the minimum allowed object size.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: EntityTooLarge
- Description: Your proposed upload exceeds the maximum allowed object size.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: ExpiredToken
- Description: The provided token has expired.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: IllegalVersioningConfigurationException
- Description: Indicates that the versioning configuration specified in the request is invalid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: IncompleteBody
- Description: You did not provide the number of bytes specified by the Content-Length HTTP header
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: IncorrectNumberOfFilesInPostRequest
- Description: POST requires exactly one file upload per request.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InlineDataTooLarge
- Description: Inline data exceeds the maximum allowed size.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InternalError
- Description: We encountered an internal error. Please try again.
- HTTP Status Code: 500 Internal Server Error
- SOAP Fault Code Prefix: Server
- Code: InvalidAccessKeyId
- Description: The Amazon Web Services access key ID you provided does not exist in our records.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: InvalidAddressingHeader
- Description: You must specify the Anonymous role.
- HTTP Status Code: N/A
- SOAP Fault Code Prefix: Client
- Code: InvalidArgument
- Description: Invalid Argument
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidBucketName
- Description: The specified bucket is not valid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidBucketState
- Description: The request is not valid with the current state of the bucket.
- HTTP Status Code: 409 Conflict
- SOAP Fault Code Prefix: Client
- Code: InvalidDigest
- Description: The Content-MD5 you specified is not valid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidEncryptionAlgorithmError
- Description: The encryption request you specified is not valid. The valid value is AES256.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidLocationConstraint
- Description: The specified location constraint is not valid. For more information about Regions, see How to Select a Region for Your Buckets.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidObjectState
- Description: The action is not valid for the current state of the object.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: InvalidPart
- Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidPartOrder
- Description: The list of parts was not in ascending order. Parts list must be specified in order by part number.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidPayer
- Description: All access to this object has been disabled. Please contact Amazon Web Services Support for further assistance.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: InvalidPolicyDocument
- Description: The content of the form does not meet the conditions specified in the policy document.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidRange
- Description: The requested range cannot be satisfied.
- HTTP Status Code: 416 Requested Range Not Satisfiable
- SOAP Fault Code Prefix: Client
- Code: InvalidRequest
- Description: Please use
AWS4-HMAC-SHA256. - HTTP Status Code: 400 Bad Request
- Code: N/A
- Description: Please use
- Code: InvalidRequest
- Description: SOAP requests must be made over an HTTPS connection.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidRequest
- Description: Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant names.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their names.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Accelerate is not configured on this bucket.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Accelerate is disabled on this bucket.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Acceleration is not supported on this bucket. Contact Amazon Web Services Support for more information.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact Amazon Web Services Support for more information.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidSecurity
- Description: The provided security credentials are not valid.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: InvalidSOAPRequest
- Description: The SOAP request body is invalid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidStorageClass
- Description: The storage class you specified is not valid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidTargetBucketForLogging
- Description: The target bucket for logging does not exist, is not owned by you, or does not have the appropriate grants for the log-delivery group.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidToken
- Description: The provided token is malformed or otherwise invalid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidURI
- Description: Couldn't parse the specified URI.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: KeyTooLongError
- Description: Your key is too long.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MalformedACLError
- Description: The XML you provided was not well-formed or did not validate against our published schema.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MalformedPOSTRequest
- Description: The body of your POST request is not well-formed multipart/form-data.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MalformedXML
- Description: This happens when the user sends malformed XML (XML that doesn't conform to the published XSD) for the configuration. The error message is, "The XML you provided was not well-formed or did not validate against our published schema."
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MaxMessageLengthExceeded
- Description: Your request was too big.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MaxPostPreDataLengthExceededError
- Description: Your POST request fields preceding the upload file were too large.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MetadataTooLarge
- Description: Your metadata headers exceed the maximum allowed metadata size.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MethodNotAllowed
- Description: The specified method is not allowed against this resource.
- HTTP Status Code: 405 Method Not Allowed
- SOAP Fault Code Prefix: Client
- Code: MissingAttachment
- Description: A SOAP attachment was expected, but none were found.
- HTTP Status Code: N/A
- SOAP Fault Code Prefix: Client
- Code: MissingContentLength
- Description: You must provide the Content-Length HTTP header.
- HTTP Status Code: 411 Length Required
- SOAP Fault Code Prefix: Client
- Code: MissingRequestBodyError
- Description: This happens when the user sends an empty XML document as a request. The error message is, "Request body is empty."
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MissingSecurityElement
- Description: The SOAP 1.1 request is missing a security element.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MissingSecurityHeader
- Description: Your request is missing a required header.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: NoLoggingStatusForKey
- Description: There is no such thing as a logging status subresource for a key.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: NoSuchBucket
- Description: The specified bucket does not exist.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NoSuchBucketPolicy
- Description: The specified bucket does not have a bucket policy.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NoSuchKey
- Description: The specified key does not exist.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NoSuchLifecycleConfiguration
- Description: The lifecycle configuration does not exist.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NoSuchUpload
- Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NoSuchVersion
- Description: Indicates that the version ID specified in the request does not match an existing version.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NotImplemented
- Description: A header you provided implies functionality that is not implemented.
- HTTP Status Code: 501 Not Implemented
- SOAP Fault Code Prefix: Server
- Code: NotSignedUp
- Description: Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: Amazon S3
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: OperationAborted
- Description: A conflicting conditional action is currently in progress against this resource. Try again.
- HTTP Status Code: 409 Conflict
- SOAP Fault Code Prefix: Client
- Code: PermanentRedirect
- Description: The bucket you are attempting to access must be addressed using the specified endpoint. Send all future requests to this endpoint.
- HTTP Status Code: 301 Moved Permanently
- SOAP Fault Code Prefix: Client
- Code: PreconditionFailed
- Description: At least one of the preconditions you specified did not hold.
- HTTP Status Code: 412 Precondition Failed
- SOAP Fault Code Prefix: Client
- Code: Redirect
- Description: Temporary redirect.
- HTTP Status Code: 307 Moved Temporarily
- SOAP Fault Code Prefix: Client
- Code: RestoreAlreadyInProgress
- Description: Object restore is already in progress.
- HTTP Status Code: 409 Conflict
- SOAP Fault Code Prefix: Client
- Code: RequestIsNotMultiPartContent
- Description: Bucket POST must be of the enclosure-type multipart/form-data.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: RequestTimeout
- Description: Your socket connection to the server was not read from or written to within the timeout period.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: RequestTimeTooSkewed
- Description: The difference between the request time and the server's time is too large.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: RequestTorrentOfBucketError
- Description: Requesting the torrent file of a bucket is not permitted.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: SignatureDoesNotMatch
- Description: The request signature we calculated does not match the signature you provided. Check your Amazon Web Services secret access key and signing method. For more information, see REST Authentication and SOAP Authentication for details.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: ServiceUnavailable
- Description: Reduce your request rate.
- HTTP Status Code: 503 Service Unavailable
- SOAP Fault Code Prefix: Server
- Code: SlowDown
- Description: Reduce your request rate.
- HTTP Status Code: 503 Slow Down
- SOAP Fault Code Prefix: Server
- Code: TemporaryRedirect
- Description: You are being redirected to the bucket while DNS updates.
- HTTP Status Code: 307 Moved Temporarily
- SOAP Fault Code Prefix: Client
- Code: TokenRefreshRequired
- Description: The provided token must be refreshed.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: TooManyBuckets
- Description: You have attempted to create more buckets than allowed.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: UnexpectedContent
- Description: This request does not support content.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: UnresolvableGrantByEmailAddress
- Description: The email address you provided does not match any account on record.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: UserKeyMustBeSpecified
- Description: The bucket POST must contain the specified field name. If it is specified, check the order of the fields.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
$sel:key:S3ServiceError', s3ServiceError_key - The error key.
$sel:message:S3ServiceError', s3ServiceError_message - The error message contains a generic description of the error condition
in English. It is intended for a human audience. Simple programs display
the message directly to the end user if they encounter an error
condition they don't know how or don't care to handle. Sophisticated
programs with more exhaustive error handling and proper
internationalization are more likely to ignore the error message.
$sel:versionId:S3ServiceError', s3ServiceError_versionId - The version ID of the error.
SSEKMS
Specifies the use of SSE-KMS to encrypt delivered inventory reports.
See: newSSEKMS smart constructor.
Instances
| FromXML SSEKMS Source # | |
| ToXML SSEKMS Source # | |
Defined in Amazonka.S3.Types.SSEKMS | |
| Generic SSEKMS Source # | |
| Show SSEKMS Source # | |
| NFData SSEKMS Source # | |
Defined in Amazonka.S3.Types.SSEKMS | |
| Eq SSEKMS Source # | |
| Hashable SSEKMS Source # | |
Defined in Amazonka.S3.Types.SSEKMS | |
| type Rep SSEKMS Source # | |
Defined in Amazonka.S3.Types.SSEKMS | |
Create a value of SSEKMS with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:SSEKMS', ssekms_keyId - Specifies the ID of the Amazon Web Services Key Management Service
(Amazon Web Services KMS) symmetric customer managed key to use for
encrypting inventory reports.
SSES3
Specifies the use of SSE-S3 to encrypt delivered inventory reports.
See: newSSES3 smart constructor.
Constructors
| SSES3' | |
Instances
Create a value of SSES3 with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ScanRange
Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.
See: newScanRange smart constructor.
Constructors
| ScanRange' (Maybe Integer) (Maybe Integer) |
Instances
| ToXML ScanRange Source # | |
Defined in Amazonka.S3.Types.ScanRange | |
| Generic ScanRange Source # | |
| Read ScanRange Source # | |
| Show ScanRange Source # | |
| NFData ScanRange Source # | |
Defined in Amazonka.S3.Types.ScanRange | |
| Eq ScanRange Source # | |
| Hashable ScanRange Source # | |
Defined in Amazonka.S3.Types.ScanRange | |
| type Rep ScanRange Source # | |
Defined in Amazonka.S3.Types.ScanRange type Rep ScanRange = D1 ('MetaData "ScanRange" "Amazonka.S3.Types.ScanRange" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "ScanRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) | |
newScanRange :: ScanRange Source #
Create a value of ScanRange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:end:ScanRange', scanRange_end - Specifies the end of the byte range. This parameter is optional. Valid
values: non-negative integers. The default value is one less than the
size of the object being queried. If only the End parameter is supplied,
it is interpreted to mean scan the last N bytes of the file. For
example, <scanrange><end>50</end></scanrange> means scan the
last 50 bytes.
$sel:start:ScanRange', scanRange_start - Specifies the start of the byte range. This parameter is optional. Valid
values: non-negative integers. The default value is 0. If only start
is supplied, it means scan from that point to the end of the file. For
example, <scanrange><start>50</start></scanrange> means scan
from byte 50 until the end of the file.
SelectObjectContentEventStream
data SelectObjectContentEventStream Source #
The container for selecting objects from a content event stream.
See: newSelectObjectContentEventStream smart constructor.
Constructors
| SelectObjectContentEventStream' (Maybe ContinuationEvent) (Maybe EndEvent) (Maybe ProgressEvent) (Maybe RecordsEvent) (Maybe StatsEvent) |
Instances
newSelectObjectContentEventStream :: SelectObjectContentEventStream Source #
Create a value of SelectObjectContentEventStream with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cont:SelectObjectContentEventStream', selectObjectContentEventStream_cont - The Continuation Event.
$sel:end:SelectObjectContentEventStream', selectObjectContentEventStream_end - The End Event.
$sel:progress:SelectObjectContentEventStream', selectObjectContentEventStream_progress - The Progress Event.
$sel:records:SelectObjectContentEventStream', selectObjectContentEventStream_records - The Records Event.
$sel:stats:SelectObjectContentEventStream', selectObjectContentEventStream_stats - The Stats Event.
SelectParameters
data SelectParameters Source #
Describes the parameters for Select job types.
See: newSelectParameters smart constructor.
Instances
Arguments
| :: InputSerialization | |
| -> ExpressionType | |
| -> Text | |
| -> OutputSerialization | |
| -> SelectParameters |
Create a value of SelectParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputSerialization:SelectParameters', selectParameters_inputSerialization - Describes the serialization format of the object.
$sel:expressionType:SelectParameters', selectParameters_expressionType - The type of the provided expression (for example, SQL).
$sel:expression:SelectParameters', selectParameters_expression - The expression that is used to query the object.
$sel:outputSerialization:SelectParameters', selectParameters_outputSerialization - Describes how the results of the Select job are serialized.
ServerSideEncryptionByDefault
data ServerSideEncryptionByDefault Source #
Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see PUT Bucket encryption in the Amazon S3 API Reference.
See: newServerSideEncryptionByDefault smart constructor.
Constructors
| ServerSideEncryptionByDefault' (Maybe (Sensitive Text)) ServerSideEncryption |
Instances
newServerSideEncryptionByDefault Source #
Arguments
| :: ServerSideEncryption | |
| -> ServerSideEncryptionByDefault |
Create a value of ServerSideEncryptionByDefault with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsMasterKeyID:ServerSideEncryptionByDefault', serverSideEncryptionByDefault_kmsMasterKeyID - Amazon Web Services Key Management Service (KMS) customer Amazon Web
Services KMS key ID to use for the default encryption. This parameter is
allowed if and only if SSEAlgorithm is set to aws:kms.
You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab - Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.
$sel:sSEAlgorithm:ServerSideEncryptionByDefault', serverSideEncryptionByDefault_sSEAlgorithm - Server-side encryption algorithm to use for the default encryption.
ServerSideEncryptionConfiguration
data ServerSideEncryptionConfiguration Source #
Specifies the default server-side-encryption configuration.
See: newServerSideEncryptionConfiguration smart constructor.
Constructors
| ServerSideEncryptionConfiguration' [ServerSideEncryptionRule] |
Instances
newServerSideEncryptionConfiguration :: ServerSideEncryptionConfiguration Source #
Create a value of ServerSideEncryptionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rules:ServerSideEncryptionConfiguration', serverSideEncryptionConfiguration_rules - Container for information about a particular server-side encryption
configuration rule.
ServerSideEncryptionRule
data ServerSideEncryptionRule Source #
Specifies the default server-side encryption configuration.
See: newServerSideEncryptionRule smart constructor.
Constructors
| ServerSideEncryptionRule' (Maybe ServerSideEncryptionByDefault) (Maybe Bool) |
Instances
newServerSideEncryptionRule :: ServerSideEncryptionRule Source #
Create a value of ServerSideEncryptionRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applyServerSideEncryptionByDefault:ServerSideEncryptionRule', serverSideEncryptionRule_applyServerSideEncryptionByDefault - Specifies the default server-side encryption to apply to new objects in
the bucket. If a PUT Object request doesn't specify any server-side
encryption, this default encryption will be applied.
$sel:bucketKeyEnabled:ServerSideEncryptionRule', serverSideEncryptionRule_bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key with server-side
encryption using KMS (SSE-KMS) for new objects in the bucket. Existing
objects are not affected. Setting the BucketKeyEnabled element to
true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket
Key is not enabled.
For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
SourceSelectionCriteria
data SourceSelectionCriteria Source #
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 a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).
See: newSourceSelectionCriteria smart constructor.
Constructors
| SourceSelectionCriteria' (Maybe ReplicaModifications) (Maybe SseKmsEncryptedObjects) |
Instances
newSourceSelectionCriteria :: SourceSelectionCriteria Source #
Create a value of SourceSelectionCriteria with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replicaModifications:SourceSelectionCriteria', sourceSelectionCriteria_replicaModifications - A filter that you can specify for selections for modifications on
replicas. Amazon S3 doesn't replicate replica modifications by default.
In the latest version of replication configuration (when Filter is
specified), you can specify this element and set the status to Enabled
to replicate modifications on replicas.
If you don't specify the Filter element, Amazon S3 assumes that the
replication configuration is the earlier version, V1. In the earlier
version, this element is not allowed
$sel:sseKmsEncryptedObjects:SourceSelectionCriteria', sourceSelectionCriteria_sseKmsEncryptedObjects - A container for filter information for the selection of Amazon S3
objects encrypted with Amazon Web Services KMS. If you include
SourceSelectionCriteria in the replication configuration, this element
is required.
SseKmsEncryptedObjects
data SseKmsEncryptedObjects Source #
A container for filter information for the selection of S3 objects encrypted with Amazon Web Services KMS.
See: newSseKmsEncryptedObjects smart constructor.
Constructors
| SseKmsEncryptedObjects' SseKmsEncryptedObjectsStatus |
Instances
newSseKmsEncryptedObjects Source #
Arguments
| :: SseKmsEncryptedObjectsStatus | |
| -> SseKmsEncryptedObjects |
Create a value of SseKmsEncryptedObjects with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:SseKmsEncryptedObjects', sseKmsEncryptedObjects_status - Specifies whether Amazon S3 replicates objects created with server-side
encryption using an Amazon Web Services KMS key stored in Amazon Web
Services Key Management Service.
Stats
Container for the stats details.
See: newStats smart constructor.
Instances
| FromXML Stats Source # | |
| Generic Stats Source # | |
| Read Stats Source # | |
| Show Stats Source # | |
| NFData Stats Source # | |
Defined in Amazonka.S3.Types.Stats | |
| Eq Stats Source # | |
| Hashable Stats Source # | |
Defined in Amazonka.S3.Types.Stats | |
| type Rep Stats Source # | |
Defined in Amazonka.S3.Types.Stats type Rep Stats = D1 ('MetaData "Stats" "Amazonka.S3.Types.Stats" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Stats'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bytesProcessed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "bytesReturned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "bytesScanned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) | |
Create a value of Stats with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bytesProcessed:Stats', stats_bytesProcessed - The total number of uncompressed object bytes processed.
$sel:bytesReturned:Stats', stats_bytesReturned - The total number of bytes of records payload data returned.
$sel:bytesScanned:Stats', stats_bytesScanned - The total number of object bytes scanned.
StatsEvent
data StatsEvent Source #
Container for the Stats Event.
See: newStatsEvent smart constructor.
Constructors
| StatsEvent' (Maybe Stats) |
Instances
newStatsEvent :: StatsEvent Source #
Create a value of StatsEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:details:StatsEvent', statsEvent_details - The Stats event details.
StorageClassAnalysis
data StorageClassAnalysis Source #
Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.
See: newStorageClassAnalysis smart constructor.
Constructors
| StorageClassAnalysis' (Maybe StorageClassAnalysisDataExport) |
Instances
newStorageClassAnalysis :: StorageClassAnalysis Source #
Create a value of StorageClassAnalysis with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataExport:StorageClassAnalysis', storageClassAnalysis_dataExport - Specifies how data related to the storage class analysis for an Amazon
S3 bucket should be exported.
StorageClassAnalysisDataExport
data StorageClassAnalysisDataExport Source #
Container for data related to the storage class analysis for an Amazon S3 bucket for export.
See: newStorageClassAnalysisDataExport smart constructor.
Constructors
| StorageClassAnalysisDataExport' StorageClassAnalysisSchemaVersion AnalyticsExportDestination |
Instances
newStorageClassAnalysisDataExport Source #
Arguments
| :: StorageClassAnalysisSchemaVersion | |
| -> AnalyticsExportDestination | |
| -> StorageClassAnalysisDataExport |
Create a value of StorageClassAnalysisDataExport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:outputSchemaVersion:StorageClassAnalysisDataExport', storageClassAnalysisDataExport_outputSchemaVersion - The version of the output schema to use when exporting data. Must be
V_1.
$sel:destination:StorageClassAnalysisDataExport', storageClassAnalysisDataExport_destination - The place to store the data for an analysis.
Tag
A container of a key value name pair.
See: newTag smart constructor.
Instances
| FromXML Tag Source # | |
| ToXML Tag Source # | |
Defined in Amazonka.S3.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.S3.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.S3.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.S3.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.S3.Types.Tag" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectKey) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - Name of the object key.
$sel:value:Tag', tag_value - Value of the tag.
Tagging
Container for TagSet elements.
See: newTagging smart constructor.
Instances
| ToXML Tagging Source # | |
Defined in Amazonka.S3.Types.Tagging | |
| Generic Tagging Source # | |
| Read Tagging Source # | |
| Show Tagging Source # | |
| NFData Tagging Source # | |
Defined in Amazonka.S3.Types.Tagging | |
| Eq Tagging Source # | |
| Hashable Tagging Source # | |
Defined in Amazonka.S3.Types.Tagging | |
| type Rep Tagging Source # | |
Defined in Amazonka.S3.Types.Tagging | |
newTagging :: Tagging Source #
Create a value of Tagging with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tagSet:Tagging', tagging_tagSet - A collection for a set of tags
TargetGrant
data TargetGrant Source #
Container for granting information.
Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions server access log delivery in the Amazon S3 User Guide.
See: newTargetGrant smart constructor.
Constructors
| TargetGrant' (Maybe Grantee) (Maybe BucketLogsPermission) |
Instances
newTargetGrant :: TargetGrant Source #
Create a value of TargetGrant with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:grantee:TargetGrant', targetGrant_grantee - Container for the person being granted permissions.
$sel:permission:TargetGrant', targetGrant_permission - Logging permissions assigned to the grantee for the bucket.
Tiering
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead.
See: newTiering smart constructor.
Constructors
| Tiering' Int IntelligentTieringAccessTier |
Instances
| FromXML Tiering Source # | |
| ToXML Tiering Source # | |
Defined in Amazonka.S3.Types.Tiering | |
| Generic Tiering Source # | |
| Read Tiering Source # | |
| Show Tiering Source # | |
| NFData Tiering Source # | |
Defined in Amazonka.S3.Types.Tiering | |
| Eq Tiering Source # | |
| Hashable Tiering Source # | |
Defined in Amazonka.S3.Types.Tiering | |
| type Rep Tiering Source # | |
Defined in Amazonka.S3.Types.Tiering type Rep Tiering = D1 ('MetaData "Tiering" "Amazonka.S3.Types.Tiering" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Tiering'" 'PrefixI 'True) (S1 ('MetaSel ('Just "days") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "accessTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IntelligentTieringAccessTier))) | |
Create a value of Tiering with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:days:Tiering', tiering_days - The number of consecutive days of no access after which an object will
be eligible to be transitioned to the corresponding tier. The minimum
number of days specified for Archive Access tier must be at least 90
days and Deep Archive Access tier must be at least 180 days. The maximum
can be up to 2 years (730 days).
$sel:accessTier:Tiering', tiering_accessTier - S3 Intelligent-Tiering access tier. See
Storage class for automatically optimizing frequently and infrequently accessed objects
for a list of access tiers in the S3 Intelligent-Tiering storage class.
TopicConfiguration
data TopicConfiguration Source #
A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
See: newTopicConfiguration smart constructor.
Constructors
| TopicConfiguration' (Maybe NotificationConfigurationFilter) (Maybe Text) Text [Event] |
Instances
newTopicConfiguration Source #
Arguments
| :: Text | |
| -> TopicConfiguration |
Create a value of TopicConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':TopicConfiguration', topicConfiguration_filter - Undocumented member.
$sel:id:TopicConfiguration', topicConfiguration_id - Undocumented member.
$sel:topicArn:TopicConfiguration', topicConfiguration_topicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon
S3 publishes a message when it detects events of the specified type.
$sel:events:TopicConfiguration', topicConfiguration_events - The Amazon S3 bucket event about which to send notifications. For more
information, see
Supported Event Types
in the Amazon S3 User Guide.
Transition
data Transition Source #
Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.
See: newTransition smart constructor.
Constructors
| Transition' (Maybe ISO8601) (Maybe Int) (Maybe TransitionStorageClass) |
Instances
newTransition :: Transition Source #
Create a value of Transition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:date:Transition', transition_date - Indicates when objects are transitioned to the specified storage class.
The date value must be in ISO 8601 format. The time is always midnight
UTC.
$sel:days:Transition', transition_days - Indicates the number of days after creation when objects are
transitioned to the specified storage class. The value must be a
positive integer.
$sel:storageClass:Transition', transition_storageClass - The storage class to which you want the object to transition.
VersioningConfiguration
data VersioningConfiguration Source #
Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning in the Amazon S3 API Reference.
See: newVersioningConfiguration smart constructor.
Constructors
| VersioningConfiguration' (Maybe MFADelete) (Maybe BucketVersioningStatus) |
Instances
newVersioningConfiguration :: VersioningConfiguration Source #
Create a value of VersioningConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mfaDelete:VersioningConfiguration', versioningConfiguration_mfaDelete - 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.
$sel:status:VersioningConfiguration', versioningConfiguration_status - The versioning state of the bucket.
WebsiteConfiguration
data WebsiteConfiguration Source #
Specifies website configuration parameters for an Amazon S3 bucket.
See: newWebsiteConfiguration smart constructor.
Constructors
| WebsiteConfiguration' (Maybe ErrorDocument) (Maybe IndexDocument) (Maybe RedirectAllRequestsTo) (Maybe [RoutingRule]) |
Instances
newWebsiteConfiguration :: WebsiteConfiguration Source #
Create a value of WebsiteConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorDocument:WebsiteConfiguration', websiteConfiguration_errorDocument - The name of the error document for the website.
$sel:indexDocument:WebsiteConfiguration', websiteConfiguration_indexDocument - The name of the index document for the website.
$sel:redirectAllRequestsTo:WebsiteConfiguration', websiteConfiguration_redirectAllRequestsTo - The redirect behavior for every request to this bucket's website
endpoint.
If you specify this property, you can't specify any other property.
$sel:routingRules:WebsiteConfiguration', websiteConfiguration_routingRules - Rules that define when a redirect is applied and the redirect behavior.