@aws-sdk/client-cloudfront-keyvaluestore 3.775.0 → 3.777.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 (7) hide show
  1. package/dist-types/commands/DeleteKeyCommand.d.ts +21 -1
  2. package/dist-types/commands/DescribeKeyValueStoreCommand.d.ts +44 -0
  3. package/dist-types/commands/GetKeyCommand.d.ts +20 -0
  4. package/dist-types/commands/ListKeysCommand.d.ts +62 -0
  5. package/dist-types/commands/PutKeyCommand.d.ts +21 -0
  6. package/dist-types/commands/UpdateKeysCommand.d.ts +91 -0
  7. package/package.json +2 -2
package/dist-types/commands/DeleteKeyCommand.d.ts CHANGED
@@ -24,7 +24,7 @@ export interface DeleteKeyCommandOutput extends DeleteKeyResponse, __MetadataBea
24
24
  declare const DeleteKeyCommand_base: {
25
25
  new (input: DeleteKeyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteKeyCommandInput, DeleteKeyCommandOutput, CloudFrontKeyValueStoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
26
  new (__0_0: DeleteKeyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteKeyCommandInput, DeleteKeyCommandOutput, CloudFrontKeyValueStoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
- getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; /** @internal type navigation helper, not in runtime. */
28
28
  };
29
29
  /**
30
30
  * <p>Deletes the key value pair specified by the key.</p>
@@ -76,6 +76,26 @@ declare const DeleteKeyCommand_base: {
76
76
  * @throws {@link CloudFrontKeyValueStoreServiceException}
77
77
  * <p>Base exception class for all service exceptions from CloudFrontKeyValueStore service.</p>
78
78
  *
79
+ *
80
+ * @example Delete 'key1' from the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'
81
+ * ```javascript
82
+ * //
83
+ * const input = {
84
+ * IfMatch: "KV0AB12C3DEF456",
85
+ * Key: "key1",
86
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58"
87
+ * };
88
+ * const command = new DeleteKeyCommand(input);
89
+ * const response = await client.send(command);
90
+ * /* response is
91
+ * {
92
+ * ETag: "KV7XY89Z0ABC012",
93
+ * ItemCount: 3,
94
+ * TotalSizeInBytes: 5
95
+ * }
96
+ * *\/
97
+ * ```
98
+ *
79
99
  * @public
80
100
  */
81
101
  export declare class DeleteKeyCommand extends DeleteKeyCommand_base {
package/dist-types/commands/DescribeKeyValueStoreCommand.d.ts CHANGED
@@ -73,6 +73,50 @@ declare const DescribeKeyValueStoreCommand_base: {
73
73
  * @throws {@link CloudFrontKeyValueStoreServiceException}
74
74
  * <p>Base exception class for all service exceptions from CloudFrontKeyValueStore service.</p>
75
75
  *
76
+ *
77
+ * @example Describe the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'
78
+ * ```javascript
79
+ * //
80
+ * const input = {
81
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58"
82
+ * };
83
+ * const command = new DescribeKeyValueStoreCommand(input);
84
+ * const response = await client.send(command);
85
+ * /* response is
86
+ * {
87
+ * Created: "2023-11-01T22:18:46Z",
88
+ * ETag: "KV7XY89Z0ABC012",
89
+ * FailureReason: "Datasource size exceeds the allowed limit",
90
+ * ItemCount: 0,
91
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58",
92
+ * LastModified: "2023-11-01T14:28:17Z",
93
+ * Status: "IMPORT_FAILURE",
94
+ * TotalSizeInBytes: 0
95
+ * }
96
+ * *\/
97
+ * ```
98
+ *
99
+ * @example Describe the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-1234a9d35678'
100
+ * ```javascript
101
+ * //
102
+ * const input = {
103
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-1234a9d35678"
104
+ * };
105
+ * const command = new DescribeKeyValueStoreCommand(input);
106
+ * const response = await client.send(command);
107
+ * /* response is
108
+ * {
109
+ * Created: "2023-11-01T22:18:46Z",
110
+ * ETag: "KV7XY89Z0ABC012",
111
+ * ItemCount: 4,
112
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-1234a9d35678",
113
+ * LastModified: "2023-11-01T14:28:17Z",
114
+ * Status: "READY",
115
+ * TotalSizeInBytes: 15
116
+ * }
117
+ * *\/
118
+ * ```
119
+ *
76
120
  * @public
77
121
  */
78
122
  export declare class DescribeKeyValueStoreCommand extends DescribeKeyValueStoreCommand_base {
package/dist-types/commands/GetKeyCommand.d.ts CHANGED
@@ -70,6 +70,26 @@ declare const GetKeyCommand_base: {
70
70
  * @throws {@link CloudFrontKeyValueStoreServiceException}
71
71
  * <p>Base exception class for all service exceptions from CloudFrontKeyValueStore service.</p>
72
72
  *
73
+ *
74
+ * @example Get 'key1' from the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'
75
+ * ```javascript
76
+ * //
77
+ * const input = {
78
+ * Key: "key1",
79
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58"
80
+ * };
81
+ * const command = new GetKeyCommand(input);
82
+ * const response = await client.send(command);
83
+ * /* response is
84
+ * {
85
+ * ItemCount: 4,
86
+ * Key: "key1",
87
+ * TotalSizeInBytes: 15,
88
+ * Value: "value1"
89
+ * }
90
+ * *\/
91
+ * ```
92
+ *
73
93
  * @public
74
94
  */
75
95
  export declare class GetKeyCommand extends GetKeyCommand_base {
package/dist-types/commands/ListKeysCommand.d.ts CHANGED
@@ -77,6 +77,68 @@ declare const ListKeysCommand_base: {
77
77
  * @throws {@link CloudFrontKeyValueStoreServiceException}
78
78
  * <p>Base exception class for all service exceptions from CloudFrontKeyValueStore service.</p>
79
79
  *
80
+ *
81
+ * @example List keys in the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'
82
+ * ```javascript
83
+ * //
84
+ * const input = {
85
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58",
86
+ * MaxResults: 3
87
+ * };
88
+ * const command = new ListKeysCommand(input);
89
+ * const response = await client.send(command);
90
+ * /* response is
91
+ * {
92
+ * Items: [
93
+ * {
94
+ * Key: "key1",
95
+ * Value: "value1"
96
+ * },
97
+ * {
98
+ * Key: "key2",
99
+ * Value: "value2"
100
+ * },
101
+ * {
102
+ * Key: "key3",
103
+ * Value: "value3"
104
+ * }
105
+ * ],
106
+ * NextToken: "hVTTZndkpBZ0VRZ0R1RF"
107
+ * }
108
+ * *\/
109
+ * ```
110
+ *
111
+ * @example List the next page in the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'
112
+ * ```javascript
113
+ * //
114
+ * const input = {
115
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58",
116
+ * MaxResults: 3,
117
+ * NextToken: "hVTTZndkpBZ0VRZ0R1RF"
118
+ * };
119
+ * const command = new ListKeysCommand(input);
120
+ * const response = await client.send(command);
121
+ * /* response is
122
+ * {
123
+ * Items: [
124
+ * {
125
+ * Key: "key4",
126
+ * Value: "value4"
127
+ * },
128
+ * {
129
+ * Key: "key5",
130
+ * Value: "value5"
131
+ * },
132
+ * {
133
+ * Key: "key6",
134
+ * Value: "value6"
135
+ * }
136
+ * ],
137
+ * NextToken: "hQTlB5YmM5UFNoFQvMk"
138
+ * }
139
+ * *\/
140
+ * ```
141
+ *
80
142
  * @public
81
143
  */
82
144
  export declare class ListKeysCommand extends ListKeysCommand_base {
package/dist-types/commands/PutKeyCommand.d.ts CHANGED
@@ -77,6 +77,27 @@ declare const PutKeyCommand_base: {
77
77
  * @throws {@link CloudFrontKeyValueStoreServiceException}
78
78
  * <p>Base exception class for all service exceptions from CloudFrontKeyValueStore service.</p>
79
79
  *
80
+ *
81
+ * @example Put 'key1' with 'value1' into the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'
82
+ * ```javascript
83
+ * //
84
+ * const input = {
85
+ * IfMatch: "KV0AB12C3DEF456",
86
+ * Key: "key1",
87
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58",
88
+ * Value: "value1"
89
+ * };
90
+ * const command = new PutKeyCommand(input);
91
+ * const response = await client.send(command);
92
+ * /* response is
93
+ * {
94
+ * ETag: "KV7XY89Z0ABC012",
95
+ * ItemCount: 4,
96
+ * TotalSizeInBytes: 15
97
+ * }
98
+ * *\/
99
+ * ```
100
+ *
80
101
  * @public
81
102
  */
82
103
  export declare class PutKeyCommand extends PutKeyCommand_base {
package/dist-types/commands/UpdateKeysCommand.d.ts CHANGED
@@ -86,6 +86,97 @@ declare const UpdateKeysCommand_base: {
86
86
  * @throws {@link CloudFrontKeyValueStoreServiceException}
87
87
  * <p>Base exception class for all service exceptions from CloudFrontKeyValueStore service.</p>
88
88
  *
89
+ *
90
+ * @example Put 2 keys into the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'
91
+ * ```javascript
92
+ * //
93
+ * const input = {
94
+ * IfMatch: "KV0AB12C3DEF456",
95
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58",
96
+ * Puts: [
97
+ * {
98
+ * Key: "key1",
99
+ * Value: "value1"
100
+ * },
101
+ * {
102
+ * Key: "key2",
103
+ * Value: "value2"
104
+ * }
105
+ * ]
106
+ * };
107
+ * const command = new UpdateKeysCommand(input);
108
+ * const response = await client.send(command);
109
+ * /* response is
110
+ * {
111
+ * ETag: "KV7XY89Z0ABC012",
112
+ * ItemCount: 4,
113
+ * TotalSizeInBytes: 15
114
+ * }
115
+ * *\/
116
+ * ```
117
+ *
118
+ * @example Delete 2 keys from the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'
119
+ * ```javascript
120
+ * //
121
+ * const input = {
122
+ * Deletes: [
123
+ * {
124
+ * Key: "key1"
125
+ * },
126
+ * {
127
+ * Key: "key2"
128
+ * }
129
+ * ],
130
+ * IfMatch: "KV0AB12C3DEF456",
131
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58"
132
+ * };
133
+ * const command = new UpdateKeysCommand(input);
134
+ * const response = await client.send(command);
135
+ * /* response is
136
+ * {
137
+ * ETag: "KV7XY89Z0ABC012",
138
+ * ItemCount: 4,
139
+ * TotalSizeInBytes: 15
140
+ * }
141
+ * *\/
142
+ * ```
143
+ *
144
+ * @example Put 2 keys into and delete 1 key from the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'
145
+ * ```javascript
146
+ * //
147
+ * const input = {
148
+ * Deletes: [
149
+ * {
150
+ * Key: "key3"
151
+ * },
152
+ * {
153
+ * Key: "key4"
154
+ * }
155
+ * ],
156
+ * IfMatch: "KV0AB12C3DEF456",
157
+ * KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58",
158
+ * Puts: [
159
+ * {
160
+ * Key: "key1",
161
+ * Value: "value1"
162
+ * },
163
+ * {
164
+ * Key: "key2",
165
+ * Value: "value2"
166
+ * }
167
+ * ]
168
+ * };
169
+ * const command = new UpdateKeysCommand(input);
170
+ * const response = await client.send(command);
171
+ * /* response is
172
+ * {
173
+ * ETag: "KV7XY89Z0ABC012",
174
+ * ItemCount: 4,
175
+ * TotalSizeInBytes: 15
176
+ * }
177
+ * *\/
178
+ * ```
179
+ *
89
180
  * @public
90
181
  */
91
182
  export declare class UpdateKeysCommand extends UpdateKeysCommand_base {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloudfront-keyvaluestore",
3
3
  "description": "AWS SDK for JavaScript Cloudfront Keyvaluestore Client for Node.js, Browser and React Native",
4
- "version": "3.775.0",
4
+ "version": "3.777.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-cloudfront-keyvaluestore",
@@ -21,7 +21,7 @@
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
23
  "@aws-sdk/core": "3.775.0",
24
- "@aws-sdk/credential-provider-node": "3.775.0",
24
+ "@aws-sdk/credential-provider-node": "3.777.0",
25
25
  "@aws-sdk/middleware-host-header": "3.775.0",
26
26
  "@aws-sdk/middleware-logger": "3.775.0",
27
27
  "@aws-sdk/middleware-recursion-detection": "3.775.0",