@aws-sdk/client-wickr 3.1008.0 → 3.1009.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.
Files changed (2) hide show
  1. package/README.md +26 -46
  2. package/package.json +33 -33
package/README.md CHANGED
@@ -9,8 +9,9 @@ AWS SDK for JavaScript Wickr Client for Node.js, Browser and React Native.
9
9
  <p>Welcome to the <i>Amazon Web Services Wickr API Reference</i>.</p> <p>The Amazon Web Services Wickr application programming interface (API) is designed for administrators to perform key tasks, such as creating and managing Amazon Web Services Wickr, networks, users, security groups, bots and more. This guide provides detailed information about the Amazon Web Services Wickr API, including operations, types, inputs and outputs, and error codes. You can use an Amazon Web Services SDK, the Amazon Web Services Command Line Interface (Amazon Web Services CLI, or the REST API to make API calls for Amazon Web Services Wickr. </p> <p> <i>Using Amazon Web Services SDK</i> </p> <p>The SDK clients authenticate your requests by using access keys that you provide. For more information, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/access.html">Authentication and access using Amazon Web Services SDKs and tools</a> in the <i>Amazon Web Services SDKs and Tools Reference Guide</i>. </p> <p> <i>Using Amazon Web Services CLI</i> </p> <p>Use your access keys with the Amazon Web Services CLI to make API calls. For more information about setting up the Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html">Getting started with the Amazon Web Services CLI</a> in the <i>Amazon Web Services Command Line Interface User Guide for Version 2</i>. </p> <p> <i>Using REST APIs</i> </p> <p>If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Web Services Wickr supports Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html">Amazon Web Services Signature Version 4 for API requests</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>. </p> <p>Access and permissions to the APIs can be controlled by Amazon Web Services Identity and Access Management. The managed policy <a href="https://docs.aws.amazon.com/wickr/latest/adminguide/security-iam-awsmanpol.html#security-iam-awsmanpol-AWSWickrFullAccess">Amazon Web ServicesWickrFullAccess</a> grants full administrative permission to the Amazon Web Services Wickr service APIs. For more information on restricting access to specific operations, see <a href="https://docs.aws.amazon.com/wickr/latest/adminguide/security-iam.html">Identity and access management for Amazon Web Services Wickr </a> in the <i>Amazon Web Services Wickr Administration Guide</i>. </p> <p> <i>Types of Errors</i>:</p> <p>The Amazon Web Services Wickr APIs provide an HTTP interface. HTTP defines ranges of HTTP Status Codes for different types of error responses.</p> <ol> <li> <p>Client errors are indicated by HTTP Status Code class of 4xx</p> </li> <li> <p>Service errors are indicated by HTTP Status Code class of 5xx</p> </li> </ol> <p>In this reference guide, the documentation for each API has an Errors section that includes a brief discussion about HTTP status codes. We recommend looking there as part of your investigation when you get an error.</p>
10
10
 
11
11
  ## Installing
12
- To install this package, simply type add or install @aws-sdk/client-wickr
13
- using your favorite package manager:
12
+
13
+ To install this package, use the CLI of your favorite package manager:
14
+
14
15
  - `npm install @aws-sdk/client-wickr`
15
16
  - `yarn add @aws-sdk/client-wickr`
16
17
  - `pnpm add @aws-sdk/client-wickr`
@@ -35,15 +36,15 @@ import { WickrClient, ListBotsCommand } from "@aws-sdk/client-wickr";
35
36
 
36
37
  ### Usage
37
38
 
38
- To send a request, you:
39
+ To send a request:
39
40
 
40
- - Initiate client with configuration (e.g. credentials, region).
41
- - Initiate command with input parameters.
42
- - Call `send` operation on client with command object as input.
43
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
41
+ - Instantiate a client with configuration (e.g. credentials, region).
42
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
43
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
44
+ - Instantiate a command with input parameters.
45
+ - Call the `send` operation on the client, providing the command object as input.
44
46
 
45
47
  ```js
46
- // a client can be shared by different commands.
47
48
  const client = new WickrClient({ region: "REGION" });
48
49
 
49
50
  const params = { /** input parameters */ };
@@ -52,7 +53,7 @@ const command = new ListBotsCommand(params);
52
53
 
53
54
  #### Async/await
54
55
 
55
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
56
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
56
57
  operator to wait for the promise returned by send operation as follows:
57
58
 
58
59
  ```js
@@ -67,26 +68,9 @@ try {
67
68
  }
68
69
  ```
69
70
 
70
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
71
- as compared to using Promise chains or callbacks.
72
-
73
71
  #### Promises
74
72
 
75
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
76
- to execute send operation.
77
-
78
- ```js
79
- client.send(command).then(
80
- (data) => {
81
- // process data.
82
- },
83
- (error) => {
84
- // error handling.
85
- }
86
- );
87
- ```
88
-
89
- Promises can also be called using `.catch()` and `.finally()` as follows:
73
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
90
74
 
91
75
  ```js
92
76
  client
@@ -102,27 +86,21 @@ client
102
86
  });
103
87
  ```
104
88
 
105
- #### Callbacks
106
-
107
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
108
- but they are supported by the send operation.
89
+ #### Aggregated client
109
90
 
110
- ```js
111
- // callbacks.
112
- client.send(command, (err, data) => {
113
- // process err and data.
114
- });
115
- ```
91
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
116
92
 
117
- #### v2 compatible style
93
+ `Wickr` extends `WickrClient` and additionally supports all operations, waiters, and paginators as methods.
94
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
118
95
 
119
- The client can also send requests using v2 compatible style.
120
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
121
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
96
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`WickrClient`).
97
+ More details are in the blog post on
98
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
122
99
 
123
100
  ```ts
124
- import * as AWS from "@aws-sdk/client-wickr";
125
- const client = new AWS.Wickr({ region: "REGION" });
101
+ import { Wickr } from "@aws-sdk/client-wickr";
102
+
103
+ const client = new Wickr({ region: "REGION" });
126
104
 
127
105
  // async/await.
128
106
  try {
@@ -142,7 +120,7 @@ client
142
120
  // error handling.
143
121
  });
144
122
 
145
- // callbacks.
123
+ // callbacks (not recommended).
146
124
  client.listBots(params, (err, data) => {
147
125
  // process err and data.
148
126
  });
@@ -170,12 +148,14 @@ try {
170
148
  }
171
149
  ```
172
150
 
151
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
152
+
173
153
  ## Getting Help
174
154
 
175
155
  Please use these community resources for getting help.
176
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
156
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
177
157
 
178
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
158
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
179
159
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
180
160
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
181
161
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-wickr",
3
3
  "description": "AWS SDK for JavaScript Wickr Client for Node.js, Browser and React Native",
4
- "version": "3.1008.0",
4
+ "version": "3.1009.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-wickr",
@@ -21,41 +21,41 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "5.2.0",
23
23
  "@aws-crypto/sha256-js": "5.2.0",
24
- "@aws-sdk/core": "^3.973.19",
25
- "@aws-sdk/credential-provider-node": "^3.972.20",
26
- "@aws-sdk/middleware-host-header": "^3.972.7",
27
- "@aws-sdk/middleware-logger": "^3.972.7",
28
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
29
- "@aws-sdk/middleware-user-agent": "^3.972.20",
30
- "@aws-sdk/region-config-resolver": "^3.972.7",
31
- "@aws-sdk/types": "^3.973.5",
32
- "@aws-sdk/util-endpoints": "^3.996.4",
33
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
34
- "@aws-sdk/util-user-agent-node": "^3.973.6",
35
- "@smithy/config-resolver": "^4.4.10",
36
- "@smithy/core": "^3.23.9",
37
- "@smithy/fetch-http-handler": "^5.3.13",
38
- "@smithy/hash-node": "^4.2.11",
39
- "@smithy/invalid-dependency": "^4.2.11",
40
- "@smithy/middleware-content-length": "^4.2.11",
41
- "@smithy/middleware-endpoint": "^4.4.23",
42
- "@smithy/middleware-retry": "^4.4.40",
43
- "@smithy/middleware-serde": "^4.2.12",
44
- "@smithy/middleware-stack": "^4.2.11",
45
- "@smithy/node-config-provider": "^4.3.11",
46
- "@smithy/node-http-handler": "^4.4.14",
47
- "@smithy/protocol-http": "^5.3.11",
48
- "@smithy/smithy-client": "^4.12.3",
49
- "@smithy/types": "^4.13.0",
50
- "@smithy/url-parser": "^4.2.11",
24
+ "@aws-sdk/core": "^3.973.20",
25
+ "@aws-sdk/credential-provider-node": "^3.972.21",
26
+ "@aws-sdk/middleware-host-header": "^3.972.8",
27
+ "@aws-sdk/middleware-logger": "^3.972.8",
28
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
29
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
30
+ "@aws-sdk/region-config-resolver": "^3.972.8",
31
+ "@aws-sdk/types": "^3.973.6",
32
+ "@aws-sdk/util-endpoints": "^3.996.5",
33
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
34
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
35
+ "@smithy/config-resolver": "^4.4.11",
36
+ "@smithy/core": "^3.23.11",
37
+ "@smithy/fetch-http-handler": "^5.3.15",
38
+ "@smithy/hash-node": "^4.2.12",
39
+ "@smithy/invalid-dependency": "^4.2.12",
40
+ "@smithy/middleware-content-length": "^4.2.12",
41
+ "@smithy/middleware-endpoint": "^4.4.25",
42
+ "@smithy/middleware-retry": "^4.4.42",
43
+ "@smithy/middleware-serde": "^4.2.14",
44
+ "@smithy/middleware-stack": "^4.2.12",
45
+ "@smithy/node-config-provider": "^4.3.12",
46
+ "@smithy/node-http-handler": "^4.4.16",
47
+ "@smithy/protocol-http": "^5.3.12",
48
+ "@smithy/smithy-client": "^4.12.5",
49
+ "@smithy/types": "^4.13.1",
50
+ "@smithy/url-parser": "^4.2.12",
51
51
  "@smithy/util-base64": "^4.3.2",
52
52
  "@smithy/util-body-length-browser": "^4.2.2",
53
53
  "@smithy/util-body-length-node": "^4.2.3",
54
- "@smithy/util-defaults-mode-browser": "^4.3.39",
55
- "@smithy/util-defaults-mode-node": "^4.2.42",
56
- "@smithy/util-endpoints": "^3.3.2",
57
- "@smithy/util-middleware": "^4.2.11",
58
- "@smithy/util-retry": "^4.2.11",
54
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
55
+ "@smithy/util-defaults-mode-node": "^4.2.44",
56
+ "@smithy/util-endpoints": "^3.3.3",
57
+ "@smithy/util-middleware": "^4.2.12",
58
+ "@smithy/util-retry": "^4.2.12",
59
59
  "@smithy/util-utf8": "^4.2.2",
60
60
  "tslib": "^2.6.2"
61
61
  },