@aws-sdk/client-clouddirectory 3.658.0 → 3.662.0

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

@@ -133,6 +133,59 @@ declare const AttachTypedLinkCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To attach a typed link to an object
+ * ```javascript
+ * //
+ * const input = {
+ *   "Attributes": [
+ *     {
+ *       "AttributeName": "22",
+ *       "Value": {
+ *         "BinaryValue": "c3Ry"
+ *       }
+ *     }
+ *   ],
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "SourceObjectReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
+ *   },
+ *   "TargetObjectReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
+ *   },
+ *   "TypedLinkFacet": {
+ *     "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1",
+ *     "TypedLinkName": "exampletypedlink8"
+ *   }
+ * };
+ * const command = new AttachTypedLinkCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TypedLinkSpecifier": {
+ *     "IdentityAttributeValues": [
+ *       {
+ *         "AttributeName": "22",
+ *         "Value": {
+ *           "BinaryValue": "c3Ry"
+ *         }
+ *       }
+ *     ],
+ *     "SourceObjectReference": {
+ *       "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
+ *     },
+ *     "TargetObjectReference": {
+ *       "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
+ *     },
+ *     "TypedLinkFacet": {
+ *       "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1",
+ *       "TypedLinkName": "exampletypedlink8"
+ *     }
+ *   }
+ * }
+ * *\/
+ * // example id: to-attach-a-typed-link-to-an-object-1506559900588
+ * ```
+ *
  */
 export declare class AttachTypedLinkCommand extends AttachTypedLinkCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -478,6 +478,24 @@ declare const BatchReadCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To run a batch read command
+ * ```javascript
+ * //
+ * const input = {
+ *   "ConsistencyLevel": "EVENTUAL",
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "Operations": []
+ * };
+ * const command = new BatchReadCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Responses": []
+ * }
+ * *\/
+ * // example id: to-run-a-batch-read-command-1506123433380
+ * ```
+ *
  */
 export declare class BatchReadCommand extends BatchReadCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -344,6 +344,23 @@ declare const BatchWriteCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To run a batch write command
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "Operations": []
+ * };
+ * const command = new BatchWriteCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Responses": []
+ * }
+ * *\/
+ * // example id: to-run-a-batch-write-command-1506122878964
+ * ```
+ *
  */
 export declare class BatchWriteCommand extends BatchWriteCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -88,6 +88,26 @@ declare const CreateDirectoryCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To create a new Cloud Directory
+ * ```javascript
+ * //
+ * const input = {
+ *   "Name": "ExampleCD",
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/published/person/1"
+ * };
+ * const command = new CreateDirectoryCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AppliedSchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI/schema/person/1",
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI",
+ *   "Name": "ExampleCD",
+ *   "ObjectIdentifier": "AQHzK-KsptZGU78KjmnwGH6i-4guCM3uQFOTA9_NjeHDrg"
+ * }
+ * *\/
+ * // example id: to-create-a-new-cloud-directory-1506119878996
+ * ```
+ *
  */
 export declare class CreateDirectoryCommand extends CreateDirectoryCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -118,6 +118,19 @@ declare const CreateFacetCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To create a facet
+ * ```javascript
+ * //
+ * const input = {
+ *   "Name": "node1",
+ *   "ObjectType": "NODE",
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
+ * };
+ * const command = new CreateFacetCommand(input);
+ * await client.send(command);
+ * // example id: to-create-a-facet-1506112442334
+ * ```
+ *
  */
 export declare class CreateFacetCommand extends CreateFacetCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -103,6 +103,26 @@ declare const CreateIndexCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To create an index
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8",
+ *   "IsUnique": true,
+ *   "LinkName": "Examplelink",
+ *   "OrderedIndexedAttributeList": [],
+ *   "ParentReference": {}
+ * };
+ * const command = new CreateIndexCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ObjectIdentifier": "AQF0Fw173YJDlpLUV1eB50WvYsWFtVoUSmOzZjz_BLULIA"
+ * }
+ * *\/
+ * // example id: to-create-an-index-1505339563796
+ * ```
+ *
  */
 export declare class CreateIndexCommand extends CreateIndexCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -120,6 +120,28 @@ declare const CreateObjectCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To create an object
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8",
+ *   "SchemaFacets": [
+ *     {
+ *       "FacetName": "Organization_Person",
+ *       "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8/schema/ExampleOrgPersonSchema/1"
+ *     }
+ *   ]
+ * };
+ * const command = new CreateObjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ObjectIdentifier": "AQF0Fw173YJDlpLUV1eB50WvScvjsYXcS3K2nP1HwDuuYQ"
+ * }
+ * *\/
+ * // example id: to-create-an-object-1494010287120
+ * ```
+ *
  */
 export declare class CreateObjectCommand extends CreateObjectCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -98,6 +98,22 @@ declare const CreateSchemaCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To create a schema
+ * ```javascript
+ * //
+ * const input = {
+ *   "Name": "Customers"
+ * };
+ * const command = new CreateSchemaCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/Customers"
+ * }
+ * *\/
+ * // example id: to-create-a-schema-1506530911949
+ * ```
+ *
  */
 export declare class CreateSchemaCommand extends CreateSchemaCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -114,6 +114,30 @@ declare const CreateTypedLinkFacetCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To create a typed link facet
+ * ```javascript
+ * //
+ * const input = {
+ *   "Facet": {
+ *     "Attributes": [
+ *       {
+ *         "Name": "1",
+ *         "RequiredBehavior": "REQUIRED_ALWAYS",
+ *         "Type": "BINARY"
+ *       }
+ *     ],
+ *     "IdentityAttributeOrder": [
+ *       "1"
+ *     ],
+ *     "Name": "FacetExample"
+ *   },
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschema"
+ * };
+ * const command = new CreateTypedLinkFacetCommand(input);
+ * await client.send(command);
+ * // example id: to-create-a-typed-link-facet-1506127699199
+ * ```
+ *
  */
 export declare class CreateTypedLinkFacetCommand extends CreateTypedLinkFacetCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -86,6 +86,22 @@ declare const DeleteDirectoryCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To delete a directory
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
+ * };
+ * const command = new DeleteDirectoryCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
+ * }
+ * *\/
+ * // example id: to-delete-a-directory-1507570867859
+ * ```
+ *
  */
 export declare class DeleteDirectoryCommand extends DeleteDirectoryCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -85,6 +85,18 @@ declare const DeleteFacetCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To delete a facet
+ * ```javascript
+ * //
+ * const input = {
+ *   "Name": "Organization",
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest"
+ * };
+ * const command = new DeleteFacetCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-facet-1507573383449
+ * ```
+ *
  */
 export declare class DeleteFacetCommand extends DeleteFacetCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -86,6 +86,20 @@ declare const DeleteObjectCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To delete an object
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI",
+ *   "ObjectReference": {
+ *     "Selector": "$AQHzK-KsptZGU78KjmnwGH6i8H-voMZDSNCqfx-fRUcBFg"
+ *   }
+ * };
+ * const command = new DeleteObjectCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-an-object-1507574607158
+ * ```
+ *
  */
 export declare class DeleteObjectCommand extends DeleteObjectCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -81,6 +81,22 @@ declare const DeleteSchemaCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To delete a schema
+ * ```javascript
+ * //
+ * const input = {
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest"
+ * };
+ * const command = new DeleteSchemaCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest"
+ * }
+ * *\/
+ * // example id: to-delete-a-schema-1507575230059
+ * ```
+ *
  */
 export declare class DeleteSchemaCommand extends DeleteSchemaCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -79,6 +79,18 @@ declare const DeleteTypedLinkFacetCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To delete a typed link facet
+ * ```javascript
+ * //
+ * const input = {
+ *   "Name": "ExampleFacet",
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschematest"
+ * };
+ * const command = new DeleteTypedLinkFacetCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-typed-link-facet-1507576290714
+ * ```
+ *
  */
 export declare class DeleteTypedLinkFacetCommand extends DeleteTypedLinkFacetCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -92,6 +92,28 @@ declare const DetachFromIndexCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To detach an object from an index
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "IndexReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q"
+ *   },
+ *   "TargetReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
+ *   }
+ * };
+ * const command = new DetachFromIndexCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DetachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
+ * }
+ * *\/
+ * // example id: to-detach-an-object-from-an-index-1507579662964
+ * ```
+ *
  */
 export declare class DetachFromIndexCommand extends DetachFromIndexCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -89,6 +89,26 @@ declare const DetachObjectCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To detach an object from its parent object
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "LinkName": "link2",
+ *   "ParentReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
+ *   }
+ * };
+ * const command = new DetachObjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DetachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
+ * }
+ * *\/
+ * // example id: to-detach-an-object-from-its-parent-object-1508196401149
+ * ```
+ *
  */
 export declare class DetachObjectCommand extends DetachObjectCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -87,6 +87,23 @@ declare const DetachPolicyCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To detach a policy from an object
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "ObjectReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWQoovm1s3Ts2v0NKrzdVnPw"
+ *   },
+ *   "PolicyReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWgcBsTVmcQEWs6jlygfhuew"
+ *   }
+ * };
+ * const command = new DetachPolicyCommand(input);
+ * await client.send(command);
+ * // example id: to-detach-a-policy-from-an-object-1508268395318
+ * ```
+ *
  */
 export declare class DetachPolicyCommand extends DetachPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -106,6 +106,37 @@ declare const DetachTypedLinkCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To detach a typed link from an object
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "TypedLinkSpecifier": {
+ *     "IdentityAttributeValues": [
+ *       {
+ *         "AttributeName": "22",
+ *         "Value": {
+ *           "BinaryValue": "c3Ry"
+ *         }
+ *       }
+ *     ],
+ *     "SourceObjectReference": {
+ *       "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
+ *     },
+ *     "TargetObjectReference": {
+ *       "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
+ *     },
+ *     "TypedLinkFacet": {
+ *       "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1",
+ *       "TypedLinkName": "exampletypedlink8"
+ *     }
+ *   }
+ * };
+ * const command = new DetachTypedLinkCommand(input);
+ * await client.send(command);
+ * // example id: to-detach-a-typed-link-from-an-object-1506540145856
+ * ```
+ *
  */
 export declare class DetachTypedLinkCommand extends DetachTypedLinkCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -82,6 +82,22 @@ declare const DisableDirectoryCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To disable a directory
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
+ * };
+ * const command = new DisableDirectoryCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
+ * }
+ * *\/
+ * // example id: to-disable-a-directory-1507253386265
+ * ```
+ *
  */
 export declare class DisableDirectoryCommand extends DisableDirectoryCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -82,6 +82,22 @@ declare const EnableDirectoryCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To enable a disabled directory
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
+ * };
+ * const command = new EnableDirectoryCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
+ * }
+ * *\/
+ * // example id: to-enable-a-disabled-directory-1507253506378
+ * ```
+ *
  */
 export declare class EnableDirectoryCommand extends EnableDirectoryCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -79,6 +79,27 @@ declare const GetDirectoryCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To get information about a directory
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY"
+ * };
+ * const command = new GetDirectoryCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Directory": {
+ *     "CreationDateTime": 1506115781.186,
+ *     "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *     "Name": "ExampleCD",
+ *     "State": "ENABLED"
+ *   }
+ * }
+ * *\/
+ * // example id: to-get-information-about-a-directory-1507235667410
+ * ```
+ *
  */
 export declare class GetDirectoryCommand extends GetDirectoryCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -86,6 +86,26 @@ declare const GetFacetCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To get information about a facet
+ * ```javascript
+ * //
+ * const input = {
+ *   "Name": "node2",
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
+ * };
+ * const command = new GetFacetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Facet": {
+ *     "Name": "node2",
+ *     "ObjectType": "NODE"
+ *   }
+ * }
+ * *\/
+ * // example id: to-get-information-about-a-facet-1507234748374
+ * ```
+ *
  */
 export declare class GetFacetCommand extends GetFacetCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -90,6 +90,32 @@ declare const GetObjectInformationCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To get information about an object
+ * ```javascript
+ * //
+ * const input = {
+ *   "ConsistencyLevel": "SERIALIZABLE",
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "ObjectReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ"
+ *   }
+ * };
+ * const command = new GetObjectInformationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ",
+ *   "SchemaFacets": [
+ *     {
+ *       "FacetName": "node2",
+ *       "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-information-about-an-object-1507228370573
+ * ```
+ *
  */
 export declare class GetObjectInformationCommand extends GetObjectInformationCommand_base {
     /** @internal type navigation helper, not in runtime. */