Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- PutBucketRequestPayment
- PutObject
- PutBucketLogging
- DeleteObject
- DeleteBucket
- ListBuckets
- CreateBucket
- PutBucketTagging
- DeleteBucketTagging
- PutObjectACL
- GetBucketNotificationConfiguration
- GetBucketLocation
- PutBucketReplication
- GetBucketWebsite
- GetObject
- DeleteBucketReplication
- GetBucketRequestPayment
- ListObjectVersions (Paginated)
- GetBucketLifecycle
- HeadBucket
- PutBucketLifecycle
- CreateMultipartUpload
- DeleteBucketLifecycle
- GetBucketReplication
- PutBucketWebsite
- CompleteMultipartUpload
- UploadPart
- ListMultipartUploads (Paginated)
- DeleteBucketWebsite
- ListObjects (Paginated)
- DeleteObjects
- PutBucketPolicy
- DeleteBucketPolicy
- AbortMultipartUpload
- GetObjectTorrent
- PutBucketCORS
- DeleteBucketCORS
- GetBucketVersioning
- PutBucketNotificationConfiguration
- GetBucketTagging
- HeadObject
- PutBucketVersioning
- GetObjectACL
- RestoreObject
- GetBucketCORS
- CopyObject
- GetBucketPolicy
- GetBucketLogging
- ListParts (Paginated)
- GetBucketACL
- PutBucketACL
- UploadPartCopy
- Types
- Re-exported Types
- BucketCannedACL
- BucketLogsPermission
- BucketVersioningStatus
- EncodingType
- Event
- ExpirationStatus
- FilterRuleName
- MFADelete
- MFADeleteStatus
- MetadataDirective
- ObjectCannedACL
- ObjectStorageClass
- ObjectVersionStorageClass
- Payer
- Permission
- Protocol
- ReplicationRuleStatus
- ReplicationStatus
- RequestCharged
- RequestPayer
- ServerSideEncryption
- StorageClass
- TransitionStorageClass
- Type
- AccessControlPolicy
- Bucket
- BucketLoggingStatus
- CORSConfiguration
- CORSRule
- CommonPrefix
- CompletedMultipartUpload
- CompletedPart
- Condition
- CopyObjectResult
- CopyPartResult
- CreateBucketConfiguration
- Delete
- DeleteMarkerEntry
- DeletedObject
- Destination
- ErrorDocument
- FilterRule
- Grant
- Grantee
- IndexDocument
- Initiator
- LambdaFunctionConfiguration
- LifecycleConfiguration
- LifecycleExpiration
- LoggingEnabled
- MultipartUpload
- NoncurrentVersionExpiration
- NoncurrentVersionTransition
- NotificationConfiguration
- NotificationConfigurationFilter
- Object
- ObjectIdentifier
- ObjectVersion
- Owner
- Part
- QueueConfiguration
- Redirect
- RedirectAllRequestsTo
- ReplicationConfiguration
- ReplicationRule
- RequestPaymentConfiguration
- RestoreRequest
- RoutingRule
- Rule
- S3KeyFilter
- S3ServiceError
- Tag
- Tagging
- TargetGrant
- TopicConfiguration
- Transition
- VersioningConfiguration
- WebsiteConfiguration
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.
See: AWS API Reference
- s3 :: Service
- _ObjectAlreadyInActiveTierError :: AsError a => Getting (First ServiceError) a ServiceError
- _BucketAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _ObjectNotInActiveTierError :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchUpload :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchBucket :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchKey :: AsError a => Getting (First ServiceError) a ServiceError
- objectNotExists :: Wait HeadObject
- bucketExists :: Wait HeadBucket
- objectExists :: Wait HeadObject
- bucketNotExists :: Wait HeadBucket
- module Network.AWS.S3.PutBucketRequestPayment
- module Network.AWS.S3.PutObject
- module Network.AWS.S3.PutBucketLogging
- module Network.AWS.S3.DeleteObject
- module Network.AWS.S3.DeleteBucket
- module Network.AWS.S3.ListBuckets
- module Network.AWS.S3.CreateBucket
- module Network.AWS.S3.PutBucketTagging
- module Network.AWS.S3.DeleteBucketTagging
- module Network.AWS.S3.PutObjectACL
- module Network.AWS.S3.GetBucketNotificationConfiguration
- module Network.AWS.S3.GetBucketLocation
- module Network.AWS.S3.PutBucketReplication
- module Network.AWS.S3.GetBucketWebsite
- module Network.AWS.S3.GetObject
- module Network.AWS.S3.DeleteBucketReplication
- module Network.AWS.S3.GetBucketRequestPayment
- module Network.AWS.S3.ListObjectVersions
- module Network.AWS.S3.GetBucketLifecycle
- module Network.AWS.S3.HeadBucket
- module Network.AWS.S3.PutBucketLifecycle
- module Network.AWS.S3.CreateMultipartUpload
- module Network.AWS.S3.DeleteBucketLifecycle
- module Network.AWS.S3.GetBucketReplication
- module Network.AWS.S3.PutBucketWebsite
- module Network.AWS.S3.CompleteMultipartUpload
- module Network.AWS.S3.UploadPart
- module Network.AWS.S3.ListMultipartUploads
- module Network.AWS.S3.DeleteBucketWebsite
- module Network.AWS.S3.ListObjects
- module Network.AWS.S3.DeleteObjects
- module Network.AWS.S3.PutBucketPolicy
- module Network.AWS.S3.DeleteBucketPolicy
- module Network.AWS.S3.AbortMultipartUpload
- module Network.AWS.S3.GetObjectTorrent
- module Network.AWS.S3.PutBucketCORS
- module Network.AWS.S3.DeleteBucketCORS
- module Network.AWS.S3.GetBucketVersioning
- module Network.AWS.S3.PutBucketNotificationConfiguration
- module Network.AWS.S3.GetBucketTagging
- module Network.AWS.S3.HeadObject
- module Network.AWS.S3.PutBucketVersioning
- module Network.AWS.S3.GetObjectACL
- module Network.AWS.S3.RestoreObject
- module Network.AWS.S3.GetBucketCORS
- module Network.AWS.S3.CopyObject
- module Network.AWS.S3.GetBucketPolicy
- module Network.AWS.S3.GetBucketLogging
- module Network.AWS.S3.ListParts
- module Network.AWS.S3.GetBucketACL
- module Network.AWS.S3.PutBucketACL
- module Network.AWS.S3.UploadPartCopy
- data Region :: *
- newtype BucketName = BucketName Text
- newtype ETag = ETag ByteString
- newtype ObjectVersionId = ObjectVersionId Text
- type Delimiter = Char
- newtype ObjectKey = ObjectKey Text
- _ObjectKey :: Iso' ObjectKey Text
- keyPrefix :: Delimiter -> Traversal' ObjectKey Text
- keyName :: Delimiter -> Traversal' ObjectKey Text
- keyComponents :: Delimiter -> IndexedTraversal' Int ObjectKey Text
- data BucketCannedACL
- data BucketLogsPermission
- = FullControl
- | Read
- | Write
- data BucketVersioningStatus
- data EncodingType = URL
- data Event
- data ExpirationStatus
- data FilterRuleName
- data MFADelete
- data MFADeleteStatus
- data MetadataDirective
- data ObjectCannedACL
- data ObjectStorageClass
- data ObjectVersionStorageClass = OVSCStandard
- data Payer
- data Permission
- = PFullControl
- | PRead
- | PReadAcp
- | PWrite
- | PWriteAcp
- data Protocol
- data ReplicationRuleStatus
- data ReplicationStatus
- data RequestCharged = RCRequester
- data RequestPayer = RPRequester
- data ServerSideEncryption
- data StorageClass
- data TransitionStorageClass = Glacier
- data Type
- data AccessControlPolicy
- accessControlPolicy :: AccessControlPolicy
- acpGrants :: Lens' AccessControlPolicy [Grant]
- acpOwner :: Lens' AccessControlPolicy (Maybe Owner)
- data Bucket
- bucket :: UTCTime -> BucketName -> Bucket
- bCreationDate :: Lens' Bucket UTCTime
- bName :: Lens' Bucket BucketName
- data BucketLoggingStatus
- bucketLoggingStatus :: BucketLoggingStatus
- blsLoggingEnabled :: Lens' BucketLoggingStatus (Maybe LoggingEnabled)
- data CORSConfiguration
- corsConfiguration :: CORSConfiguration
- ccCORSRules :: Lens' CORSConfiguration [CORSRule]
- data CORSRule
- corsRule :: CORSRule
- crAllowedMethods :: Lens' CORSRule [Text]
- crMaxAgeSeconds :: Lens' CORSRule (Maybe Int)
- crAllowedHeaders :: Lens' CORSRule [Text]
- crAllowedOrigins :: Lens' CORSRule [Text]
- crExposeHeaders :: Lens' CORSRule [Text]
- data CommonPrefix
- commonPrefix :: CommonPrefix
- cpPrefix :: Lens' CommonPrefix (Maybe Text)
- data CompletedMultipartUpload
- completedMultipartUpload :: CompletedMultipartUpload
- cmuParts :: Lens' CompletedMultipartUpload (Maybe (NonEmpty CompletedPart))
- data CompletedPart
- completedPart :: Int -> ETag -> CompletedPart
- cpPartNumber :: Lens' CompletedPart Int
- cpETag :: Lens' CompletedPart ETag
- data Condition
- condition :: Condition
- cKeyPrefixEquals :: Lens' Condition (Maybe Text)
- cHTTPErrorCodeReturnedEquals :: Lens' Condition (Maybe Text)
- data CopyObjectResult
- copyObjectResult :: CopyObjectResult
- corETag :: Lens' CopyObjectResult (Maybe ETag)
- corLastModified :: Lens' CopyObjectResult (Maybe UTCTime)
- data CopyPartResult
- copyPartResult :: CopyPartResult
- cprETag :: Lens' CopyPartResult (Maybe ETag)
- cprLastModified :: Lens' CopyPartResult (Maybe UTCTime)
- data CreateBucketConfiguration
- createBucketConfiguration :: CreateBucketConfiguration
- cbcLocationConstraint :: Lens' CreateBucketConfiguration (Maybe Region)
- data Delete
- delete' :: Delete
- dQuiet :: Lens' Delete (Maybe Bool)
- dObjects :: Lens' Delete [ObjectIdentifier]
- data DeleteMarkerEntry
- deleteMarkerEntry :: DeleteMarkerEntry
- dmeVersionId :: Lens' DeleteMarkerEntry (Maybe ObjectVersionId)
- dmeIsLatest :: Lens' DeleteMarkerEntry (Maybe Bool)
- dmeOwner :: Lens' DeleteMarkerEntry (Maybe Owner)
- dmeKey :: Lens' DeleteMarkerEntry (Maybe ObjectKey)
- dmeLastModified :: Lens' DeleteMarkerEntry (Maybe UTCTime)
- data DeletedObject
- deletedObject :: DeletedObject
- dVersionId :: Lens' DeletedObject (Maybe ObjectVersionId)
- dDeleteMarker :: Lens' DeletedObject (Maybe Bool)
- dDeleteMarkerVersionId :: Lens' DeletedObject (Maybe Text)
- dKey :: Lens' DeletedObject (Maybe ObjectKey)
- data Destination
- destination :: BucketName -> Destination
- dBucket :: Lens' Destination BucketName
- data ErrorDocument
- errorDocument :: ObjectKey -> ErrorDocument
- edKey :: Lens' ErrorDocument ObjectKey
- data FilterRule
- filterRule :: FilterRule
- frValue :: Lens' FilterRule (Maybe Text)
- frName :: Lens' FilterRule (Maybe FilterRuleName)
- data Grant
- grant :: Grant
- gPermission :: Lens' Grant (Maybe Permission)
- gGrantee :: Lens' Grant (Maybe Grantee)
- data Grantee
- grantee :: Type -> Grantee
- gURI :: Lens' Grantee (Maybe Text)
- gEmailAddress :: Lens' Grantee (Maybe Text)
- gId :: Lens' Grantee (Maybe Text)
- gDisplayName :: Lens' Grantee (Maybe Text)
- gType :: Lens' Grantee Type
- data IndexDocument
- indexDocument :: Text -> IndexDocument
- idSuffix :: Lens' IndexDocument Text
- data Initiator
- initiator :: Initiator
- iId :: Lens' Initiator (Maybe Text)
- iDisplayName :: Lens' Initiator (Maybe Text)
- data LambdaFunctionConfiguration
- lambdaFunctionConfiguration :: Text -> LambdaFunctionConfiguration
- lfcId :: Lens' LambdaFunctionConfiguration (Maybe Text)
- lfcFilter :: Lens' LambdaFunctionConfiguration (Maybe NotificationConfigurationFilter)
- lfcLambdaFunctionARN :: Lens' LambdaFunctionConfiguration Text
- lfcEvents :: Lens' LambdaFunctionConfiguration [Event]
- data LifecycleConfiguration
- lifecycleConfiguration :: LifecycleConfiguration
- lcRules :: Lens' LifecycleConfiguration [Rule]
- data LifecycleExpiration
- lifecycleExpiration :: LifecycleExpiration
- leDays :: Lens' LifecycleExpiration (Maybe Int)
- leDate :: Lens' LifecycleExpiration (Maybe UTCTime)
- data LoggingEnabled
- loggingEnabled :: LoggingEnabled
- leTargetBucket :: Lens' LoggingEnabled (Maybe Text)
- leTargetGrants :: Lens' LoggingEnabled [TargetGrant]
- leTargetPrefix :: Lens' LoggingEnabled (Maybe Text)
- data MultipartUpload
- multipartUpload :: MultipartUpload
- muInitiated :: Lens' MultipartUpload (Maybe UTCTime)
- muInitiator :: Lens' MultipartUpload (Maybe Initiator)
- muOwner :: Lens' MultipartUpload (Maybe Owner)
- muKey :: Lens' MultipartUpload (Maybe ObjectKey)
- muStorageClass :: Lens' MultipartUpload (Maybe StorageClass)
- muUploadId :: Lens' MultipartUpload (Maybe Text)
- data NoncurrentVersionExpiration
- noncurrentVersionExpiration :: Int -> NoncurrentVersionExpiration
- nveNoncurrentDays :: Lens' NoncurrentVersionExpiration Int
- data NoncurrentVersionTransition
- noncurrentVersionTransition :: Int -> TransitionStorageClass -> NoncurrentVersionTransition
- nvtNoncurrentDays :: Lens' NoncurrentVersionTransition Int
- nvtStorageClass :: Lens' NoncurrentVersionTransition TransitionStorageClass
- data NotificationConfiguration
- notificationConfiguration :: NotificationConfiguration
- ncQueueConfigurations :: Lens' NotificationConfiguration [QueueConfiguration]
- ncTopicConfigurations :: Lens' NotificationConfiguration [TopicConfiguration]
- ncLambdaFunctionConfigurations :: Lens' NotificationConfiguration [LambdaFunctionConfiguration]
- data NotificationConfigurationFilter
- notificationConfigurationFilter :: NotificationConfigurationFilter
- ncfKey :: Lens' NotificationConfigurationFilter (Maybe S3KeyFilter)
- data Object
- object' :: ETag -> Int -> ObjectKey -> ObjectStorageClass -> UTCTime -> Object
- oOwner :: Lens' Object (Maybe Owner)
- oETag :: Lens' Object ETag
- oSize :: Lens' Object Int
- oKey :: Lens' Object ObjectKey
- oStorageClass :: Lens' Object ObjectStorageClass
- oLastModified :: Lens' Object UTCTime
- data ObjectIdentifier
- objectIdentifier :: ObjectKey -> ObjectIdentifier
- oiVersionId :: Lens' ObjectIdentifier (Maybe ObjectVersionId)
- oiKey :: Lens' ObjectIdentifier ObjectKey
- data ObjectVersion
- objectVersion :: ObjectVersion
- ovVersionId :: Lens' ObjectVersion (Maybe ObjectVersionId)
- ovETag :: Lens' ObjectVersion (Maybe ETag)
- ovSize :: Lens' ObjectVersion (Maybe Int)
- ovIsLatest :: Lens' ObjectVersion (Maybe Bool)
- ovOwner :: Lens' ObjectVersion (Maybe Owner)
- ovKey :: Lens' ObjectVersion (Maybe ObjectKey)
- ovStorageClass :: Lens' ObjectVersion (Maybe ObjectVersionStorageClass)
- ovLastModified :: Lens' ObjectVersion (Maybe UTCTime)
- data Owner
- owner :: Owner
- oId :: Lens' Owner (Maybe Text)
- oDisplayName :: Lens' Owner (Maybe Text)
- data Part
- part :: Part
- pETag :: Lens' Part (Maybe ETag)
- pSize :: Lens' Part (Maybe Int)
- pPartNumber :: Lens' Part (Maybe Int)
- pLastModified :: Lens' Part (Maybe UTCTime)
- data QueueConfiguration
- queueConfiguration :: Text -> QueueConfiguration
- qcId :: Lens' QueueConfiguration (Maybe Text)
- qcFilter :: Lens' QueueConfiguration (Maybe NotificationConfigurationFilter)
- qcQueueARN :: Lens' QueueConfiguration Text
- qcEvents :: Lens' QueueConfiguration [Event]
- data Redirect
- redirect :: Redirect
- rHostName :: Lens' Redirect (Maybe Text)
- rProtocol :: Lens' Redirect (Maybe Protocol)
- rHTTPRedirectCode :: Lens' Redirect (Maybe Text)
- rReplaceKeyWith :: Lens' Redirect (Maybe Text)
- rReplaceKeyPrefixWith :: Lens' Redirect (Maybe Text)
- data RedirectAllRequestsTo
- redirectAllRequestsTo :: Text -> RedirectAllRequestsTo
- rartProtocol :: Lens' RedirectAllRequestsTo (Maybe Protocol)
- rartHostName :: Lens' RedirectAllRequestsTo Text
- data ReplicationConfiguration
- replicationConfiguration :: Text -> ReplicationConfiguration
- rcRole :: Lens' ReplicationConfiguration Text
- rcRules :: Lens' ReplicationConfiguration [ReplicationRule]
- data ReplicationRule
- replicationRule :: Text -> ReplicationRuleStatus -> Destination -> ReplicationRule
- rrId :: Lens' ReplicationRule (Maybe Text)
- rrPrefix :: Lens' ReplicationRule Text
- rrStatus :: Lens' ReplicationRule ReplicationRuleStatus
- rrDestination :: Lens' ReplicationRule Destination
- data RequestPaymentConfiguration
- requestPaymentConfiguration :: Payer -> RequestPaymentConfiguration
- rpcPayer :: Lens' RequestPaymentConfiguration Payer
- data RestoreRequest
- restoreRequest :: Int -> RestoreRequest
- rrDays :: Lens' RestoreRequest Int
- data RoutingRule
- routingRule :: Redirect -> RoutingRule
- rrCondition :: Lens' RoutingRule (Maybe Condition)
- rrRedirect :: Lens' RoutingRule Redirect
- data Rule
- rule :: Text -> ExpirationStatus -> Rule
- rNoncurrentVersionExpiration :: Lens' Rule (Maybe NoncurrentVersionExpiration)
- rTransition :: Lens' Rule (Maybe Transition)
- rExpiration :: Lens' Rule (Maybe LifecycleExpiration)
- rNoncurrentVersionTransition :: Lens' Rule (Maybe NoncurrentVersionTransition)
- rId :: Lens' Rule (Maybe Text)
- rPrefix :: Lens' Rule Text
- rStatus :: Lens' Rule ExpirationStatus
- data S3KeyFilter
- s3KeyFilter :: S3KeyFilter
- skfFilterRules :: Lens' S3KeyFilter [FilterRule]
- data S3ServiceError
- s3ServiceError :: S3ServiceError
- sseVersionId :: Lens' S3ServiceError (Maybe ObjectVersionId)
- sseKey :: Lens' S3ServiceError (Maybe ObjectKey)
- sseCode :: Lens' S3ServiceError (Maybe Text)
- sseMessage :: Lens' S3ServiceError (Maybe Text)
- data Tag
- tag :: ObjectKey -> Text -> Tag
- tagKey :: Lens' Tag ObjectKey
- tagValue :: Lens' Tag Text
- data Tagging
- tagging :: Tagging
- tTagSet :: Lens' Tagging [Tag]
- data TargetGrant
- targetGrant :: TargetGrant
- tgPermission :: Lens' TargetGrant (Maybe BucketLogsPermission)
- tgGrantee :: Lens' TargetGrant (Maybe Grantee)
- data TopicConfiguration
- topicConfiguration :: Text -> TopicConfiguration
- tcId :: Lens' TopicConfiguration (Maybe Text)
- tcFilter :: Lens' TopicConfiguration (Maybe NotificationConfigurationFilter)
- tcTopicARN :: Lens' TopicConfiguration Text
- tcEvents :: Lens' TopicConfiguration [Event]
- data Transition
- transition :: Transition
- tDays :: Lens' Transition (Maybe Int)
- tDate :: Lens' Transition (Maybe UTCTime)
- tStorageClass :: Lens' Transition (Maybe TransitionStorageClass)
- data VersioningConfiguration
- versioningConfiguration :: VersioningConfiguration
- vcStatus :: Lens' VersioningConfiguration (Maybe BucketVersioningStatus)
- vcMFADelete :: Lens' VersioningConfiguration (Maybe MFADelete)
- data WebsiteConfiguration
- websiteConfiguration :: WebsiteConfiguration
- wcRedirectAllRequestsTo :: Lens' WebsiteConfiguration (Maybe RedirectAllRequestsTo)
- wcErrorDocument :: Lens' WebsiteConfiguration (Maybe ErrorDocument)
- wcRoutingRules :: Lens' WebsiteConfiguration [RoutingRule]
- wcIndexDocument :: Lens' WebsiteConfiguration (Maybe IndexDocument)
Service Configuration
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
.
ObjectAlreadyInActiveTierError
_ObjectAlreadyInActiveTierError :: AsError a => Getting (First ServiceError) a ServiceError Source
This operation is not allowed against this storage tier
BucketAlreadyExists
_BucketAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source
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.
ObjectNotInActiveTierError
_ObjectNotInActiveTierError :: AsError a => Getting (First ServiceError) a ServiceError Source
The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier.
NoSuchUpload
_NoSuchUpload :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified multipart upload does not exist.
NoSuchBucket
_NoSuchBucket :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified bucket does not exist.
NoSuchKey
_NoSuchKey :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified key does not exist.
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.
ObjectNotExists
objectNotExists :: Wait HeadObject Source
Polls HeadObject
every 5 seconds until a
successful state is reached. An error is returned after 20 failed checks.
BucketExists
bucketExists :: Wait HeadBucket Source
Polls HeadBucket
every 5 seconds until a
successful state is reached. An error is returned after 20 failed checks.
ObjectExists
objectExists :: Wait HeadObject Source
Polls HeadObject
every 5 seconds until a
successful state is reached. An error is returned after 20 failed checks.
BucketNotExists
bucketNotExists :: Wait HeadBucket Source
Polls HeadBucket
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.
PutBucketRequestPayment
PutObject
module Network.AWS.S3.PutObject
PutBucketLogging
DeleteObject
module Network.AWS.S3.DeleteObject
DeleteBucket
module Network.AWS.S3.DeleteBucket
ListBuckets
module Network.AWS.S3.ListBuckets
CreateBucket
module Network.AWS.S3.CreateBucket
PutBucketTagging
DeleteBucketTagging
PutObjectACL
module Network.AWS.S3.PutObjectACL
GetBucketNotificationConfiguration
GetBucketLocation
PutBucketReplication
GetBucketWebsite
GetObject
module Network.AWS.S3.GetObject
DeleteBucketReplication
GetBucketRequestPayment
ListObjectVersions (Paginated)
GetBucketLifecycle
HeadBucket
module Network.AWS.S3.HeadBucket
PutBucketLifecycle
CreateMultipartUpload
DeleteBucketLifecycle
GetBucketReplication
PutBucketWebsite
CompleteMultipartUpload
UploadPart
module Network.AWS.S3.UploadPart
ListMultipartUploads (Paginated)
DeleteBucketWebsite
ListObjects (Paginated)
module Network.AWS.S3.ListObjects
DeleteObjects
module Network.AWS.S3.DeleteObjects
PutBucketPolicy
DeleteBucketPolicy
AbortMultipartUpload
GetObjectTorrent
PutBucketCORS
module Network.AWS.S3.PutBucketCORS
DeleteBucketCORS
GetBucketVersioning
PutBucketNotificationConfiguration
GetBucketTagging
HeadObject
module Network.AWS.S3.HeadObject
PutBucketVersioning
GetObjectACL
module Network.AWS.S3.GetObjectACL
RestoreObject
module Network.AWS.S3.RestoreObject
GetBucketCORS
module Network.AWS.S3.GetBucketCORS
CopyObject
module Network.AWS.S3.CopyObject
GetBucketPolicy
GetBucketLogging
ListParts (Paginated)
module Network.AWS.S3.ListParts
GetBucketACL
module Network.AWS.S3.GetBucketACL
PutBucketACL
module Network.AWS.S3.PutBucketACL
UploadPartCopy
Types
Re-exported Types
data Region :: *
The sum of available AWS regions.
Ireland | Europe / eu-west-1 |
Frankfurt | Europe / eu-central-1 |
Tokyo | Asia Pacific / ap-northeast-1 |
Singapore | Asia Pacific / ap-southeast-1 |
Sydney | Asia Pacific / ap-southeast-2 |
Beijing | China / cn-north-1 |
NorthVirginia | US / us-east-1 |
NorthCalifornia | US / us-west-1 |
Oregon | US / us-west-2 |
GovCloud | AWS GovCloud / us-gov-west-1 |
GovCloudFIPS | AWS GovCloud (FIPS 140-2) S3 Only / fips-us-gov-west-1 |
SaoPaulo | South America / sa-east-1 |
Eq Region | |
Data Region | |
Ord Region | |
Read Region | |
Show Region | |
Generic Region | |
Hashable Region | |
ToLog Region | |
FromXML Region | |
ToXML Region | |
ToByteString Region | |
FromText Region | |
ToText Region | |
Typeable * Region | |
type Rep Region = D1 D1Region ((:+:) ((:+:) ((:+:) (C1 C1_0Region U1) ((:+:) (C1 C1_1Region U1) (C1 C1_2Region U1))) ((:+:) (C1 C1_3Region U1) ((:+:) (C1 C1_4Region U1) (C1 C1_5Region U1)))) ((:+:) ((:+:) (C1 C1_6Region U1) ((:+:) (C1 C1_7Region U1) (C1 C1_8Region U1))) ((:+:) (C1 C1_9Region U1) ((:+:) (C1 C1_10Region U1) (C1 C1_11Region U1))))) |
newtype BucketName Source
newtype ObjectVersionId Source
keyPrefix :: Delimiter -> Traversal' ObjectKey Text Source
Traverse the prefix of an object key.
The prefix is classified as the entirety of the object key minus the name. A leading prefix in the presence of a name, and no other delimiters is interpreted as a blank prefix.
>>>
"/home/jsmith/base.wiki" ^? keyPrefix '/'
Just "/home/jsmith"
>>>
"/home/jsmith/" ^? keyPrefix '/'
Just "/home/jsmith"
>>>
"/home" ^? keyPrefix '/'
Nothing
>>>
"/" ^? keyPrefix '/'
Nothing
keyComponents :: Delimiter -> IndexedTraversal' Int ObjectKey Text Source
Traverse the path components of an object key using the specified delimiter.
BucketCannedACL
data BucketCannedACL Source
BucketLogsPermission
data BucketLogsPermission Source
BucketVersioningStatus
data BucketVersioningStatus Source
EncodingType
data 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.
Event
Bucket event for which to send notifications.
ExpirationStatus
data ExpirationStatus Source
FilterRuleName
data FilterRuleName Source
MFADelete
MFADeleteStatus
data MFADeleteStatus Source
MetadataDirective
data MetadataDirective Source
ObjectCannedACL
data ObjectCannedACL Source
ObjectStorageClass
data ObjectStorageClass Source
ObjectVersionStorageClass
data ObjectVersionStorageClass Source
Payer
Permission
data Permission Source
Protocol
ReplicationRuleStatus
data ReplicationRuleStatus Source
ReplicationStatus
data ReplicationStatus Source
RequestCharged
data RequestCharged Source
If present, indicates that the requester was successfully charged for the request.
RequestPayer
data RequestPayer Source
Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
ServerSideEncryption
data ServerSideEncryption Source
StorageClass
data StorageClass Source
TransitionStorageClass
data TransitionStorageClass Source
Type
AccessControlPolicy
data AccessControlPolicy Source
See: accessControlPolicy
smart constructor.
accessControlPolicy :: AccessControlPolicy Source
Creates a value of AccessControlPolicy
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acpGrants :: Lens' AccessControlPolicy [Grant] Source
A list of grants.
Bucket
See: bucket
smart constructor.
Creates a value of Bucket
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bCreationDate :: Lens' Bucket UTCTime Source
Date the bucket was created.
bName :: Lens' Bucket BucketName Source
The name of the bucket.
BucketLoggingStatus
data BucketLoggingStatus Source
See: bucketLoggingStatus
smart constructor.
bucketLoggingStatus :: BucketLoggingStatus Source
Creates a value of BucketLoggingStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blsLoggingEnabled :: Lens' BucketLoggingStatus (Maybe LoggingEnabled) Source
Undocumented member.
CORSConfiguration
data CORSConfiguration Source
See: corsConfiguration
smart constructor.
corsConfiguration :: CORSConfiguration Source
Creates a value of CORSConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccCORSRules :: Lens' CORSConfiguration [CORSRule] Source
Undocumented member.
CORSRule
See: corsRule
smart constructor.
Creates a value of CORSRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crAllowedMethods :: Lens' CORSRule [Text] Source
Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.
crMaxAgeSeconds :: Lens' CORSRule (Maybe Int) Source
The time in seconds that your browser is to cache the preflight response for the specified resource.
crAllowedHeaders :: Lens' CORSRule [Text] Source
Specifies which headers are allowed in a pre-flight OPTIONS request.
crAllowedOrigins :: Lens' CORSRule [Text] Source
One or more origins you want customers to be able to access the bucket from.
crExposeHeaders :: Lens' CORSRule [Text] Source
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).
CommonPrefix
data CommonPrefix Source
See: commonPrefix
smart constructor.
commonPrefix :: CommonPrefix Source
Creates a value of CommonPrefix
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
CompletedMultipartUpload
data CompletedMultipartUpload Source
See: completedMultipartUpload
smart constructor.
completedMultipartUpload :: CompletedMultipartUpload Source
Creates a value of CompletedMultipartUpload
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cmuParts :: Lens' CompletedMultipartUpload (Maybe (NonEmpty CompletedPart)) Source
Undocumented member.
CompletedPart
data CompletedPart Source
See: completedPart
smart constructor.
Creates a value of CompletedPart
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cpPartNumber :: Lens' CompletedPart Int Source
Part number that identifies the part. This is a positive integer between 1 and 10,000.
cpETag :: Lens' CompletedPart ETag Source
Entity tag returned when the part was uploaded.
Condition
See: condition
smart constructor.
Creates a value of Condition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cKeyPrefixEquals :: Lens' Condition (Maybe Text) Source
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.
cHTTPErrorCodeReturnedEquals :: Lens' Condition (Maybe Text) Source
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.
CopyObjectResult
data CopyObjectResult Source
See: copyObjectResult
smart constructor.
copyObjectResult :: CopyObjectResult Source
Creates a value of CopyObjectResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
corLastModified :: Lens' CopyObjectResult (Maybe UTCTime) Source
Undocumented member.
CopyPartResult
data CopyPartResult Source
See: copyPartResult
smart constructor.
copyPartResult :: CopyPartResult Source
Creates a value of CopyPartResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cprLastModified :: Lens' CopyPartResult (Maybe UTCTime) Source
Date and time at which the object was uploaded.
CreateBucketConfiguration
data CreateBucketConfiguration Source
See: createBucketConfiguration
smart constructor.
createBucketConfiguration :: CreateBucketConfiguration Source
Creates a value of CreateBucketConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cbcLocationConstraint :: Lens' CreateBucketConfiguration (Maybe Region) Source
Specifies the region where the bucket will be created. If you don't specify a region, the bucket will be created in US Standard.
Delete
See: delete'
smart constructor.
dQuiet :: Lens' Delete (Maybe Bool) Source
Element to enable quiet mode for the request. When you add this element, you must set its value to true.
dObjects :: Lens' Delete [ObjectIdentifier] Source
Undocumented member.
DeleteMarkerEntry
data DeleteMarkerEntry Source
See: deleteMarkerEntry
smart constructor.
deleteMarkerEntry :: DeleteMarkerEntry Source
Creates a value of DeleteMarkerEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dmeVersionId :: Lens' DeleteMarkerEntry (Maybe ObjectVersionId) Source
Version ID of an object.
dmeIsLatest :: Lens' DeleteMarkerEntry (Maybe Bool) Source
Specifies whether the object is (true) or is not (false) the latest version of an object.
dmeLastModified :: Lens' DeleteMarkerEntry (Maybe UTCTime) Source
Date and time the object was last modified.
DeletedObject
data DeletedObject Source
See: deletedObject
smart constructor.
deletedObject :: DeletedObject Source
Creates a value of DeletedObject
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dVersionId :: Lens' DeletedObject (Maybe ObjectVersionId) Source
Undocumented member.
dDeleteMarker :: Lens' DeletedObject (Maybe Bool) Source
Undocumented member.
dDeleteMarkerVersionId :: Lens' DeletedObject (Maybe Text) Source
Undocumented member.
Destination
data Destination Source
See: destination
smart constructor.
Creates a value of Destination
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dBucket :: Lens' Destination BucketName Source
Amazon resource name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule.
ErrorDocument
data ErrorDocument Source
See: errorDocument
smart constructor.
Creates a value of ErrorDocument
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edKey :: Lens' ErrorDocument ObjectKey Source
The object key name to use when a 4XX class error occurs.
FilterRule
data FilterRule Source
Container for key value pair that defines the criteria for the filter rule.
See: filterRule
smart constructor.
filterRule :: FilterRule Source
Creates a value of FilterRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
frName :: Lens' FilterRule (Maybe FilterRuleName) Source
Object key name prefix or suffix identifying one or more objects to which the filtering rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
Grant
See: grant
smart constructor.
Creates a value of Grant
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gPermission :: Lens' Grant (Maybe Permission) Source
Specifies the permission given to the grantee.
Grantee
See: grantee
smart constructor.
Creates a value of Grantee
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
IndexDocument
data IndexDocument Source
See: indexDocument
smart constructor.
Creates a value of IndexDocument
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
idSuffix :: Lens' IndexDocument Text Source
A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
Initiator
See: initiator
smart constructor.
Creates a value of Initiator
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iId :: Lens' Initiator (Maybe Text) Source
If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.
LambdaFunctionConfiguration
data LambdaFunctionConfiguration Source
Container for specifying the AWS Lambda notification configuration.
See: lambdaFunctionConfiguration
smart constructor.
lambdaFunctionConfiguration Source
Creates a value of LambdaFunctionConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lfcFilter :: Lens' LambdaFunctionConfiguration (Maybe NotificationConfigurationFilter) Source
Undocumented member.
lfcLambdaFunctionARN :: Lens' LambdaFunctionConfiguration Text Source
Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.
lfcEvents :: Lens' LambdaFunctionConfiguration [Event] Source
Undocumented member.
LifecycleConfiguration
data LifecycleConfiguration Source
See: lifecycleConfiguration
smart constructor.
lifecycleConfiguration :: LifecycleConfiguration Source
Creates a value of LifecycleConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcRules :: Lens' LifecycleConfiguration [Rule] Source
Undocumented member.
LifecycleExpiration
data LifecycleExpiration Source
See: lifecycleExpiration
smart constructor.
lifecycleExpiration :: LifecycleExpiration Source
Creates a value of LifecycleExpiration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
leDays :: Lens' LifecycleExpiration (Maybe Int) Source
Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
leDate :: Lens' LifecycleExpiration (Maybe UTCTime) Source
Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
LoggingEnabled
data LoggingEnabled Source
See: loggingEnabled
smart constructor.
loggingEnabled :: LoggingEnabled Source
Creates a value of LoggingEnabled
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
leTargetBucket :: Lens' LoggingEnabled (Maybe Text) Source
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.
leTargetGrants :: Lens' LoggingEnabled [TargetGrant] Source
Undocumented member.
leTargetPrefix :: Lens' LoggingEnabled (Maybe Text) Source
This element lets you specify a prefix for the keys that the log files will be stored under.
MultipartUpload
data MultipartUpload Source
See: multipartUpload
smart constructor.
multipartUpload :: MultipartUpload Source
Creates a value of MultipartUpload
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
muInitiated :: Lens' MultipartUpload (Maybe UTCTime) Source
Date and time at which the multipart upload was initiated.
muInitiator :: Lens' MultipartUpload (Maybe Initiator) Source
Identifies who initiated the multipart upload.
muKey :: Lens' MultipartUpload (Maybe ObjectKey) Source
Key of the object for which the multipart upload was initiated.
muStorageClass :: Lens' MultipartUpload (Maybe StorageClass) Source
The class of storage used to store the object.
muUploadId :: Lens' MultipartUpload (Maybe Text) Source
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: noncurrentVersionExpiration
smart constructor.
noncurrentVersionExpiration Source
Creates a value of NoncurrentVersionExpiration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nveNoncurrentDays :: Lens' NoncurrentVersionExpiration Int Source
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
NoncurrentVersionTransition
data NoncurrentVersionTransition Source
Container for the transition rule that describes when noncurrent objects transition to the GLACIER 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 GLACIER storage class at a specific period in the object's lifetime.
See: noncurrentVersionTransition
smart constructor.
noncurrentVersionTransition Source
Creates a value of NoncurrentVersionTransition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nvtNoncurrentDays :: Lens' NoncurrentVersionTransition Int Source
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
nvtStorageClass :: Lens' NoncurrentVersionTransition TransitionStorageClass Source
The class of storage used to store the object.
NotificationConfiguration
data NotificationConfiguration Source
Container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off on the bucket.
See: notificationConfiguration
smart constructor.
notificationConfiguration :: NotificationConfiguration Source
Creates a value of NotificationConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ncQueueConfigurations :: Lens' NotificationConfiguration [QueueConfiguration] Source
Undocumented member.
ncTopicConfigurations :: Lens' NotificationConfiguration [TopicConfiguration] Source
Undocumented member.
ncLambdaFunctionConfigurations :: Lens' NotificationConfiguration [LambdaFunctionConfiguration] Source
Undocumented member.
NotificationConfigurationFilter
data NotificationConfigurationFilter Source
Container for object key name filtering rules. For information about key name filtering, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
See: notificationConfigurationFilter
smart constructor.
notificationConfigurationFilter :: NotificationConfigurationFilter Source
Creates a value of NotificationConfigurationFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ncfKey :: Lens' NotificationConfigurationFilter (Maybe S3KeyFilter) Source
Undocumented member.
Object
See: object'
smart constructor.
Creates a value of Object
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oStorageClass :: Lens' Object ObjectStorageClass Source
The class of storage used to store the object.
oLastModified :: Lens' Object UTCTime Source
Undocumented member.
ObjectIdentifier
data ObjectIdentifier Source
See: objectIdentifier
smart constructor.
Creates a value of ObjectIdentifier
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oiVersionId :: Lens' ObjectIdentifier (Maybe ObjectVersionId) Source
VersionId for the specific version of the object to delete.
oiKey :: Lens' ObjectIdentifier ObjectKey Source
Key name of the object to delete.
ObjectVersion
data ObjectVersion Source
See: objectVersion
smart constructor.
objectVersion :: ObjectVersion Source
Creates a value of ObjectVersion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ovVersionId :: Lens' ObjectVersion (Maybe ObjectVersionId) Source
Version ID of an object.
ovIsLatest :: Lens' ObjectVersion (Maybe Bool) Source
Specifies whether the object is (true) or is not (false) the latest version of an object.
ovStorageClass :: Lens' ObjectVersion (Maybe ObjectVersionStorageClass) Source
The class of storage used to store the object.
ovLastModified :: Lens' ObjectVersion (Maybe UTCTime) Source
Date and time the object was last modified.
Owner
See: owner
smart constructor.
Creates a value of Owner
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Part
See: part
smart constructor.
Creates a value of Part
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pPartNumber :: Lens' Part (Maybe Int) Source
Part number identifying the part. This is a positive integer between 1 and 10,000.
QueueConfiguration
data QueueConfiguration Source
Container for specifying an configuration when you want Amazon S3 to publish events to an Amazon Simple Queue Service (Amazon SQS) queue.
See: queueConfiguration
smart constructor.
Creates a value of QueueConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qcFilter :: Lens' QueueConfiguration (Maybe NotificationConfigurationFilter) Source
Undocumented member.
qcQueueARN :: Lens' QueueConfiguration Text Source
Amazon SQS queue ARN to which Amazon S3 will publish a message when it detects events of specified type.
qcEvents :: Lens' QueueConfiguration [Event] Source
Undocumented member.
Redirect
See: redirect
smart constructor.
Creates a value of Redirect
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rProtocol :: Lens' Redirect (Maybe Protocol) Source
Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.
rHTTPRedirectCode :: Lens' Redirect (Maybe Text) Source
The HTTP redirect code to use on the response. Not required if one of the siblings is present.
rReplaceKeyWith :: Lens' Redirect (Maybe Text) Source
The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.
rReplaceKeyPrefixWith :: Lens' Redirect (Maybe Text) Source
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.
RedirectAllRequestsTo
data RedirectAllRequestsTo Source
See: redirectAllRequestsTo
smart constructor.
Creates a value of RedirectAllRequestsTo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rartProtocol :: Lens' RedirectAllRequestsTo (Maybe Protocol) Source
Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.
rartHostName :: Lens' RedirectAllRequestsTo Text Source
Name of the host where requests will be redirected.
ReplicationConfiguration
data ReplicationConfiguration Source
Container for replication rules. You can add as many as 1,000 rules. Total replication configuration size can be up to 2 MB.
See: replicationConfiguration
smart constructor.
replicationConfiguration Source
Creates a value of ReplicationConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcRole :: Lens' ReplicationConfiguration Text Source
Amazon Resource Name (ARN) of an IAM role for Amazon S3 to assume when replicating the objects.
rcRules :: Lens' ReplicationConfiguration [ReplicationRule] Source
Container for information about a particular replication rule. Replication configuration must have at least one rule and can contain up to 1,000 rules.
ReplicationRule
data ReplicationRule Source
See: replicationRule
smart constructor.
Creates a value of ReplicationRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrId :: Lens' ReplicationRule (Maybe Text) Source
Unique identifier for the rule. The value cannot be longer than 255 characters.
rrPrefix :: Lens' ReplicationRule Text Source
Object keyname prefix identifying one or more objects to which the rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes are not supported.
rrStatus :: Lens' ReplicationRule ReplicationRuleStatus Source
The rule is ignored if status is not Enabled.
rrDestination :: Lens' ReplicationRule Destination Source
Undocumented member.
RequestPaymentConfiguration
data RequestPaymentConfiguration Source
See: requestPaymentConfiguration
smart constructor.
requestPaymentConfiguration Source
Creates a value of RequestPaymentConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rpcPayer :: Lens' RequestPaymentConfiguration Payer Source
Specifies who pays for the download and request fees.
RestoreRequest
data RestoreRequest Source
See: restoreRequest
smart constructor.
:: Int | |
-> RestoreRequest |
Creates a value of RestoreRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrDays :: Lens' RestoreRequest Int Source
Lifetime of the active copy in days
RoutingRule
data RoutingRule Source
See: routingRule
smart constructor.
Creates a value of RoutingRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrCondition :: Lens' RoutingRule (Maybe Condition) Source
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.
rrRedirect :: Lens' RoutingRule Redirect Source
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 can specify a different error code to return.
Rule
See: rule
smart constructor.
Creates a value of Rule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rNoncurrentVersionExpiration :: Lens' Rule (Maybe NoncurrentVersionExpiration) Source
Undocumented member.
rTransition :: Lens' Rule (Maybe Transition) Source
Undocumented member.
rExpiration :: Lens' Rule (Maybe LifecycleExpiration) Source
Undocumented member.
rNoncurrentVersionTransition :: Lens' Rule (Maybe NoncurrentVersionTransition) Source
Undocumented member.
rId :: Lens' Rule (Maybe Text) Source
Unique identifier for the rule. The value cannot be longer than 255 characters.
rStatus :: Lens' Rule ExpirationStatus Source
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
S3KeyFilter
data S3KeyFilter Source
Container for object key name prefix and suffix filtering rules.
See: s3KeyFilter
smart constructor.
s3KeyFilter :: S3KeyFilter Source
Creates a value of S3KeyFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
skfFilterRules :: Lens' S3KeyFilter [FilterRule] Source
Undocumented member.
S3ServiceError
data S3ServiceError Source
See: s3ServiceError
smart constructor.
s3ServiceError :: S3ServiceError Source
Creates a value of S3ServiceError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sseVersionId :: Lens' S3ServiceError (Maybe ObjectVersionId) Source
Undocumented member.
sseMessage :: Lens' S3ServiceError (Maybe Text) Source
Undocumented member.
Tag
See: tag
smart constructor.
Tagging
See: tagging
smart constructor.
TargetGrant
data TargetGrant Source
See: targetGrant
smart constructor.
targetGrant :: TargetGrant Source
Creates a value of TargetGrant
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tgPermission :: Lens' TargetGrant (Maybe BucketLogsPermission) Source
Logging permissions assigned to the Grantee for the bucket.
TopicConfiguration
data TopicConfiguration Source
Container for specifying the configuration when you want Amazon S3 to publish events to an Amazon Simple Notification Service (Amazon SNS) topic.
See: topicConfiguration
smart constructor.
Creates a value of TopicConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tcFilter :: Lens' TopicConfiguration (Maybe NotificationConfigurationFilter) Source
Undocumented member.
tcTopicARN :: Lens' TopicConfiguration Text Source
Amazon SNS topic ARN to which Amazon S3 will publish a message when it detects events of specified type.
tcEvents :: Lens' TopicConfiguration [Event] Source
Undocumented member.
Transition
data Transition Source
See: transition
smart constructor.
transition :: Transition Source
Creates a value of Transition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tDays :: Lens' Transition (Maybe Int) Source
Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
tDate :: Lens' Transition (Maybe UTCTime) Source
Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
tStorageClass :: Lens' Transition (Maybe TransitionStorageClass) Source
The class of storage used to store the object.
VersioningConfiguration
data VersioningConfiguration Source
See: versioningConfiguration
smart constructor.
versioningConfiguration :: VersioningConfiguration Source
Creates a value of VersioningConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vcStatus :: Lens' VersioningConfiguration (Maybe BucketVersioningStatus) Source
The versioning state of the bucket.
vcMFADelete :: Lens' VersioningConfiguration (Maybe MFADelete) Source
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.
WebsiteConfiguration
data WebsiteConfiguration Source
See: websiteConfiguration
smart constructor.
websiteConfiguration :: WebsiteConfiguration Source
Creates a value of WebsiteConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wcRedirectAllRequestsTo :: Lens' WebsiteConfiguration (Maybe RedirectAllRequestsTo) Source
Undocumented member.
wcErrorDocument :: Lens' WebsiteConfiguration (Maybe ErrorDocument) Source
Undocumented member.
wcRoutingRules :: Lens' WebsiteConfiguration [RoutingRule] Source
Undocumented member.
wcIndexDocument :: Lens' WebsiteConfiguration (Maybe IndexDocument) Source
Undocumented member.