Amazon S3 API Amazon Simple Storage Service API
The Amazon Simple Storage Service API from Amazon S3 API — 48 operation(s) for amazon simple storage service.
Amazon S3 API Amazon Simple Storage Service API is one of 2 APIs that Amazon S3 API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Amazon Simple Storage Service. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.
This API exposes 96 operations across 48 paths, and defines 392 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 8 base URLs: http://s3{dash-or-dot}{region}.amazonaws.com, https://s3{dash-or-dot}{region}.amazonaws.com, http://s3.amazonaws.com, https://s3.amazonaws.com, http://s3.{region}.amazonaws.com, https://s3.{region}.amazonaws.com, http://s3.{region}.amazonaws.com.cn, https://s3.{region}.amazonaws.com.cn.
96 operations
48 paths
392 schemas
17 DELETE41 GET2 HEAD5 POST31 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Amazon S3 API Amazon Simple Storage Service API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon S3 signature
Paths & Operations 96
Across 48 paths, the API surfaces 96 operations — 17 DELETE, 41 GET, 2 HEAD, 5 POST, 31 PUT. Each is listed below with its method, path, parameters, and response codes.
Amazon Simple Storage Service 96
DELETE
/{Bucket}/{Key}#uploadId
Amazon S3 - AbortMultipartUpload
POST
/{Bucket}/{Key}#uploadId
Amazon S3 - CompleteMultipartUpload
GET
/{Bucket}/{Key}#uploadId
Amazon S3 - ListParts
PUT
/{Bucket}/{Key}#x-amz-copy-source
Amazon S3 - CopyObject
PUT
/{Bucket}
Amazon S3 - CreateBucket
DELETE
/{Bucket}
Amazon S3 - DeleteBucket
HEAD
/{Bucket}
Amazon S3 - HeadBucket
GET
/{Bucket}
Amazon S3 - ListObjects
POST
/{Bucket}/{Key}#uploads
Amazon S3 - CreateMultipartUpload
DELETE
/{Bucket}#analytics&id
Amazon S3 - DeleteBucketAnalyticsConfiguration
GET
/{Bucket}#analytics&id
Amazon S3 - GetBucketAnalyticsConfiguration
PUT
/{Bucket}#analytics&id
Amazon S3 - PutBucketAnalyticsConfiguration
DELETE
/{Bucket}#cors
Amazon S3 - DeleteBucketCors
GET
/{Bucket}#cors
Amazon S3 - GetBucketCors
PUT
/{Bucket}#cors
Amazon S3 - PutBucketCors
DELETE
/{Bucket}#encryption
Amazon S3 - DeleteBucketEncryption
GET
/{Bucket}#encryption
Amazon S3 - GetBucketEncryption
PUT
/{Bucket}#encryption
Amazon S3 - PutBucketEncryption
DELETE
/{Bucket}#intelligent-tiering&id
Amazon S3 - DeleteBucketIntelligentTieringConfiguration
GET
/{Bucket}#intelligent-tiering&id
Amazon S3 - GetBucketIntelligentTieringConfiguration
PUT
/{Bucket}#intelligent-tiering&id
Amazon S3 - PutBucketIntelligentTieringConfiguration
DELETE
/{Bucket}#inventory&id
Amazon S3 - DeleteBucketInventoryConfiguration
GET
/{Bucket}#inventory&id
Amazon S3 - GetBucketInventoryConfiguration
PUT
/{Bucket}#inventory&id
Amazon S3 - PutBucketInventoryConfiguration
DELETE
/{Bucket}#lifecycle
Amazon S3 - DeleteBucketLifecycle
GET
/{Bucket}#lifecycle
Amazon S3 - GetBucketLifecycleConfiguration
PUT
/{Bucket}#lifecycle
Amazon S3 - PutBucketLifecycleConfiguration
DELETE
/{Bucket}#metrics&id
Amazon S3 - DeleteBucketMetricsConfiguration
GET
/{Bucket}#metrics&id
Amazon S3 - GetBucketMetricsConfiguration
PUT
/{Bucket}#metrics&id
Amazon S3 - PutBucketMetricsConfiguration
DELETE
/{Bucket}#ownershipControls
Amazon S3 - DeleteBucketOwnershipControls
GET
/{Bucket}#ownershipControls
Amazon S3 - GetBucketOwnershipControls
PUT
/{Bucket}#ownershipControls
Amazon S3 - PutBucketOwnershipControls
DELETE
/{Bucket}#policy
Amazon S3 - DeleteBucketPolicy
GET
/{Bucket}#policy
Amazon S3 - GetBucketPolicy
PUT
/{Bucket}#policy
Amazon S3 - PutBucketPolicy
DELETE
/{Bucket}#replication
Amazon S3 - DeleteBucketReplication
GET
/{Bucket}#replication
Amazon S3 - GetBucketReplication
PUT
/{Bucket}#replication
Amazon S3 - PutBucketReplication
DELETE
/{Bucket}#tagging
Amazon S3 - DeleteBucketTagging
GET
/{Bucket}#tagging
Amazon S3 - GetBucketTagging
PUT
/{Bucket}#tagging
Amazon S3 - PutBucketTagging
DELETE
/{Bucket}#website
Amazon S3 - DeleteBucketWebsite
GET
/{Bucket}#website
Amazon S3 - GetBucketWebsite
PUT
/{Bucket}#website
Amazon S3 - PutBucketWebsite
DELETE
/{Bucket}/{Key}
Amazon S3 - DeleteObject
GET
/{Bucket}/{Key}
Amazon S3 - GetObject
HEAD
/{Bucket}/{Key}
Amazon S3 - HeadObject
PUT
/{Bucket}/{Key}
Amazon S3 - PutObject
DELETE
/{Bucket}/{Key}#tagging
Amazon S3 - DeleteObjectTagging
GET
/{Bucket}/{Key}#tagging
Amazon S3 - GetObjectTagging
PUT
/{Bucket}/{Key}#tagging
Amazon S3 - PutObjectTagging
POST
/{Bucket}#delete
Amazon S3 - DeleteObjects
DELETE
/{Bucket}#publicAccessBlock
Amazon S3 - DeletePublicAccessBlock
GET
/{Bucket}#publicAccessBlock
Amazon S3 - GetPublicAccessBlock
PUT
/{Bucket}#publicAccessBlock
Amazon S3 - PutPublicAccessBlock
GET
/{Bucket}#accelerate
Amazon S3 - GetBucketAccelerateConfiguration
PUT
/{Bucket}#accelerate
Amazon S3 - PutBucketAccelerateConfiguration
GET
/{Bucket}#acl
Amazon S3 - GetBucketAcl
PUT
/{Bucket}#acl
Amazon S3 - PutBucketAcl
GET
/{Bucket}#lifecycle&deprecated!deprecated
Amazon S3 - GetBucketLifecycle
PUT
/{Bucket}#lifecycle&deprecated!deprecated
Amazon S3 - PutBucketLifecycle
GET
/{Bucket}#location
Amazon S3 - GetBucketLocation
GET
/{Bucket}#logging
Amazon S3 - GetBucketLogging
PUT
/{Bucket}#logging
Amazon S3 - PutBucketLogging
GET
/{Bucket}#notification
Amazon S3 - GetBucketNotificationConfiguration
PUT
/{Bucket}#notification
Amazon S3 - PutBucketNotificationConfiguration
GET
/{Bucket}#notification&deprecated!deprecated
Amazon S3 - GetBucketNotification
PUT
/{Bucket}#notification&deprecated!deprecated
Amazon S3 - PutBucketNotification
GET
/{Bucket}#policyStatus
Amazon S3 - GetBucketPolicyStatus
GET
/{Bucket}#requestPayment
Amazon S3 - GetBucketRequestPayment
PUT
/{Bucket}#requestPayment
Amazon S3 - PutBucketRequestPayment
GET
/{Bucket}#versioning
Amazon S3 - GetBucketVersioning
PUT
/{Bucket}#versioning
Amazon S3 - PutBucketVersioning
GET
/{Bucket}/{Key}#acl
Amazon S3 - GetObjectAcl
PUT
/{Bucket}/{Key}#acl
Amazon S3 - PutObjectAcl
GET
/{Bucket}/{Key}#attributes&x-amz-object-attributes
Amazon S3 - GetObjectAttributes
GET
/{Bucket}/{Key}#legal-hold
Amazon S3 - GetObjectLegalHold
PUT
/{Bucket}/{Key}#legal-hold
Amazon S3 - PutObjectLegalHold
GET
/{Bucket}#object-lock
Amazon S3 - GetObjectLockConfiguration
PUT
/{Bucket}#object-lock
Amazon S3 - PutObjectLockConfiguration
GET
/{Bucket}/{Key}#retention
Amazon S3 - GetObjectRetention
PUT
/{Bucket}/{Key}#retention
Amazon S3 - PutObjectRetention
GET
/{Bucket}/{Key}#torrent
Amazon S3 - GetObjectTorrent
GET
/{Bucket}#analytics
Amazon S3 - ListBucketAnalyticsConfigurations
GET
/{Bucket}#intelligent-tiering
Amazon S3 - ListBucketIntelligentTieringConfigurations
GET
/{Bucket}#inventory
Amazon S3 - ListBucketInventoryConfigurations
GET
/{Bucket}#metrics
Amazon S3 - ListBucketMetricsConfigurations
GET
/
Amazon S3 - ListBuckets
GET
/{Bucket}#uploads
Amazon S3 - ListMultipartUploads
GET
/{Bucket}#versions
Amazon S3 - ListObjectVersions
GET
/{Bucket}#list-type=2
Amazon S3 - ListObjectsV2
POST
/{Bucket}/{Key}#restore
Amazon S3 - RestoreObject
POST
/{Bucket}/{Key}#select&select-type=2
Amazon S3 - SelectObjectContent
PUT
/{Bucket}/{Key}#partNumber&uploadId
Amazon S3 - UploadPart
PUT
/{Bucket}/{Key}#x-amz-copy-source&partNumber&uploadId
Amazon S3 - UploadPartCopy
Schemas 392
The contract defines 392 schemas that model the data the API accepts and returns. The most detailed are ListObjectVersionsOutput (13 properties), ListPartsOutput (12 properties), ListMultipartUploadsOutput (12 properties), ListObjectsV2Output (12 properties). Each schema is shown below with its type and property counts.
GetObjectTaggingOutput
object
1 property
1 required
NotificationConfigurationDeprecated
object
3 properties
OwnerOverride
string
SSEKMSKeyId
string
StorageClassAnalysisSchemaVersion
string
PutObjectLockConfigurationOutput
object
AllowedHeader
string
RoutingRules
array
PartNumber
integer
OutputSerialization
object
Describes how results of the Select job are serialized.
2 properties
InventoryConfigurationList
array
InventoryFormat
string
TagSet
array
RestoreRequestType
string
CopyObjectResult
object
Container for all response elements.
6 properties
ReplaceKeyWith
string
ReplicationRuleAndOperator
object
A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify mo…
2 properties
DefaultRetention
object
The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket. The DefaultRetention settings r…
3 properties
TieringList
array
PartsCount
integer
Condition
object
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, redir…
2 properties
TransitionStorageClass
string
Encryption
object
Contains the type of server-side encryption used.
3 properties
1 required
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.
5 properties
NoSuchKey
AllowedHeaders
array
MultipartUploadList
array
SelectObjectContentEventStream
object
The container for selecting objects from a content event stream.
5 properties
InventoryOptionalFields
array
Delimiter
string
InventoryOptionalField
string
ServerSideEncryption
string
S3Location
object
Describes an Amazon S3 location that will receive the results of the restore request.
8 properties
2 required
Role
string
Priority
integer
GetBucketVersioningOutput
object
2 properties
Message
string
BucketAccelerateStatus
string
CreateMultipartUploadOutput
object
3 properties
PolicyStatus
object
The container element for a bucket's policy status.
1 property
HttpRedirectCode
string
ListPartsOutput
object
12 properties
ObjectAlreadyInActiveTierError
GetBucketIntelligentTieringConfigurationOutput
object
1 property
CORSRule
object
Specifies a cross-origin access rule for an Amazon S3 bucket.
6 properties
2 required
ReplicationConfiguration
object
A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.
2 properties
2 required
NextToken
string
ObjectLockRule
object
The container element for an Object Lock rule.
1 property
ObjectLockLegalHold
object
A legal hold configuration for an object.
1 property
EventList
array
GlacierJobParameters
object
Container for S3 Glacier job parameters.
1 property
1 required
MaxAgeSeconds
integer
ObjectNotInActiveTierError
QuoteFields
string
DeleteObjectTaggingOutput
object
Policy
string
UploadIdMarker
string
ChecksumAlgorithmList
array
ObjectOwnership
string
The container element for object ownership for a bucket's ownership controls. BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the buc…
DeleteObjectOutput
object
FilterRule
object
Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.
2 properties
ExistingObjectReplication
object
Optional configuration to replicate existing source bucket objects. For more information, see Replicating Existing Objects in the Amazon S3 User Guide .
1 property
1 required
ObjectVersion
object
The version of an object.
9 properties
DeletedObjects
array
StartAfter
string
ServerSideEncryptionRule
object
Specifies the default server-side encryption configuration.
2 properties
IntelligentTieringAccessTier
string
ProgressEvent
object
This data type contains information about the progress event of an operation.
1 property
Token
string
UserMetadata
array
DeleteMarkerReplication
object
Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplicati…
1 property
EmailAddress
string
ReplicaModifications
object
A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn't replicate replica modifications by default. In the latest version…
1 property
1 required
Checksum
object
Contains all the possible checksum or digest values for an object.
4 properties
ServerSideEncryptionByDefault
object
Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this de…
2 properties
1 required
InventoryFrequency
string
DisplayName
string
NextVersionIdMarker
string
Object
object
An object consists of data and its descriptive metadata.
7 properties
Minutes
integer
KMSContext
string
Redirect
object
Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.
5 properties
MultipartUploadId
string
Error
object
Container for all error elements.
4 properties
BucketLogsPermission
string
GetBucketLifecycleConfigurationOutput
object
1 property
KeyPrefixEquals
string
Rules
array
IsPublic
boolean
ChecksumCRC32C
string
DeleteMarker
boolean
ObjectLockRetention
object
A Retention configuration for an object.
2 properties
NotificationConfiguration
object
A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.
4 properties
CloudFunctionInvocationRole
string
LambdaFunctionConfigurationList
array
GetBucketWebsiteOutput
object
4 properties
PutObjectLegalHoldOutput
object
HostName
string
MaxKeys
integer
MultipartUpload
object
Container for the MultipartUpload for the Amazon S3 object.
7 properties
GetBucketAccelerateConfigurationOutput
object
1 property
LastModified
string
JSONOutput
object
Specifies JSON as request's output serialization format.
1 property
GetBucketPolicyStatusOutput
object
1 property
NextPartNumberMarker
integer
ReplicationRules
array
Grant
object
Container for grant information.
2 properties
GetBucketEncryptionOutput
object
1 property
StatsEvent
object
Container for the Stats Event.
1 property
NotificationConfigurationFilter
object
Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon S3 User Guide .
1 property
OwnershipControlsRule
object
The container element for an ownership control rule.
1 property
1 required
ObjectLockConfiguration
object
The container element for Object Lock configuration parameters.
2 properties
ObjectSize
integer
BucketKeyEnabled
boolean
ChecksumCRC32
string
InventorySchedule
object
Specifies the schedule for generating inventory results.
1 property
1 required
IndexDocument
object
Container for the Suffix element.
1 property
1 required
DeleteMarkers
array
GetBucketAnalyticsConfigurationOutput
object
1 property
UploadPartCopyOutput
object
1 property
HeadObjectOutput
object
1 property
Initiated
string
Days
integer
StorageClass
string
MetricsConfigurationList
array
ReplicationTimeValue
object
A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold .
1 property
ReplicationTime
object
A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operatio…
2 properties
2 required
FilterRuleValue
string
Permission
string
Metrics
object
A container specifying replication metrics-related settings enabling replication metrics and events.
2 properties
1 required
GetBucketPolicyOutput
object
1 property
InventoryDestination
object
Specifies the inventory configuration for an Amazon S3 bucket.
1 property
1 required
RoutingRule
object
Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see Configuring advanced conditional redirects in the…
2 properties
1 required
ExpressionType
string
GetBucketLoggingOutput
object
1 property
PartNumberMarker
integer
Years
integer
LifecycleExpiration
object
Container for the expiration for the lifecycle of the object.
3 properties
Location
string
CreateBucketOutput
object
VersionIdMarker
string
ReplicaKmsKeyID
string
SseKmsEncryptedObjects
object
A container for filter information for the selection of S3 objects encrypted with Amazon Web Services KMS.
1 property
1 required
ObjectLockLegalHoldStatus
string
CopyPartResult
object
Container for all response elements.
6 properties
MaxParts
integer
IntelligentTieringStatus
string
QuoteEscapeCharacter
string
GetObjectAttributesParts
object
A collection of parts associated with a multipart upload.
6 properties
Expression
string
UploadPartOutput
object
AnalyticsExportDestination
object
Where to publish the analytics results.
1 property
1 required
InventoryS3BucketDestination
object
Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.
5 properties
2 required
Part
object
Container for elements related to a part.
8 properties
LifecycleRule
object
A lifecycle rule for individual objects in an Amazon S3 bucket.
9 properties
1 required
NextKeyMarker
string
BucketAlreadyExists
Tiering
object
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, wit…
2 properties
2 required
ServerSideEncryptionRules
array
SSES3
object
Specifies the use of SSE-S3 to encrypt delivered inventory reports.
Code
string
GetObjectLegalHoldOutput
object
1 property
AnalyticsAndOperator
object
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and…
2 properties
ExposeHeader
string
MFADeleteStatus
string
TopicConfiguration
object
A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects spe…
4 properties
2 required
InventoryEncryption
object
Contains the type of server-side encryption used to encrypt the inventory results.
2 properties
GetBucketLifecycleOutput
object
1 property
ListBucketMetricsConfigurationsOutput
object
4 properties
GetObjectOutput
object
2 properties
CSVOutput
object
Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.
5 properties
Initiator
object
Container element that identifies who initiated the multipart upload.
2 properties
RedirectAllRequestsTo
object
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
2 properties
1 required
ChecksumAlgorithm
string
FilterRuleList
array
A list of containers for the key-value pair that defines the criteria for the filter rule.
BucketAlreadyOwnedByYou
Tag
object
A container of a key value name pair.
2 properties
2 required
QuoteCharacter
string
AbortMultipartUploadOutput
object
Event
string
The bucket event for which to send notifications.
AbortIncompleteMultipartUpload
object
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For mor…
1 property
TargetGrants
array
EncodingType
string
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…
Protocol
string
RecordDelimiter
string
Destination
object
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
7 properties
1 required
IntelligentTieringConfiguration
object
Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket. For information about the S3 Intelligent-Tiering storage class, see Storage class f…
4 properties
3 required
MFADelete
string
AnalyticsS3BucketDestination
object
Contains information about where to publish the analytics results.
4 properties
2 required
JSONType
string
EnableRequestProgress
boolean
Quiet
boolean
QueueConfigurationList
array
AccessControlTranslation
object
A container for information about access control for replicas.
1 property
1 required
ListBucketInventoryConfigurationsOutput
object
4 properties
Tier
string
BytesScanned
integer
CommonPrefix
object
Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act lik…
1 property
NoSuchBucket
ObjectSizeGreaterThanBytes
integer
DeleteMarkerEntry
object
Information about the delete marker.
5 properties
ObjectLockEnabled
string
GetBucketReplicationOutput
object
1 property
NextUploadIdMarker
string
AnalyticsConfiguration
object
Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
3 properties
2 required
MetricsId
string
TopicConfigurationDeprecated
object
A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects spe…
4 properties
GetObjectLockConfigurationOutput
object
1 property
ObjectAttributes
string
AllowedOrigins
array
Suffix
string
Description
string
Value
string
Body
string
QueueArn
string
Metadata
object
OwnershipControls
object
The container element for a bucket's ownership controls.
1 property
1 required
Grants
array
InventoryIncludedObjectVersions
string
StorageClassAnalysisDataExport
object
Container for data related to the storage class analysis for an Amazon S3 bucket for export.
2 properties
2 required
Comments
string
ChecksumSHA1
string
NoncurrentVersionExpiration
object
Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configu…
2 properties
ContinuationEvent
object
ObjectVersionStorageClass
string
ReplicaModificationsStatus
string
ChecksumSHA256
string
StorageClassAnalysis
object
Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.
1 property
Start
integer
CopyObjectOutput
object
1 property
ListObjectsOutput
object
10 properties
InventoryId
string
ExpirationStatus
string
ServerSideEncryptionConfiguration
object
Specifies the default server-side-encryption configuration.
1 property
1 required
AllowedOrigin
string
TargetPrefix
string
EndEvent
object
A message that indicates the request is complete and no more messages will be sent. You should not assume that the request is complete until the client receive…
Setting
boolean
IsTruncated
boolean
Transition
object
Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Object…
3 properties
ListBucketIntelligentTieringConfigurationsOutput
object
4 properties
CompleteMultipartUploadOutput
object
8 properties
Marker
string
TopicConfigurationList
array
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 predi…
4 properties
NoSuchUpload
ReplicationTimeStatus
string
RestoreObjectOutput
object
ReplicationRule
object
Specifies which Amazon S3 objects to replicate and where to store the replicas.
9 properties
2 required
PartsList
array
Bucket
object
In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally unique, and the namespace is shared by all Amazon Web Services account…
2 properties
Date
string
Parts
array
NoncurrentVersionTransitionList
array
PutObjectRetentionOutput
object
GetObjectAclOutput
object
2 properties
SelectParameters
object
Describes the parameters for Select job types.
4 properties
4 required
ObjectStorageClass
string
BytesProcessed
integer
MaxUploads
integer
IntelligentTieringId
string
IntelligentTieringFilter
object
The Filter is used to identify objects that the S3 Intelligent-Tiering configuration applies to.
3 properties
IsEnabled
boolean
NextMarker
string
TransitionList
array
SSEKMS
object
Specifies the use of SSE-KMS to encrypt delivered inventory reports.
1 property
1 required
GetBucketAclOutput
object
2 properties
URI
string
LambdaFunctionConfiguration
object
A container for specifying the configuration for Lambda notifications.
4 properties
2 required
ListObjectsV2Output
object
12 properties
ObjectIdentifier
object
Object Identifier is unique value to identify objects.
2 properties
1 required
CORSRules
array
Progress
object
This data type contains information about progress of an operation.
3 properties
GetObjectRetentionOutput
object
1 property
GetObjectTorrentOutput
object
1 property
DeleteMarkerReplicationStatus
string
ListMultipartUploadsOutput
object
12 properties
AllowedMethod
string
NotificationId
string
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
ID
string
VersionCount
integer
Owner
object
Container for the owner's display name and ID.
2 properties
LocationPrefix
string
GetBucketTaggingOutput
object
1 property
1 required
CommonPrefixList
array
ObjectKey
string
GetPublicAccessBlockOutput
object
1 property
AnalyticsFilter
object
The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no fil…
3 properties
FieldDelimiter
string
LambdaFunctionArn
string
InputSerialization
object
Describes the serialization format of the object.
4 properties
EncryptionConfiguration
object
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
1 property
AccessPointArn
string
Tagging
object
Container for TagSet elements.
1 property
1 required
ObjectSizeLessThanBytes
integer
ObjectPart
object
A container for elements related to an individual part.
6 properties
BucketName
string
MetadataEntry
object
A metadata key-value pair to store with an object.
2 properties
KeyCount
integer
BytesReturned
integer
MetadataKey
string
AnalyticsConfigurationList
array
DeleteObjectsOutput
object
2 properties
PutObjectAclOutput
object
ExistingObjectReplicationStatus
string
AnalyticsS3ExportFileFormat
string
PutObjectOutput
object
BucketLocationConstraint
string
End
integer
AllowedMethods
array
SourceSelectionCriteria
object
A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replicatio…
2 properties
ObjectList
array
CloudFunctionConfiguration
object
Container for specifying the Lambda notification configuration.
5 properties
ObjectLockRetentionMode
string
OwnershipControlsRules
array
GetBucketOwnershipControlsOutput
object
1 property
DeleteMarkerVersionId
string
ExposeHeaders
array
Prefix
string
InventoryConfiguration
object
Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference .
7 properties
5 required
ErrorDocument
object
The error information.
1 property
1 required
Payer
string
Rule
object
Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration in the Amazon S3 API Reference . For examples,…
8 properties
2 required
GetBucketInventoryConfigurationOutput
object
1 property
ObjectVersionList
array
IsLatest
boolean
EventBridgeConfiguration
object
A container for specifying the configuration for Amazon EventBridge.
SseKmsEncryptedObjectsStatus
string
ObjectVersionId
string
Grantee
object
Container for the person being granted permissions.
5 properties
1 required
KeyMarker
string
CSVInput
object
Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.
7 properties
DaysAfterInitiation
integer
GetObjectAttributesOutput
object
5 properties
ObjectIdentifierList
array
MetadataValue
string
CreationDate
string
AccountId
string
LoggingEnabled
object
Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the…
3 properties
2 required
ExpiredObjectDeleteMarker
boolean
Stats
object
Container for the stats details.
3 properties
GetBucketLocationOutput
object
1 property
Buckets
array
BucketVersioningStatus
string
Type
string
TargetBucket
string
CompressionType
string
PublicAccessBlockConfiguration
object
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more info…
4 properties
IntelligentTieringConfigurationList
array
S3KeyFilter
object
A container for object key name prefix and suffix filtering rules.
1 property
JSONInput
object
Specifies JSON as object's input serialization format.
1 property
PutObjectTaggingOutput
object
GetBucketRequestPaymentOutput
object
1 property
ETag
string
MetricsStatus
string
ListObjectVersionsOutput
object
13 properties
GetBucketCorsOutput
object
1 property
OutputLocation
object
Describes the location where the restore job's output is stored.
1 property
QueueConfiguration
object
Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
4 properties
2 required
FileHeaderInfo
string
MetricsConfiguration
object
Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating a…
2 properties
1 required
ObjectCannedACL
string
ParquetInput
object
Container for Parquet.
MetricsFilter
object
Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object…
4 properties
ReplicationRuleFilter
object
A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix , Tag , or an And child element.
3 properties
InventoryFilter
object
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.
1 property
1 required
CompletedPart
object
Details of the parts that were uploaded.
6 properties
DeletedObject
object
Information about the deleted object.
4 properties
ReplaceKeyPrefixWith
string
AllowQuotedRecordDelimiter
boolean
MetricsAndOperator
object
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must mat…
3 properties
InvalidObjectState
FilterRuleName
string
TopicArn
string
TargetGrant
object
Container for granting information. Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information,…
2 properties
ListBucketAnalyticsConfigurationsOutput
object
4 properties
IntelligentTieringDays
integer
GetBucketMetricsConfigurationOutput
object
1 property
ListBucketsOutput
object
2 properties
IntelligentTieringAndOperator
object
A container for specifying S3 Intelligent-Tiering filters. The filters determine the subset of objects to which the rule applies.
2 properties
NoncurrentVersionTransition
object
Container for the transition rule that describes when noncurrent objects transition to the STANDARDIA , ONEZONEIA , INTELLIGENTTIERING , GLACIERIR , GLACIER ,…
3 properties
RecordsEvent
object
The container for the records event.
1 property
LifecycleRules
array
ReplicationRuleStatus
string
Errors
array
Size
integer
HttpErrorCodeReturnedEquals
string
CompletedPartList
array
CloudFunction
string
SelectObjectContentOutput
object
1 property
AnalyticsId
string
QueueConfigurationDeprecated
object
This data type is deprecated. Use QueueConfiguration for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Sim…
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Amazon S3 API 1
Other APIs Amazon S3 API publishes across the network.
Amazon S3 API WriteGetObjectResponse#x Amz Request Route&x Amz Request Token API
#Amazon Simple Storage Service
Where this information came from
This is an independent, third-party profile of Amazon S3 API Amazon Simple Storage Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.