aws-sdk 2.1691.0 → 2.1693.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -201
- package/apis/s3-2006-03-01.examples.json +100 -100
- package/apis/s3-2006-03-01.min.json +167 -102
- package/clients/s3.d.ts +192 -128
- package/dist/aws-sdk-core-react-native.js +756 -346
- package/dist/aws-sdk-react-native.js +3759 -2939
- package/dist/aws-sdk.js +172 -107
- package/dist/aws-sdk.min.js +24 -24
- package/lib/core.js +1 -1
- package/lib/maintenance_mode_message.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,215 +1,30 @@
|
|
|
1
|
-
# AWS SDK for JavaScript
|
|
1
|
+
# AWS SDK for JavaScript (v2)
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/aws-sdk)
|
|
4
|
-
[](https://www.npmjs.com/package/aws-sdk)
|
|
5
|
-
[](https://gitter.im/aws/aws-sdk-js)
|
|
6
4
|
|
|
7
|
-
|
|
8
|
-
[](https://codecov.io/gh/aws/aws-sdk-js)
|
|
9
|
-
[](https://snyk.io/test/github/aws/aws-sdk-js)
|
|
5
|
+
## 🚫 End-of-support as of **September 8, 2025**
|
|
10
6
|
|
|
11
|
-
|
|
7
|
+
The AWS SDK for JavaScript v2 has reached [end-of-support][v2-end-of-support] on **September 8, 2025**.
|
|
8
|
+
It will no longer receive updates or releases. Previously published versions are available on npm at
|
|
9
|
+
[aws-sdk][], and source code remains on GitHub at [aws/aws-sdk-js][].
|
|
12
10
|
|
|
13
|
-
We
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
The **AWS SDK for JavaScript v3** is the latest and recommended version,
|
|
18
|
-
which has been GA since December 2020. Here is [why and how you should use
|
|
19
|
-
**AWS SDK for JavaScript v3**][v3-recommended-blog]. You can try our experimental
|
|
20
|
-
migration scripts in [aws-sdk-js-codemod][aws-sdk-js-codemod] to migrate
|
|
21
|
-
your application from v2 to v3.
|
|
11
|
+
We recommend that you migrate to [AWS SDK for JavaScript v3][v3-developer-guide], which has been GA
|
|
12
|
+
since December 2020. Here is [why and how you should use it][v3-recommended-blog]. You can try
|
|
13
|
+
migration scripts in [aws-sdk-js-codemod][] to migrate your application from v2 to v3.
|
|
22
14
|
|
|
23
15
|
To get help with your migration, please follow our general guidelines to
|
|
24
|
-
[open an issue][v3-new-issue
|
|
16
|
+
[open an issue][v3-new-issue-migration].
|
|
25
17
|
To give feedback on and report issues in the v3 repo, please refer to
|
|
26
18
|
[Giving feedback and contributing][v3-contributing].
|
|
27
19
|
|
|
28
|
-
Watch this README and the [AWS Developer Tools Blog][aws-devtools-blog]
|
|
29
|
-
for updates and announcements regarding the maintenance plans and timelines.
|
|
30
|
-
|
|
31
|
-
A maintenance mode message may be emitted by this package on startup.
|
|
32
|
-
To suppress this message, use an environment variable:
|
|
33
|
-
|
|
34
|
-
```sh
|
|
35
|
-
AWS_SDK_JS_SUPPRESS_MAINTENANCE_MODE_MESSAGE=1 node my_program.js
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
or a JavaScript setting as follows:
|
|
39
|
-
```js
|
|
40
|
-
var SDK = require('aws-sdk');
|
|
41
|
-
require('aws-sdk/lib/maintenance_mode_message').suppress = true;
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
[v3-new-issue]: https://github.com/aws/aws-sdk-js-v3/issues/new?assignees=&labels=needs-triage%2Cv2-v3-inconsistency&projects=&template=v2-to-v3-migration.yml&title=MIGRATION+ISSUE%3A+%5BYour+Title+Here%5D
|
|
45
|
-
[v2-maintenance-mode]: https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-aws-sdk-for-javascript-v2
|
|
46
|
-
[v3-recommended-blog]: https://aws.amazon.com/blogs/developer/why-and-how-you-should-use-aws-sdk-for-javascript-v3-on-node-js-18/
|
|
47
|
-
[v3-contributing]: https://github.com/aws/aws-sdk-js-v3#giving-feedback-and-contributing
|
|
48
|
-
[aws-sdk-js-v3]: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html
|
|
49
|
-
[aws-devtools-blog]: https://aws.amazon.com/blogs/developer/
|
|
50
|
-
[open-issue-v3-guidance]: https://github.com/aws/aws-sdk-js-v3/issues/new?assignees=&labels=guidance%2C+needs-triage&template=---questions---help.md&title=
|
|
51
20
|
[aws-sdk-js-codemod]: https://www.npmjs.com/package/aws-sdk-js-codemod
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
## How To Install
|
|
61
|
-
|
|
62
|
-
### In the Browser
|
|
63
|
-
|
|
64
|
-
To use the SDK in the browser, simply add the following script tag to your
|
|
65
|
-
HTML pages:
|
|
66
|
-
|
|
67
|
-
<script src="https://sdk.amazonaws.com/js/aws-sdk-2.1691.0.min.js"></script>
|
|
68
|
-
|
|
69
|
-
You can also build a custom browser SDK with your specified set of AWS services.
|
|
70
|
-
This can allow you to reduce the SDK's size, specify different API versions of
|
|
71
|
-
services, or use AWS services that don't currently support CORS if you are
|
|
72
|
-
working in an environment that does not enforce CORS. To get started:
|
|
73
|
-
|
|
74
|
-
http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/building-sdk-for-browsers.html
|
|
75
|
-
|
|
76
|
-
The AWS SDK is also compatible with [browserify](http://browserify.org).
|
|
77
|
-
|
|
78
|
-
For browser-based web, mobile and hybrid apps, you can use [AWS Amplify Library](https://aws.github.io/aws-amplify/?utm_source=aws-js-sdk&utm_campaign=browser) which extends the AWS SDK and provides an easier and declarative interface.
|
|
79
|
-
|
|
80
|
-
### In Node.js
|
|
81
|
-
|
|
82
|
-
The preferred way to install the AWS SDK for Node.js is to use the
|
|
83
|
-
[npm](http://npmjs.org) package manager for Node.js. Simply type the following
|
|
84
|
-
into a terminal window:
|
|
85
|
-
|
|
86
|
-
```sh
|
|
87
|
-
npm install aws-sdk
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
### In React Native
|
|
91
|
-
To use the SDK in a react native project, first install the SDK using npm:
|
|
92
|
-
|
|
93
|
-
```sh
|
|
94
|
-
npm install aws-sdk
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
Then within your application, you can reference the react native compatible version of the SDK with the following:
|
|
98
|
-
|
|
99
|
-
```javascript
|
|
100
|
-
var AWS = require('aws-sdk/dist/aws-sdk-react-native');
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
Alternatively, you can use [AWS Amplify Library](https://aws.github.io/aws-amplify/media/react_native_guide?utm_source=aws-js-sdk&utm_campaign=react-native) which extends AWS SDK and provides React Native UI components and CLI support to work with AWS services.
|
|
104
|
-
|
|
105
|
-
### Using Bower
|
|
106
|
-
|
|
107
|
-
You can also use [Bower](http://bower.io) to install the SDK by typing the
|
|
108
|
-
following into a terminal window:
|
|
109
|
-
|
|
110
|
-
```sh
|
|
111
|
-
bower install aws-sdk-js
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
## Usage with TypeScript
|
|
115
|
-
The AWS SDK for JavaScript bundles TypeScript definition files for use in TypeScript projects and to support tools that can read `.d.ts` files.
|
|
116
|
-
Our goal is to keep these TypeScript definition files updated with each release for any public api.
|
|
117
|
-
|
|
118
|
-
### Pre-requisites
|
|
119
|
-
Before you can begin using these TypeScript definitions with your project, you need to make sure your project meets a few of these requirements:
|
|
120
|
-
|
|
121
|
-
* Use latest version of TypeScript. We recommend 4.x+
|
|
122
|
-
* Includes the TypeScript definitions for node. You can use npm to install this by typing the following into a terminal window:
|
|
123
|
-
|
|
124
|
-
```sh
|
|
125
|
-
npm install --save-dev @types/node
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
* If you are targeting at es5 or older ECMA standards, your `tsconfig.json` has to include `'es5'` and `'es2015.promise'` under `compilerOptions.lib`.
|
|
129
|
-
See [tsconfig.json](https://github.com/aws/aws-sdk-js/blob/master/ts/tsconfig.json) for an example.
|
|
130
|
-
|
|
131
|
-
### In the Browser
|
|
132
|
-
To use the TypeScript definition files with the global `AWS` object in a front-end project, add the following line to the top of your JavaScript file:
|
|
133
|
-
|
|
134
|
-
```javascript
|
|
135
|
-
/// <reference types="aws-sdk" />
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
This will provide support for the global `AWS` object.
|
|
139
|
-
|
|
140
|
-
### In Node.js
|
|
141
|
-
To use the TypeScript definition files within a Node.js project, simply import `aws-sdk` as you normally would.
|
|
142
|
-
|
|
143
|
-
In a TypeScript file:
|
|
144
|
-
|
|
145
|
-
```javascript
|
|
146
|
-
// import entire SDK
|
|
147
|
-
import AWS from 'aws-sdk';
|
|
148
|
-
// import AWS object without services
|
|
149
|
-
import AWS from 'aws-sdk/global';
|
|
150
|
-
// import individual service
|
|
151
|
-
import S3 from 'aws-sdk/clients/s3';
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
**NOTE:** You need to add `"esModuleInterop": true` to compilerOptions of your `tsconfig.json`. If not possible, use like `import * as AWS from 'aws-sdk'`.
|
|
155
|
-
|
|
156
|
-
In a JavaScript file:
|
|
157
|
-
|
|
158
|
-
```javascript
|
|
159
|
-
// import entire SDK
|
|
160
|
-
var AWS = require('aws-sdk');
|
|
161
|
-
// import AWS object without services
|
|
162
|
-
var AWS = require('aws-sdk/global');
|
|
163
|
-
// import individual service
|
|
164
|
-
var S3 = require('aws-sdk/clients/s3');
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
### With React
|
|
168
|
-
|
|
169
|
-
To create React applications with AWS SDK, you can use [AWS Amplify Library](https://aws.github.io/aws-amplify/media/react_guide?utm_source=aws-js-sdk&utm_campaign=react) which provides React components and CLI support to work with AWS services.
|
|
170
|
-
|
|
171
|
-
### With Angular
|
|
172
|
-
Due to the SDK's reliance on node.js typings, you may encounter compilation
|
|
173
|
-
[issues](https://github.com/aws/aws-sdk-js/issues/1271) when using the
|
|
174
|
-
typings provided by the SDK in an Angular project created using the Angular CLI.
|
|
175
|
-
|
|
176
|
-
To resolve these issues, either add `"types": ["node"]` to the project's `tsconfig.app.json`
|
|
177
|
-
file, or remove the `"types"` field entirely.
|
|
178
|
-
|
|
179
|
-
[AWS Amplify Library](https://aws.github.io/aws-amplify/media/angular_guide?utm_source=aws-js-sdk&utm_campaign=angular) provides Angular components and CLI support to work with AWS services.
|
|
180
|
-
|
|
181
|
-
### Known Limitations
|
|
182
|
-
There are a few known limitations with the bundled TypeScript definitions at this time:
|
|
183
|
-
|
|
184
|
-
* Service client typings reflect the latest `apiVersion`, regardless of which `apiVersion` is specified when creating a client.
|
|
185
|
-
* Service-bound parameters use the `any` type.
|
|
186
|
-
|
|
187
|
-
# Getting Help
|
|
188
|
-
|
|
189
|
-
The best way to interact with our team is through GitHub.
|
|
190
|
-
You can [open an issue](https://github.com/aws/aws-sdk-js/issues/new/choose) and choose from one of our templates for
|
|
191
|
-
[bug reports](https://github.com/aws/aws-sdk-js/issues/new?assignees=&labels=bug%2C+needs-triage&template=---bug-report.md&title=),
|
|
192
|
-
[feature requests](https://github.com/aws/aws-sdk-js/issues/new?assignees=&labels=feature-request&template=---feature-request.md&title=)
|
|
193
|
-
or [guidance](https://github.com/aws/aws-sdk-js/issues/new?assignees=&labels=guidance%2C+needs-triage&template=---questions---help.md&title=).
|
|
194
|
-
You may also find help on community resources such as [StackOverFlow](https://stackoverflow.com/questions/tagged/aws-sdk-js) with the tag #aws-sdk-js.
|
|
195
|
-
If you have a support plan with [AWS Support](https://aws.amazon.com/premiumsupport/), you can also create a new support case.
|
|
196
|
-
|
|
197
|
-
Please make sure to check out our resources too before opening an issue:
|
|
198
|
-
* Our [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/welcome.html) and [API reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/)
|
|
199
|
-
* Our [Changelog](https://github.com/aws/aws-sdk-js/blob/master/CHANGELOG.md) for recent changes.
|
|
200
|
-
* Our [code examples](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/sdk-code-samples.html).
|
|
201
|
-
|
|
202
|
-
Please see [SERVICES.md](https://github.com/aws/aws-sdk-js/blob/master/SERVICES.md) for a list of supported services.
|
|
203
|
-
|
|
204
|
-
# Maintenance and support for SDK major versions
|
|
205
|
-
For information about maintenance and support for SDK major versions and their underlying dependencies, see the following in the [AWS SDKs and Tools Shared Configuration and Credentials Reference Guide](https://docs.aws.amazon.com/credref/latest/refdocs/overview.html):
|
|
206
|
-
* [AWS SDKs and Tools Maintenance Policy](https://docs.aws.amazon.com/credref/latest/refdocs/maint-policy.html)
|
|
207
|
-
* [AWS SDKs and Tools Version Support Matrix](https://docs.aws.amazon.com/credref/latest/refdocs/version-support-matrix.html)
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
# Contributing
|
|
212
|
-
We welcome community contributions and pull requests. See [CONTRIBUTING.md](https://github.com/aws/aws-sdk-js/blob/master/CONTRIBUTING.md) for information on how to set up a development environment and submit code.
|
|
21
|
+
[aws-sdk]: https://www.npmjs.com/package/aws-sdk
|
|
22
|
+
[aws/aws-sdk-js]: https://github.com/aws/aws-sdk-js
|
|
23
|
+
[v2-end-of-support]: https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-aws-sdk-for-javascript-v2
|
|
24
|
+
[v3-contributing]: https://github.com/aws/aws-sdk-js-v3#giving-feedback-and-contributing
|
|
25
|
+
[v3-developer-guide]: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html
|
|
26
|
+
[v3-new-issue-migration]: https://github.com/aws/aws-sdk-js-v3/issues/new?assignees=&labels=needs-triage%2Cv2-v3-inconsistency&projects=&template=v2-to-v3-migration.yml&title=MIGRATION+ISSUE%3A+%5BYour+Title+Here%5D
|
|
27
|
+
[v3-recommended-blog]: https://aws.amazon.com/blogs/developer/why-and-how-you-should-use-aws-sdk-for-javascript-v3-on-node-js-18/
|
|
213
28
|
|
|
214
29
|
## License
|
|
215
30
|
|
|
@@ -292,11 +292,10 @@
|
|
|
292
292
|
{
|
|
293
293
|
"input": {
|
|
294
294
|
"Bucket": "examplebucket",
|
|
295
|
-
"Key": "HappyFace.jpg"
|
|
296
|
-
"VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
|
|
295
|
+
"Key": "HappyFace.jpg"
|
|
297
296
|
},
|
|
298
297
|
"output": {
|
|
299
|
-
"VersionId": "
|
|
298
|
+
"VersionId": "null"
|
|
300
299
|
},
|
|
301
300
|
"comments": {
|
|
302
301
|
"input": {
|
|
@@ -304,17 +303,18 @@
|
|
|
304
303
|
"output": {
|
|
305
304
|
}
|
|
306
305
|
},
|
|
307
|
-
"description": "The following example removes tag set associated with the specified object
|
|
308
|
-
"id": "to-remove-tag-set-from-an-object-
|
|
309
|
-
"title": "To remove tag set from an object
|
|
306
|
+
"description": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.",
|
|
307
|
+
"id": "to-remove-tag-set-from-an-object-1483145342862",
|
|
308
|
+
"title": "To remove tag set from an object"
|
|
310
309
|
},
|
|
311
310
|
{
|
|
312
311
|
"input": {
|
|
313
312
|
"Bucket": "examplebucket",
|
|
314
|
-
"Key": "HappyFace.jpg"
|
|
313
|
+
"Key": "HappyFace.jpg",
|
|
314
|
+
"VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
|
|
315
315
|
},
|
|
316
316
|
"output": {
|
|
317
|
-
"VersionId": "
|
|
317
|
+
"VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
|
|
318
318
|
},
|
|
319
319
|
"comments": {
|
|
320
320
|
"input": {
|
|
@@ -322,9 +322,9 @@
|
|
|
322
322
|
"output": {
|
|
323
323
|
}
|
|
324
324
|
},
|
|
325
|
-
"description": "The following example removes tag set associated with the specified object.
|
|
326
|
-
"id": "to-remove-tag-set-from-an-object-
|
|
327
|
-
"title": "To remove tag set from an object"
|
|
325
|
+
"description": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.",
|
|
326
|
+
"id": "to-remove-tag-set-from-an-object-version-1483145285913",
|
|
327
|
+
"title": "To remove tag set from an object version"
|
|
328
328
|
}
|
|
329
329
|
],
|
|
330
330
|
"DeleteObjects": [
|
|
@@ -728,17 +728,18 @@
|
|
|
728
728
|
{
|
|
729
729
|
"input": {
|
|
730
730
|
"Bucket": "examplebucket",
|
|
731
|
-
"Key": "
|
|
731
|
+
"Key": "SampleFile.txt",
|
|
732
|
+
"Range": "bytes=0-9"
|
|
732
733
|
},
|
|
733
734
|
"output": {
|
|
734
735
|
"AcceptRanges": "bytes",
|
|
735
|
-
"ContentLength": "
|
|
736
|
-
"
|
|
737
|
-
"
|
|
738
|
-
"
|
|
736
|
+
"ContentLength": "10",
|
|
737
|
+
"ContentRange": "bytes 0-9/43",
|
|
738
|
+
"ContentType": "text/plain",
|
|
739
|
+
"ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
|
|
740
|
+
"LastModified": "Thu, 09 Oct 2014 22:57:28 GMT",
|
|
739
741
|
"Metadata": {
|
|
740
742
|
},
|
|
741
|
-
"TagCount": 2,
|
|
742
743
|
"VersionId": "null"
|
|
743
744
|
},
|
|
744
745
|
"comments": {
|
|
@@ -747,25 +748,24 @@
|
|
|
747
748
|
"output": {
|
|
748
749
|
}
|
|
749
750
|
},
|
|
750
|
-
"description": "The following example retrieves an object for an S3 bucket.",
|
|
751
|
-
"id": "to-retrieve-an-object
|
|
752
|
-
"title": "To retrieve an object"
|
|
751
|
+
"description": "The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.",
|
|
752
|
+
"id": "to-retrieve-a-byte-range-of-an-object--1481832674603",
|
|
753
|
+
"title": "To retrieve a byte range of an object "
|
|
753
754
|
},
|
|
754
755
|
{
|
|
755
756
|
"input": {
|
|
756
757
|
"Bucket": "examplebucket",
|
|
757
|
-
"Key": "
|
|
758
|
-
"Range": "bytes=0-9"
|
|
758
|
+
"Key": "HappyFace.jpg"
|
|
759
759
|
},
|
|
760
760
|
"output": {
|
|
761
761
|
"AcceptRanges": "bytes",
|
|
762
|
-
"ContentLength": "
|
|
763
|
-
"
|
|
764
|
-
"
|
|
765
|
-
"
|
|
766
|
-
"LastModified": "Thu, 09 Oct 2014 22:57:28 GMT",
|
|
762
|
+
"ContentLength": "3191",
|
|
763
|
+
"ContentType": "image/jpeg",
|
|
764
|
+
"ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
765
|
+
"LastModified": "Thu, 15 Dec 2016 01:19:41 GMT",
|
|
767
766
|
"Metadata": {
|
|
768
767
|
},
|
|
768
|
+
"TagCount": 2,
|
|
769
769
|
"VersionId": "null"
|
|
770
770
|
},
|
|
771
771
|
"comments": {
|
|
@@ -774,9 +774,9 @@
|
|
|
774
774
|
"output": {
|
|
775
775
|
}
|
|
776
776
|
},
|
|
777
|
-
"description": "The following example retrieves an object for an S3 bucket.
|
|
778
|
-
"id": "to-retrieve-
|
|
779
|
-
"title": "To retrieve
|
|
777
|
+
"description": "The following example retrieves an object for an S3 bucket.",
|
|
778
|
+
"id": "to-retrieve-an-object-1481827837012",
|
|
779
|
+
"title": "To retrieve an object"
|
|
780
780
|
}
|
|
781
781
|
],
|
|
782
782
|
"GetObjectAcl": [
|
|
@@ -840,20 +840,17 @@
|
|
|
840
840
|
{
|
|
841
841
|
"input": {
|
|
842
842
|
"Bucket": "examplebucket",
|
|
843
|
-
"Key": "
|
|
843
|
+
"Key": "exampleobject",
|
|
844
|
+
"VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
|
|
844
845
|
},
|
|
845
846
|
"output": {
|
|
846
847
|
"TagSet": [
|
|
847
848
|
{
|
|
848
|
-
"Key": "
|
|
849
|
-
"Value": "
|
|
850
|
-
},
|
|
851
|
-
{
|
|
852
|
-
"Key": "Key3",
|
|
853
|
-
"Value": "Value3"
|
|
849
|
+
"Key": "Key1",
|
|
850
|
+
"Value": "Value1"
|
|
854
851
|
}
|
|
855
852
|
],
|
|
856
|
-
"VersionId": "
|
|
853
|
+
"VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
|
|
857
854
|
},
|
|
858
855
|
"comments": {
|
|
859
856
|
"input": {
|
|
@@ -861,24 +858,27 @@
|
|
|
861
858
|
"output": {
|
|
862
859
|
}
|
|
863
860
|
},
|
|
864
|
-
"description": "The following example retrieves tag set of an object.",
|
|
865
|
-
"id": "to-retrieve-tag-set-of-
|
|
866
|
-
"title": "To retrieve tag set of
|
|
861
|
+
"description": "The following example retrieves tag set of an object. The request specifies object version.",
|
|
862
|
+
"id": "to-retrieve-tag-set-of-a-specific-object-version-1483400283663",
|
|
863
|
+
"title": "To retrieve tag set of a specific object version"
|
|
867
864
|
},
|
|
868
865
|
{
|
|
869
866
|
"input": {
|
|
870
867
|
"Bucket": "examplebucket",
|
|
871
|
-
"Key": "
|
|
872
|
-
"VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
|
|
868
|
+
"Key": "HappyFace.jpg"
|
|
873
869
|
},
|
|
874
870
|
"output": {
|
|
875
871
|
"TagSet": [
|
|
876
872
|
{
|
|
877
|
-
"Key": "
|
|
878
|
-
"Value": "
|
|
873
|
+
"Key": "Key4",
|
|
874
|
+
"Value": "Value4"
|
|
875
|
+
},
|
|
876
|
+
{
|
|
877
|
+
"Key": "Key3",
|
|
878
|
+
"Value": "Value3"
|
|
879
879
|
}
|
|
880
880
|
],
|
|
881
|
-
"VersionId": "
|
|
881
|
+
"VersionId": "null"
|
|
882
882
|
},
|
|
883
883
|
"comments": {
|
|
884
884
|
"input": {
|
|
@@ -886,9 +886,9 @@
|
|
|
886
886
|
"output": {
|
|
887
887
|
}
|
|
888
888
|
},
|
|
889
|
-
"description": "The following example retrieves tag set of an object.
|
|
890
|
-
"id": "to-retrieve-tag-set-of-
|
|
891
|
-
"title": "To retrieve tag set of
|
|
889
|
+
"description": "The following example retrieves tag set of an object.",
|
|
890
|
+
"id": "to-retrieve-tag-set-of-an-object-1481833847896",
|
|
891
|
+
"title": "To retrieve tag set of an object"
|
|
892
892
|
}
|
|
893
893
|
],
|
|
894
894
|
"GetObjectTorrent": [
|
|
@@ -1567,16 +1567,13 @@
|
|
|
1567
1567
|
"PutObject": [
|
|
1568
1568
|
{
|
|
1569
1569
|
"input": {
|
|
1570
|
-
"Body": "
|
|
1570
|
+
"Body": "filetoupload",
|
|
1571
1571
|
"Bucket": "examplebucket",
|
|
1572
|
-
"Key": "
|
|
1573
|
-
"ServerSideEncryption": "AES256",
|
|
1574
|
-
"StorageClass": "STANDARD_IA"
|
|
1572
|
+
"Key": "objectkey"
|
|
1575
1573
|
},
|
|
1576
1574
|
"output": {
|
|
1577
1575
|
"ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
1578
|
-
"
|
|
1579
|
-
"VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
|
|
1576
|
+
"VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
|
|
1580
1577
|
},
|
|
1581
1578
|
"comments": {
|
|
1582
1579
|
"input": {
|
|
@@ -1584,19 +1581,23 @@
|
|
|
1584
1581
|
"output": {
|
|
1585
1582
|
}
|
|
1586
1583
|
},
|
|
1587
|
-
"description": "The following example
|
|
1588
|
-
"id": "to-
|
|
1589
|
-
"title": "To
|
|
1584
|
+
"description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.",
|
|
1585
|
+
"id": "to-create-an-object-1483147613675",
|
|
1586
|
+
"title": "To create an object."
|
|
1590
1587
|
},
|
|
1591
1588
|
{
|
|
1592
1589
|
"input": {
|
|
1593
1590
|
"Body": "filetoupload",
|
|
1594
1591
|
"Bucket": "examplebucket",
|
|
1595
|
-
"Key": "
|
|
1592
|
+
"Key": "exampleobject",
|
|
1593
|
+
"Metadata": {
|
|
1594
|
+
"metadata1": "value1",
|
|
1595
|
+
"metadata2": "value2"
|
|
1596
|
+
}
|
|
1596
1597
|
},
|
|
1597
1598
|
"output": {
|
|
1598
1599
|
"ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
1599
|
-
"VersionId": "
|
|
1600
|
+
"VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
|
|
1600
1601
|
},
|
|
1601
1602
|
"comments": {
|
|
1602
1603
|
"input": {
|
|
@@ -1604,9 +1605,9 @@
|
|
|
1604
1605
|
"output": {
|
|
1605
1606
|
}
|
|
1606
1607
|
},
|
|
1607
|
-
"description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.",
|
|
1608
|
-
"id": "to-
|
|
1609
|
-
"title": "To
|
|
1608
|
+
"description": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.",
|
|
1609
|
+
"id": "to-upload-object-and-specify-user-defined-metadata-1483396974757",
|
|
1610
|
+
"title": "To upload object and specify user-defined metadata"
|
|
1610
1611
|
},
|
|
1611
1612
|
{
|
|
1612
1613
|
"input": {
|
|
@@ -1630,14 +1631,14 @@
|
|
|
1630
1631
|
},
|
|
1631
1632
|
{
|
|
1632
1633
|
"input": {
|
|
1633
|
-
"
|
|
1634
|
+
"ACL": "authenticated-read",
|
|
1635
|
+
"Body": "filetoupload",
|
|
1634
1636
|
"Bucket": "examplebucket",
|
|
1635
|
-
"Key": "
|
|
1636
|
-
"Tagging": "key1=value1&key2=value2"
|
|
1637
|
+
"Key": "exampleobject"
|
|
1637
1638
|
},
|
|
1638
1639
|
"output": {
|
|
1639
1640
|
"ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
1640
|
-
"VersionId": "
|
|
1641
|
+
"VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
|
|
1641
1642
|
},
|
|
1642
1643
|
"comments": {
|
|
1643
1644
|
"input": {
|
|
@@ -1645,20 +1646,22 @@
|
|
|
1645
1646
|
"output": {
|
|
1646
1647
|
}
|
|
1647
1648
|
},
|
|
1648
|
-
"description": "The following example uploads
|
|
1649
|
-
"id": "to-upload-an-object-and-specify-
|
|
1650
|
-
"title": "To upload an object and specify
|
|
1649
|
+
"description": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.",
|
|
1650
|
+
"id": "to-upload-an-object-and-specify-canned-acl-1483397779571",
|
|
1651
|
+
"title": "To upload an object and specify canned ACL."
|
|
1651
1652
|
},
|
|
1652
1653
|
{
|
|
1653
1654
|
"input": {
|
|
1654
|
-
"
|
|
1655
|
-
"Body": "filetoupload",
|
|
1655
|
+
"Body": "HappyFace.jpg",
|
|
1656
1656
|
"Bucket": "examplebucket",
|
|
1657
|
-
"Key": "
|
|
1657
|
+
"Key": "HappyFace.jpg",
|
|
1658
|
+
"ServerSideEncryption": "AES256",
|
|
1659
|
+
"StorageClass": "STANDARD_IA"
|
|
1658
1660
|
},
|
|
1659
1661
|
"output": {
|
|
1660
1662
|
"ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
1661
|
-
"
|
|
1663
|
+
"ServerSideEncryption": "AES256",
|
|
1664
|
+
"VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
|
|
1662
1665
|
},
|
|
1663
1666
|
"comments": {
|
|
1664
1667
|
"input": {
|
|
@@ -1666,23 +1669,20 @@
|
|
|
1666
1669
|
"output": {
|
|
1667
1670
|
}
|
|
1668
1671
|
},
|
|
1669
|
-
"description": "The following example uploads
|
|
1670
|
-
"id": "to-upload-an-object-
|
|
1671
|
-
"title": "To upload an object
|
|
1672
|
+
"description": "The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.",
|
|
1673
|
+
"id": "to-upload-an-object-(specify-optional-headers)",
|
|
1674
|
+
"title": "To upload an object (specify optional headers)"
|
|
1672
1675
|
},
|
|
1673
1676
|
{
|
|
1674
1677
|
"input": {
|
|
1675
|
-
"Body": "
|
|
1678
|
+
"Body": "c:\\HappyFace.jpg",
|
|
1676
1679
|
"Bucket": "examplebucket",
|
|
1677
|
-
"Key": "
|
|
1678
|
-
"
|
|
1679
|
-
"metadata1": "value1",
|
|
1680
|
-
"metadata2": "value2"
|
|
1681
|
-
}
|
|
1680
|
+
"Key": "HappyFace.jpg",
|
|
1681
|
+
"Tagging": "key1=value1&key2=value2"
|
|
1682
1682
|
},
|
|
1683
1683
|
"output": {
|
|
1684
1684
|
"ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
1685
|
-
"VersionId": "
|
|
1685
|
+
"VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
|
|
1686
1686
|
},
|
|
1687
1687
|
"comments": {
|
|
1688
1688
|
"input": {
|
|
@@ -1690,9 +1690,9 @@
|
|
|
1690
1690
|
"output": {
|
|
1691
1691
|
}
|
|
1692
1692
|
},
|
|
1693
|
-
"description": "The following example
|
|
1694
|
-
"id": "to-upload-object-and-specify-
|
|
1695
|
-
"title": "To upload object and specify
|
|
1693
|
+
"description": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.",
|
|
1694
|
+
"id": "to-upload-an-object-and-specify-optional-tags-1481762310955",
|
|
1695
|
+
"title": "To upload an object and specify optional tags"
|
|
1696
1696
|
},
|
|
1697
1697
|
{
|
|
1698
1698
|
"input": {
|
|
@@ -1826,14 +1826,15 @@
|
|
|
1826
1826
|
"input": {
|
|
1827
1827
|
"Bucket": "examplebucket",
|
|
1828
1828
|
"CopySource": "/bucketname/sourceobjectkey",
|
|
1829
|
+
"CopySourceRange": "bytes=1-100000",
|
|
1829
1830
|
"Key": "examplelargeobject",
|
|
1830
|
-
"PartNumber": "
|
|
1831
|
+
"PartNumber": "2",
|
|
1831
1832
|
"UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
|
|
1832
1833
|
},
|
|
1833
1834
|
"output": {
|
|
1834
1835
|
"CopyPartResult": {
|
|
1835
|
-
"ETag": "\"
|
|
1836
|
-
"LastModified": "2016-12-29T21:
|
|
1836
|
+
"ETag": "\"65d16d19e65a7508a51f043180edcc36\"",
|
|
1837
|
+
"LastModified": "2016-12-29T21:44:28.000Z"
|
|
1837
1838
|
}
|
|
1838
1839
|
},
|
|
1839
1840
|
"comments": {
|
|
@@ -1842,23 +1843,22 @@
|
|
|
1842
1843
|
"output": {
|
|
1843
1844
|
}
|
|
1844
1845
|
},
|
|
1845
|
-
"description": "The following example uploads a part of a multipart upload by copying
|
|
1846
|
-
"id": "to-upload-a-part-by-copying-
|
|
1847
|
-
"title": "To upload a part by copying
|
|
1846
|
+
"description": "The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.",
|
|
1847
|
+
"id": "to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594",
|
|
1848
|
+
"title": "To upload a part by copying byte range from an existing object as data source"
|
|
1848
1849
|
},
|
|
1849
1850
|
{
|
|
1850
1851
|
"input": {
|
|
1851
1852
|
"Bucket": "examplebucket",
|
|
1852
1853
|
"CopySource": "/bucketname/sourceobjectkey",
|
|
1853
|
-
"CopySourceRange": "bytes=1-100000",
|
|
1854
1854
|
"Key": "examplelargeobject",
|
|
1855
|
-
"PartNumber": "
|
|
1855
|
+
"PartNumber": "1",
|
|
1856
1856
|
"UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
|
|
1857
1857
|
},
|
|
1858
1858
|
"output": {
|
|
1859
1859
|
"CopyPartResult": {
|
|
1860
|
-
"ETag": "\"
|
|
1861
|
-
"LastModified": "2016-12-29T21:
|
|
1860
|
+
"ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
|
1861
|
+
"LastModified": "2016-12-29T21:24:43.000Z"
|
|
1862
1862
|
}
|
|
1863
1863
|
},
|
|
1864
1864
|
"comments": {
|
|
@@ -1867,9 +1867,9 @@
|
|
|
1867
1867
|
"output": {
|
|
1868
1868
|
}
|
|
1869
1869
|
},
|
|
1870
|
-
"description": "The following example uploads a part of a multipart upload by copying
|
|
1871
|
-
"id": "to-upload-a-part-by-copying-
|
|
1872
|
-
"title": "To upload a part by copying
|
|
1870
|
+
"description": "The following example uploads a part of a multipart upload by copying data from an existing object as data source.",
|
|
1871
|
+
"id": "to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348",
|
|
1872
|
+
"title": "To upload a part by copying data from an existing object as data source"
|
|
1873
1873
|
}
|
|
1874
1874
|
]
|
|
1875
1875
|
}
|