@aws-sdk/client-clouddirectory 3.658.0 → 3.662.0

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

@@ -78,6 +78,23 @@ declare const GetSchemaAsJsonCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To get schema information and display it in JSON format
+ * ```javascript
+ * //
+ * const input = {
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
+ * };
+ * const command = new GetSchemaAsJsonCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Document": "{\"sourceSchemaArn\":\"arn:aws:clouddirectory:us-west-2:45132example:schema/published/org/1\",\"facets\":{\"node2\":{\"facetAttributes\":{},\"objectType\":\"NODE\"},\"Organization\":{\"facetAttributes\":{\"account_id\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"account_name\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"telephone_number\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"description\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_country\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_state\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_street2\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_street1\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"web_site\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"email\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_city\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"organization_status\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_postal_code\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"}},\"objectType\":\"LEAF_NODE\"},\"nodex\":{\"facetAttributes\":{},\"objectType\":\"NODE\"},\"Legal_Entity\":{\"facetAttributes\":{\"industry_vertical\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"registered_company_name\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"billing_currency\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_country\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_state\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_street2\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_street1\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"tax_id\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_city\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_postal_code\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"}},\"objectType\":\"LEAF_NODE\"},\"policyfacet\":{\"facetAttributes\":{},\"objectType\":\"POLICY\"},\"node1\":{\"facetAttributes\":{},\"objectType\":\"NODE\"}},\"typedLinkFacets\":{\"exampletypedlink\":{\"facetAttributes\":{\"1\":{\"attributeDefinition\":{\"attributeType\":\"BINARY\",\"isImmutable\":false,\"attributeRules\":{}},\"requiredBehavior\":\"REQUIRED_ALWAYS\"}},\"identityAttributeOrder\":[\"1\"]},\"exampletypedlink8\":{\"facetAttributes\":{\"22\":{\"attributeDefinition\":{\"attributeType\":\"BINARY\",\"isImmutable\":false,\"attributeRules\":{}},\"requiredBehavior\":\"REQUIRED_ALWAYS\"}},\"identityAttributeOrder\":[\"22\"]}}}",
+ *   "Name": "org"
+ * }
+ * *\/
+ * // example id: to-get-schema-information-and-display-it-in-json-format-1507249604181
+ * ```
+ *
  */
 export declare class GetSchemaAsJsonCommand extends GetSchemaAsJsonCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -86,6 +86,25 @@ declare const GetTypedLinkFacetInformationCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To get information about a typed link facet
+ * ```javascript
+ * //
+ * const input = {
+ *   "Name": "exampletypedlink8",
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
+ * };
+ * const command = new GetTypedLinkFacetInformationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "IdentityAttributeOrder": [
+ *     "22"
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-information-about-a-typed-link-facet-1507251423121
+ * ```
+ *
  */
 export declare class GetTypedLinkFacetInformationCommand extends GetTypedLinkFacetInformationCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -86,6 +86,24 @@ declare const ListAppliedSchemaArnsCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To list applied schema ARNs for a specified directory
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY"
+ * };
+ * const command = new ListAppliedSchemaArnsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "SchemaArns": [
+ *     "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-applied-schema-arns-for-a-specified-directory-1508194900072
+ * ```
+ *
  */
 export declare class ListAppliedSchemaArnsCommand extends ListAppliedSchemaArnsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -107,6 +107,30 @@ declare const ListAttachedIndicesCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To list the indices attached to an object
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "TargetReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
+ *   }
+ * };
+ * const command = new ListAttachedIndicesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "IndexAttachments": [
+ *     {
+ *       "IndexedAttributes": [],
+ *       "ObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-indices-attached-to-an-object-1507579868633
+ * ```
+ *
  */
 export declare class ListAttachedIndicesCommand extends ListAttachedIndicesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -85,6 +85,27 @@ declare const ListDevelopmentSchemaArnsCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To list all development schema arns in your AWS account
+ * ```javascript
+ * //
+ * const input = {};
+ * const command = new ListDevelopmentSchemaArnsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "SchemaArns": [
+ *     "arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschematest",
+ *     "arn:aws:clouddirectory:us-west-2:45132example:schema/development/testCDschema",
+ *     "arn:aws:clouddirectory:us-west-2:45132example:schema/development/Customers",
+ *     "arn:aws:clouddirectory:us-west-2:45132example:schema/development/CourseCatalog",
+ *     "arn:aws:clouddirectory:us-west-2:45132example:schema/development/Consumers",
+ *     "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorg"
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-development-schema-arns-1508262502911
+ * ```
+ *
  */
 export declare class ListDevelopmentSchemaArnsCommand extends ListDevelopmentSchemaArnsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -87,6 +87,51 @@ declare const ListDirectoriesCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To list all directories in your AWS account
+ * ```javascript
+ * //
+ * const input = {};
+ * const command = new ListDirectoriesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Directories": [
+ *     {
+ *       "CreationDateTime": 1506121791.167,
+ *       "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/Ae89hOKmw0bRpvYgW8EAsus",
+ *       "Name": "ExampleCD4",
+ *       "State": "ENABLED"
+ *     },
+ *     {
+ *       "CreationDateTime": 1485473189.746,
+ *       "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8",
+ *       "Name": "testCD",
+ *       "State": "DELETED"
+ *     },
+ *     {
+ *       "CreationDateTime": 1506115781.186,
+ *       "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *       "Name": "ExampleCD",
+ *       "State": "ENABLED"
+ *     },
+ *     {
+ *       "CreationDateTime": 1506118003.859,
+ *       "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI",
+ *       "Name": "ExampleCD2",
+ *       "State": "ENABLED"
+ *     },
+ *     {
+ *       "CreationDateTime": 1485477107.925,
+ *       "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AWeI1yjiB0SylWVTvQklCD0",
+ *       "Name": "testCD2",
+ *       "State": "DELETED"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-all-directories-in-your-aws-account-1508262706411
+ * ```
+ *
  */
 export declare class ListDirectoriesCommand extends ListDirectoriesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -115,6 +115,195 @@ declare const ListFacetAttributesCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To list facet attributes
+ * ```javascript
+ * //
+ * const input = {
+ *   "Name": "Organization",
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
+ * };
+ * const command = new ListFacetAttributesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Attributes": [
+ *     {
+ *       "AttributeDefinition": {
+ *         "IsImmutable": false,
+ *         "Rules": {
+ *           "nameLength": {
+ *             "Parameters": {
+ *               "max": "1024",
+ *               "min": "1"
+ *             },
+ *             "Type": "STRING_LENGTH"
+ *           }
+ *         },
+ *         "Type": "STRING"
+ *       },
+ *       "Name": "account_id",
+ *       "RequiredBehavior": "NOT_REQUIRED"
+ *     },
+ *     {
+ *       "AttributeDefinition": {
+ *         "IsImmutable": false,
+ *         "Rules": {
+ *           "nameLength": {
+ *             "Parameters": {
+ *               "max": "1024",
+ *               "min": "1"
+ *             },
+ *             "Type": "STRING_LENGTH"
+ *           }
+ *         },
+ *         "Type": "STRING"
+ *       },
+ *       "Name": "account_name",
+ *       "RequiredBehavior": "NOT_REQUIRED"
+ *     },
+ *     {
+ *       "AttributeDefinition": {
+ *         "IsImmutable": false,
+ *         "Rules": {
+ *           "nameLength": {
+ *             "Parameters": {
+ *               "max": "1024",
+ *               "min": "1"
+ *             },
+ *             "Type": "STRING_LENGTH"
+ *           }
+ *         },
+ *         "Type": "STRING"
+ *       },
+ *       "Name": "description",
+ *       "RequiredBehavior": "NOT_REQUIRED"
+ *     },
+ *     {
+ *       "AttributeDefinition": {
+ *         "IsImmutable": false,
+ *         "Rules": {
+ *           "nameLength": {
+ *             "Parameters": {
+ *               "max": "1024",
+ *               "min": "1"
+ *             },
+ *             "Type": "STRING_LENGTH"
+ *           }
+ *         },
+ *         "Type": "STRING"
+ *       },
+ *       "Name": "email",
+ *       "RequiredBehavior": "NOT_REQUIRED"
+ *     },
+ *     {
+ *       "AttributeDefinition": {
+ *         "IsImmutable": false,
+ *         "Rules": {
+ *           "nameLength": {
+ *             "Parameters": {
+ *               "max": "1024",
+ *               "min": "1"
+ *             },
+ *             "Type": "STRING_LENGTH"
+ *           }
+ *         },
+ *         "Type": "STRING"
+ *       },
+ *       "Name": "mailing_address_city",
+ *       "RequiredBehavior": "NOT_REQUIRED"
+ *     },
+ *     {
+ *       "AttributeDefinition": {
+ *         "IsImmutable": false,
+ *         "Rules": {
+ *           "nameLength": {
+ *             "Parameters": {
+ *               "max": "1024",
+ *               "min": "1"
+ *             },
+ *             "Type": "STRING_LENGTH"
+ *           }
+ *         },
+ *         "Type": "STRING"
+ *       },
+ *       "Name": "mailing_address_country",
+ *       "RequiredBehavior": "NOT_REQUIRED"
+ *     },
+ *     {
+ *       "AttributeDefinition": {
+ *         "IsImmutable": false,
+ *         "Rules": {
+ *           "nameLength": {
+ *             "Parameters": {
+ *               "max": "1024",
+ *               "min": "1"
+ *             },
+ *             "Type": "STRING_LENGTH"
+ *           }
+ *         },
+ *         "Type": "STRING"
+ *       },
+ *       "Name": "mailing_address_postal_code",
+ *       "RequiredBehavior": "NOT_REQUIRED"
+ *     },
+ *     {
+ *       "AttributeDefinition": {
+ *         "IsImmutable": false,
+ *         "Rules": {
+ *           "nameLength": {
+ *             "Parameters": {
+ *               "max": "1024",
+ *               "min": "1"
+ *             },
+ *             "Type": "STRING_LENGTH"
+ *           }
+ *         },
+ *         "Type": "STRING"
+ *       },
+ *       "Name": "mailing_address_state",
+ *       "RequiredBehavior": "NOT_REQUIRED"
+ *     },
+ *     {
+ *       "AttributeDefinition": {
+ *         "IsImmutable": false,
+ *         "Rules": {
+ *           "nameLength": {
+ *             "Parameters": {
+ *               "max": "1024",
+ *               "min": "1"
+ *             },
+ *             "Type": "STRING_LENGTH"
+ *           }
+ *         },
+ *         "Type": "STRING"
+ *       },
+ *       "Name": "mailing_address_street1",
+ *       "RequiredBehavior": "NOT_REQUIRED"
+ *     },
+ *     {
+ *       "AttributeDefinition": {
+ *         "IsImmutable": false,
+ *         "Rules": {
+ *           "nameLength": {
+ *             "Parameters": {
+ *               "max": "1024",
+ *               "min": "1"
+ *             },
+ *             "Type": "STRING_LENGTH"
+ *           }
+ *         },
+ *         "Type": "STRING"
+ *       },
+ *       "Name": "mailing_address_street2",
+ *       "RequiredBehavior": "NOT_REQUIRED"
+ *     }
+ *   ],
+ *   "NextToken": "V0b3JnYW5pemF0aW9uX3N0YXR1cw=="
+ * }
+ * *\/
+ * // example id: to-list-facet-attributes-1508275015421
+ * ```
+ *
  */
 export declare class ListFacetAttributesCommand extends ListFacetAttributesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -85,6 +85,29 @@ declare const ListFacetNamesCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To list facet names
+ * ```javascript
+ * //
+ * const input = {
+ *   "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
+ * };
+ * const command = new ListFacetNamesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FacetNames": [
+ *     "Legal_Entity",
+ *     "Organization",
+ *     "node1",
+ *     "node2",
+ *     "nodex",
+ *     "policyfacet"
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-facet-names-1508275974689
+ * ```
+ *
  */
 export declare class ListFacetNamesCommand extends ListFacetNamesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -148,6 +148,87 @@ declare const ListIncomingTypedLinksCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To list incoming typed links
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "ObjectReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
+ *   }
+ * };
+ * const command = new ListIncomingTypedLinksCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "LinkSpecifiers": [
+ *     {
+ *       "IdentityAttributeValues": [
+ *         {
+ *           "AttributeName": "22",
+ *           "Value": {
+ *             "BinaryValue": ""
+ *           }
+ *         }
+ *       ],
+ *       "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"
+ *       }
+ *     },
+ *     {
+ *       "IdentityAttributeValues": [
+ *         {
+ *           "AttributeName": "22",
+ *           "Value": {
+ *             "BinaryValue": "MA=="
+ *           }
+ *         }
+ *       ],
+ *       "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"
+ *       }
+ *     },
+ *     {
+ *       "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"
+ *       }
+ *     }
+ *   ],
+ *   "NextToken": ""
+ * }
+ * *\/
+ * // example id: to-list-incoming-typed-links-1508276145750
+ * ```
+ *
  */
 export declare class ListIncomingTypedLinksCommand extends ListIncomingTypedLinksCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -144,6 +144,39 @@ declare const ListIndexCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To list an index
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "IndexReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q"
+ *   }
+ * };
+ * const command = new ListIndexCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "IndexAttachments": [
+ *     {
+ *       "IndexedAttributes": [
+ *         {
+ *           "Key": {
+ *             "FacetName": "Organization",
+ *             "Name": "description",
+ *             "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
+ *           },
+ *           "Value": {}
+ *         }
+ *       ],
+ *       "ObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-an-index-1508281185950
+ * ```
+ *
  */
 export declare class ListIndexCommand extends ListIndexCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -114,6 +114,46 @@ declare const ListObjectAttributesCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To list object attributes
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "ObjectReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q"
+ *   }
+ * };
+ * const command = new ListObjectAttributesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Attributes": [
+ *     {
+ *       "Key": {
+ *         "FacetName": "INDEX",
+ *         "Name": "index_is_unique",
+ *         "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/CloudDirectory/1.0"
+ *       },
+ *       "Value": {
+ *         "BooleanValue": true
+ *       }
+ *     },
+ *     {
+ *       "Key": {
+ *         "FacetName": "INDEX",
+ *         "Name": "ordered_indexed_attributes",
+ *         "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/CloudDirectory/1.0"
+ *       },
+ *       "Value": {
+ *         "StringValue": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1*Organization*description"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-object-attributes-1508281422770
+ * ```
+ *
  */
 export declare class ListObjectAttributesCommand extends ListObjectAttributesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -97,6 +97,27 @@ declare const ListObjectChildrenCommand_base: {
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
  *
  * @public
+ * @example To list an objects children
+ * ```javascript
+ * //
+ * const input = {
+ *   "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
+ *   "ObjectReference": {
+ *     "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
+ *   }
+ * };
+ * const command = new ListObjectChildrenCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Children": {
+ *     "link2": "AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
+ *   }
+ * }
+ * *\/
+ * // example id: to-list-an-objects-children-1508281694794
+ * ```
+ *
  */
 export declare class ListObjectChildrenCommand extends ListObjectChildrenCommand_base {
     /** @internal type navigation helper, not in runtime. */