@aws-sdk/client-cloudfront 3.456.0 → 3.457.0

package/dist-types/commands/CreateFunctionCommand.d.ts

@@ -116,6 +116,58 @@ export interface CreateFunctionCommandOutput extends CreateFunctionResult, __Met
  * @throws {@link CloudFrontServiceException}
  * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
+ * @example To create a function
+ * ```javascript
+ * // Use the following command to create a function.
+ * const input = {
+ *   "FunctionCode": "function-code.js",
+ *   "FunctionConfig": {
+ *     "Comment": "my-function-comment",
+ *     "KeyValueStoreAssociations": {
+ *       "Items": [
+ *         {
+ *           "KeyValueStoreARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889"
+ *         }
+ *       ],
+ *       "Quantity": 1
+ *     },
+ *     "Runtime": "cloudfront-js-2.0"
+ *   },
+ *   "Name": "my-function-name"
+ * };
+ * const command = new CreateFunctionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ETag": "ETVPDKIKX0DER",
+ *   "FunctionSummary": {
+ *     "FunctionConfig": {
+ *       "Comment": "my-function-comment",
+ *       "KeyValueStoreAssociations": {
+ *         "Items": [
+ *           {
+ *             "KeyValueStoreARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889"
+ *           }
+ *         ],
+ *         "Quantity": 1
+ *       },
+ *       "Runtime": "cloudfront-js-2.0"
+ *     },
+ *     "FunctionMetadata": {
+ *       "CreatedTime": "2023-11-07T19:53:50.334Z",
+ *       "FunctionARN": "arn:aws:cloudfront::123456789012:function/my-function-name",
+ *       "LastModifiedTime": "2023-11-07T19:53:50.334Z",
+ *       "Stage": "DEVELOPMENT"
+ *     },
+ *     "Name": "my-function-name",
+ *     "Status": "UNPUBLISHED"
+ *   },
+ *   "Location": "https://cloudfront.amazonaws.com/2020-05-31/function/arn:aws:cloudfront::123456789012:function/my-function-name"
+ * }
+ * *\/
+ * // example id: to-create-a-function-1699737558249
+ * ```
+ *
  */
 export declare class CreateFunctionCommand extends $Command<CreateFunctionCommandInput, CreateFunctionCommandOutput, CloudFrontClientResolvedConfig> {
     readonly input: CreateFunctionCommandInput;

package/dist-types/commands/CreateKeyValueStoreCommand.d.ts

@@ -80,6 +80,36 @@ export interface CreateKeyValueStoreCommandOutput extends CreateKeyValueStoreRes
  * @throws {@link CloudFrontServiceException}
  * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
+ * @example To create a KeyValueStore
+ * ```javascript
+ * // Use the following command to create a KeyValueStore.
+ * const input = {
+ *   "Comment": "my-key-valuestore-comment",
+ *   "ImportSource": {
+ *     "SourceARN": "arn:aws:s3:::my-bucket/validJSON.json",
+ *     "SourceType": "S3"
+ *   },
+ *   "Name": "my-keyvaluestore-name"
+ * };
+ * const command = new CreateKeyValueStoreCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ETag": "ETVPDKIKX0DER",
+ *   "KeyValueStore": {
+ *     "ARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889",
+ *     "Comment": "my-key-valuestore-comment",
+ *     "Id": "54947df8-0e9e-4471-a2f9-9af509fb5889",
+ *     "LastModifiedTime": "2023-11-07T18:15:52.042Z",
+ *     "Name": "my-keyvaluestore-name",
+ *     "Status": "PROVISIONING"
+ *   },
+ *   "Location": "https://cloudfront.amazonaws.com/2020-05-31/key-value-store/arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889"
+ * }
+ * *\/
+ * // example id: to-create-a-key-value-store-1699751722467
+ * ```
+ *
  */
 export declare class CreateKeyValueStoreCommand extends $Command<CreateKeyValueStoreCommandInput, CreateKeyValueStoreCommandOutput, CloudFrontClientResolvedConfig> {
     readonly input: CreateKeyValueStoreCommandInput;

package/dist-types/commands/DeleteKeyValueStoreCommand.d.ts

@@ -65,6 +65,18 @@ export interface DeleteKeyValueStoreCommandOutput extends __MetadataBearer {
  * @throws {@link CloudFrontServiceException}
  * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
+ * @example To delete a KeyValueStore
+ * ```javascript
+ * // Use the following command to delete a KeyValueStore.
+ * const input = {
+ *   "IfMatch": "ETVPDKIKX0DER",
+ *   "Name": "my-keyvaluestore-name"
+ * };
+ * const command = new DeleteKeyValueStoreCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-key-value-store-1699751759648
+ * ```
+ *
  */
 export declare class DeleteKeyValueStoreCommand extends $Command<DeleteKeyValueStoreCommandInput, DeleteKeyValueStoreCommandOutput, CloudFrontClientResolvedConfig> {
     readonly input: DeleteKeyValueStoreCommandInput;

package/dist-types/commands/DescribeKeyValueStoreCommand.d.ts

@@ -67,6 +67,30 @@ export interface DescribeKeyValueStoreCommandOutput extends DescribeKeyValueStor
  * @throws {@link CloudFrontServiceException}
  * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
+ * @example To describe a KeyValueStore
+ * ```javascript
+ * // Use the following command to describe a KeyValueStore.
+ * const input = {
+ *   "Name": "my-keyvaluestore-name"
+ * };
+ * const command = new DescribeKeyValueStoreCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ETag": "ETVPDKIKX0DER",
+ *   "KeyValueStore": {
+ *     "ARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889",
+ *     "Comment": "my-key-valuestore-comment",
+ *     "Id": "54947df8-0e9e-4471-a2f9-9af509fb5889",
+ *     "LastModifiedTime": "2023-11-07T18:20:33.056Z",
+ *     "Name": "my-keyvaluestore-name",
+ *     "Status": "READY"
+ *   }
+ * }
+ * *\/
+ * // example id: to-describe-a-key-value-store-1699751788152
+ * ```
+ *
  */
 export declare class DescribeKeyValueStoreCommand extends $Command<DescribeKeyValueStoreCommandInput, DescribeKeyValueStoreCommandOutput, CloudFrontClientResolvedConfig> {
     readonly input: DescribeKeyValueStoreCommandInput;

package/dist-types/commands/ListKeyValueStoresCommand.d.ts

@@ -72,6 +72,38 @@ export interface ListKeyValueStoresCommandOutput extends ListKeyValueStoresResul
  * @throws {@link CloudFrontServiceException}
  * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
+ * @example To get a list of KeyValueStores
+ * ```javascript
+ * // The following command retrieves a list of KeyValueStores with READY status.
+ * const input = {
+ *   "Marker": "",
+ *   "MaxItems": "100",
+ *   "Status": "READY"
+ * };
+ * const command = new ListKeyValueStoresCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "KeyValueStoreList": {
+ *     "Items": [
+ *       {
+ *         "ARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889",
+ *         "Comment": "",
+ *         "Id": "54947df8-0e9e-4471-a2f9-9af509fb5889",
+ *         "LastModifiedTime": "2023-11-07T18:45:21.069Z",
+ *         "Name": "my-keyvaluestore-name",
+ *         "Status": "READY"
+ *       }
+ *     ],
+ *     "MaxItems": 100,
+ *     "NextMarker": "",
+ *     "Quantity": 1
+ *   }
+ * }
+ * *\/
+ * // example id: to-get-a-list-of-key-value-store-1699751799198
+ * ```
+ *
  */
 export declare class ListKeyValueStoresCommand extends $Command<ListKeyValueStoresCommandInput, ListKeyValueStoresCommandOutput, CloudFrontClientResolvedConfig> {
     readonly input: ListKeyValueStoresCommandInput;

package/dist-types/commands/UpdateFunctionCommand.d.ts

@@ -111,6 +111,58 @@ export interface UpdateFunctionCommandOutput extends UpdateFunctionResult, __Met
  * @throws {@link CloudFrontServiceException}
  * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
+ * @example To update a function
+ * ```javascript
+ * // Use the following command to update a function.
+ * const input = {
+ *   "FunctionCode": "function-code-changed.js",
+ *   "FunctionConfig": {
+ *     "Comment": "my-changed-comment",
+ *     "KeyValueStoreAssociations": {
+ *       "Items": [
+ *         {
+ *           "KeyValueStoreARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889"
+ *         }
+ *       ],
+ *       "Quantity": 1
+ *     },
+ *     "Runtime": "cloudfront-js-2.0"
+ *   },
+ *   "IfMatch": "ETVPDKIKX0DER",
+ *   "Name": "my-function-name"
+ * };
+ * const command = new UpdateFunctionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ETag": "E3UN6WX5RRO2AG",
+ *   "FunctionSummary": {
+ *     "FunctionConfig": {
+ *       "Comment": "my-changed-comment",
+ *       "KeyValueStoreAssociations": {
+ *         "Items": [
+ *           {
+ *             "KeyValueStoreARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889"
+ *           }
+ *         ],
+ *         "Quantity": 1
+ *       },
+ *       "Runtime": "cloudfront-js-2.0"
+ *     },
+ *     "FunctionMetadata": {
+ *       "CreatedTime": "2023-11-07T19:53:50.334Z",
+ *       "FunctionARN": "arn:aws:cloudfront::123456789012:function/my-function-name",
+ *       "LastModifiedTime": "2023-11-07T20:01:37.174Z",
+ *       "Stage": "DEVELOPMENT"
+ *     },
+ *     "Name": "my-function-name",
+ *     "Status": "UNPUBLISHED"
+ *   }
+ * }
+ * *\/
+ * // example id: to-update-a-function-1699751865053
+ * ```
+ *
  */
 export declare class UpdateFunctionCommand extends $Command<UpdateFunctionCommandInput, UpdateFunctionCommandOutput, CloudFrontClientResolvedConfig> {
     readonly input: UpdateFunctionCommandInput;

package/dist-types/commands/UpdateKeyValueStoreCommand.d.ts

@@ -76,6 +76,32 @@ export interface UpdateKeyValueStoreCommandOutput extends UpdateKeyValueStoreRes
  * @throws {@link CloudFrontServiceException}
  * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
+ * @example To update a KeyValueStore
+ * ```javascript
+ * // Use the following command to update a KeyValueStore.
+ * const input = {
+ *   "Comment": "my-changed-comment",
+ *   "IfMatch": "ETVPDKIKX0DER",
+ *   "Name": "my-keyvaluestore-name"
+ * };
+ * const command = new UpdateKeyValueStoreCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ETag": "E3UN6WX5RRO2AG",
+ *   "KeyValueStore": {
+ *     "ARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889",
+ *     "Comment": "my-changed-comment",
+ *     "Id": "54947df8-0e9e-4471-a2f9-9af509fb5889",
+ *     "LastModifiedTime": "2023-11-07T18:45:21.069Z",
+ *     "Name": "my-keyvaluestore-name",
+ *     "Status": "READY"
+ *   }
+ * }
+ * *\/
+ * // example id: to-update-a-key-value-store-1699751822090
+ * ```
+ *
  */
 export declare class UpdateKeyValueStoreCommand extends $Command<UpdateKeyValueStoreCommandInput, UpdateKeyValueStoreCommandOutput, CloudFrontClientResolvedConfig> {
     readonly input: UpdateKeyValueStoreCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-cloudfront",
   "description": "AWS SDK for JavaScript Cloudfront Client for Node.js, Browser and React Native",
-  "version": "3.456.0",
+  "version": "3.457.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",