@datafire/amazonaws_s3
Client library for Amazon Simple Storage Service
Installation and Usage
npm install --save @datafire/amazonaws_s3
let amazonaws_s3 = require('@datafire/amazonaws_s3').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_s3.ListBuckets({}).then(data => {
console.log(data);
});
Description
Actions
ListBuckets
amazonaws_s3.ListBuckets({}, context)
Input
- input
object
Output
- output ListBucketsOutput
DeleteBucket
amazonaws_s3.DeleteBucket({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
CreateBucket
amazonaws_s3.CreateBucket({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- CreateBucketConfiguration CreateBucketConfiguration
- Bucket required
Output
- output CreateBucketOutput
HeadBucket
amazonaws_s3.HeadBucket({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
ListObjects
amazonaws_s3.ListObjects({
"Bucket": ""
}, context)
Input
- input
object
- MaxKeys
string
- Marker
string
- Bucket required
string
- MaxKeys
Output
- output ListObjectsOutput
AbortMultipartUpload
amazonaws_s3.AbortMultipartUpload({
"Bucket": "",
"Key": []
}, context)
Input
- input
object
- Bucket required
string
- Key required
array
- Bucket required
Output
- output AbortMultipartUploadOutput
CompleteMultipartUpload
amazonaws_s3.CompleteMultipartUpload({
"Bucket": "",
"Key": []
}, context)
Input
- input
object
- Bucket required
string
- Key required
array
- MultipartUpload CompletedMultipartUpload
- Bucket required
Output
CopyObject
amazonaws_s3.CopyObject({
"Bucket": "",
"Key": []
}, context)
Input
- input
object
- Bucket required
string
- Key required
array
- Bucket required
Output
- output CopyObjectOutput
DeleteObject
amazonaws_s3.DeleteObject({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- Bucket required
Output
- output DeleteObjectOutput
GetObject
amazonaws_s3.GetObject({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- Bucket required
Output
- output GetObjectOutput
HeadObject
amazonaws_s3.HeadObject({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- Bucket required
Output
- output HeadObjectOutput
ListParts
amazonaws_s3.ListParts({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- MaxParts
string
- PartNumberMarker
string
- Bucket required
string
- Key required
string
- MaxParts
Output
- output ListPartsOutput
PutObject
amazonaws_s3.PutObject({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- Body Body
- Bucket required
Output
- output PutObjectOutput
UploadPart
amazonaws_s3.UploadPart({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- Body Body
- Bucket required
Output
- output UploadPartOutput
UploadPartCopy
amazonaws_s3.UploadPartCopy({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- Bucket required
Output
- output UploadPartCopyOutput
GetObjectAcl
amazonaws_s3.GetObjectAcl({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- Bucket required
Output
- output GetObjectAclOutput
PutObjectAcl
amazonaws_s3.PutObjectAcl({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- AccessControlPolicy AccessControlPolicy
- Bucket required
Output
- output PutObjectAclOutput
RestoreObject
amazonaws_s3.RestoreObject({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- RestoreRequest RestoreRequest
- Bucket required
Output
- output RestoreObjectOutput
DeleteObjectTagging
amazonaws_s3.DeleteObjectTagging({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- Bucket required
Output
- output DeleteObjectTaggingOutput
GetObjectTagging
amazonaws_s3.GetObjectTagging({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- Bucket required
Output
- output GetObjectTaggingOutput
PutObjectTagging
amazonaws_s3.PutObjectTagging({
"Bucket": "",
"Key": "",
"Tagging": {
"TagSet": []
}
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- Tagging required Tagging
- Bucket required
Output
- output PutObjectTaggingOutput
GetObjectTorrent
amazonaws_s3.GetObjectTorrent({
"Bucket": "",
"Key": ""
}, context)
Input
- input
object
- Bucket required
string
- Key required
string
- Bucket required
Output
- output GetObjectTorrentOutput
CreateMultipartUpload
amazonaws_s3.CreateMultipartUpload({
"Bucket": "",
"Key": []
}, context)
Input
- input
object
- Bucket required
string
- Key required
array
- Bucket required
Output
- output CreateMultipartUploadOutput
GetBucketAccelerateConfiguration
amazonaws_s3.GetBucketAccelerateConfiguration({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
PutBucketAccelerateConfiguration
amazonaws_s3.PutBucketAccelerateConfiguration({
"Bucket": "",
"AccelerateConfiguration": {}
}, context)
Input
- input
object
- Bucket required
string
- AccelerateConfiguration required AccelerateConfiguration
- Bucket required
Output
Output schema unknown
GetBucketAcl
amazonaws_s3.GetBucketAcl({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output GetBucketAclOutput
PutBucketAcl
amazonaws_s3.PutBucketAcl({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- AccessControlPolicy AccessControlPolicy
- Bucket required
Output
Output schema unknown
DeleteBucketAnalyticsConfiguration
amazonaws_s3.DeleteBucketAnalyticsConfiguration({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
GetBucketAnalyticsConfiguration
amazonaws_s3.GetBucketAnalyticsConfiguration({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
ListBucketAnalyticsConfigurations
amazonaws_s3.ListBucketAnalyticsConfigurations({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
PutBucketAnalyticsConfiguration
amazonaws_s3.PutBucketAnalyticsConfiguration({
"Bucket": "",
"AnalyticsConfiguration": {
"Id": "",
"StorageClassAnalysis": {}
}
}, context)
Input
- input
object
- Bucket required
string
- AnalyticsConfiguration required AnalyticsConfiguration
- Bucket required
Output
Output schema unknown
DeleteBucketCors
amazonaws_s3.DeleteBucketCors({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
GetBucketCors
amazonaws_s3.GetBucketCors({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output GetBucketCorsOutput
PutBucketCors
amazonaws_s3.PutBucketCors({
"Bucket": "",
"CORSConfiguration": {
"CORSRules": []
}
}, context)
Input
- input
object
- Bucket required
string
- CORSConfiguration required CORSConfiguration
- Bucket required
Output
Output schema unknown
DeleteObjects
amazonaws_s3.DeleteObjects({
"Bucket": "",
"Delete": {
"Objects": []
}
}, context)
Input
- input
object
- Bucket required
string
- Delete required Delete
- Bucket required
Output
- output DeleteObjectsOutput
DeleteBucketEncryption
amazonaws_s3.DeleteBucketEncryption({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
GetBucketEncryption
amazonaws_s3.GetBucketEncryption({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output GetBucketEncryptionOutput
PutBucketEncryption
amazonaws_s3.PutBucketEncryption({
"Bucket": "",
"ServerSideEncryptionConfiguration": {
"Rules": []
}
}, context)
Input
- input
object
- Bucket required
string
- ServerSideEncryptionConfiguration required ServerSideEncryptionConfiguration
- Bucket required
Output
Output schema unknown
DeleteBucketInventoryConfiguration
amazonaws_s3.DeleteBucketInventoryConfiguration({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
GetBucketInventoryConfiguration
amazonaws_s3.GetBucketInventoryConfiguration({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
ListBucketInventoryConfigurations
amazonaws_s3.ListBucketInventoryConfigurations({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
PutBucketInventoryConfiguration
amazonaws_s3.PutBucketInventoryConfiguration({
"Bucket": "",
"InventoryConfiguration": {
"Destination": {
"S3BucketDestination": {
"Bucket": "",
"Format": ""
}
},
"IsEnabled": true,
"Id": "",
"IncludedObjectVersions": "",
"Schedule": {
"Frequency": ""
}
}
}, context)
Input
- input
object
- Bucket required
string
- InventoryConfiguration required InventoryConfiguration
- Bucket required
Output
Output schema unknown
DeleteBucketLifecycle
amazonaws_s3.DeleteBucketLifecycle({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
GetBucketLifecycle
amazonaws_s3.GetBucketLifecycle({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output GetBucketLifecycleOutput
GetBucketLifecycleConfiguration
amazonaws_s3.GetBucketLifecycleConfiguration({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
PutBucketLifecycle
amazonaws_s3.PutBucketLifecycle({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- LifecycleConfiguration LifecycleConfiguration
- Bucket required
Output
Output schema unknown
PutBucketLifecycleConfiguration
amazonaws_s3.PutBucketLifecycleConfiguration({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- LifecycleConfiguration BucketLifecycleConfiguration
- Bucket required
Output
Output schema unknown
ListObjectsV2
amazonaws_s3.ListObjectsV2({
"Bucket": ""
}, context)
Input
- input
object
- MaxKeys
string
- ContinuationToken
string
- Bucket required
string
- MaxKeys
Output
- output ListObjectsV2Output
GetBucketLocation
amazonaws_s3.GetBucketLocation({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output GetBucketLocationOutput
GetBucketLogging
amazonaws_s3.GetBucketLogging({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output GetBucketLoggingOutput
PutBucketLogging
amazonaws_s3.PutBucketLogging({
"Bucket": "",
"BucketLoggingStatus": {}
}, context)
Input
- input
object
- Bucket required
string
- BucketLoggingStatus required BucketLoggingStatus
- Bucket required
Output
Output schema unknown
DeleteBucketMetricsConfiguration
amazonaws_s3.DeleteBucketMetricsConfiguration({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
GetBucketMetricsConfiguration
amazonaws_s3.GetBucketMetricsConfiguration({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
ListBucketMetricsConfigurations
amazonaws_s3.ListBucketMetricsConfigurations({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
PutBucketMetricsConfiguration
amazonaws_s3.PutBucketMetricsConfiguration({
"Bucket": "",
"MetricsConfiguration": {
"Id": ""
}
}, context)
Input
- input
object
- Bucket required
string
- MetricsConfiguration required MetricsConfiguration
- Bucket required
Output
Output schema unknown
GetBucketNotification
amazonaws_s3.GetBucketNotification({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
GetBucketNotificationConfiguration
amazonaws_s3.GetBucketNotificationConfiguration({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output NotificationConfiguration
PutBucketNotification
amazonaws_s3.PutBucketNotification({
"Bucket": "",
"NotificationConfiguration": {}
}, context)
Input
- input
object
- Bucket required
string
- NotificationConfiguration required NotificationConfigurationDeprecated
- Bucket required
Output
Output schema unknown
PutBucketNotificationConfiguration
amazonaws_s3.PutBucketNotificationConfiguration({
"Bucket": "",
"NotificationConfiguration": {}
}, context)
Input
- input
object
- Bucket required
string
- NotificationConfiguration required NotificationConfiguration
- Bucket required
Output
Output schema unknown
DeleteBucketPolicy
amazonaws_s3.DeleteBucketPolicy({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
GetBucketPolicy
amazonaws_s3.GetBucketPolicy({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output GetBucketPolicyOutput
PutBucketPolicy
amazonaws_s3.PutBucketPolicy({
"Bucket": "",
"Policy": ""
}, context)
Input
- input
object
- Bucket required
string
- Policy required Policy
- Bucket required
Output
Output schema unknown
DeleteBucketReplication
amazonaws_s3.DeleteBucketReplication({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
GetBucketReplication
amazonaws_s3.GetBucketReplication({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output GetBucketReplicationOutput
PutBucketReplication
amazonaws_s3.PutBucketReplication({
"Bucket": "",
"ReplicationConfiguration": {
"Role": "",
"Rules": []
}
}, context)
Input
- input
object
- Bucket required
string
- ReplicationConfiguration required ReplicationConfiguration
- Bucket required
Output
Output schema unknown
GetBucketRequestPayment
amazonaws_s3.GetBucketRequestPayment({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
PutBucketRequestPayment
amazonaws_s3.PutBucketRequestPayment({
"Bucket": "",
"RequestPaymentConfiguration": {
"Payer": ""
}
}, context)
Input
- input
object
- Bucket required
string
- RequestPaymentConfiguration required RequestPaymentConfiguration
- Bucket required
Output
Output schema unknown
DeleteBucketTagging
amazonaws_s3.DeleteBucketTagging({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
GetBucketTagging
amazonaws_s3.GetBucketTagging({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output GetBucketTaggingOutput
PutBucketTagging
amazonaws_s3.PutBucketTagging({
"Bucket": "",
"Tagging": {
"TagSet": []
}
}, context)
Input
- input
object
- Bucket required
string
- Tagging required Tagging
- Bucket required
Output
Output schema unknown
ListMultipartUploads
amazonaws_s3.ListMultipartUploads({
"Bucket": ""
}, context)
Input
- input
object
- MaxUploads
string
- KeyMarker
string
- UploadIdMarker
string
- Bucket required
string
- MaxUploads
Output
- output ListMultipartUploadsOutput
GetBucketVersioning
amazonaws_s3.GetBucketVersioning({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output GetBucketVersioningOutput
PutBucketVersioning
amazonaws_s3.PutBucketVersioning({
"Bucket": "",
"VersioningConfiguration": {}
}, context)
Input
- input
object
- Bucket required
string
- VersioningConfiguration required VersioningConfiguration
- Bucket required
Output
Output schema unknown
ListObjectVersions
amazonaws_s3.ListObjectVersions({
"Bucket": ""
}, context)
Input
- input
object
- MaxKeys
string
- KeyMarker
string
- VersionIdMarker
string
- Bucket required
string
- MaxKeys
Output
- output ListObjectVersionsOutput
DeleteBucketWebsite
amazonaws_s3.DeleteBucketWebsite({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
Output schema unknown
GetBucketWebsite
amazonaws_s3.GetBucketWebsite({
"Bucket": ""
}, context)
Input
- input
object
- Bucket required
string
- Bucket required
Output
- output GetBucketWebsiteOutput
PutBucketWebsite
amazonaws_s3.PutBucketWebsite({
"Bucket": "",
"WebsiteConfiguration": {}
}, context)
Input
- input
object
- Bucket required
string
- WebsiteConfiguration required WebsiteConfiguration
- Bucket required
Output
Output schema unknown
Definitions
AbortDate
- AbortDate
string
AbortIncompleteMultipartUpload
- AbortIncompleteMultipartUpload
object
: Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload.- DaysAfterInitiation DaysAfterInitiation
AbortMultipartUploadOutput
- AbortMultipartUploadOutput
object
AbortMultipartUploadRequest
- AbortMultipartUploadRequest
object
AbortRuleId
- AbortRuleId
string
AccelerateConfiguration
- AccelerateConfiguration
object
- Status BucketAccelerateStatus
AcceptRanges
- AcceptRanges
string
AccessControlPolicy
AccessControlTranslation
- AccessControlTranslation
object
: Container for information regarding the access control for replicas.- Owner required OwnerOverride
AccountId
- AccountId
string
AllowedHeader
- AllowedHeader
string
AllowedHeaders
- AllowedHeaders
array
- items AllowedHeader
AllowedMethod
- AllowedMethod
string
AllowedMethods
- AllowedMethods
array
- items AllowedMethod
AllowedOrigin
- AllowedOrigin
string
AllowedOrigins
- AllowedOrigins
array
- items AllowedOrigin
AnalyticsAndOperator
AnalyticsConfiguration
- AnalyticsConfiguration
object
- Filter AnalyticsFilter
- Id required AnalyticsId
- StorageClassAnalysis required StorageClassAnalysis
AnalyticsConfigurationList
- AnalyticsConfigurationList
array
- items AnalyticsConfiguration
AnalyticsExportDestination
- AnalyticsExportDestination
object
- S3BucketDestination required AnalyticsS3BucketDestination
AnalyticsFilter
- AnalyticsFilter
object
- And AnalyticsAndOperator
- Prefix Prefix
- Tag Tag
AnalyticsId
- AnalyticsId
string
AnalyticsS3BucketDestination
- AnalyticsS3BucketDestination
object
- Bucket required BucketName
- BucketAccountId AccountId
- Format required AnalyticsS3ExportFileFormat
- Prefix Prefix
AnalyticsS3ExportFileFormat
- AnalyticsS3ExportFileFormat
string
(values: CSV)
Body
- Body
string
Bucket
- Bucket
object
- CreationDate CreationDate
- Name BucketName
BucketAccelerateStatus
- BucketAccelerateStatus
string
(values: Enabled, Suspended)
BucketAlreadyExists
- BucketAlreadyExists
object
: 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.
BucketAlreadyOwnedByYou
- BucketAlreadyOwnedByYou
object
BucketCannedACL
- BucketCannedACL
string
(values: private, public-read, public-read-write, authenticated-read)
BucketLifecycleConfiguration
- BucketLifecycleConfiguration
object
- Rules required LifecycleRules
BucketLocationConstraint
- BucketLocationConstraint
string
(values: EU, eu-west-1, us-west-1, us-west-2, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1, cn-north-1, eu-central-1)
BucketLoggingStatus
- BucketLoggingStatus
object
- LoggingEnabled LoggingEnabled
BucketLogsPermission
- BucketLogsPermission
string
(values: FULL_CONTROL, READ, WRITE)
BucketName
- BucketName
string
BucketVersioningStatus
- BucketVersioningStatus
string
(values: Enabled, Suspended)
Buckets
- Buckets
array
- items Bucket
CORSConfiguration
- CORSConfiguration
object
- CORSRules required CORSRules
CORSRule
- CORSRule
object
- AllowedHeaders AllowedHeaders
- AllowedMethods required AllowedMethods
- AllowedOrigins required AllowedOrigins
- ExposeHeaders ExposeHeaders
- MaxAgeSeconds MaxAgeSeconds
CORSRules
- CORSRules
array
- items CORSRule
CSVInput
- CSVInput
object
: Describes how a CSV-formatted input object is formatted.- Comments Comments
- FieldDelimiter FieldDelimiter
- FileHeaderInfo FileHeaderInfo
- QuoteCharacter QuoteCharacter
- QuoteEscapeCharacter QuoteEscapeCharacter
- RecordDelimiter RecordDelimiter
CSVOutput
- CSVOutput
object
: Describes how CSV-formatted results are formatted.- FieldDelimiter FieldDelimiter
- QuoteCharacter QuoteCharacter
- QuoteEscapeCharacter QuoteEscapeCharacter
- QuoteFields QuoteFields
- RecordDelimiter RecordDelimiter
CacheControl
- CacheControl
string
CloudFunction
- CloudFunction
string
CloudFunctionConfiguration
- CloudFunctionConfiguration
object
- CloudFunction CloudFunction
- Event Event
- Events EventList
- Id NotificationId
- InvocationRole CloudFunctionInvocationRole
CloudFunctionInvocationRole
- CloudFunctionInvocationRole
string
Code
- Code
string
Comments
- Comments
string
CommonPrefix
- CommonPrefix
object
- Prefix Prefix
CommonPrefixList
- CommonPrefixList
array
- items CommonPrefix
CompleteMultipartUploadOutput
- CompleteMultipartUploadOutput
object
- Bucket BucketName
- ETag ETag
- Key ObjectKey
- Location Location
CompleteMultipartUploadRequest
- CompleteMultipartUploadRequest
object
- MultipartUpload CompletedMultipartUpload
CompletedMultipartUpload
- CompletedMultipartUpload
object
- Parts CompletedPartList
CompletedPart
- CompletedPart
object
- ETag ETag
- PartNumber PartNumber
CompletedPartList
- CompletedPartList
array
- items CompletedPart
Condition
- Condition
object
- HttpErrorCodeReturnedEquals HttpErrorCodeReturnedEquals
- KeyPrefixEquals KeyPrefixEquals
ConfirmRemoveSelfBucketAccess
- ConfirmRemoveSelfBucketAccess
boolean
ContentDisposition
- ContentDisposition
string
ContentEncoding
- ContentEncoding
string
ContentLanguage
- ContentLanguage
string
ContentLength
- ContentLength
integer
ContentMD5
- ContentMD5
string
ContentRange
- ContentRange
string
ContentType
- ContentType
string
CopyObjectOutput
- CopyObjectOutput
object
- CopyObjectResult CopyObjectResult
CopyObjectRequest
- CopyObjectRequest
object
CopyObjectResult
- CopyObjectResult
object
- ETag ETag
- LastModified LastModified
CopyPartResult
- CopyPartResult
object
- ETag ETag
- LastModified LastModified
CopySource
- CopySource
string
CopySourceIfMatch
- CopySourceIfMatch
string
CopySourceIfModifiedSince
- CopySourceIfModifiedSince
string
CopySourceIfNoneMatch
- CopySourceIfNoneMatch
string
CopySourceIfUnmodifiedSince
- CopySourceIfUnmodifiedSince
string
CopySourceRange
- CopySourceRange
string
CopySourceSSECustomerAlgorithm
- CopySourceSSECustomerAlgorithm
string
CopySourceSSECustomerKey
- CopySourceSSECustomerKey
string
CopySourceSSECustomerKeyMD5
- CopySourceSSECustomerKeyMD5
string
CopySourceVersionId
- CopySourceVersionId
string
CreateBucketConfiguration
- CreateBucketConfiguration
object
- LocationConstraint BucketLocationConstraint
CreateBucketOutput
- CreateBucketOutput
object
CreateBucketRequest
- CreateBucketRequest
object
- CreateBucketConfiguration CreateBucketConfiguration
CreateMultipartUploadOutput
- CreateMultipartUploadOutput
object
- Bucket BucketName
- Key ObjectKey
- UploadId MultipartUploadId
CreateMultipartUploadRequest
- CreateMultipartUploadRequest
object
CreationDate
- CreationDate
string
Date
- Date
string
Days
- Days
integer
DaysAfterInitiation
- DaysAfterInitiation
integer
Delete
- Delete
object
- Objects required ObjectIdentifierList
- Quiet Quiet
DeleteBucketAnalyticsConfigurationRequest
- DeleteBucketAnalyticsConfigurationRequest
object
DeleteBucketCorsRequest
- DeleteBucketCorsRequest
object
DeleteBucketEncryptionRequest
- DeleteBucketEncryptionRequest
object
DeleteBucketInventoryConfigurationRequest
- DeleteBucketInventoryConfigurationRequest
object
DeleteBucketLifecycleRequest
- DeleteBucketLifecycleRequest
object
DeleteBucketMetricsConfigurationRequest
- DeleteBucketMetricsConfigurationRequest
object
DeleteBucketPolicyRequest
- DeleteBucketPolicyRequest
object
DeleteBucketReplicationRequest
- DeleteBucketReplicationRequest
object
DeleteBucketRequest
- DeleteBucketRequest
object
DeleteBucketTaggingRequest
- DeleteBucketTaggingRequest
object
DeleteBucketWebsiteRequest
- DeleteBucketWebsiteRequest
object
DeleteMarker
- DeleteMarker
boolean
DeleteMarkerEntry
- DeleteMarkerEntry
object
- IsLatest IsLatest
- Key ObjectKey
- LastModified LastModified
- Owner Owner
- VersionId ObjectVersionId
DeleteMarkerVersionId
- DeleteMarkerVersionId
string
DeleteMarkers
- DeleteMarkers
array
- items DeleteMarkerEntry
DeleteObjectOutput
- DeleteObjectOutput
object
DeleteObjectRequest
- DeleteObjectRequest
object
DeleteObjectTaggingOutput
- DeleteObjectTaggingOutput
object
DeleteObjectTaggingRequest
- DeleteObjectTaggingRequest
object
DeleteObjectsOutput
- DeleteObjectsOutput
object
- Deleted DeletedObjects
- Errors Errors
DeleteObjectsRequest
- DeleteObjectsRequest
object
- Delete required Delete
DeletedObject
- DeletedObject
object
- DeleteMarker DeleteMarker
- DeleteMarkerVersionId DeleteMarkerVersionId
- Key ObjectKey
- VersionId ObjectVersionId
DeletedObjects
- DeletedObjects
array
- items DeletedObject
Delimiter
- Delimiter
string
Description
- Description
string
Destination
- Destination
object
: Container for replication destination information.- AccessControlTranslation AccessControlTranslation
- Account AccountId
- Bucket required BucketName
- EncryptionConfiguration EncryptionConfiguration
- StorageClass StorageClass
DisplayName
- DisplayName
string
ETag
- ETag
string
EmailAddress
- EmailAddress
string
EncodingType
- EncodingType
string
(values: url): 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.
Encryption
- Encryption
object
: Describes the server-side encryption that will be applied to the restore results.- EncryptionType required ServerSideEncryption
- KMSContext KMSContext
- KMSKeyId SSEKMSKeyId
EncryptionConfiguration
- EncryptionConfiguration
object
: Container for information regarding encryption based configuration for replicas.- ReplicaKmsKeyID ReplicaKmsKeyID
Error
- Error
object
- Code Code
- Key ObjectKey
- Message Message
- VersionId ObjectVersionId
ErrorDocument
- ErrorDocument
object
- Key required ObjectKey
Errors
- Errors
array
- items Error
Event
- Event
string
(values: s3:ReducedRedundancyLostObject, s3:ObjectCreated:, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated): Bucket event for which to send notifications.
EventList
- EventList
array
- items Event
Expiration
- Expiration
string
ExpirationStatus
- ExpirationStatus
string
(values: Enabled, Disabled)
ExpiredObjectDeleteMarker
- ExpiredObjectDeleteMarker
boolean
Expires
- Expires
string
ExposeHeader
- ExposeHeader
string
ExposeHeaders
- ExposeHeaders
array
- items ExposeHeader
Expression
- Expression
string
ExpressionType
- ExpressionType
string
(values: SQL)
FetchOwner
- FetchOwner
boolean
FieldDelimiter
- FieldDelimiter
string
FileHeaderInfo
- FileHeaderInfo
string
(values: USE, IGNORE, NONE)
FilterRule
- FilterRule
object
: Container for key value pair that defines the criteria for the filter rule.- Name FilterRuleName
- Value FilterRuleValue
FilterRuleList
- FilterRuleList
array
: A list of containers for key value pair that defines the criteria for the filter rule.- items FilterRule
FilterRuleName
- FilterRuleName
string
(values: prefix, suffix)
FilterRuleValue
- FilterRuleValue
string
GetBucketAccelerateConfigurationOutput
- GetBucketAccelerateConfigurationOutput
object
- Status BucketAccelerateStatus
GetBucketAccelerateConfigurationRequest
- GetBucketAccelerateConfigurationRequest
object
GetBucketAclOutput
GetBucketAclRequest
- GetBucketAclRequest
object
GetBucketAnalyticsConfigurationOutput
- GetBucketAnalyticsConfigurationOutput
object
- AnalyticsConfiguration AnalyticsConfiguration
GetBucketAnalyticsConfigurationRequest
- GetBucketAnalyticsConfigurationRequest
object
GetBucketCorsOutput
- GetBucketCorsOutput
object
- CORSRules CORSRules
GetBucketCorsRequest
- GetBucketCorsRequest
object
GetBucketEncryptionOutput
- GetBucketEncryptionOutput
object
- ServerSideEncryptionConfiguration ServerSideEncryptionConfiguration
GetBucketEncryptionRequest
- GetBucketEncryptionRequest
object
GetBucketInventoryConfigurationOutput
- GetBucketInventoryConfigurationOutput
object
- InventoryConfiguration InventoryConfiguration
GetBucketInventoryConfigurationRequest
- GetBucketInventoryConfigurationRequest
object
GetBucketLifecycleConfigurationOutput
- GetBucketLifecycleConfigurationOutput
object
- Rules LifecycleRules
GetBucketLifecycleConfigurationRequest
- GetBucketLifecycleConfigurationRequest
object
GetBucketLifecycleOutput
- GetBucketLifecycleOutput
object
- Rules Rules
GetBucketLifecycleRequest
- GetBucketLifecycleRequest
object
GetBucketLocationOutput
- GetBucketLocationOutput
object
- LocationConstraint BucketLocationConstraint
GetBucketLocationRequest
- GetBucketLocationRequest
object
GetBucketLoggingOutput
- GetBucketLoggingOutput
object
- LoggingEnabled LoggingEnabled
GetBucketLoggingRequest
- GetBucketLoggingRequest
object
GetBucketMetricsConfigurationOutput
- GetBucketMetricsConfigurationOutput
object
- MetricsConfiguration MetricsConfiguration
GetBucketMetricsConfigurationRequest
- GetBucketMetricsConfigurationRequest
object
GetBucketNotificationConfigurationRequest
- GetBucketNotificationConfigurationRequest
object
GetBucketPolicyOutput
- GetBucketPolicyOutput
object
- Policy Policy
GetBucketPolicyRequest
- GetBucketPolicyRequest
object
GetBucketReplicationOutput
- GetBucketReplicationOutput
object
- ReplicationConfiguration ReplicationConfiguration
GetBucketReplicationRequest
- GetBucketReplicationRequest
object
GetBucketRequestPaymentOutput
- GetBucketRequestPaymentOutput
object
- Payer Payer
GetBucketRequestPaymentRequest
- GetBucketRequestPaymentRequest
object
GetBucketTaggingOutput
- GetBucketTaggingOutput
object
- TagSet required TagSet
GetBucketTaggingRequest
- GetBucketTaggingRequest
object
GetBucketVersioningOutput
- GetBucketVersioningOutput
object
- MFADelete MFADeleteStatus
- Status BucketVersioningStatus
GetBucketVersioningRequest
- GetBucketVersioningRequest
object
GetBucketWebsiteOutput
- GetBucketWebsiteOutput
object
- ErrorDocument ErrorDocument
- IndexDocument IndexDocument
- RedirectAllRequestsTo RedirectAllRequestsTo
- RoutingRules RoutingRules
GetBucketWebsiteRequest
- GetBucketWebsiteRequest
object
GetObjectAclOutput
GetObjectAclRequest
- GetObjectAclRequest
object
GetObjectOutput
- GetObjectOutput
object
- Body Body
GetObjectRequest
- GetObjectRequest
object
GetObjectTaggingOutput
- GetObjectTaggingOutput
object
- TagSet required TagSet
GetObjectTaggingRequest
- GetObjectTaggingRequest
object
GetObjectTorrentOutput
- GetObjectTorrentOutput
object
- Body Body
GetObjectTorrentRequest
- GetObjectTorrentRequest
object
GlacierJobParameters
- GlacierJobParameters
object
- Tier required Tier
Grant
- Grant
object
- Grantee Grantee
- Permission Permission
GrantFullControl
- GrantFullControl
string
GrantRead
- GrantRead
string
GrantReadACP
- GrantReadACP
string
GrantWrite
- GrantWrite
string
GrantWriteACP
- GrantWriteACP
string
Grantee
- Grantee
object
- DisplayName DisplayName
- EmailAddress EmailAddress
- ID ID
- Type required Type
- URI URI
Grants
- Grants
array
- items Grant
HeadBucketRequest
- HeadBucketRequest
object
HeadObjectOutput
- HeadObjectOutput
object
HeadObjectRequest
- HeadObjectRequest
object
HostName
- HostName
string
HttpErrorCodeReturnedEquals
- HttpErrorCodeReturnedEquals
string
HttpRedirectCode
- HttpRedirectCode
string
ID
- ID
string
IfMatch
- IfMatch
string
IfModifiedSince
- IfModifiedSince
string
IfNoneMatch
- IfNoneMatch
string
IfUnmodifiedSince
- IfUnmodifiedSince
string
IndexDocument
- IndexDocument
object
- Suffix required Suffix
Initiated
- Initiated
string
Initiator
- Initiator
object
- DisplayName DisplayName
- ID ID
InputSerialization
- InputSerialization
object
: Describes the serialization format of the object.- CSV CSVInput
InventoryConfiguration
- InventoryConfiguration
object
- Destination required InventoryDestination
- Filter InventoryFilter
- Id required InventoryId
- IncludedObjectVersions required InventoryIncludedObjectVersions
- IsEnabled required IsEnabled
- OptionalFields InventoryOptionalFields
- Schedule required InventorySchedule
InventoryConfigurationList
- InventoryConfigurationList
array
- items InventoryConfiguration
InventoryDestination
- InventoryDestination
object
- S3BucketDestination required InventoryS3BucketDestination
InventoryEncryption
- InventoryEncryption
object
: Contains the type of server-side encryption used to encrypt the inventory results.
InventoryFilter
- InventoryFilter
object
- Prefix required Prefix
InventoryFormat
- InventoryFormat
string
(values: CSV, ORC)
InventoryFrequency
- InventoryFrequency
string
(values: Daily, Weekly)
InventoryId
- InventoryId
string
InventoryIncludedObjectVersions
- InventoryIncludedObjectVersions
string
(values: All, Current)
InventoryOptionalField
- InventoryOptionalField
string
(values: Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus)
InventoryOptionalFields
- InventoryOptionalFields
array
- items InventoryOptionalField
InventoryS3BucketDestination
- InventoryS3BucketDestination
object
- AccountId AccountId
- Bucket required BucketName
- Encryption InventoryEncryption
- Format required InventoryFormat
- Prefix Prefix
InventorySchedule
- InventorySchedule
object
- Frequency required InventoryFrequency
IsEnabled
- IsEnabled
boolean
IsLatest
- IsLatest
boolean
IsTruncated
- IsTruncated
boolean
KMSContext
- KMSContext
string
KeyCount
- KeyCount
integer
KeyMarker
- KeyMarker
string
KeyPrefixEquals
- KeyPrefixEquals
string
LambdaFunctionArn
- LambdaFunctionArn
string
LambdaFunctionConfiguration
- LambdaFunctionConfiguration
object
: Container for specifying the AWS Lambda notification configuration.- Events required EventList
- Filter NotificationConfigurationFilter
- Id NotificationId
- LambdaFunctionArn required LambdaFunctionArn
LambdaFunctionConfigurationList
- LambdaFunctionConfigurationList
array
LastModified
- LastModified
string
LifecycleConfiguration
- LifecycleConfiguration
object
- Rules required Rules
LifecycleExpiration
- LifecycleExpiration
object
- Date Date
- Days Days
- ExpiredObjectDeleteMarker ExpiredObjectDeleteMarker
LifecycleRule
- LifecycleRule
object
- AbortIncompleteMultipartUpload AbortIncompleteMultipartUpload
- Expiration LifecycleExpiration
- Filter LifecycleRuleFilter
- ID ID
- NoncurrentVersionExpiration NoncurrentVersionExpiration
- NoncurrentVersionTransitions NoncurrentVersionTransitionList
- Prefix Prefix
- Status required ExpirationStatus
- Transitions TransitionList
LifecycleRuleAndOperator
- LifecycleRuleAndOperator
object
: This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.
LifecycleRuleFilter
- LifecycleRuleFilter
object
: The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified.- And LifecycleRuleAndOperator
- Prefix Prefix
- Tag Tag
LifecycleRules
- LifecycleRules
array
- items LifecycleRule
ListBucketAnalyticsConfigurationsOutput
- ListBucketAnalyticsConfigurationsOutput
object
- AnalyticsConfigurationList AnalyticsConfigurationList
- ContinuationToken Token
- IsTruncated IsTruncated
- NextContinuationToken NextToken
ListBucketAnalyticsConfigurationsRequest
- ListBucketAnalyticsConfigurationsRequest
object
ListBucketInventoryConfigurationsOutput
- ListBucketInventoryConfigurationsOutput
object
- ContinuationToken Token
- InventoryConfigurationList InventoryConfigurationList
- IsTruncated IsTruncated
- NextContinuationToken NextToken
ListBucketInventoryConfigurationsRequest
- ListBucketInventoryConfigurationsRequest
object
ListBucketMetricsConfigurationsOutput
- ListBucketMetricsConfigurationsOutput
object
- ContinuationToken Token
- IsTruncated IsTruncated
- MetricsConfigurationList MetricsConfigurationList
- NextContinuationToken NextToken
ListBucketMetricsConfigurationsRequest
- ListBucketMetricsConfigurationsRequest
object
ListBucketsOutput
ListMultipartUploadsOutput
- ListMultipartUploadsOutput
object
- Bucket BucketName
- CommonPrefixes CommonPrefixList
- Delimiter Delimiter
- EncodingType EncodingType
- IsTruncated IsTruncated
- KeyMarker KeyMarker
- MaxUploads MaxUploads
- NextKeyMarker NextKeyMarker
- NextUploadIdMarker NextUploadIdMarker
- Prefix Prefix
- UploadIdMarker UploadIdMarker
- Uploads MultipartUploadList
ListMultipartUploadsRequest
- ListMultipartUploadsRequest
object
ListObjectVersionsOutput
- ListObjectVersionsOutput
object
- CommonPrefixes CommonPrefixList
- DeleteMarkers DeleteMarkers
- Delimiter Delimiter
- EncodingType EncodingType
- IsTruncated IsTruncated
- KeyMarker KeyMarker
- MaxKeys MaxKeys
- Name BucketName
- NextKeyMarker NextKeyMarker
- NextVersionIdMarker NextVersionIdMarker
- Prefix Prefix
- VersionIdMarker VersionIdMarker
- Versions ObjectVersionList
ListObjectVersionsRequest
- ListObjectVersionsRequest
object
ListObjectsOutput
- ListObjectsOutput
object
- CommonPrefixes CommonPrefixList
- Contents ObjectList
- Delimiter Delimiter
- EncodingType EncodingType
- IsTruncated IsTruncated
- Marker Marker
- MaxKeys MaxKeys
- Name BucketName
- NextMarker NextMarker
- Prefix Prefix
ListObjectsRequest
- ListObjectsRequest
object
ListObjectsV2Output
- ListObjectsV2Output
object
- CommonPrefixes CommonPrefixList
- Contents ObjectList
- ContinuationToken Token
- Delimiter Delimiter
- EncodingType EncodingType
- IsTruncated IsTruncated
- KeyCount KeyCount
- MaxKeys MaxKeys
- Name BucketName
- NextContinuationToken NextToken
- Prefix Prefix
- StartAfter StartAfter
ListObjectsV2Request
- ListObjectsV2Request
object
ListPartsOutput
- ListPartsOutput
object
- Bucket BucketName
- Initiator Initiator
- IsTruncated IsTruncated
- Key ObjectKey
- MaxParts MaxParts
- NextPartNumberMarker NextPartNumberMarker
- Owner Owner
- PartNumberMarker PartNumberMarker
- Parts Parts
- StorageClass StorageClass
- UploadId MultipartUploadId
ListPartsRequest
- ListPartsRequest
object
Location
- Location
string
LocationPrefix
- LocationPrefix
string
LoggingEnabled
- LoggingEnabled
object
- TargetBucket TargetBucket
- TargetGrants TargetGrants
- TargetPrefix TargetPrefix
MFA
- MFA
string
MFADelete
- MFADelete
string
(values: Enabled, Disabled)
MFADeleteStatus
- MFADeleteStatus
string
(values: Enabled, Disabled)
Marker
- Marker
string
MaxAgeSeconds
- MaxAgeSeconds
integer
MaxKeys
- MaxKeys
integer
MaxParts
- MaxParts
integer
MaxUploads
- MaxUploads
integer
Message
- Message
string
Metadata
- Metadata
array
- items
object
- key MetadataKey
- value MetadataValue
- items
MetadataDirective
- MetadataDirective
string
(values: COPY, REPLACE)
MetadataEntry
- MetadataEntry
object
: A metadata key-value pair to store with an object.- Name MetadataKey
- Value MetadataValue
MetadataKey
- MetadataKey
string
MetadataValue
- MetadataValue
string
MetricsAndOperator
MetricsConfiguration
- MetricsConfiguration
object
- Filter MetricsFilter
- Id required MetricsId
MetricsConfigurationList
- MetricsConfigurationList
array
- items MetricsConfiguration
MetricsFilter
- MetricsFilter
object
- And MetricsAndOperator
- Prefix Prefix
- Tag Tag
MetricsId
- MetricsId
string
MissingMeta
- MissingMeta
integer
MultipartUpload
- MultipartUpload
object
- Initiated Initiated
- Initiator Initiator
- Key ObjectKey
- Owner Owner
- StorageClass StorageClass
- UploadId MultipartUploadId
MultipartUploadId
- MultipartUploadId
string
MultipartUploadList
- MultipartUploadList
array
- items MultipartUpload
NextKeyMarker
- NextKeyMarker
string
NextMarker
- NextMarker
string
NextPartNumberMarker
- NextPartNumberMarker
integer
NextToken
- NextToken
string
NextUploadIdMarker
- NextUploadIdMarker
string
NextVersionIdMarker
- NextVersionIdMarker
string
NoSuchBucket
- NoSuchBucket
object
: The specified bucket does not exist.
NoSuchKey
- NoSuchKey
object
: The specified key does not exist.
NoSuchUpload
- NoSuchUpload
object
: The specified multipart upload does not exist.
NoncurrentVersionExpiration
- NoncurrentVersionExpiration
object
: 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.- NoncurrentDays Days
NoncurrentVersionTransition
- NoncurrentVersionTransition
object
: 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.- NoncurrentDays Days
- StorageClass TransitionStorageClass
NoncurrentVersionTransitionList
- NoncurrentVersionTransitionList
array
NotificationConfiguration
- NotificationConfiguration
object
: Container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off on the bucket.- LambdaFunctionConfigurations LambdaFunctionConfigurationList
- QueueConfigurations QueueConfigurationList
- TopicConfigurations TopicConfigurationList
NotificationConfigurationDeprecated
- NotificationConfigurationDeprecated
object
- CloudFunctionConfiguration CloudFunctionConfiguration
- QueueConfiguration QueueConfigurationDeprecated
- TopicConfiguration TopicConfigurationDeprecated
NotificationConfigurationFilter
- NotificationConfigurationFilter
object
: 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.- Key S3KeyFilter
NotificationId
- NotificationId
string
: Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
Object
- Object
object
- ETag ETag
- Key ObjectKey
- LastModified LastModified
- Owner Owner
- Size Size
- StorageClass ObjectStorageClass
ObjectAlreadyInActiveTierError
- ObjectAlreadyInActiveTierError
object
: This operation is not allowed against this storage tier
ObjectCannedACL
- ObjectCannedACL
string
(values: private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control)
ObjectIdentifier
- ObjectIdentifier
object
- Key required ObjectKey
- VersionId ObjectVersionId
ObjectIdentifierList
- ObjectIdentifierList
array
- items ObjectIdentifier
ObjectKey
- ObjectKey
string
ObjectList
- ObjectList
array
- items Object
ObjectNotInActiveTierError
- ObjectNotInActiveTierError
object
: The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier.
ObjectStorageClass
- ObjectStorageClass
string
(values: STANDARD, REDUCED_REDUNDANCY, GLACIER)
ObjectVersion
- ObjectVersion
object
- ETag ETag
- IsLatest IsLatest
- Key ObjectKey
- LastModified LastModified
- Owner Owner
- Size Size
- StorageClass ObjectVersionStorageClass
- VersionId ObjectVersionId
ObjectVersionId
- ObjectVersionId
string
ObjectVersionList
- ObjectVersionList
array
- items ObjectVersion
ObjectVersionStorageClass
- ObjectVersionStorageClass
string
(values: STANDARD)
OutputLocation
- OutputLocation
object
: Describes the location where the restore job's output is stored.- S3 S3Location
OutputSerialization
- OutputSerialization
object
: Describes how results of the Select job are serialized.- CSV CSVOutput
Owner
- Owner
object
- DisplayName DisplayName
- ID ID
OwnerOverride
- OwnerOverride
string
(values: Destination)
Part
- Part
object
- ETag ETag
- LastModified LastModified
- PartNumber PartNumber
- Size Size
PartNumber
- PartNumber
integer
PartNumberMarker
- PartNumberMarker
integer
Parts
- Parts
array
- items Part
PartsCount
- PartsCount
integer
Payer
- Payer
string
(values: Requester, BucketOwner)
Permission
- Permission
string
(values: FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP)
Policy
- Policy
string
Prefix
- Prefix
string
Protocol
- Protocol
string
(values: http, https)
PutBucketAccelerateConfigurationRequest
- PutBucketAccelerateConfigurationRequest
object
- AccelerateConfiguration required AccelerateConfiguration
PutBucketAclRequest
- PutBucketAclRequest
object
- AccessControlPolicy AccessControlPolicy
PutBucketAnalyticsConfigurationRequest
- PutBucketAnalyticsConfigurationRequest
object
- AnalyticsConfiguration required AnalyticsConfiguration
PutBucketCorsRequest
- PutBucketCorsRequest
object
- CORSConfiguration required CORSConfiguration
PutBucketEncryptionRequest
- PutBucketEncryptionRequest
object
- ServerSideEncryptionConfiguration required ServerSideEncryptionConfiguration
PutBucketInventoryConfigurationRequest
- PutBucketInventoryConfigurationRequest
object
- InventoryConfiguration required InventoryConfiguration
PutBucketLifecycleConfigurationRequest
- PutBucketLifecycleConfigurationRequest
object
- LifecycleConfiguration BucketLifecycleConfiguration
PutBucketLifecycleRequest
- PutBucketLifecycleRequest
object
- LifecycleConfiguration LifecycleConfiguration
PutBucketLoggingRequest
- PutBucketLoggingRequest
object
- BucketLoggingStatus required BucketLoggingStatus
PutBucketMetricsConfigurationRequest
- PutBucketMetricsConfigurationRequest
object
- MetricsConfiguration required MetricsConfiguration
PutBucketNotificationConfigurationRequest
- PutBucketNotificationConfigurationRequest
object
- NotificationConfiguration required NotificationConfiguration
PutBucketNotificationRequest
- PutBucketNotificationRequest
object
- NotificationConfiguration required NotificationConfigurationDeprecated
PutBucketPolicyRequest
- PutBucketPolicyRequest
object
- Policy required Policy
PutBucketReplicationRequest
- PutBucketReplicationRequest
object
- ReplicationConfiguration required ReplicationConfiguration
PutBucketRequestPaymentRequest
- PutBucketRequestPaymentRequest
object
- RequestPaymentConfiguration required RequestPaymentConfiguration
PutBucketTaggingRequest
- PutBucketTaggingRequest
object
- Tagging required Tagging
PutBucketVersioningRequest
- PutBucketVersioningRequest
object
- VersioningConfiguration required VersioningConfiguration
PutBucketWebsiteRequest
- PutBucketWebsiteRequest
object
- WebsiteConfiguration required WebsiteConfiguration
PutObjectAclOutput
- PutObjectAclOutput
object
PutObjectAclRequest
- PutObjectAclRequest
object
- AccessControlPolicy AccessControlPolicy
PutObjectOutput
- PutObjectOutput
object
PutObjectRequest
- PutObjectRequest
object
- Body Body
PutObjectTaggingOutput
- PutObjectTaggingOutput
object
PutObjectTaggingRequest
- PutObjectTaggingRequest
object
- Tagging required Tagging
QueueArn
- QueueArn
string
QueueConfiguration
- QueueConfiguration
object
: Container for specifying an configuration when you want Amazon S3 to publish events to an Amazon Simple Queue Service (Amazon SQS) queue.- Events required EventList
- Filter NotificationConfigurationFilter
- Id NotificationId
- QueueArn required QueueArn
QueueConfigurationDeprecated
- QueueConfigurationDeprecated
object
- Event Event
- Events EventList
- Id NotificationId
- Queue QueueArn
QueueConfigurationList
- QueueConfigurationList
array
- items QueueConfiguration
Quiet
- Quiet
boolean
QuoteCharacter
- QuoteCharacter
string
QuoteEscapeCharacter
- QuoteEscapeCharacter
string
QuoteFields
- QuoteFields
string
(values: ALWAYS, ASNEEDED)
Range
- Range
string
RecordDelimiter
- RecordDelimiter
string
Redirect
- Redirect
object
- HostName HostName
- HttpRedirectCode HttpRedirectCode
- Protocol Protocol
- ReplaceKeyPrefixWith ReplaceKeyPrefixWith
- ReplaceKeyWith ReplaceKeyWith
RedirectAllRequestsTo
ReplaceKeyPrefixWith
- ReplaceKeyPrefixWith
string
ReplaceKeyWith
- ReplaceKeyWith
string
ReplicaKmsKeyID
- ReplicaKmsKeyID
string
ReplicationConfiguration
- ReplicationConfiguration
object
: Container for replication rules. You can add as many as 1,000 rules. Total replication configuration size can be up to 2 MB.- Role required Role
- Rules required ReplicationRules
ReplicationRule
- ReplicationRule
object
: Container for information about a particular replication rule.- Destination required Destination
- ID ID
- Prefix required Prefix
- SourceSelectionCriteria SourceSelectionCriteria
- Status required ReplicationRuleStatus
ReplicationRuleStatus
- ReplicationRuleStatus
string
(values: Enabled, Disabled)
ReplicationRules
- ReplicationRules
array
- items ReplicationRule
ReplicationStatus
- ReplicationStatus
string
(values: COMPLETE, PENDING, FAILED, REPLICA)
RequestCharged
- RequestCharged
string
(values: requester): If present, indicates that the requester was successfully charged for the request.
RequestPayer
- RequestPayer
string
(values: requester): 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
RequestPaymentConfiguration
- RequestPaymentConfiguration
object
- Payer required Payer
ResponseCacheControl
- ResponseCacheControl
string
ResponseContentDisposition
- ResponseContentDisposition
string
ResponseContentEncoding
- ResponseContentEncoding
string
ResponseContentLanguage
- ResponseContentLanguage
string
ResponseContentType
- ResponseContentType
string
ResponseExpires
- ResponseExpires
string
Restore
- Restore
string
RestoreObjectOutput
- RestoreObjectOutput
object
RestoreObjectRequest
- RestoreObjectRequest
object
- RestoreRequest RestoreRequest
RestoreOutputPath
- RestoreOutputPath
string
RestoreRequest
- RestoreRequest
object
: Container for restore job parameters.- Days Days
- Description Description
- GlacierJobParameters GlacierJobParameters
- OutputLocation OutputLocation
- SelectParameters SelectParameters
- Tier Tier
- Type RestoreRequestType
RestoreRequestType
- RestoreRequestType
string
(values: SELECT)
Role
- Role
string
RoutingRule
RoutingRules
- RoutingRules
array
- items RoutingRule
Rule
- Rule
object
- AbortIncompleteMultipartUpload AbortIncompleteMultipartUpload
- Expiration LifecycleExpiration
- ID ID
- NoncurrentVersionExpiration NoncurrentVersionExpiration
- NoncurrentVersionTransition NoncurrentVersionTransition
- Prefix required Prefix
- Status required ExpirationStatus
- Transition Transition
Rules
- Rules
array
- items Rule
S3KeyFilter
- S3KeyFilter
object
: Container for object key name prefix and suffix filtering rules.- FilterRules FilterRuleList
S3Location
- S3Location
object
: Describes an S3 location that will receive the results of the restore request.- AccessControlList Grants
- BucketName required BucketName
- CannedACL ObjectCannedACL
- Encryption Encryption
- Prefix required LocationPrefix
- StorageClass StorageClass
- Tagging Tagging
- UserMetadata UserMetadata
SSECustomerAlgorithm
- SSECustomerAlgorithm
string
SSECustomerKey
- SSECustomerKey
string
SSECustomerKeyMD5
- SSECustomerKeyMD5
string
SSEKMS
- SSEKMS
object
: Specifies the use of SSE-KMS to encrypt delievered Inventory reports.- KeyId required SSEKMSKeyId
SSEKMSKeyId
- SSEKMSKeyId
string
SSES3
- SSES3
object
: Specifies the use of SSE-S3 to encrypt delievered Inventory reports.
SelectParameters
- SelectParameters
object
: Describes the parameters for Select job types.- Expression required Expression
- ExpressionType required ExpressionType
- InputSerialization required InputSerialization
- OutputSerialization required OutputSerialization
ServerSideEncryption
- ServerSideEncryption
string
(values: AES256, aws:kms)
ServerSideEncryptionByDefault
- ServerSideEncryptionByDefault
object
: Describes the default server-side encryption to apply to new objects in the bucket. If Put Object request does not specify any server-side encryption, this default encryption will be applied.- KMSMasterKeyID SSEKMSKeyId
- SSEAlgorithm required ServerSideEncryption
ServerSideEncryptionConfiguration
- ServerSideEncryptionConfiguration
object
: Container for server-side encryption configuration rules. Currently S3 supports one rule only.- Rules required ServerSideEncryptionRules
ServerSideEncryptionRule
- ServerSideEncryptionRule
object
: Container for information about a particular server-side encryption configuration rule.- ApplyServerSideEncryptionByDefault ServerSideEncryptionByDefault
ServerSideEncryptionRules
- ServerSideEncryptionRules
array
- items ServerSideEncryptionRule
Size
- Size
integer
SourceSelectionCriteria
- SourceSelectionCriteria
object
: Container for filters that define which source objects should be replicated.- SseKmsEncryptedObjects SseKmsEncryptedObjects
SseKmsEncryptedObjects
- SseKmsEncryptedObjects
object
: Container for filter information of selection of KMS Encrypted S3 objects.- Status required SseKmsEncryptedObjectsStatus
SseKmsEncryptedObjectsStatus
- SseKmsEncryptedObjectsStatus
string
(values: Enabled, Disabled)
StartAfter
- StartAfter
string
StorageClass
- StorageClass
string
(values: STANDARD, REDUCED_REDUNDANCY, STANDARD_IA)
StorageClassAnalysis
- StorageClassAnalysis
object
- DataExport StorageClassAnalysisDataExport
StorageClassAnalysisDataExport
- StorageClassAnalysisDataExport
object
- Destination required AnalyticsExportDestination
- OutputSchemaVersion required StorageClassAnalysisSchemaVersion
StorageClassAnalysisSchemaVersion
- StorageClassAnalysisSchemaVersion
string
(values: V_1)
Suffix
- Suffix
string
Tag
TagCount
- TagCount
integer
TagSet
- TagSet
array
- items Tag
Tagging
- Tagging
object
- TagSet required TagSet
TaggingDirective
- TaggingDirective
string
(values: COPY, REPLACE)
TaggingHeader
- TaggingHeader
string
TargetBucket
- TargetBucket
string
TargetGrant
- TargetGrant
object
- Grantee Grantee
- Permission BucketLogsPermission
TargetGrants
- TargetGrants
array
- items TargetGrant
TargetPrefix
- TargetPrefix
string
Tier
- Tier
string
(values: Standard, Bulk, Expedited)
Token
- Token
string
TopicArn
- TopicArn
string
TopicConfiguration
- TopicConfiguration
object
: Container for specifying the configuration when you want Amazon S3 to publish events to an Amazon Simple Notification Service (Amazon SNS) topic.- Events required EventList
- Filter NotificationConfigurationFilter
- Id NotificationId
- TopicArn required TopicArn
TopicConfigurationDeprecated
- TopicConfigurationDeprecated
object
- Event Event
- Events EventList
- Id NotificationId
- Topic TopicArn
TopicConfigurationList
- TopicConfigurationList
array
- items TopicConfiguration
Transition
- Transition
object
- Date Date
- Days Days
- StorageClass TransitionStorageClass
TransitionList
- TransitionList
array
- items Transition
TransitionStorageClass
- TransitionStorageClass
string
(values: GLACIER, STANDARD_IA)
Type
- Type
string
(values: CanonicalUser, AmazonCustomerByEmail, Group)
URI
- URI
string
UploadIdMarker
- UploadIdMarker
string
UploadPartCopyOutput
- UploadPartCopyOutput
object
- CopyPartResult CopyPartResult
UploadPartCopyRequest
- UploadPartCopyRequest
object
UploadPartOutput
- UploadPartOutput
object
UploadPartRequest
- UploadPartRequest
object
- Body Body
UserMetadata
- UserMetadata
array
- items MetadataEntry
Value
- Value
string
VersionIdMarker
- VersionIdMarker
string
VersioningConfiguration
- VersioningConfiguration
object
- MFADelete MFADelete
- Status BucketVersioningStatus
WebsiteConfiguration
- WebsiteConfiguration
object
- ErrorDocument ErrorDocument
- IndexDocument IndexDocument
- RedirectAllRequestsTo RedirectAllRequestsTo
- RoutingRules RoutingRules
WebsiteRedirectLocation
- WebsiteRedirectLocation
string