amazonka-s3-1.3.4: Amazon Simple Storage Service SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.S3.Types

Contents

Description

 

Synopsis

Service Configuration

s3 :: Service Source

API version '2006-03-01' of the Amazon Simple Storage Service SDK configuration.

Errors

_ObjectAlreadyInActiveTierError :: AsError a => Getting (First ServiceError) a ServiceError Source

This operation is not allowed against this storage tier

_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 :: 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 :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified multipart upload does not exist.

_NoSuchBucket :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified bucket does not exist.

_NoSuchKey :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified key does not exist.

Re-exported Types

data Region :: *

The sum of available AWS regions.

Constructors

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

Instances

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

Constructors

BucketName Text 

Instances

newtype ETag Source

Constructors

ETag ByteString 

Instances

newtype ObjectVersionId Source

Constructors

ObjectVersionId Text 

Instances

type Delimiter = Char Source

newtype ObjectKey Source

Constructors

ObjectKey Text 

Instances

_ObjectKey :: Iso' ObjectKey Text 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

keyName :: Delimiter -> Traversal' ObjectKey Text Source

Traverse the name of an object key.

keyComponents :: Delimiter -> IndexedTraversal' Int ObjectKey Text Source

Traverse the path components of an object key using the specified delimiter.

BucketCannedACL

data BucketCannedACL Source

Constructors

BAuthenticatedRead 
BPrivate 
BPublicRead 
BPublicReadWrite 

Instances

BucketLogsPermission

data BucketLogsPermission Source

Constructors

FullControl 
Read 
Write 

Instances

BucketVersioningStatus

data BucketVersioningStatus Source

Constructors

BVSEnabled 
BVSSuspended 

Instances

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.

Constructors

URL 

Instances

Event

data Event Source

Bucket event for which to send notifications.

Constructors

S3ObjectCreated 
S3ObjectCreatedCompleteMultipartUpload 
S3ObjectCreatedCopy 
S3ObjectCreatedPost 
S3ObjectCreatedPut 
S3ObjectRemoved 
S3ObjectRemovedDelete 
S3ObjectRemovedDeleteMarkerCreated 
S3ReducedRedundancyLostObject 

Instances

ExpirationStatus

data ExpirationStatus Source

Constructors

ESDisabled 
ESEnabled 

Instances

FilterRuleName

data FilterRuleName Source

Constructors

Prefix 
Suffix 

Instances

MFADelete

data MFADelete Source

Constructors

MDDisabled 
MDEnabled 

Instances

MFADeleteStatus

data MFADeleteStatus Source

Constructors

MDSDisabled 
MDSEnabled 

Instances

MetadataDirective

data MetadataDirective Source

Constructors

Copy 
Replace 

Instances

ObjectCannedACL

data ObjectCannedACL Source

Constructors

OAuthenticatedRead 
OBucketOwnerFullControl 
OBucketOwnerRead 
OPrivate 
OPublicRead 
OPublicReadWrite 

Instances

ObjectStorageClass

data ObjectStorageClass Source

Constructors

OSCGlacier 
OSCReducedRedundancy 
OSCStandard 
OSCStandardIA 

Instances

ObjectVersionStorageClass

data ObjectVersionStorageClass Source

Constructors

OVSCStandard 

Instances

Payer

data Payer Source

Constructors

BucketOwner 
Requester 

Instances

Permission

data Permission Source

Constructors

PFullControl 
PRead 
PReadAcp 
PWrite 
PWriteAcp 

Instances

Protocol

data Protocol Source

Constructors

HTTP 
HTTPS 

Instances

ReplicationRuleStatus

data ReplicationRuleStatus Source

Constructors

Disabled 
Enabled 

Instances

ReplicationStatus

data ReplicationStatus Source

Constructors

Complete 
Failed 
Pending 
Replica 

Instances

RequestCharged

data RequestCharged Source

If present, indicates that the requester was successfully charged for the request.

Constructors

RCRequester 

Instances

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

Constructors

RPRequester 

Instances

ServerSideEncryption

data ServerSideEncryption Source

Constructors

AES256 
AWSKMS 

Instances

StorageClass

data StorageClass Source

Constructors

ReducedRedundancy 
Standard 
StandardIA 

Instances

TransitionStorageClass

data TransitionStorageClass Source

Constructors

TSCGlacier 
TSCStandardIA 

Instances

Type

data Type Source

Constructors

AmazonCustomerByEmail 
CanonicalUser 
Group 

Instances

UploadPartRequestServerSideEncryption

data UploadPartRequestServerSideEncryption Source

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256).

Constructors

UPRSSEAES256 

Instances

AccessControlPolicy

data AccessControlPolicy Source

See: accessControlPolicy smart constructor.

Instances

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.

acpOwner :: Lens' AccessControlPolicy (Maybe Owner) Source

Undocumented member.

Bucket

data Bucket Source

See: bucket smart constructor.

Instances

bucket Source

Arguments

:: UTCTime

bCreationDate

-> BucketName

bName

-> Bucket 

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.

BucketLifecycleConfiguration

data BucketLifecycleConfiguration Source

See: bucketLifecycleConfiguration smart constructor.

Instances

bucketLifecycleConfiguration :: BucketLifecycleConfiguration Source

Creates a value of BucketLifecycleConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

blcRules :: Lens' BucketLifecycleConfiguration [LifecycleRule] Source

Undocumented member.

BucketLoggingStatus

data BucketLoggingStatus Source

See: bucketLoggingStatus smart constructor.

Instances

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.

Instances

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

data CORSRule Source

See: corsRule smart constructor.

Instances

corsRule :: CORSRule Source

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:

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.

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

crAllowedMethods :: Lens' CORSRule [Text] Source

Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.

crAllowedOrigins :: Lens' CORSRule [Text] Source

One or more origins you want customers to be able to access the bucket from.

CommonPrefix

data CommonPrefix Source

See: commonPrefix smart constructor.

Instances

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:

cpPrefix :: Lens' CommonPrefix (Maybe Text) Source

Undocumented member.

CompletedMultipartUpload

data CompletedMultipartUpload Source

See: completedMultipartUpload smart constructor.

Instances

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.

Instances

completedPart Source

Arguments

:: Int

cpPartNumber

-> ETag

cpETag

-> CompletedPart 

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

data Condition Source

See: condition smart constructor.

Instances

condition :: Condition Source

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.

Instances

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:

corETag :: Lens' CopyObjectResult (Maybe ETag) Source

Undocumented member.

corLastModified :: Lens' CopyObjectResult (Maybe UTCTime) Source

Undocumented member.

CopyPartResult

data CopyPartResult Source

See: copyPartResult smart constructor.

Instances

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:

cprETag :: Lens' CopyPartResult (Maybe ETag) Source

Entity tag of the object.

cprLastModified :: Lens' CopyPartResult (Maybe UTCTime) Source

Date and time at which the object was uploaded.

CreateBucketConfiguration

data CreateBucketConfiguration Source

See: createBucketConfiguration smart constructor.

Instances

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

data Delete Source

See: delete' smart constructor.

Instances

delete' :: Delete Source

Creates a value of Delete with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

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.

Instances

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.

dmeOwner :: Lens' DeleteMarkerEntry (Maybe Owner) Source

Undocumented member.

dmeKey :: Lens' DeleteMarkerEntry (Maybe ObjectKey) Source

The object key.

dmeLastModified :: Lens' DeleteMarkerEntry (Maybe UTCTime) Source

Date and time the object was last modified.

DeletedObject

data DeletedObject Source

See: deletedObject smart constructor.

Instances

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.

dKey :: Lens' DeletedObject (Maybe ObjectKey) Source

Undocumented member.

Destination

data Destination Source

See: destination smart constructor.

Instances

destination Source

Arguments

:: BucketName

dBucket

-> Destination 

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:

dStorageClass :: Lens' Destination (Maybe StorageClass) Source

The class of storage used to store the object.

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.

Instances

errorDocument Source

Arguments

:: ObjectKey

edKey

-> ErrorDocument 

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.

Instances

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:

frValue :: Lens' FilterRule (Maybe Text) Source

Undocumented member.

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

data Grant Source

See: grant smart constructor.

Instances

grant :: Grant Source

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.

gGrantee :: Lens' Grant (Maybe Grantee) Source

Undocumented member.

Grantee

data Grantee Source

See: grantee smart constructor.

Instances

grantee Source

Arguments

:: Type

gType

-> Grantee 

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:

gURI :: Lens' Grantee (Maybe Text) Source

URI of the grantee group.

gEmailAddress :: Lens' Grantee (Maybe Text) Source

Email address of the grantee.

gDisplayName :: Lens' Grantee (Maybe Text) Source

Screen name of the grantee.

gId :: Lens' Grantee (Maybe Text) Source

The canonical user ID of the grantee.

gType :: Lens' Grantee Type Source

Type of grantee

IndexDocument

data IndexDocument Source

See: indexDocument smart constructor.

Instances

indexDocument Source

Arguments

:: Text

idSuffix

-> IndexDocument 

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

data Initiator Source

See: initiator smart constructor.

Instances

initiator :: Initiator Source

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:

iDisplayName :: Lens' Initiator (Maybe Text) Source

Name of the Principal.

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.

Instances

lambdaFunctionConfiguration Source

Arguments

:: Text

lfcLambdaFunctionARN

-> LambdaFunctionConfiguration 

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:

lfcId :: Lens' LambdaFunctionConfiguration (Maybe Text) Source

Undocumented member.

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.

LifecycleExpiration

data LifecycleExpiration Source

See: lifecycleExpiration smart constructor.

Instances

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.

LifecycleRule

data LifecycleRule Source

See: lifecycleRule smart constructor.

Instances

lifecycleRule Source

Arguments

:: Text

lrPrefix

-> ExpirationStatus

lrStatus

-> LifecycleRule 

Creates a value of LifecycleRule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lrTransitions :: Lens' LifecycleRule [Transition] Source

Undocumented member.

lrNoncurrentVersionExpiration :: Lens' LifecycleRule (Maybe NoncurrentVersionExpiration) Source

Undocumented member.

lrNoncurrentVersionTransitions :: Lens' LifecycleRule [NoncurrentVersionTransition] Source

Undocumented member.

lrExpiration :: Lens' LifecycleRule (Maybe LifecycleExpiration) Source

Undocumented member.

lrId :: Lens' LifecycleRule (Maybe Text) Source

Unique identifier for the rule. The value cannot be longer than 255 characters.

lrPrefix :: Lens' LifecycleRule Text Source

Prefix identifying one or more objects to which the rule applies.

lrStatus :: Lens' LifecycleRule ExpirationStatus Source

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

LoggingEnabled

data LoggingEnabled Source

See: loggingEnabled smart constructor.

Instances

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.

Instances

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.

muOwner :: Lens' MultipartUpload (Maybe Owner) Source

Undocumented member.

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.

Instances

noncurrentVersionExpiration Source

Arguments

:: Int

nveNoncurrentDays

-> NoncurrentVersionExpiration 

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 STANDARD_IA or 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 STANDARD_IA or GLACIER storage class at a specific period in the object's lifetime.

See: noncurrentVersionTransition smart constructor.

Instances

noncurrentVersionTransition Source

Arguments

:: Int

nvtNoncurrentDays

-> TransitionStorageClass

nvtStorageClass

-> NoncurrentVersionTransition 

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.

Instances

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.

Instances

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

data Object Source

See: object' smart constructor.

Instances

object' Source

Arguments

:: ETag

oETag

-> Int

oSize

-> ObjectKey

oKey

-> ObjectStorageClass

oStorageClass

-> UTCTime

oLastModified

-> Object 

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:

oOwner :: Lens' Object (Maybe Owner) Source

Undocumented member.

oETag :: Lens' Object ETag Source

Undocumented member.

oSize :: Lens' Object Int Source

Undocumented member.

oKey :: Lens' Object ObjectKey Source

Undocumented member.

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.

Instances

objectIdentifier Source

Arguments

:: ObjectKey

oiKey

-> ObjectIdentifier 

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.

Instances

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:

ovETag :: Lens' ObjectVersion (Maybe ETag) Source

Undocumented member.

ovVersionId :: Lens' ObjectVersion (Maybe ObjectVersionId) Source

Version ID of an object.

ovSize :: Lens' ObjectVersion (Maybe Int) Source

Size in bytes of the object.

ovIsLatest :: Lens' ObjectVersion (Maybe Bool) Source

Specifies whether the object is (true) or is not (false) the latest version of an object.

ovOwner :: Lens' ObjectVersion (Maybe Owner) Source

Undocumented member.

ovKey :: Lens' ObjectVersion (Maybe ObjectKey) Source

The object key.

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

data Owner Source

See: owner smart constructor.

Instances

owner :: Owner Source

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:

oDisplayName :: Lens' Owner (Maybe Text) Source

Undocumented member.

oId :: Lens' Owner (Maybe Text) Source

Undocumented member.

Part

data Part Source

See: part smart constructor.

Instances

part :: Part Source

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:

pETag :: Lens' Part (Maybe ETag) Source

Entity tag returned when the part was uploaded.

pSize :: Lens' Part (Maybe Int) Source

Size of the uploaded part data.

pPartNumber :: Lens' Part (Maybe Int) Source

Part number identifying the part. This is a positive integer between 1 and 10,000.

pLastModified :: Lens' Part (Maybe UTCTime) Source

Date and time at which the part was uploaded.

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.

Instances

queueConfiguration Source

Arguments

:: Text

qcQueueARN

-> QueueConfiguration 

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:

qcId :: Lens' QueueConfiguration (Maybe Text) Source

Undocumented member.

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

data Redirect Source

See: redirect smart constructor.

Instances

redirect :: Redirect Source

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:

rHostName :: Lens' Redirect (Maybe Text) Source

The host name to use in the redirect request.

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.

Instances

redirectAllRequestsTo Source

Arguments

:: Text

rartHostName

-> RedirectAllRequestsTo 

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.

Instances

replicationConfiguration Source

Arguments

:: Text

rcRole

-> ReplicationConfiguration 

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.

Instances

replicationRule Source

Arguments

:: Text

rrPrefix

-> ReplicationRuleStatus

rrStatus

-> Destination

rrDestination

-> ReplicationRule 

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.

Instances

requestPaymentConfiguration Source

Arguments

:: Payer

rpcPayer

-> RequestPaymentConfiguration 

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.

Instances

restoreRequest Source

Arguments

:: Int

rrDays

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

Instances

routingRule Source

Arguments

:: Redirect

rrRedirect

-> RoutingRule 

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.

S3KeyFilter

data S3KeyFilter Source

Container for object key name prefix and suffix filtering rules.

See: s3KeyFilter smart constructor.

Instances

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.

Instances

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.

sseKey :: Lens' S3ServiceError (Maybe ObjectKey) Source

Undocumented member.

sseCode :: Lens' S3ServiceError (Maybe Text) Source

Undocumented member.

sseMessage :: Lens' S3ServiceError (Maybe Text) Source

Undocumented member.

Tag

data Tag Source

See: tag smart constructor.

Instances

tag Source

Arguments

:: ObjectKey

tagKey

-> Text

tagValue

-> Tag 

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tagKey :: Lens' Tag ObjectKey Source

Name of the tag.

tagValue :: Lens' Tag Text Source

Value of the tag.

Tagging

data Tagging Source

See: tagging smart constructor.

Instances

tagging :: Tagging Source

Creates a value of Tagging with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tTagSet :: Lens' Tagging [Tag] Source

Undocumented member.

TargetGrant

data TargetGrant Source

See: targetGrant smart constructor.

Instances

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.

tgGrantee :: Lens' TargetGrant (Maybe Grantee) Source

Undocumented member.

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.

Instances

topicConfiguration Source

Arguments

:: Text

tcTopicARN

-> TopicConfiguration 

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:

tcId :: Lens' TopicConfiguration (Maybe Text) Source

Undocumented member.

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.

Instances

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.

Instances

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.

Instances

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.

wcIndexDocument :: Lens' WebsiteConfiguration (Maybe IndexDocument) Source

Undocumented member.

wcRoutingRules :: Lens' WebsiteConfiguration [RoutingRule] Source

Undocumented member.