@aws-sdk/client-iot-managed-integrations 3.761.0 → 3.762.0

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

@@ -85,6 +85,103 @@ declare const GetSchemaVersionCommand_base: {
  * <p>Base exception class for all service exceptions from IoTManagedIntegrations service.</p>
  *
  * @public
+ * @example GetSchemaVersion happy path for an example schema version.
+ * ```javascript
+ * //
+ * const input = {
+ *   "SchemaVersionedId": "matter.ColorControl@$latest",
+ *   "Type": "capability"
+ * };
+ * const command = new GetSchemaVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Description": "The Color Control cluster defined as Harmony Capability.",
+ *   "Namespace": "matter",
+ *   "Schema": {
+ *     "name": "Color Control",
+ *     "$defs": {},
+ *     "$id": "matter.ColorControl@1.3",
+ *     "$ref": "aws.capability@1.0",
+ *     "actions": [
+ *       {
+ *         "$ref": "aws.action.ReadState@1.0"
+ *       },
+ *       {
+ *         "$ref": "aws.action.UpdateState@1.0"
+ *       },
+ *       {
+ *         "name": "MoveToHue",
+ *         "extrinsicId": "0x00",
+ *         "request": {
+ *           "parameters": {
+ *             "Hue": {
+ *               "value": {
+ *                 "$ref": "aws.integer@1.0"
+ *               },
+ *               "extrinsicId": "0"
+ *             }
+ *           }
+ *         }
+ *       }
+ *     ],
+ *     "description": "The Color Control cluster defined as Harmony Capability.",
+ *     "events": [],
+ *     "extrinsicId": "0x0300",
+ *     "extrinsicVersion": "14",
+ *     "properties": {
+ *       "CurrentHue": {
+ *         "value": {
+ *           "$ref": "aws.integer@1.0"
+ *         },
+ *         "mutable": false
+ *       }
+ *     },
+ *     "title": "Color Control Cluster"
+ *   },
+ *   "SchemaId": "matter.ColorControl",
+ *   "SemanticVersion": "1.3",
+ *   "Type": "capability"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example GetSchemaVersion happy path for an example schema version.
+ * ```javascript
+ * //
+ * const input = {
+ *   "Format": "ZCL",
+ *   "SchemaVersionedId": "matter.ColorControl@1.3",
+ *   "Type": "capability"
+ * };
+ * const command = new GetSchemaVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Description": "The Color Control cluster defined as Harmony Capability.",
+ *   "Namespace": "matter",
+ *   "Schema": {},
+ *   "SchemaId": "matter.ColorControl",
+ *   "SemanticVersion": "1.3",
+ *   "Type": "capability"
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
+ * @example GetSchemaVersion error path for an example schema version that does not exist.
+ * ```javascript
+ * //
+ * const input = {
+ *   "SchemaVersionedId": "matter.ColorControl@$latest",
+ *   "Type": "capability"
+ * };
+ * const command = new GetSchemaVersionCommand(input);
+ * await client.send(command);
+ * // example id: example-3
+ * ```
+ *
  */
 export declare class GetSchemaVersionCommand extends GetSchemaVersionCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -90,6 +90,69 @@ declare const ListSchemaVersionsCommand_base: {
  * <p>Base exception class for all service exceptions from IoTManagedIntegrations service.</p>
  *
  * @public
+ * @example ListSchemaVersions happy path for an example schema version.
+ * ```javascript
+ * //
+ * const input = {
+ *   "SchemaId": "matter.ColorControl",
+ *   "Type": "capability"
+ * };
+ * const command = new ListSchemaVersionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Items": [
+ *     {
+ *       "Description": "The Color Control cluster defined as Harmony Capability.",
+ *       "Namespace": "matter",
+ *       "SchemaId": "matter.ColorControl",
+ *       "SemanticVersion": "1.3",
+ *       "Type": "capability"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example ListSchemaVersions by version.
+ * ```javascript
+ * //
+ * const input = {
+ *   "SemanticVersion": "34.56",
+ *   "Type": "capability"
+ * };
+ * const command = new ListSchemaVersionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Items": [
+ *     {
+ *       "Description": "The Color Control cluster defined as Harmony Capability.",
+ *       "Namespace": "matter",
+ *       "SchemaId": "matter.ColorControl",
+ *       "SemanticVersion": "1.3",
+ *       "Type": "capability"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
+ * @example ListSchemaVersions error  for invalid input.
+ * ```javascript
+ * //
+ * const input = {
+ *   "Namespace": "matter",
+ *   "SchemaId": "matter.ColorControl",
+ *   "Type": "capability"
+ * };
+ * const command = new ListSchemaVersionsCommand(input);
+ * await client.send(command);
+ * // example id: example-3
+ * ```
+ *
  */
 export declare class ListSchemaVersionsCommand extends ListSchemaVersionsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-iot-managed-integrations",
   "description": "AWS SDK for JavaScript Iot Managed Integrations Client for Node.js, Browser and React Native",
-  "version": "3.761.0",
+  "version": "3.762.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",