logo资料库

亚马逊S3接口文档.pdf

第1页 / 共541页
第2页 / 共541页
第3页 / 共541页
第4页 / 共541页
第5页 / 共541页
第6页 / 共541页
第7页 / 共541页
第8页 / 共541页
资料共541页,剩余部分请下载后查看
Amazon Simple Storage Service
Table of Contents
Amazon S3 REST API Introduction
Common Request Headers
Common Response Headers
Error Responses
REST Error Responses
List of Error Codes
Authenticating Requests (AWS Signature Version 4)
Authentication Methods
Introduction to Signing Requests
Authenticating Requests: Using the Authorization Header (AWS Signature Version 4)
Overview
Signature Calculations for the Authorization Header: Transferring Payload in a Single Chunk (AWS Signature Version 4)
Calculating a Signature
Task 1: Create a Canonical Request
Task 2: Create a String to Sign
Task 3: Calculate Signature
Examples: Signature Calculations
Example: GET Object
Example: PUT Object
Example: GET Bucket Lifecycle
Example: Get Bucket (List Objects)
Signature Calculations for the Authorization Header: Transferring Payload in Multiple Chunks (Chunked Upload) (AWS Signature Version 4)
Calculating the Seed Signature
Defining the Chunk Body
Example: PUT Object
Example: PUT Object
Authenticating Requests: Using Query Parameters (AWS Signature Version 4)
Calculating a Signature
An Example
Examples: Signature Calculations in AWS Signature Version 4
Signature Calculation Examples Using Java (AWS Signature Version 4)
Examples of Signature Calculations Using C# (AWS Signature Version 4)
Authenticating Requests: Browser-Based Uploads Using POST (AWS Signature Version 4)
Calculating a Signature
Amazon S3 Signature Version 4 Authentication Specific Policy Keys
Bucket Policy Examples Using Signature Version 4 Related Condition Keys
Authenticating Requests in Browser-Based Uploads Using POST (AWS Signature Version 4)
Browser-Based Uploads Using HTTP POST
Calculating a Signature
Creating an HTML Form (Using AWS Signature Version 4)
HTML Form Declaration
HTML Form Fields
Creating a POST Policy
Expiration
Condition Matching
Conditions
Character Escaping
Example: Browser-Based Upload using HTTP POST (Using AWS Signature Version 4)
Uploading a File to Amazon S3 Using HTTP POST
Sample Policy and Form
Using POST with Adobe Flash to Upload Objects
Using POST with Adobe Flash
Adobe Flash Player Security
Other Adobe Flash Considerations
Browser-Based Uploads to Amazon S3 Using the AWS Amplify Library
Using the AWS Amplify JavaScript library to Upload Files to Amazon S3
More Info
Operations on the Service
GET Service
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
Operations on Buckets
DELETE Bucket
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
DELETE Bucket analytics
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Examples
Sample Request
Sample Response
Related Resources
DELETE Bucket cors
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Examples
Example 1: Retrieve cors subresource
Sample Request
Sample Response
Related Resources
DELETE Bucket encryption
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Examples
Sample Request
Sample Response
Related Resources
DELETE Bucket inventory
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Examples
Sample Request
Sample Response
Related Resources
DELETE Bucket lifecycle
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Examples
Sample Request
Sample Response
Related Resources
DELETE Bucket metrics
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
DELETE Bucket policy
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
DELETE Bucket replication
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Examples
Related Resources
DELETE Bucket tagging
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Examples
Sample Request
Sample Response
Related Resources
DELETE Bucket website
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Examples
Sample Request
Sample Response
Related Resources
GET Bucket (List Objects) Version 2
Description
Requests
Syntax
Request Parameters
Request Elements
Request Headers
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Listing Keys
Sample Request
Sample Response
Example 2: Listing Keys Using the max-keys, prefix, and start-after Parameters
Sample Request
Sample Response
Example 3: Listing Keys Using the prefix and delimiter Parameters
Example 4: Using a Continuation Token
Related Resources
GET Bucket (List Objects) Version 1
Description
Requests
Syntax
Request Parameters
Request Elements
Request Headers
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Request Using Request Parameters
Sample Response
Sample Request Using Prefix and Delimiter
Related Resources
GET Bucket accelerate
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Retrieve the transfer acceleration configuration for a bucket
Related Resources
GET Bucket acl
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
GET Bucket analytics
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example: Configure an Analytics Report
Related Resources
GET Bucket cors
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Retrieve cors subresource
Sample Request
Sample Response
Related Resources
GET Bucket encryption
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Retrieve the Encryption Configuration for an S3 Bucket
Related Resources
GET Bucket Inventory
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example: Configure an Inventory Report
Related Resources
GET Bucket lifecycle
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Retrieve lifecycle subresource
Sample Request
Sample Response
Related Resources
GET Bucket location
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
GET Bucket logging
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response Showing an Enabled Logging Status
Sample Response Showing a Disabled Logging Status
Related Resources
GET Bucket metrics
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
First Sample Request
First Sample Response
Second Sample Request
Second Sample Response
Related Resources
GET Bucket notification
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
GET Bucket Object versions
Description
Requests
Syntax
Request Parameters
Request Headers
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response to GET Versions
Sample Request
Sample Response
Sample Request Using prefix
Sample Response
Sample Request Using key-marker and version-id-marker Parameters
Sample Response
Sample Request Using key-marker, version-id-marker and max-keys
Sample Response
Sample Request Using the Delimiter and the Prefix Parameters
Related Resources
GET Bucket policy
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
GET Bucket replication
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Retrieve Replication Configuration Information
Related Resources
GET Bucket requestPayment
Description
Requests
Syntax
Request Parameters
Request Headers
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
GET Bucket tagging
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
GET Bucket versioning
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
GET Bucket website
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Examples
Sample Request
Sample Response
Related Resources
HEAD Bucket
Description
Requests
Syntax
Request Parameters
Request Elements
Request Headers
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
List Bucket Analytics Configurations
Description
Requests
Syntax
Request Parameters
Request Elements
Request Headers
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Listing Analytics Configurations
Sample Request
Sample Response
Related Resources
List Bucket Inventory Configurations
Description
Requests
Syntax
Request Parameters
Request Elements
Request Headers
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Listing Inventory Configurations
Sample Request
Sample Response
Related Resources
List Bucket Metrics Configurations
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Examples
Sample Request
Sample Response
Related Resources
List Multipart Uploads
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Examples
Sample Request
Sample Response
Sample Request Using the Delimiter and the Prefix Parameters
Related Actions
PUT Bucket
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Request: Setting the region of a bucket
Sample Response
Sample Request: Creating a bucket and configuring access permission using a canned ACL
Sample Response
Sample Request: Creating a bucket and configuring access permissions explicitly
Sample Response
Related Resources
PUT Bucket accelerate
Description
Requests
Syntax
Request Parameters
Request Headers
Request Body
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Add Transfer Acceleration Configuration to Set Acceleration Status
Related Resources
PUT Bucket acl
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Grantee Values
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request: Access permissions specified in the body
Sample Response
Sample Request: Access permissions specified using headers
Sample Response
Related Resources
PUT Bucket analytics
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Creating an Analytics Configuration
Related Resources
PUT Bucket cors
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example : Configure cors
Sample Request
Sample Response
Related Resources
PUT Bucket encryption
Description
Requests
Syntax
Request Parameters
Request Headers
Request Body
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Set the Default Encryption Configuration for an S3 Bucket
Related Resources
PUT Bucket inventory
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Creating an Inventory Configuration
Related Resources
PUT Bucket lifecycle
Description
Permissions
Requests
Syntax
Request Parameters
Request Headers
Request Body
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Add lifecycle configuration - bucket not versioning-enabled
Example 2: Add lifecycle configuration - bucket is versioning-enabled
Additional Examples
Related Resources
PUT Bucket logging
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Grantee Values
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Request Disabling Logging
Sample Response
Related Resources
PUT Bucket metrics
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
First Sample Request
First Sample Response
Second Sample Request
Second Sample Response
Related Resources
PUT Bucket notification
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Configure Notification to Invoke a cloud function in Lambda
Example 2: Configure a Notification with Multiple Destinations
Example 3: Configure a Notification with Object Key Name Filtering
Related Resources
PUT Bucket policy
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
PUT Bucket replication
Description
Requests
Syntax
Request Parameters
Request Headers
Request Body
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Add Replication Configuration
Example 2: Change Replica Owner in Cross-Account Scenario
Related Resources
PUT Bucket requestPayment
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Resources
PUT Bucket tagging
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request: Add tag set to a bucket
Sample Response
Related Resources
PUT Bucket versioning
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Request
Sample Response
Sample Request
Sample Response
Related Resources
PUT Bucket website
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Examples
Example 1: Configure bucket as a website (add website configuration)
Example 2: Configure bucket as a website but redirect all requests
Example 3: Configure bucket as a website and also specify optional redirection rules
Example 4: Configure bucket as a website and redirect errors
Example 5: Configure a bucket as a website and redirect folder requests to a page
Operations on Objects
Delete Multiple Objects
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Examples
Example 1: Multi-Object Delete resulting in mixed success/error response
Sample Request
Sample Response
Example 2: Deleting Object from a Versioned Bucket
Case 1 - Simple Delete
Case 2 - Versioned Delete
Case 3 - Versioned Delete of a Delete Marker
Example 3: Malformed XML in the Request
Sample Request
Sample Response
Related Actions
DELETE Object
Description
Versioning
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Request Deleting a Specified Version of an Object
Sample Response
Sample Response if the Object Deleted is a Delete Marker
Sample Request Deleting a Specified Version of an Object in an MFA-Enabled Bucket
Sample Response
Related Resources
DELETE Object tagging
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Examples
Sample Request
Sample Response
Related Resources
GET Object
Description
Permissions
Versioning
Requests
Syntax
Request Parameters
Request Headers
Specific Request Headers for Server-Side Encryption with Customer-Provided Encryption Keys
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Response if an Object Is Archived in Amazon Glacier
Sample Response if the Latest Object Is a Delete Marker
Sample Request Getting a Specified Version of an Object
Sample Response to a Versioned Object GET Request
Sample Request with Parameters Altering Response Header Values
Sample Response with Overridden Response Header Values
Sample Request with a Range Header
Sample Response
Sample: Get an Object Stored Using Server-Side Encryption with Customer-Provided Encryption Keys
Related Resources
GET Object ACL
Description
Versioning
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Request Getting the ACL of the Specific Version of an Object
Sample Response Showing the ACL of the Specific Version
Related Resources
GET Object tagging
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Examples
Sample Request
Sample Response
Related Resources
GET Object torrent
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Getting Torrent Files in a Bucket
Sample Response
Related Resources
HEAD Object
Description
Permissions
Versioning
Requests
Syntax
Request Parameters
Request Headers
Specific Request Headers for Server-Side Encryption with Customer-Provided Encryption Keys
Request Elements
Responses
Response Headers
Response Elements
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Request Getting Metadata from a Specified Version of an Object
Sample Response to a Versioned HEAD Request
Sample Request for an Amazon Glacier Object
Sample Response - Glacier Object
Related Resources
OPTIONS object
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Examples
Example : Send a preflight OPTIONS request to a cors enabled bucket
Sample Request
Sample Response
Related Resources
POST Object
Description
Versioning
Requests
Syntax
Request Parameters
Form Fields
Server-Side Encryption Specific Request Form Fields
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response with Versioning Suspended
Sample Response with Versioning Enabled
Related Resources
POST Object restore
Description
Querying Archives with Select Requests
Restoring Archives
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Restore an Object for Two Days Using the Expedited Retrieval Option
Query an Archive with a SELECT Request
More Info
PUT Object
Description
Versioning
Storage Class Options
Access Permissions
Requests
Syntax
Request Parameters
Request Headers
Access Control List (ACL) Specific Request Headers
Server-Side Encryption Specific Request Headers
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Upload an Object
Sample Request
Sample Response with Versioning Suspended
Sample Response with Versioning Enabled
Example 2: Upload an Object (Specify Storage Class)
Sample Request: Specifying reduced redundancy storage class
Sample Response
Example 3:Upload an Object (Specify Access Permission Explicitly)
Sample Request: Uploading an object and specifying access permissions explicitly
Sample Response
Example 4: Upload an Object (Specify Access Permission Using Canned ACL)
Sample Request: Using a canned ACL to set access permissions
Sample Response
Example 5: Upload an Object (Request Server-Side Encryption Using Customer-Provided Encryption Key)
Example 6: Upload an Object and Specify Tags
Related Resources
PUT Object - Copy
Description
Versioning
Access Permissions
Requests
Syntax
Request Parameters
Request Headers
Server-Side Encryption Specific Request Headers
Access Control List (ACL) Specific Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Request: Copying a specified version of an object
Success Response: Copying a versioned object into a version enabled bucket
Success Response: Copying a versioned object into a version-suspended bucket
Sample: Copy from unencrypted object to an object encrypted with server-side encryption with customer-provided encryption keys
Sample: Copy from an object encrypted with SSE-C to an object encrypted with SSE-C
Related Resources
PUT Object acl
Description
Versioning
Requests
Syntax
Request Parameters
Request Headers
Access Control List (ACL) Specific Request Headers
Request Elements
Grantee Values
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Request: Setting the ACL of a specified object version
Sample Response
Sample Request: Access permissions specified using headers
Sample Response
Related Resources
PUT Object tagging
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request: Add tag set to an object
Sample Response
Related Resources
SELECT Object Content (Preview)
Description
Requests
Syntax
Request Parameters
Request Headers
Request Body
Responses
Response Headers
Response Body
Record(s) Frame
Continuation Frame
End Frame
Special Errors
Examples
Example 1: CSV Object
Example 2: JSON Object
Notes
Related Resources
Abort Multipart Upload
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Related Actions
Complete Multipart Upload
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Response with Error Specified in Header
Sample Response with Error Specified in Body
Related Actions
Initiate Multipart Upload
Description
Requests
Syntax
Request Parameters
Request Headers
Access Control List (ACL) Specific Request Headers
Server-Side Encryption–Specific Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample: Initiate multipart upload, using server-side encryption with customer-provided encryption keys
Related Actions
List Parts
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Examples
Sample Request
Sample Response
Related Actions
Upload Part
Description
Requests
Syntax
Request Parameters
Request Headers
Server-Side Encryption Specific Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample: Upload a part with an encryption key in the request for server-side encryption
Related Actions
Upload Part - Copy
Description
Requests
Syntax
Request Parameters
Request Headers
Server-Side Encryption Specific Request Headers
Request Elements
Versioning
Responses
Response Headers
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Request
Sample Request
Sample Response
Related Actions
Amazon S3 Resources
Document History
Appendix
Appendix: SOAP API
Operations on the Service (SOAP API)
ListAllMyBuckets (SOAP API)
Response Body
Access Control
Operations on Buckets (SOAP API)
CreateBucket (SOAP API)
Elements
Access Control
Related Resources
DeleteBucket (SOAP API)
Elements
Access Control
ListBucket (SOAP API)
Requests
Syntax
Parameters
Success Response
Syntax
Response Elements
Response Body
Access Control
GetBucketAccessControlPolicy (SOAP API)
Response Body
Access Control
SetBucketAccessControlPolicy (SOAP API)
Access Control
GetBucketLoggingStatus (SOAP API)
Access Control
SetBucketLoggingStatus (SOAP API)
Access Control
Operations on Objects (SOAP API)
PutObjectInline (SOAP API)
Elements
Responses
Access Control
Related Resources
PutObject (SOAP API)
Elements
Responses
Access Control
Related Resources
CopyObject (SOAP API)
Description
Request Syntax
Request Parameters
Response Syntax
Response Elements
Special Errors
Examples
Sample Request
Sample Response
Sample Request
Sample Response
Related Resources
GetObject (SOAP API)
Elements
Returned Elements
Access Control
SOAP Chunked and Resumable Downloads
Range GETs
Versioned GetObject
REST GET Error Recovery
Related Resources
GetObjectExtended (SOAP API)
DeleteObject (SOAP API)
Elements
Access Control
GetObjectAccessControlPolicy (SOAP API)
Response Body
Access Control
SetObjectAccessControlPolicy (SOAP API)
Access Control
SOAP Error Responses
Appendix: Lifecycle Configuration APIs (Deprecated)
PUT Bucket lifecycle (deprecated)
Description
Permissions
Requests
Syntax
Request Parameters
Request Headers
Request Body
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Add lifecycle configuration - bucket not versioning-enabled
Example 2: Add lifecycle configuration - bucket is versioning-enabled
Additional Examples
Related Resources
GET Bucket lifecycle (deprecated)
Description
Requests
Syntax
Request Parameters
Request Headers
Request Elements
Responses
Response Headers
Response Elements
Special Errors
Examples
Example 1: Retrieve lifecycle subresource
Sample Request
Sample Response
Related Resources
Glossary
Amazon Simple Storage Service API Reference API Version 2006-03-01
Amazon Simple Storage Service API Reference Amazon Simple Storage Service: API Reference Copyright © 2018 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.
Amazon Simple Storage Service API Reference Table of Contents Amazon S3 REST API Introduction ....................................................................................................... 1 Common Request Headers .................................................................................................................. 2 Common Response Headers ................................................................................................................ 4 Error Responses ................................................................................................................................. 6 REST Error Responses ................................................................................................................. 6 List of Error Codes ..................................................................................................................... 7 Authenticating Requests (AWS Signature Version 4) .............................................................................. 14 Authentication Methods ............................................................................................................ 15 Introduction to Signing Requests ............................................................................................... 15 Using an Authorization Header .................................................................................................. 16 Overview ......................................................................................................................... 16 Signature Calculation: Transfer Payload in a Single Chunk ..................................................... 18 Signature Calculation: Transfer Payload in Multiple Chunks .................................................... 29 Using Query Parameters ........................................................................................................... 35 Calculating a Signature ..................................................................................................... 37 An Example ..................................................................................................................... 39 Examples: Signature Calculations ................................................................................................ 41 Signature Calculation Examples Using Java .......................................................................... 41 Signature Calculation Examples Using C# ............................................................................ 42 Authenticating HTTP POST Requests .......................................................................................... 43 Calculating a Signature ..................................................................................................... 44 Amazon S3 Signature Version 4 Authentication Specific Policy Keys ................................................ 45 Bucket Policy Examples Using Signature Version 4 Related Condition Keys ............................... 46 Browser-Based Uploads Using POST ................................................................................................... 48 Browser-Based Uploads Using HTTP POST ................................................................................... 48 Calculating a Signature ............................................................................................................. 49 Creating HTML Forms ............................................................................................................... 50 HTML Form Declaration .................................................................................................... 51 HTML Form Fields ............................................................................................................ 51 Creating a POST Policy ............................................................................................................. 55 Expiration ........................................................................................................................ 55 Condition Matching .......................................................................................................... 55 Conditions ....................................................................................................................... 56 Character Escaping ........................................................................................................... 58 POST Upload Example .............................................................................................................. 60 Uploading a File to Amazon S3 Using HTTP POST ................................................................ 60 Using POST with Adobe Flash .................................................................................................... 62 Using POST with Adobe Flash ............................................................................................ 62 Browser-Based Uploads Using AWS Amplify ................................................................................ 62 Using the AWS Amplify JavaScript library to Upload Files to Amazon S3 .................................. 63 More Info ........................................................................................................................ 63 Operations on the Service ................................................................................................................. 64 GET Service ............................................................................................................................. 64 Description ...................................................................................................................... 64 Requests ......................................................................................................................... 64 Responses ....................................................................................................................... 64 Examples ......................................................................................................................... 66 Related Resources ............................................................................................................ 66 Operations on Buckets ...................................................................................................................... 67 DELETE Bucket ......................................................................................................................... 69 Description ...................................................................................................................... 69 Requests ......................................................................................................................... 69 Responses ....................................................................................................................... 69 Examples ......................................................................................................................... 69 API Version 2006-03-01 iii
Amazon Simple Storage Service API Reference Related Resources ............................................................................................................ 70 DELETE Bucket analytics ........................................................................................................... 71 Description ...................................................................................................................... 71 Requests ......................................................................................................................... 71 Responses ....................................................................................................................... 72 Examples ......................................................................................................................... 72 Related Resources ............................................................................................................ 72 DELETE Bucket cors .................................................................................................................. 73 Description ...................................................................................................................... 73 Requests ......................................................................................................................... 73 Responses ....................................................................................................................... 73 Examples ......................................................................................................................... 73 Related Resources ............................................................................................................ 74 DELETE Bucket encryption ......................................................................................................... 75 Description ...................................................................................................................... 75 Requests ......................................................................................................................... 75 Responses ....................................................................................................................... 75 Examples ......................................................................................................................... 75 Related Resources ............................................................................................................ 76 DELETE Bucket inventory .......................................................................................................... 77 Description ...................................................................................................................... 77 Requests ......................................................................................................................... 77 Responses ....................................................................................................................... 78 Examples ......................................................................................................................... 78 Related Resources ............................................................................................................ 78 DELETE Bucket lifecycle ............................................................................................................ 79 Description ...................................................................................................................... 79 Requests ......................................................................................................................... 79 Responses ....................................................................................................................... 79 Examples ......................................................................................................................... 80 Related Resources ............................................................................................................ 80 DELETE Bucket metrics ............................................................................................................. 80 Description ...................................................................................................................... 80 Requests ......................................................................................................................... 80 DELETE Bucket policy ............................................................................................................... 83 Description ...................................................................................................................... 83 Requests ......................................................................................................................... 83 Responses ....................................................................................................................... 83 Examples ......................................................................................................................... 84 Related Resources ............................................................................................................ 84 DELETE Bucket replication ......................................................................................................... 85 Description ...................................................................................................................... 85 Requests ......................................................................................................................... 85 Responses ....................................................................................................................... 85 Examples ......................................................................................................................... 85 Related Resources ............................................................................................................ 86 DELETE Bucket tagging ............................................................................................................. 87 Description ...................................................................................................................... 87 Requests ......................................................................................................................... 87 Responses ....................................................................................................................... 87 Examples ......................................................................................................................... 87 Related Resources ............................................................................................................ 88 DELETE Bucket website ............................................................................................................. 89 Description ...................................................................................................................... 89 Requests ......................................................................................................................... 89 Responses ....................................................................................................................... 89 Examples ......................................................................................................................... 90 API Version 2006-03-01 iv
Amazon Simple Storage Service API Reference Related Resources ............................................................................................................ 90 GET Bucket (List Objects) Version 2 ............................................................................................ 91 Description ...................................................................................................................... 91 Requests ......................................................................................................................... 91 Responses ....................................................................................................................... 93 Examples ......................................................................................................................... 96 Related Resources ........................................................................................................... 100 GET Bucket (List Objects) Version 1 .................................................................................. 101 GET Bucket accelerate ............................................................................................................. 109 Description .................................................................................................................... 109 Requests ........................................................................................................................ 109 Responses ...................................................................................................................... 110 Examples ....................................................................................................................... 110 Related Resources ........................................................................................................... 111 GET Bucket acl ....................................................................................................................... 112 Description .................................................................................................................... 112 Requests ........................................................................................................................ 112 Responses ...................................................................................................................... 112 Examples ....................................................................................................................... 114 Related Resources ........................................................................................................... 114 GET Bucket analytics ............................................................................................................... 115 Description .................................................................................................................... 115 Requests ........................................................................................................................ 115 Responses ...................................................................................................................... 116 Examples ....................................................................................................................... 118 Related Resources ........................................................................................................... 119 GET Bucket cors ..................................................................................................................... 120 Description .................................................................................................................... 120 Requests ........................................................................................................................ 120 Responses ...................................................................................................................... 120 Special Errors ................................................................................................................. 122 Examples ....................................................................................................................... 122 Related Resources ........................................................................................................... 123 GET Bucket encryption ............................................................................................................ 124 Description .................................................................................................................... 124 Requests ........................................................................................................................ 124 Responses ...................................................................................................................... 124 Examples ....................................................................................................................... 126 Related Resources ........................................................................................................... 127 GET Bucket Inventory .............................................................................................................. 128 Description .................................................................................................................... 128 Requests ........................................................................................................................ 128 Responses ...................................................................................................................... 129 Examples ....................................................................................................................... 132 Related Resources ........................................................................................................... 133 GET Bucket lifecycle ................................................................................................................ 134 Description .................................................................................................................... 134 Requests ........................................................................................................................ 134 Responses ...................................................................................................................... 134 Special Errors ................................................................................................................. 139 Examples ....................................................................................................................... 139 Related Resources ........................................................................................................... 140 GET Bucket location ................................................................................................................ 141 Description .................................................................................................................... 141 Requests ........................................................................................................................ 141 GET Bucket logging ................................................................................................................ 143 Description .................................................................................................................... 143 API Version 2006-03-01 v
Amazon Simple Storage Service API Reference Requests ........................................................................................................................ 143 Responses ...................................................................................................................... 143 Examples ....................................................................................................................... 145 Related Resources ........................................................................................................... 145 GET Bucket metrics ................................................................................................................. 146 Description .................................................................................................................... 146 Requests ........................................................................................................................ 146 Responses ...................................................................................................................... 146 Examples ....................................................................................................................... 148 Related Resources ........................................................................................................... 149 GET Bucket notification ........................................................................................................... 150 Description .................................................................................................................... 150 Requests ........................................................................................................................ 150 Responses ...................................................................................................................... 150 Examples ....................................................................................................................... 153 Related Resources ........................................................................................................... 154 GET Bucket Object versions ..................................................................................................... 155 Description .................................................................................................................... 155 Requests ........................................................................................................................ 155 Responses ...................................................................................................................... 156 Examples ....................................................................................................................... 160 Related Resources ........................................................................................................... 166 GET Bucket policy ................................................................................................................... 167 Description .................................................................................................................... 167 Requests ........................................................................................................................ 167 Responses ...................................................................................................................... 167 Examples ....................................................................................................................... 168 Related Resources ........................................................................................................... 168 GET Bucket replication ............................................................................................................ 169 Description .................................................................................................................... 169 Requests ........................................................................................................................ 169 Responses ...................................................................................................................... 169 Special Errors ................................................................................................................. 172 Examples ....................................................................................................................... 173 Related Resources ........................................................................................................... 173 GET Bucket requestPayment .................................................................................................... 174 Description .................................................................................................................... 174 Requests ........................................................................................................................ 174 Responses ...................................................................................................................... 174 Examples ....................................................................................................................... 175 Related Resources ........................................................................................................... 175 GET Bucket tagging ................................................................................................................ 176 Description .................................................................................................................... 176 Requests ........................................................................................................................ 176 Responses ...................................................................................................................... 176 Examples ....................................................................................................................... 177 Related Resources ........................................................................................................... 178 GET Bucket versioning ............................................................................................................. 179 Description .................................................................................................................... 179 Requests ........................................................................................................................ 179 Responses ...................................................................................................................... 180 Examples ....................................................................................................................... 180 Related Resources ........................................................................................................... 181 GET Bucket website ................................................................................................................ 182 Description .................................................................................................................... 182 Requests ........................................................................................................................ 182 Responses ...................................................................................................................... 182 API Version 2006-03-01 vi
Amazon Simple Storage Service API Reference Examples ....................................................................................................................... 183 Related Resources ........................................................................................................... 183 HEAD Bucket .......................................................................................................................... 184 Description .................................................................................................................... 184 Requests ........................................................................................................................ 184 Responses ...................................................................................................................... 184 Examples ....................................................................................................................... 185 List Bucket Analytics Configurations .......................................................................................... 186 Description .................................................................................................................... 186 Requests ........................................................................................................................ 186 Responses ...................................................................................................................... 187 Examples ....................................................................................................................... 188 Related Resources ........................................................................................................... 189 List Bucket Inventory Configurations ......................................................................................... 190 Description .................................................................................................................... 190 Requests ........................................................................................................................ 190 Responses ...................................................................................................................... 191 Examples ....................................................................................................................... 192 Related Resources ........................................................................................................... 194 List Bucket Metrics Configurations ............................................................................................ 195 Description .................................................................................................................... 195 Requests ........................................................................................................................ 195 Responses ...................................................................................................................... 196 Examples ....................................................................................................................... 196 Related Resources ........................................................................................................... 197 List Multipart Uploads ............................................................................................................. 198 Description .................................................................................................................... 198 Requests ........................................................................................................................ 198 Responses ...................................................................................................................... 200 Examples ....................................................................................................................... 203 Related Actions .............................................................................................................. 206 PUT Bucket ............................................................................................................................ 207 Description .................................................................................................................... 207 Requests ........................................................................................................................ 207 Examples ....................................................................................................................... 210 Related Resources ........................................................................................................... 211 PUT Bucket accelerate ............................................................................................................. 212 Description .................................................................................................................... 212 Requests ........................................................................................................................ 212 Responses ...................................................................................................................... 213 Examples ....................................................................................................................... 213 Related Resources ........................................................................................................... 214 PUT Bucket acl ....................................................................................................................... 215 Description .................................................................................................................... 215 Requests ........................................................................................................................ 215 Responses ...................................................................................................................... 219 Examples ....................................................................................................................... 219 Related Resources ........................................................................................................... 221 PUT Bucket analytics .............................................................................................................. 222 Description .................................................................................................................... 222 Requests ........................................................................................................................ 222 Responses ...................................................................................................................... 225 Examples ....................................................................................................................... 226 Related Resources ........................................................................................................... 227 PUT Bucket cors ..................................................................................................................... 228 Description .................................................................................................................... 228 Requests ........................................................................................................................ 229 API Version 2006-03-01 vii
Amazon Simple Storage Service API Reference Responses ...................................................................................................................... 231 Examples ....................................................................................................................... 232 Related Resources ........................................................................................................... 232 PUT Bucket encryption ............................................................................................................ 234 Description .................................................................................................................... 234 Requests ........................................................................................................................ 234 Responses ...................................................................................................................... 236 Examples ....................................................................................................................... 236 Related Resources ........................................................................................................... 237 PUT Bucket inventory ............................................................................................................. 238 Description .................................................................................................................... 238 Requests ........................................................................................................................ 238 Responses ...................................................................................................................... 242 Examples ....................................................................................................................... 243 Related Resources ........................................................................................................... 244 PUT Bucket lifecycle ............................................................................................................... 245 Description .................................................................................................................... 245 Requests ........................................................................................................................ 245 Responses ...................................................................................................................... 253 Examples ....................................................................................................................... 254 Related Resources ........................................................................................................... 256 PUT Bucket logging ................................................................................................................ 257 Description .................................................................................................................... 257 Requests ........................................................................................................................ 257 Responses ...................................................................................................................... 260 Examples ....................................................................................................................... 260 Related Resources ........................................................................................................... 261 PUT Bucket metrics ................................................................................................................ 261 Description .................................................................................................................... 261 Requests ........................................................................................................................ 261 Responses ...................................................................................................................... 263 Examples ....................................................................................................................... 263 Related Resources ........................................................................................................... 265 PUT Bucket notification ........................................................................................................... 266 Description .................................................................................................................... 266 Requests ........................................................................................................................ 266 Responses ...................................................................................................................... 270 Examples ....................................................................................................................... 271 Related Resources ........................................................................................................... 273 PUT Bucket policy .................................................................................................................. 274 Description .................................................................................................................... 274 Requests ........................................................................................................................ 274 Responses ...................................................................................................................... 274 Examples ....................................................................................................................... 275 Related Resources ........................................................................................................... 275 PUT Bucket replication ............................................................................................................ 276 Description .................................................................................................................... 276 Requests ........................................................................................................................ 276 Responses ...................................................................................................................... 281 Examples ....................................................................................................................... 281 Related Resources ........................................................................................................... 283 PUT Bucket requestPayment .................................................................................................... 284 Description .................................................................................................................... 284 Requests ........................................................................................................................ 284 Responses ...................................................................................................................... 285 Examples ....................................................................................................................... 285 Related Resources ........................................................................................................... 285 API Version 2006-03-01 viii
分享到:
收藏