Amazon Simple Storage Service
License: Apache 2.0 License
Resources
Returns a list of all buckets owned by the authenticated sender of the request.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html
Request
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListBucketsOutput
|
object |
Properties
Owner
|
Owner | ||||||||||||||||||
|
|
|||||||||||||||||||
Buckets
|
Buckets | ||||||||||||||||||
|
|||||||||||||||||||
Examples
{
"Buckets": [
{
"CreationDate": "2012-02-15T21: 03: 02.000Z",
"Name": "examplebucket"
},
{
"CreationDate": "2011-07-24T19: 33: 50.000Z",
"Name": "examplebucket2"
},
{
"CreationDate": "2010-12-17T00: 56: 49.000Z",
"Name": "examplebucket3"
}
],
"Owner": {
"DisplayName": "own-display-name",
"ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31"
}
}Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
analytics
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBucketAnalyticsConfigurationRequest
|
object |
Responses
Deletes the CORS configuration information set for the bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
cors
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBucketCorsRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBucketRequest
|
object |
Examples
{
"Bucket": "forrandall2"
}Responses
Deletes the server-side encryption configuration from the bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
encryption
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBucketEncryptionRequest
|
object |
Responses
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
inventory
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBucketInventoryConfigurationRequest
|
object |
Responses
Deletes the lifecycle configuration from the bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
lifecycle
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBucketLifecycleRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
metrics
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBucketMetricsConfigurationRequest
|
object |
Responses
Deletes the policy from the bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
policy
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBucketPolicyRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Deletes the replication configuration from the bucket. For information about replication configuration, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
replication
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBucketReplicationRequest
|
object |
Examples
{
"Bucket": "example"
}Responses
Deletes the tags from the bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
tagging
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBucketTaggingRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
This operation removes the website configuration from the bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
website
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBucketWebsiteRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.
http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
delete
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteObjectsRequest
|
object |
Properties
Delete
|
Delete | |||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
Examples
{
"Bucket": "examplebucket",
"Delete": {
"Objects": [
{
"Key": "HappyFace.jpg",
"VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
},
{
"Key": "HappyFace.jpg",
"VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
}
],
"Quiet": false
}
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteObjectsOutput
|
object |
Properties
Errors
|
Errors | ||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Deleted
|
DeletedObjects | ||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Examples
{
"Deleted": [
{
"Key": "HappyFace.jpg",
"VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
},
{
"Key": "HappyFace.jpg",
"VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
}
]
}Removes the PublicAccessBlock configuration from an Amazon S3 bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
publicAccessBlock
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeletePublicAccessBlockRequest
|
object |
Responses
Returns the accelerate configuration of a bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
accelerate
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketAccelerateConfigurationRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketAccelerateConfigurationOutput
|
object |
Properties
Status
|
BucketAccelerateStatus |
The accelerate configuration of the bucket. |
||||
|
||||||
Gets the access control policy for the bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
acl
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketAclRequest
|
object |
Gets an analytics configuration for the bucket (specified by the analytics configuration ID).
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
analytics
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketAnalyticsConfigurationRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketAnalyticsConfigurationOutput
|
object |
Properties
AnalyticsConfiguration
|
AnalyticsConfiguration |
The configuration and any analyses for the analytics filter. |
||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
Returns the CORS configuration for the bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
cors
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketCorsRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketCorsOutput
|
object |
Properties
CORSRules
|
CORSRules | |||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Examples
{
"CORSRules": [
{
"AllowedHeaders": [
"Authorization"
],
"AllowedMethods": [
"GET"
],
"AllowedOrigins": [
"*"
],
"MaxAgeSeconds": 3000
}
]
}Returns the server-side encryption configuration of a bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
encryption
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketEncryptionRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketEncryptionOutput
|
object |
Properties
ServerSideEncryptionConfiguration
|
ServerSideEncryptionConfiguration | |||||||||||||||
Properties
|
||||||||||||||||
Returns an inventory configuration (identified by the inventory ID) from the bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
inventory
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketInventoryConfigurationRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketInventoryConfigurationOutput
|
object |
Properties
InventoryConfiguration
|
InventoryConfiguration |
Specifies the inventory configuration. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns the lifecycle configuration information set on the bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
lifecycle
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketLifecycleConfigurationRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketLifecycleConfigurationOutput
|
object |
Properties
Rules
|
LifecycleRules | |||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
Examples
{
"Rules": [
{
"ID": "Rule for TaxDocs\/",
"Prefix": "TaxDocs",
"Status": "Enabled",
"Transitions": [
{
"Days": 365,
"StorageClass": "STANDARD_IA"
}
]
}
]
}Deprecated, see the GetBucketLifecycleConfiguration operation.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
lifecycle
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketLifecycleRequest
|
object |
Examples
{
"Bucket": "acl1"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketLifecycleOutput
|
object |
Properties
Rules
|
Rules | ||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
Examples
{
"Rules": [
{
"Expiration": {
"Days": 1
},
"ID": "delete logs",
"Prefix": "123\/",
"Status": "Enabled"
}
]
}Returns the region the bucket resides in.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
location
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketLocationRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketLocationOutput
|
object |
Properties
LocationConstraint
|
BucketLocationConstraint | |||||
|
||||||
Examples
{
"LocationConstraint": "us-west-2"
}Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
logging
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketLoggingRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketLoggingOutput
|
object |
Properties
LoggingEnabled
|
LoggingEnabled | |||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
metrics
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketMetricsConfigurationRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketMetricsConfigurationOutput
|
object |
Properties
MetricsConfiguration
|
MetricsConfiguration |
Specifies the metrics configuration. |
|||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||
Returns the notification configuration of a bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
notification
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketNotificationConfigurationRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
NotificationConfiguration
|
object |
A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket. |
Properties
LambdaFunctionConfigurations
|
LambdaFunctionConfigurationList | ||||||||||||||||||||||||
|
|||||||||||||||||||||||||
QueueConfigurations
|
QueueConfigurationList | ||||||||||||||||||||||||
|
|||||||||||||||||||||||||
TopicConfigurations
|
TopicConfigurationList | ||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Deprecated, see the GetBucketNotificationConfiguration operation.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
notification
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketNotificationConfigurationRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
NotificationConfigurationDeprecated
|
object |
Properties
CloudFunctionConfiguration
|
CloudFunctionConfiguration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QueueConfiguration
|
QueueConfigurationDeprecated | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TopicConfiguration
|
TopicConfigurationDeprecated | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"QueueConfiguration": {
"Event": "s3:ObjectCreated:Put",
"Events": [
"s3:ObjectCreated:Put"
],
"Id": "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx",
"Queue": "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue"
},
"TopicConfiguration": {
"Event": "s3:ObjectCreated:Copy",
"Events": [
"s3:ObjectCreated:Copy"
],
"Id": "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi",
"Topic": "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic"
}
}Returns the policy of a specified bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
policy
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketPolicyRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketPolicyOutput
|
object |
Properties
Policy
|
Policy |
The bucket policy as a JSON document. |
||||
|
||||||
Examples
{
"Policy": "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1\/*\",\"arn:aws:s3:::policytest1\"]}]}"
}Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
policyStatus
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketPolicyStatusRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketPolicyStatusOutput
|
object |
Properties
PolicyStatus
|
PolicyStatus |
The policy status for the specified bucket. |
||||||||||||||
Properties
|
||||||||||||||||
Returns the replication configuration of a bucket.
It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
replication
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketReplicationRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketReplicationOutput
|
object |
Properties
ReplicationConfiguration
|
ReplicationConfiguration | |||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
Examples
{
"ReplicationConfiguration": {
"Role": "arn:aws:iam::acct-id:role\/example-role",
"Rules": [
{
"Destination": {
"Bucket": "arn:aws:s3:::destination-bucket"
},
"ID": "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy",
"Prefix": "Tax",
"Status": "Enabled"
}
]
}
}Returns the request payment configuration of a bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
requestPayment
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketRequestPaymentRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketRequestPaymentOutput
|
object |
Properties
Payer
|
Payer |
Specifies who pays for the download and request fees. |
||||
|
||||||
Examples
{
"Payer": "BucketOwner"
}Returns the tag set associated with the bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
tagging
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketTaggingRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Returns the versioning state of a bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
versioning
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketVersioningRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketVersioningOutput
|
object |
Properties
MFADelete
|
MFADeleteStatus |
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. |
||||
|
||||||
Status
|
BucketVersioningStatus |
The versioning state of the bucket. |
||||
|
||||||
Examples
{
"MFADelete": "Disabled",
"Status": "Enabled"
}Returns the website configuration for a bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
website
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketWebsiteRequest
|
object |
Examples
{
"Bucket": "examplebucket"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetBucketWebsiteOutput
|
object |
Properties
RoutingRules
|
RoutingRules | |||||||||||||||||||||||||
|
||||||||||||||||||||||||||
ErrorDocument
|
ErrorDocument | |||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
IndexDocument
|
IndexDocument | |||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
RedirectAllRequestsTo
|
RedirectAllRequestsTo | |||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
Examples
{
"ErrorDocument": {
"Key": "error.html"
},
"IndexDocument": {
"Suffix": "index.html"
}
}Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
object-lock
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetObjectLockConfigurationRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetObjectLockConfigurationOutput
|
object |
Properties
ObjectLockConfiguration
|
ObjectLockConfiguration |
The specified bucket's Object Lock configuration. |
|||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||
Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
publicAccessBlock
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetPublicAccessBlockRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetPublicAccessBlockOutput
|
object |
Properties
PublicAccessBlockConfiguration
|
PublicAccessBlockConfiguration |
The |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
This operation is useful to determine if a bucket exists and you have permission to access it.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketHEAD.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
HeadBucketRequest
|
object |
Examples
{
"Bucket": "acl1"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
NoSuchBucket
|
Lists the analytics configurations for the bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
analytics
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListBucketAnalyticsConfigurationsRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListBucketAnalyticsConfigurationsOutput
|
object |
Properties
AnalyticsConfigurationList
|
AnalyticsConfigurationList |
The list of analytics configurations for a bucket. |
||||||||||||||||||||
|
||||||||||||||||||||||
NextContinuationToken
|
NextToken |
NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. |
||||||||||||||||||||
|
||||||||||||||||||||||
ContinuationToken
|
Token |
The ContinuationToken that represents where this request began. |
||||||||||||||||||||
|
||||||||||||||||||||||
IsTruncated
|
IsTruncated |
Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. |
||||||||||||||||||||
|
||||||||||||||||||||||
Returns a list of inventory configurations for the bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
inventory
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListBucketInventoryConfigurationsRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListBucketInventoryConfigurationsOutput
|
object |
Properties
NextContinuationToken
|
NextToken |
The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
IsTruncated
|
IsTruncated |
Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
InventoryConfigurationList
|
InventoryConfigurationList |
The list of inventory configurations for a bucket. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
ContinuationToken
|
Token |
If sent in the request, the marker that is used as a starting point for this inventory configuration list response. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
Lists the metrics configurations for the bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
metrics
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListBucketMetricsConfigurationsRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListBucketMetricsConfigurationsOutput
|
object |
Properties
MetricsConfigurationList
|
MetricsConfigurationList |
The list of metrics configurations for a bucket. |
|||||||||||||||||
|
|||||||||||||||||||
NextContinuationToken
|
NextToken |
The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. |
|||||||||||||||||
|
|||||||||||||||||||
ContinuationToken
|
Token |
The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request. |
|||||||||||||||||
|
|||||||||||||||||||
IsTruncated
|
IsTruncated |
Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. |
|||||||||||||||||
|
|||||||||||||||||||
This operation lists in-progress multipart uploads.
http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
MaxUploads
|
string |
Pagination limit |
KeyMarker
|
string |
Pagination token |
UploadIdMarker
|
string |
Pagination token |
uploads
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListMultipartUploadsRequest
|
object |
Examples
{
"Bucket": "examplebucket",
"KeyMarker": "nextkeyfrompreviousresponse",
"MaxUploads": "2",
"UploadIdMarker": "valuefrompreviousresponse"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListMultipartUploadsOutput
|
object |
Properties
EncodingType
|
EncodingType |
Encoding type used by Amazon S3 to encode object keys in the response. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
CommonPrefixes
|
CommonPrefixList | ||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Uploads
|
MultipartUploadList | ||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
IsTruncated
|
IsTruncated |
Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
MaxUploads
|
MaxUploads |
Maximum number of multipart uploads that could have been included in the response. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
NextUploadIdMarker
|
NextUploadIdMarker |
When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Delimiter
|
Delimiter | ||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Prefix
|
Prefix |
When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
NextKeyMarker
|
NextKeyMarker |
When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
UploadIdMarker
|
UploadIdMarker |
Upload ID after which listing began. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
KeyMarker
|
KeyMarker |
The key at or after which the listing began. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Bucket
|
BucketName |
Name of the bucket to which the multipart upload was initiated. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Examples
{
"Bucket": "acl1",
"IsTruncated": true,
"KeyMarker": "",
"MaxUploads": "2",
"NextKeyMarker": "someobjectkey",
"NextUploadIdMarker": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
"UploadIdMarker": "",
"Uploads": [
{
"Initiated": "2014-05-01T05:40:58.000Z",
"Initiator": {
"DisplayName": "ownder-display-name",
"ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
},
"Key": "JavaFile",
"Owner": {
"DisplayName": "mohanataws",
"ID": "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
},
"StorageClass": "STANDARD",
"UploadId": "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--"
},
{
"Initiated": "2014-05-01T05:41:27.000Z",
"Initiator": {
"DisplayName": "ownder-display-name",
"ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
},
"Key": "JavaFile",
"Owner": {
"DisplayName": "ownder-display-name",
"ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
},
"StorageClass": "STANDARD",
"UploadId": "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--"
}
]
}Returns metadata about all of the versions of objects in a bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
MaxKeys
|
string |
Pagination limit |
KeyMarker
|
string |
Pagination token |
VersionIdMarker
|
string |
Pagination token |
versions
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListObjectVersionsRequest
|
object |
Examples
{
"Bucket": "examplebucket",
"Prefix": "HappyFace.jpg"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListObjectVersionsOutput
|
object |
Properties
EncodingType
|
EncodingType |
Encoding type used by Amazon S3 to encode object keys in the response. |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
CommonPrefixes
|
CommonPrefixList | ||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
MaxKeys
|
MaxKeys | ||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
Delimiter
|
Delimiter | ||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
Prefix
|
Prefix | ||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
Name
|
BucketName | ||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
DeleteMarkers
|
DeleteMarkers | ||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
Versions
|
ObjectVersionList | ||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
NextVersionIdMarker
|
NextVersionIdMarker |
Use this value for the next version id marker parameter in a subsequent request. |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
NextKeyMarker
|
NextKeyMarker |
Use this value for the key marker request parameter in a subsequent request. |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
VersionIdMarker
|
VersionIdMarker | ||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
KeyMarker
|
KeyMarker |
Marks the last Key returned in a truncated response. |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
IsTruncated
|
IsTruncated |
A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results. |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
Examples
{
"Versions": [
{
"ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
"IsLatest": true,
"Key": "HappyFace.jpg",
"LastModified": "2016-12-15T01:19:41.000Z",
"Owner": {
"DisplayName": "owner-display-name",
"ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
},
"Size": 3191,
"StorageClass": "STANDARD",
"VersionId": "null"
},
{
"ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
"IsLatest": false,
"Key": "HappyFace.jpg",
"LastModified": "2016-12-13T00:58:26.000Z",
"Owner": {
"DisplayName": "owner-display-name",
"ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
},
"Size": 3191,
"StorageClass": "STANDARD",
"VersionId": "PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k"
}
]
}Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
MaxKeys
|
string |
Pagination limit |
Marker
|
string |
Pagination token |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListObjectsRequest
|
object |
Examples
{
"Bucket": "examplebucket",
"MaxKeys": "2"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListObjectsOutput
|
object |
Properties
EncodingType
|
EncodingType |
Encoding type used by Amazon S3 to encode object keys in the response. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
CommonPrefixes
|
CommonPrefixList | ||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
MaxKeys
|
MaxKeys | ||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Delimiter
|
Delimiter | ||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Prefix
|
Prefix | ||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Name
|
BucketName | ||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Contents
|
ObjectList | ||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
NextMarker
|
NextMarker |
When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Marker
|
Marker | ||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
IsTruncated
|
IsTruncated |
A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Examples
{
"Contents": [
{
"ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"",
"Key": "example1.jpg",
"LastModified": "2014-11-21T19:40:05.000Z",
"Owner": {
"DisplayName": "myname",
"ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
},
"Size": 11,
"StorageClass": "STANDARD"
},
{
"ETag": "\"9c8af9a76df052144598c115ef33e511\"",
"Key": "example2.jpg",
"LastModified": "2013-11-15T01:10:49.000Z",
"Owner": {
"DisplayName": "myname",
"ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
},
"Size": 713193,
"StorageClass": "STANDARD"
}
],
"NextMarker": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
}Body
| Name | Data Type | Description |
|---|---|---|
NoSuchBucket
|
Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
MaxKeys
|
string |
Pagination limit |
ContinuationToken
|
string |
Pagination token |
list-type
|
string Allowed values: - 2 |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListObjectsV2Request
|
object |
Examples
{
"Bucket": "examplebucket",
"MaxKeys": "2"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListObjectsV2Output
|
object |
Properties
StartAfter
|
StartAfter |
StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
NextContinuationToken
|
NextToken |
NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
ContinuationToken
|
Token |
ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
KeyCount
|
KeyCount |
KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
EncodingType
|
EncodingType |
Encoding type used by Amazon S3 to encode object keys in the response. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
CommonPrefixes
|
CommonPrefixList |
CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
MaxKeys
|
MaxKeys |
Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Delimiter
|
Delimiter |
A delimiter is a character you use to group keys. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Prefix
|
Prefix |
Limits the response to keys that begin with the specified prefix. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Name
|
BucketName |
Name of the bucket to list. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Contents
|
ObjectList |
Metadata about each object returned. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
IsTruncated
|
IsTruncated |
A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Examples
{
"Contents": [
{
"ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"",
"Key": "happyface.jpg",
"LastModified": "2014-11-21T19:40:05.000Z",
"Size": 11,
"StorageClass": "STANDARD"
},
{
"ETag": "\"becf17f89c30367a9a44495d62ed521a-1\"",
"Key": "test.jpg",
"LastModified": "2014-05-02T04:51:50.000Z",
"Size": 4192256,
"StorageClass": "STANDARD"
}
],
"IsTruncated": true,
"KeyCount": "2",
"MaxKeys": "2",
"Name": "examplebucket",
"NextContinuationToken": "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI\/EyIJg==",
"Prefix": ""
}Body
| Name | Data Type | Description |
|---|---|---|
NoSuchBucket
|
Sets the accelerate configuration of an existing bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
accelerate
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketAccelerateConfigurationRequest
|
object |
Properties
AccelerateConfiguration
|
AccelerateConfiguration |
Specifies the Accelerate Configuration you want to set for the bucket. |
||||||||||||||
Properties
|
||||||||||||||||
Responses
Sets the permissions on a bucket using access control lists (ACL).
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
acl
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketAclRequest
|
object |
Properties
AccessControlPolicy
|
AccessControlPolicy | ||
Examples
{
"Bucket": "examplebucket",
"GrantFullControl": "id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484",
"GrantWrite": "uri=http:\/\/acs.amazonaws.com\/groups\/s3\/LogDelivery"
}Responses
Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
analytics
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketAnalyticsConfigurationRequest
|
object |
Properties
AnalyticsConfiguration
|
AnalyticsConfiguration |
The configuration and any analyses for the analytics filter. |
||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
Responses
Sets the CORS configuration for a bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
cors
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketCorsRequest
|
object |
Properties
CORSConfiguration
|
CORSConfiguration | ||
|
|
|||
Examples
{
"Bucket": "",
"CORSConfiguration": {
"CORSRules": [
{
"AllowedHeaders": [
"*"
],
"AllowedMethods": [
"PUT",
"POST",
"DELETE"
],
"AllowedOrigins": [
"http:\/\/www.example.com"
],
"ExposeHeaders": [
"x-amz-server-side-encryption"
],
"MaxAgeSeconds": 3000
},
{
"AllowedHeaders": [
"Authorization"
],
"AllowedMethods": [
"GET"
],
"AllowedOrigins": [
"*"
],
"MaxAgeSeconds": 3000
}
]
},
"ContentMD5": ""
}Responses
Creates a new server-side encryption configuration (or replaces an existing one, if present).
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
encryption
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketEncryptionRequest
|
object |
Properties
ServerSideEncryptionConfiguration
|
ServerSideEncryptionConfiguration | |||||||||||||||
Properties
|
||||||||||||||||
Responses
Adds an inventory configuration (identified by the inventory ID) from the bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
inventory
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketInventoryConfigurationRequest
|
object |
Properties
InventoryConfiguration
|
InventoryConfiguration |
Specifies the inventory configuration. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
lifecycle
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketLifecycleConfigurationRequest
|
object |
Properties
LifecycleConfiguration
|
BucketLifecycleConfiguration | |||||||||||||||
Properties
|
||||||||||||||||
Examples
{
"Bucket": "examplebucket",
"LifecycleConfiguration": {
"Rules": [
{
"Expiration": {
"Days": 3650
},
"Filter": {
"Prefix": "documents\/"
},
"ID": "TestOnly",
"Status": "Enabled",
"Transitions": [
{
"Days": 365,
"StorageClass": "GLACIER"
}
]
}
]
}
}Responses
Deprecated, see the PutBucketLifecycleConfiguration operation.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
lifecycle
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketLifecycleRequest
|
object |
Properties
LifecycleConfiguration
|
LifecycleConfiguration | ||
|
|
|||
Responses
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
logging
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketLoggingRequest
|
object |
Properties
BucketLoggingStatus
|
BucketLoggingStatus | ||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||
Examples
{
"Bucket": "sourcebucket",
"BucketLoggingStatus": {
"LoggingEnabled": {
"TargetBucket": "targetbucket",
"TargetGrants": [
{
"Grantee": {
"Type": "Group",
"URI": "http:\/\/acs.amazonaws.com\/groups\/global\/AllUsers"
},
"Permission": "READ"
}
],
"TargetPrefix": "MyBucketLogs\/"
}
}
}Responses
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
metrics
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketMetricsConfigurationRequest
|
object |
Properties
MetricsConfiguration
|
MetricsConfiguration |
Specifies the metrics configuration. |
|||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||
Responses
Enables notifications of specified events for a bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
notification
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketNotificationConfigurationRequest
|
object |
Properties
NotificationConfiguration
|
NotificationConfiguration | |||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
Examples
{
"Bucket": "examplebucket",
"NotificationConfiguration": {
"TopicConfigurations": [
{
"Events": [
"s3:ObjectCreated:*"
],
"TopicArn": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic"
}
]
}
}Responses
Deprecated, see the PutBucketNotificationConfiguraiton operation.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
notification
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketNotificationRequest
|
object |
Properties
NotificationConfiguration
|
NotificationConfigurationDeprecated | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Examples |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
policy
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketPolicyRequest
|
object |
Properties
Policy
|
Policy |
The bucket policy as a JSON document. |
||||
|
||||||
Examples
{
"Bucket": "examplebucket",
"Policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3\/*\" ] } ]}"
}Responses
Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
replication
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketReplicationRequest
|
object |
Properties
ReplicationConfiguration
|
ReplicationConfiguration | |||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
Examples
{
"Bucket": "examplebucket",
"ReplicationConfiguration": {
"Role": "arn:aws:iam::123456789012:role\/examplerole",
"Rules": [
{
"Destination": {
"Bucket": "arn:aws:s3:::destinationbucket",
"StorageClass": "STANDARD"
},
"Prefix": "",
"Status": "Enabled"
}
]
}
}Responses
Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
requestPayment
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketRequestPaymentRequest
|
object |
Properties
RequestPaymentConfiguration
|
RequestPaymentConfiguration | |||||||||||||||
Properties
|
||||||||||||||||
Examples
{
"Bucket": "examplebucket",
"RequestPaymentConfiguration": {
"Payer": "Requester"
}
}Responses
Sets the tags for a bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
tagging
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
Responses
Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
versioning
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketVersioningRequest
|
object |
Properties
VersioningConfiguration
|
VersioningConfiguration | |||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
Examples
{
"Bucket": "examplebucket",
"VersioningConfiguration": {
"MFADelete": "Disabled",
"Status": "Enabled"
}
}Responses
Set the website configuration for a bucket.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
website
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutBucketWebsiteRequest
|
object |
Properties
WebsiteConfiguration
|
WebsiteConfiguration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"Bucket": "examplebucket",
"ContentMD5": "",
"WebsiteConfiguration": {
"ErrorDocument": {
"Key": "error.html"
},
"IndexDocument": {
"Suffix": "index.html"
}
}
}Responses
Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
object-lock
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutObjectLockConfigurationRequest
|
object |
Properties
ObjectLockConfiguration
|
ObjectLockConfiguration |
The Object Lock configuration that you want to apply to the specified bucket. |
|||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
PutObjectLockConfigurationOutput
|
object |
Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
publicAccessBlock
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutPublicAccessBlockRequest
|
object |
Properties
PublicAccessBlockConfiguration
|
PublicAccessBlockConfiguration |
The |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
Responses
Initiates a multipart upload and returns an upload ID.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string | |
Key
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
uploads
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateMultipartUploadRequest
|
object |
Properties
Metadata
|
Metadata |
A map of metadata to store with the object in S3. |
||||
|
||||||
Examples
{
"Bucket": "examplebucket",
"Key": "largeobject"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateMultipartUploadOutput
|
object |
Properties
UploadId
|
MultipartUploadId |
ID for the initiated multipart upload. |
||||
|
||||||
Key
|
ObjectKey |
Object key for which the multipart upload was initiated. |
||||
|
||||||
Bucket
|
BucketName |
Name of the bucket to which the multipart upload was initiated. |
||||
|
||||||
Examples
{
"Bucket": "examplebucket",
"Key": "largeobject",
"UploadId": "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--"
}Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string | |
Key
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteObjectRequest
|
object |
Examples
{
"Bucket": "ExampleBucket",
"Key": "HappyFace.jpg"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteObjectOutput
|
object |
Removes the tag-set from an existing object.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string | |
Key
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
tagging
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteObjectTaggingRequest
|
object |
Examples
{
"Bucket": "examplebucket",
"Key": "HappyFace.jpg"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteObjectTaggingOutput
|
object |
Examples
{
"VersionId": "null"
}Returns the access control list (ACL) of an object.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string | |
Key
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
acl
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetObjectAclRequest
|
object |
Examples
{
"Bucket": "examplebucket",
"Key": "HappyFace.jpg"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetObjectAclOutput
|
object |
Properties
Grants
|
Grants |
A list of grants. |
|||||||||||||||||
|
|||||||||||||||||||
Owner
|
Owner | ||||||||||||||||||
|
|
|||||||||||||||||||
Examples
{
"Grants": [
{
"Grantee": {
"DisplayName": "owner-display-name",
"ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
"Type": "CanonicalUser"
},
"Permission": "WRITE"
},
{
"Grantee": {
"DisplayName": "owner-display-name",
"ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
"Type": "CanonicalUser"
},
"Permission": "WRITE_ACP"
},
{
"Grantee": {
"DisplayName": "owner-display-name",
"ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
"Type": "CanonicalUser"
},
"Permission": "READ"
},
{
"Grantee": {
"DisplayName": "owner-display-name",
"ID": "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
"Type": "CanonicalUser"
},
"Permission": "READ_ACP"
}
],
"Owner": {
"DisplayName": "owner-display-name",
"ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
}
}Body
| Name | Data Type | Description |
|---|---|---|
NoSuchKey
|
Retrieves objects from Amazon S3.
http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string | |
Key
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetObjectRequest
|
object |
Examples
{
"Bucket": "examplebucket",
"Key": "SampleFile.txt",
"Range": "bytes=0-9"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetObjectOutput
|
object |
Properties
Metadata
|
Metadata |
A map of metadata to store with the object in S3. |
||||
|
||||||
Body
|
Body |
Object data. |
||||
|
||||||
Examples
{
"AcceptRanges": "bytes",
"ContentLength": "10",
"ContentRange": "bytes 0-9\/43",
"ContentType": "text\/plain",
"ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
"LastModified": "Thu, 09 Oct 2014 22:57:28 GMT",
"Metadata": [],
"VersionId": "null"
}Body
| Name | Data Type | Description |
|---|---|---|
NoSuchKey
|
Gets an object's current Legal Hold status.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Bucket
|
string | |
Key
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
legal-hold
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
x-amz-security-token
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetObjectLegalHoldRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetObjectLegalHoldOutput
|
object |
Properties
LegalHold
|
ObjectLockLegalHold |
The current Legal Hold status for the specified object. |
|||||||||||
Properties
| |||||||||||||