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

Safe HaskellNone
LanguageHaskell2010

Network.AWS.S3.Types

Contents

Synopsis

Service

data S3 Source

Version 2006-03-01 of the Amazon Simple Storage Service service.

Instances

AWSService S3 
type Sg S3 = V4 
type Er S3 = RESTError 

Error

data RESTError :: *

Instances

Eq RESTError 
Show RESTError 
Generic RESTError 
AWSErrorCode RESTError 
FromXML RESTError 
type Rep RESTError = D1 D1RESTError (C1 C1_0RESTError ((:*:) ((:*:) (S1 S1_0_0RESTError (Rec0 Text)) (S1 S1_0_1RESTError (Rec0 (Maybe ErrorType)))) ((:*:) (S1 S1_0_2RESTError (Rec0 ErrorCode)) (S1 S1_0_3RESTError (Rec0 Text))))) 

XML

Event

data Event Source

Constructors

S3ObjectCreatedCompleteMultipartUpload

s3:ObjectCreated:CompleteMultipartUpload

S3ObjectCreatedCopy

s3:ObjectCreated:Copy

S3ObjectCreatedPost

s3:ObjectCreated:Post

S3ObjectCreatedPut

s3:ObjectCreated:Put

S3ReducedRedundancyLostObject

s3:ReducedRedundancyLostObject

Instances

Enum Event 
Eq Event 
Ord Event 
Read Event 
Show Event 
Generic Event 
Hashable Event 
ToXML Event 
FromXML Event 
ToText Event 
FromText Event 
ToQuery Event 
ToHeader Event 
ToByteString Event 
type Rep Event 

NoncurrentVersionExpiration

noncurrentVersionExpiration Source

NoncurrentVersionExpiration constructor.

The fields accessible through corresponding lenses are:

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.

Transition

transition :: Transition Source

Transition constructor.

The fields accessible through corresponding lenses are:

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.

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.

tStorageClass :: Lens' Transition (Maybe TransitionStorageClass) Source

The class of storage used to store the object.

DeleteMarkerEntry

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.

dmeVersionId :: Lens' DeleteMarkerEntry (Maybe Text) Source

Version ID of an object.

ExpirationStatus

Part

data Part Source

Instances

Eq Part 
Ord Part 
Read Part 
Show Part 
ToXML Part 
FromXML Part 

part :: Part Source

Part constructor.

The fields accessible through corresponding lenses are:

pETag :: Lens' Part (Maybe Text) Source

Entity tag returned when the part was uploaded.

pLastModified :: Lens' Part (Maybe UTCTime) Source

Date and time at which the part was uploaded.

pPartNumber :: Lens' Part (Maybe Int) Source

Part number identifying the part.

pSize :: Lens' Part (Maybe Int) Source

Size of the uploaded part data.

VersioningConfiguration

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.

Tag

data Tag Source

Instances

Eq Tag 
Ord Tag 
Read Tag 
Show Tag 
ToXML Tag 
FromXML Tag 

tag Source

Arguments

:: Text

tagKey

-> Text

tagValue

-> Tag 

Tag constructor.

The fields accessible through corresponding lenses are:

tagKey :: Lens' Tag Text Source

Name of the tag.

tagValue :: Lens' Tag Text Source

Value of the tag.

ObjectStorageClass

MetadataDirective

RedirectAllRequestsTo

redirectAllRequestsTo Source

RedirectAllRequestsTo constructor.

The fields accessible through corresponding lenses are:

rartHostName :: Lens' RedirectAllRequestsTo Text Source

Name of the host where requests will be redirected.

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.

RoutingRule

routingRule Source

RoutingRule constructor.

The fields accessible through corresponding lenses are:

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.

NotificationConfiguration

S3ServiceError

s3ServiceError :: S3ServiceError Source

S3ServiceError constructor.

The fields accessible through corresponding lenses are:

ObjectCannedACL

BucketVersioningStatus

DeletedObject

deletedObject :: DeletedObject Source

DeletedObject constructor.

The fields accessible through corresponding lenses are:

ObjectVersionStorageClass

CopyPartResult

copyPartResult :: CopyPartResult Source

CopyPartResult constructor.

The fields accessible through corresponding lenses are:

cprETag :: Lens' CopyPartResult (Maybe Text) Source

Entity tag of the object.

cprLastModified :: Lens' CopyPartResult (Maybe UTCTime) Source

Date and time at which the object was uploaded.

EncodingType

RequestPaymentConfiguration

requestPaymentConfiguration Source

RequestPaymentConfiguration constructor.

The fields accessible through corresponding lenses are:

rpcPayer :: Lens' RequestPaymentConfiguration Payer Source

Specifies who pays for the download and request fees.

CORSRule

corsrule :: CORSRule Source

CORSRule constructor.

The fields accessible through corresponding lenses are:

corsrAllowedHeaders :: Lens' CORSRule [Text] Source

Specifies which headers are allowed in a pre-flight OPTIONS request.

corsrAllowedMethods :: Lens' CORSRule [Text] Source

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

corsrAllowedOrigins :: Lens' CORSRule [Text] Source

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

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

corsrMaxAgeSeconds :: Lens' CORSRule (Maybe Int) Source

The time in seconds that your browser is to cache the preflight response for the specified resource.

WebsiteConfiguration

NoncurrentVersionTransition

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.

Initiator

initiator :: Initiator Source

Initiator constructor.

The fields accessible through corresponding lenses are:

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.

ObjectIdentifier

objectIdentifier Source

Arguments

:: Text

oiKey

-> ObjectIdentifier 

ObjectIdentifier constructor.

The fields accessible through corresponding lenses are:

oiKey :: Lens' ObjectIdentifier Text Source

Key name of the object to delete.

oiVersionId :: Lens' ObjectIdentifier (Maybe Text) Source

VersionId for the specific version of the object to delete.

Bucket

data Bucket Source

Instances

bucket Source

Bucket constructor.

The fields accessible through corresponding lenses are:

bCreationDate :: Lens' Bucket UTCTime Source

Date the bucket was created.

bName :: Lens' Bucket Text Source

The name of the bucket.

Protocol

data Protocol Source

Constructors

Http

http

Https

https

Instances

Grant

data Grant Source

Instances

Eq Grant 
Read Grant 
Show Grant 
ToXMLRoot Grant 
ToXML Grant 
FromXML Grant 

grant :: Grant Source

Grant constructor.

The fields accessible through corresponding lenses are:

gPermission :: Lens' Grant (Maybe Permission) Source

Specifies the permission given to the grantee.

Rule

data Rule Source

Instances

Eq Rule 
Read Rule 
Show Rule 
ToXML Rule 
FromXML Rule 

rID :: Lens' Rule (Maybe Text) Source

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

rPrefix :: Lens' Rule Text Source

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

rStatus :: Lens' Rule ExpirationStatus Source

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

TopicConfiguration

topicConfiguration :: TopicConfiguration Source

TopicConfiguration constructor.

The fields accessible through corresponding lenses are:

tcEvent :: Lens' TopicConfiguration (Maybe Event) Source

Bucket event for which to send notifications.

tcTopic :: Lens' TopicConfiguration (Maybe Text) Source

Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.

QueueConfiguration

queueConfiguration :: QueueConfiguration Source

QueueConfiguration constructor.

The fields accessible through corresponding lenses are:

Owner

data Owner Source

Instances

Eq Owner 
Ord Owner 
Read Owner 
Show Owner 
ToXMLRoot Owner 
ToXML Owner 
FromXML Owner 

owner :: Owner Source

Owner constructor.

The fields accessible through corresponding lenses are:

BucketLoggingStatus

bucketLoggingStatus :: BucketLoggingStatus Source

BucketLoggingStatus constructor.

The fields accessible through corresponding lenses are:

ErrorDocument

errorDocument Source

Arguments

:: Text

edKey

-> ErrorDocument 

ErrorDocument constructor.

The fields accessible through corresponding lenses are:

edKey :: Lens' ErrorDocument Text Source

The object key name to use when a 4XX class error occurs.

StorageClass

ObjectVersion

ovIsLatest :: Lens' ObjectVersion (Maybe Bool) Source

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

ovLastModified :: Lens' ObjectVersion (Maybe UTCTime) Source

Date and time the object was last modified.

ovSize :: Lens' ObjectVersion (Maybe Int) Source

Size in bytes of the object.

ovStorageClass :: Lens' ObjectVersion (Maybe ObjectVersionStorageClass) Source

The class of storage used to store the object.

ovVersionId :: Lens' ObjectVersion (Maybe Text) Source

Version ID of an object.

TargetGrant

targetGrant :: TargetGrant Source

TargetGrant constructor.

The fields accessible through corresponding lenses are:

tgPermission :: Lens' TargetGrant (Maybe BucketLogsPermission) Source

Logging permissions assigned to the Grantee for the bucket.

MFADeleteStatus

Payer

data Payer Source

Constructors

BucketOwner

BucketOwner

Requester

Requester

Instances

Enum Payer 
Eq Payer 
Ord Payer 
Read Payer 
Show Payer 
Generic Payer 
Hashable Payer 
ToXML Payer 
FromXML Payer 
ToText Payer 
FromText Payer 
ToQuery Payer 
ToHeader Payer 
ToByteString Payer 
type Rep Payer 

Redirect

rHostName :: Lens' Redirect (Maybe Text) Source

The host name to use in the redirect 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.

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.

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.

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.

BucketLogsPermission

CompletedPart

completedPart :: CompletedPart Source

CompletedPart constructor.

The fields accessible through corresponding lenses are:

cpETag :: Lens' CompletedPart (Maybe Text) Source

Entity tag returned when the part was uploaded.

cpPartNumber :: Lens' CompletedPart (Maybe Int) Source

Part number that identifies the part.

CreateBucketConfiguration

createBucketConfiguration :: CreateBucketConfiguration Source

CreateBucketConfiguration constructor.

The fields accessible through corresponding lenses are:

cbcLocationConstraint :: Lens' CreateBucketConfiguration (Maybe Region) Source

Specifies the region where the bucket will be created.

Tagging

tagging :: Tagging Source

Tagging constructor.

The fields accessible through corresponding lenses are:

LifecycleExpiration

lifecycleExpiration :: LifecycleExpiration Source

LifecycleExpiration constructor.

The fields accessible through corresponding lenses are:

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.

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.

CORSConfiguration

corsconfiguration :: CORSConfiguration Source

CORSConfiguration constructor.

The fields accessible through corresponding lenses are:

Object

data Object Source

Instances

Eq Object 
Read Object 
Show Object 
ToXML Object 
FromXML Object 

oStorageClass :: Lens' Object ObjectStorageClass Source

The class of storage used to store the object.

CommonPrefix

commonPrefix :: CommonPrefix Source

CommonPrefix constructor.

The fields accessible through corresponding lenses are:

MultipartUpload

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

Type

data Type Source

Constructors

AmazonCustomerByEmail

AmazonCustomerByEmail

CanonicalUser

CanonicalUser

Group

Group

Instances

Enum Type 
Eq Type 
Ord Type 
Read Type 
Show Type 
Generic Type 
Hashable Type 
ToXML Type 
FromXML Type 
ToText Type 
FromText Type 
ToQuery Type 
ToHeader Type 
ToByteString Type 
type Rep Type 

TransitionStorageClass

CompletedMultipartUpload

completedMultipartUpload :: CompletedMultipartUpload Source

CompletedMultipartUpload constructor.

The fields accessible through corresponding lenses are:

Condition

condition :: Condition Source

Condition constructor.

The fields accessible through corresponding lenses are:

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.

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.

Permission

data Permission Source

Constructors

PFullControl

FULL_CONTROL

PRead

READ

PReadAcp

READ_ACP

PWrite

WRITE

PWriteAcp

WRITE_ACP

AccessControlPolicy

accessControlPolicy :: AccessControlPolicy Source

AccessControlPolicy constructor.

The fields accessible through corresponding lenses are:

BucketCannedACL

MFADelete

data MFADelete Source

Constructors

MFADDisabled

Disabled

MFADEnabled

Enabled

CloudFunctionConfiguration

Grantee

data Grantee Source

Instances

grantee Source

Arguments

:: Type

gType

-> Grantee 

Grantee constructor.

The fields accessible through corresponding lenses are:

gDisplayName :: Lens' Grantee (Maybe Text) Source

Screen name of the grantee.

gEmailAddress :: Lens' Grantee (Maybe Text) Source

Email address of the grantee.

gID :: Lens' Grantee (Maybe Text) Source

The canonical user ID of the grantee.

gType :: Lens' Grantee Type Source

Type of grantee

gURI :: Lens' Grantee (Maybe Text) Source

URI of the grantee group.

LifecycleConfiguration

lifecycleConfiguration :: LifecycleConfiguration Source

LifecycleConfiguration constructor.

The fields accessible through corresponding lenses are:

LoggingEnabled

loggingEnabled :: LoggingEnabled Source

LoggingEnabled constructor.

The fields accessible through corresponding lenses are:

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.

leTargetPrefix :: Lens' LoggingEnabled (Maybe Text) Source

This element lets you specify a prefix for the keys that the log files will be stored under.

ServerSideEncryption

IndexDocument

indexDocument Source

Arguments

:: Text

idSuffix

-> IndexDocument 

IndexDocument constructor.

The fields accessible through corresponding lenses are:

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

CopyObjectResult

copyObjectResult :: CopyObjectResult Source

CopyObjectResult constructor.

The fields accessible through corresponding lenses are:

Delete

data Delete Source

Instances

Eq Delete 
Read Delete 
Show Delete 
ToXML Delete 
FromXML Delete 

delete' :: Delete Source

Delete constructor.

The fields accessible through corresponding lenses are:

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.

RestoreRequest

restoreRequest Source

Arguments

:: Int

rDays

-> RestoreRequest 

RestoreRequest constructor.

The fields accessible through corresponding lenses are:

rDays :: Lens' RestoreRequest Int Source

Lifetime of the active copy in days

Common

newtype BucketName Source

Constructors

BucketName Text 

newtype ObjectKey Source

Constructors

ObjectKey Text 

Instances

newtype ETag Source

Constructors

ETag Text 

Instances

Eq ETag 
Ord ETag 
Show ETag 
IsString ETag 
Generic ETag 
ToXML ETag 
FromXML ETag 
ToText ETag 
FromText ETag 
ToQuery ETag 
ToByteString ETag 
type Rep ETag 

data Region :: *

Instances

Eq Region 
Ord Region 
Read Region 
Show Region 
Generic Region 
Default Region 
Hashable Region 
ToXML Region 
FromXML Region 
ToText Region 
FromText Region 
ToByteString Region 
ToBuilder 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)))))