@aws-sdk/client-clouddirectory 3.658.1 → 3.662.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 (41) hide show
  1. package/dist-types/commands/AddFacetToObjectCommand.d.ts +19 -0
  2. package/dist-types/commands/ApplySchemaCommand.d.ts +18 -0
  3. package/dist-types/commands/AttachObjectCommand.d.ts +23 -0
  4. package/dist-types/commands/AttachPolicyCommand.d.ts +17 -0
  5. package/dist-types/commands/AttachToIndexCommand.d.ts +22 -0
  6. package/dist-types/commands/AttachTypedLinkCommand.d.ts +53 -0
  7. package/dist-types/commands/BatchReadCommand.d.ts +18 -0
  8. package/dist-types/commands/BatchWriteCommand.d.ts +17 -0
  9. package/dist-types/commands/CreateDirectoryCommand.d.ts +20 -0
  10. package/dist-types/commands/CreateFacetCommand.d.ts +13 -0
  11. package/dist-types/commands/CreateIndexCommand.d.ts +20 -0
  12. package/dist-types/commands/CreateObjectCommand.d.ts +22 -0
  13. package/dist-types/commands/CreateSchemaCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateTypedLinkFacetCommand.d.ts +24 -0
  15. package/dist-types/commands/DeleteDirectoryCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteFacetCommand.d.ts +12 -0
  17. package/dist-types/commands/DeleteObjectCommand.d.ts +14 -0
  18. package/dist-types/commands/DeleteSchemaCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteTypedLinkFacetCommand.d.ts +12 -0
  20. package/dist-types/commands/DetachFromIndexCommand.d.ts +22 -0
  21. package/dist-types/commands/DetachObjectCommand.d.ts +20 -0
  22. package/dist-types/commands/DetachPolicyCommand.d.ts +17 -0
  23. package/dist-types/commands/DetachTypedLinkCommand.d.ts +31 -0
  24. package/dist-types/commands/DisableDirectoryCommand.d.ts +16 -0
  25. package/dist-types/commands/EnableDirectoryCommand.d.ts +16 -0
  26. package/dist-types/commands/GetDirectoryCommand.d.ts +21 -0
  27. package/dist-types/commands/GetFacetCommand.d.ts +20 -0
  28. package/dist-types/commands/GetObjectInformationCommand.d.ts +26 -0
  29. package/dist-types/commands/GetSchemaAsJsonCommand.d.ts +17 -0
  30. package/dist-types/commands/GetTypedLinkFacetInformationCommand.d.ts +19 -0
  31. package/dist-types/commands/ListAppliedSchemaArnsCommand.d.ts +18 -0
  32. package/dist-types/commands/ListAttachedIndicesCommand.d.ts +24 -0
  33. package/dist-types/commands/ListDevelopmentSchemaArnsCommand.d.ts +21 -0
  34. package/dist-types/commands/ListDirectoriesCommand.d.ts +45 -0
  35. package/dist-types/commands/ListFacetAttributesCommand.d.ts +189 -0
  36. package/dist-types/commands/ListFacetNamesCommand.d.ts +23 -0
  37. package/dist-types/commands/ListIncomingTypedLinksCommand.d.ts +81 -0
  38. package/dist-types/commands/ListIndexCommand.d.ts +33 -0
  39. package/dist-types/commands/ListObjectAttributesCommand.d.ts +40 -0
  40. package/dist-types/commands/ListObjectChildrenCommand.d.ts +21 -0
  41. package/package.json +35 -35
package/dist-types/commands/EnableDirectoryCommand.d.ts CHANGED
@@ -82,6 +82,22 @@ declare const EnableDirectoryCommand_base: {
82
82
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
83
83
  *
84
84
  * @public
85
+ * @example To enable a disabled directory
86
+ * ```javascript
87
+ * //
88
+ * const input = {
89
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
90
+ * };
91
+ * const command = new EnableDirectoryCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response ==
94
+ * {
95
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
96
+ * }
97
+ * *\/
98
+ * // example id: to-enable-a-disabled-directory-1507253506378
99
+ * ```
100
+ *
85
101
  */
86
102
  export declare class EnableDirectoryCommand extends EnableDirectoryCommand_base {
87
103
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/GetDirectoryCommand.d.ts CHANGED
@@ -79,6 +79,27 @@ declare const GetDirectoryCommand_base: {
79
79
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
80
80
  *
81
81
  * @public
82
+ * @example To get information about a directory
83
+ * ```javascript
84
+ * //
85
+ * const input = {
86
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY"
87
+ * };
88
+ * const command = new GetDirectoryCommand(input);
89
+ * const response = await client.send(command);
90
+ * /* response ==
91
+ * {
92
+ * "Directory": {
93
+ * "CreationDateTime": 1506115781.186,
94
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
95
+ * "Name": "ExampleCD",
96
+ * "State": "ENABLED"
97
+ * }
98
+ * }
99
+ * *\/
100
+ * // example id: to-get-information-about-a-directory-1507235667410
101
+ * ```
102
+ *
82
103
  */
83
104
  export declare class GetDirectoryCommand extends GetDirectoryCommand_base {
84
105
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/GetFacetCommand.d.ts CHANGED
@@ -86,6 +86,26 @@ declare const GetFacetCommand_base: {
86
86
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
87
87
  *
88
88
  * @public
89
+ * @example To get information about a facet
90
+ * ```javascript
91
+ * //
92
+ * const input = {
93
+ * "Name": "node2",
94
+ * "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
95
+ * };
96
+ * const command = new GetFacetCommand(input);
97
+ * const response = await client.send(command);
98
+ * /* response ==
99
+ * {
100
+ * "Facet": {
101
+ * "Name": "node2",
102
+ * "ObjectType": "NODE"
103
+ * }
104
+ * }
105
+ * *\/
106
+ * // example id: to-get-information-about-a-facet-1507234748374
107
+ * ```
108
+ *
89
109
  */
90
110
  export declare class GetFacetCommand extends GetFacetCommand_base {
91
111
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/GetObjectInformationCommand.d.ts CHANGED
@@ -90,6 +90,32 @@ declare const GetObjectInformationCommand_base: {
90
90
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
91
91
  *
92
92
  * @public
93
+ * @example To get information about an object
94
+ * ```javascript
95
+ * //
96
+ * const input = {
97
+ * "ConsistencyLevel": "SERIALIZABLE",
98
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
99
+ * "ObjectReference": {
100
+ * "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ"
101
+ * }
102
+ * };
103
+ * const command = new GetObjectInformationCommand(input);
104
+ * const response = await client.send(command);
105
+ * /* response ==
106
+ * {
107
+ * "ObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ",
108
+ * "SchemaFacets": [
109
+ * {
110
+ * "FacetName": "node2",
111
+ * "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
112
+ * }
113
+ * ]
114
+ * }
115
+ * *\/
116
+ * // example id: to-get-information-about-an-object-1507228370573
117
+ * ```
118
+ *
93
119
  */
94
120
  export declare class GetObjectInformationCommand extends GetObjectInformationCommand_base {
95
121
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/GetSchemaAsJsonCommand.d.ts CHANGED
@@ -78,6 +78,23 @@ declare const GetSchemaAsJsonCommand_base: {
78
78
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
79
79
  *
80
80
  * @public
81
+ * @example To get schema information and display it in JSON format
82
+ * ```javascript
83
+ * //
84
+ * const input = {
85
+ * "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
86
+ * };
87
+ * const command = new GetSchemaAsJsonCommand(input);
88
+ * const response = await client.send(command);
89
+ * /* response ==
90
+ * {
91
+ * "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\"]}}}",
92
+ * "Name": "org"
93
+ * }
94
+ * *\/
95
+ * // example id: to-get-schema-information-and-display-it-in-json-format-1507249604181
96
+ * ```
97
+ *
81
98
  */
82
99
  export declare class GetSchemaAsJsonCommand extends GetSchemaAsJsonCommand_base {
83
100
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/GetTypedLinkFacetInformationCommand.d.ts CHANGED
@@ -86,6 +86,25 @@ declare const GetTypedLinkFacetInformationCommand_base: {
86
86
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
87
87
  *
88
88
  * @public
89
+ * @example To get information about a typed link facet
90
+ * ```javascript
91
+ * //
92
+ * const input = {
93
+ * "Name": "exampletypedlink8",
94
+ * "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
95
+ * };
96
+ * const command = new GetTypedLinkFacetInformationCommand(input);
97
+ * const response = await client.send(command);
98
+ * /* response ==
99
+ * {
100
+ * "IdentityAttributeOrder": [
101
+ * "22"
102
+ * ]
103
+ * }
104
+ * *\/
105
+ * // example id: to-get-information-about-a-typed-link-facet-1507251423121
106
+ * ```
107
+ *
89
108
  */
90
109
  export declare class GetTypedLinkFacetInformationCommand extends GetTypedLinkFacetInformationCommand_base {
91
110
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/ListAppliedSchemaArnsCommand.d.ts CHANGED
@@ -86,6 +86,24 @@ declare const ListAppliedSchemaArnsCommand_base: {
86
86
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
87
87
  *
88
88
  * @public
89
+ * @example To list applied schema ARNs for a specified directory
90
+ * ```javascript
91
+ * //
92
+ * const input = {
93
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY"
94
+ * };
95
+ * const command = new ListAppliedSchemaArnsCommand(input);
96
+ * const response = await client.send(command);
97
+ * /* response ==
98
+ * {
99
+ * "SchemaArns": [
100
+ * "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
101
+ * ]
102
+ * }
103
+ * *\/
104
+ * // example id: to-list-applied-schema-arns-for-a-specified-directory-1508194900072
105
+ * ```
106
+ *
89
107
  */
90
108
  export declare class ListAppliedSchemaArnsCommand extends ListAppliedSchemaArnsCommand_base {
91
109
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/ListAttachedIndicesCommand.d.ts CHANGED
@@ -107,6 +107,30 @@ declare const ListAttachedIndicesCommand_base: {
107
107
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
108
108
  *
109
109
  * @public
110
+ * @example To list the indices attached to an object
111
+ * ```javascript
112
+ * //
113
+ * const input = {
114
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
115
+ * "TargetReference": {
116
+ * "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
117
+ * }
118
+ * };
119
+ * const command = new ListAttachedIndicesCommand(input);
120
+ * const response = await client.send(command);
121
+ * /* response ==
122
+ * {
123
+ * "IndexAttachments": [
124
+ * {
125
+ * "IndexedAttributes": [],
126
+ * "ObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q"
127
+ * }
128
+ * ]
129
+ * }
130
+ * *\/
131
+ * // example id: to-list-the-indices-attached-to-an-object-1507579868633
132
+ * ```
133
+ *
110
134
  */
111
135
  export declare class ListAttachedIndicesCommand extends ListAttachedIndicesCommand_base {
112
136
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/ListDevelopmentSchemaArnsCommand.d.ts CHANGED
@@ -85,6 +85,27 @@ declare const ListDevelopmentSchemaArnsCommand_base: {
85
85
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
86
86
  *
87
87
  * @public
88
+ * @example To list all development schema arns in your AWS account
89
+ * ```javascript
90
+ * //
91
+ * const input = {};
92
+ * const command = new ListDevelopmentSchemaArnsCommand(input);
93
+ * const response = await client.send(command);
94
+ * /* response ==
95
+ * {
96
+ * "SchemaArns": [
97
+ * "arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschematest",
98
+ * "arn:aws:clouddirectory:us-west-2:45132example:schema/development/testCDschema",
99
+ * "arn:aws:clouddirectory:us-west-2:45132example:schema/development/Customers",
100
+ * "arn:aws:clouddirectory:us-west-2:45132example:schema/development/CourseCatalog",
101
+ * "arn:aws:clouddirectory:us-west-2:45132example:schema/development/Consumers",
102
+ * "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorg"
103
+ * ]
104
+ * }
105
+ * *\/
106
+ * // example id: to-list-the-development-schema-arns-1508262502911
107
+ * ```
108
+ *
88
109
  */
89
110
  export declare class ListDevelopmentSchemaArnsCommand extends ListDevelopmentSchemaArnsCommand_base {
90
111
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/ListDirectoriesCommand.d.ts CHANGED
@@ -87,6 +87,51 @@ declare const ListDirectoriesCommand_base: {
87
87
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
88
88
  *
89
89
  * @public
90
+ * @example To list all directories in your AWS account
91
+ * ```javascript
92
+ * //
93
+ * const input = {};
94
+ * const command = new ListDirectoriesCommand(input);
95
+ * const response = await client.send(command);
96
+ * /* response ==
97
+ * {
98
+ * "Directories": [
99
+ * {
100
+ * "CreationDateTime": 1506121791.167,
101
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/Ae89hOKmw0bRpvYgW8EAsus",
102
+ * "Name": "ExampleCD4",
103
+ * "State": "ENABLED"
104
+ * },
105
+ * {
106
+ * "CreationDateTime": 1485473189.746,
107
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8",
108
+ * "Name": "testCD",
109
+ * "State": "DELETED"
110
+ * },
111
+ * {
112
+ * "CreationDateTime": 1506115781.186,
113
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
114
+ * "Name": "ExampleCD",
115
+ * "State": "ENABLED"
116
+ * },
117
+ * {
118
+ * "CreationDateTime": 1506118003.859,
119
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI",
120
+ * "Name": "ExampleCD2",
121
+ * "State": "ENABLED"
122
+ * },
123
+ * {
124
+ * "CreationDateTime": 1485477107.925,
125
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AWeI1yjiB0SylWVTvQklCD0",
126
+ * "Name": "testCD2",
127
+ * "State": "DELETED"
128
+ * }
129
+ * ]
130
+ * }
131
+ * *\/
132
+ * // example id: to-list-all-directories-in-your-aws-account-1508262706411
133
+ * ```
134
+ *
90
135
  */
91
136
  export declare class ListDirectoriesCommand extends ListDirectoriesCommand_base {
92
137
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/ListFacetAttributesCommand.d.ts CHANGED
@@ -115,6 +115,195 @@ declare const ListFacetAttributesCommand_base: {
115
115
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
116
116
  *
117
117
  * @public
118
+ * @example To list facet attributes
119
+ * ```javascript
120
+ * //
121
+ * const input = {
122
+ * "Name": "Organization",
123
+ * "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
124
+ * };
125
+ * const command = new ListFacetAttributesCommand(input);
126
+ * const response = await client.send(command);
127
+ * /* response ==
128
+ * {
129
+ * "Attributes": [
130
+ * {
131
+ * "AttributeDefinition": {
132
+ * "IsImmutable": false,
133
+ * "Rules": {
134
+ * "nameLength": {
135
+ * "Parameters": {
136
+ * "max": "1024",
137
+ * "min": "1"
138
+ * },
139
+ * "Type": "STRING_LENGTH"
140
+ * }
141
+ * },
142
+ * "Type": "STRING"
143
+ * },
144
+ * "Name": "account_id",
145
+ * "RequiredBehavior": "NOT_REQUIRED"
146
+ * },
147
+ * {
148
+ * "AttributeDefinition": {
149
+ * "IsImmutable": false,
150
+ * "Rules": {
151
+ * "nameLength": {
152
+ * "Parameters": {
153
+ * "max": "1024",
154
+ * "min": "1"
155
+ * },
156
+ * "Type": "STRING_LENGTH"
157
+ * }
158
+ * },
159
+ * "Type": "STRING"
160
+ * },
161
+ * "Name": "account_name",
162
+ * "RequiredBehavior": "NOT_REQUIRED"
163
+ * },
164
+ * {
165
+ * "AttributeDefinition": {
166
+ * "IsImmutable": false,
167
+ * "Rules": {
168
+ * "nameLength": {
169
+ * "Parameters": {
170
+ * "max": "1024",
171
+ * "min": "1"
172
+ * },
173
+ * "Type": "STRING_LENGTH"
174
+ * }
175
+ * },
176
+ * "Type": "STRING"
177
+ * },
178
+ * "Name": "description",
179
+ * "RequiredBehavior": "NOT_REQUIRED"
180
+ * },
181
+ * {
182
+ * "AttributeDefinition": {
183
+ * "IsImmutable": false,
184
+ * "Rules": {
185
+ * "nameLength": {
186
+ * "Parameters": {
187
+ * "max": "1024",
188
+ * "min": "1"
189
+ * },
190
+ * "Type": "STRING_LENGTH"
191
+ * }
192
+ * },
193
+ * "Type": "STRING"
194
+ * },
195
+ * "Name": "email",
196
+ * "RequiredBehavior": "NOT_REQUIRED"
197
+ * },
198
+ * {
199
+ * "AttributeDefinition": {
200
+ * "IsImmutable": false,
201
+ * "Rules": {
202
+ * "nameLength": {
203
+ * "Parameters": {
204
+ * "max": "1024",
205
+ * "min": "1"
206
+ * },
207
+ * "Type": "STRING_LENGTH"
208
+ * }
209
+ * },
210
+ * "Type": "STRING"
211
+ * },
212
+ * "Name": "mailing_address_city",
213
+ * "RequiredBehavior": "NOT_REQUIRED"
214
+ * },
215
+ * {
216
+ * "AttributeDefinition": {
217
+ * "IsImmutable": false,
218
+ * "Rules": {
219
+ * "nameLength": {
220
+ * "Parameters": {
221
+ * "max": "1024",
222
+ * "min": "1"
223
+ * },
224
+ * "Type": "STRING_LENGTH"
225
+ * }
226
+ * },
227
+ * "Type": "STRING"
228
+ * },
229
+ * "Name": "mailing_address_country",
230
+ * "RequiredBehavior": "NOT_REQUIRED"
231
+ * },
232
+ * {
233
+ * "AttributeDefinition": {
234
+ * "IsImmutable": false,
235
+ * "Rules": {
236
+ * "nameLength": {
237
+ * "Parameters": {
238
+ * "max": "1024",
239
+ * "min": "1"
240
+ * },
241
+ * "Type": "STRING_LENGTH"
242
+ * }
243
+ * },
244
+ * "Type": "STRING"
245
+ * },
246
+ * "Name": "mailing_address_postal_code",
247
+ * "RequiredBehavior": "NOT_REQUIRED"
248
+ * },
249
+ * {
250
+ * "AttributeDefinition": {
251
+ * "IsImmutable": false,
252
+ * "Rules": {
253
+ * "nameLength": {
254
+ * "Parameters": {
255
+ * "max": "1024",
256
+ * "min": "1"
257
+ * },
258
+ * "Type": "STRING_LENGTH"
259
+ * }
260
+ * },
261
+ * "Type": "STRING"
262
+ * },
263
+ * "Name": "mailing_address_state",
264
+ * "RequiredBehavior": "NOT_REQUIRED"
265
+ * },
266
+ * {
267
+ * "AttributeDefinition": {
268
+ * "IsImmutable": false,
269
+ * "Rules": {
270
+ * "nameLength": {
271
+ * "Parameters": {
272
+ * "max": "1024",
273
+ * "min": "1"
274
+ * },
275
+ * "Type": "STRING_LENGTH"
276
+ * }
277
+ * },
278
+ * "Type": "STRING"
279
+ * },
280
+ * "Name": "mailing_address_street1",
281
+ * "RequiredBehavior": "NOT_REQUIRED"
282
+ * },
283
+ * {
284
+ * "AttributeDefinition": {
285
+ * "IsImmutable": false,
286
+ * "Rules": {
287
+ * "nameLength": {
288
+ * "Parameters": {
289
+ * "max": "1024",
290
+ * "min": "1"
291
+ * },
292
+ * "Type": "STRING_LENGTH"
293
+ * }
294
+ * },
295
+ * "Type": "STRING"
296
+ * },
297
+ * "Name": "mailing_address_street2",
298
+ * "RequiredBehavior": "NOT_REQUIRED"
299
+ * }
300
+ * ],
301
+ * "NextToken": "V0b3JnYW5pemF0aW9uX3N0YXR1cw=="
302
+ * }
303
+ * *\/
304
+ * // example id: to-list-facet-attributes-1508275015421
305
+ * ```
306
+ *
118
307
  */
119
308
  export declare class ListFacetAttributesCommand extends ListFacetAttributesCommand_base {
120
309
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/ListFacetNamesCommand.d.ts CHANGED
@@ -85,6 +85,29 @@ declare const ListFacetNamesCommand_base: {
85
85
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
86
86
  *
87
87
  * @public
88
+ * @example To list facet names
89
+ * ```javascript
90
+ * //
91
+ * const input = {
92
+ * "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
93
+ * };
94
+ * const command = new ListFacetNamesCommand(input);
95
+ * const response = await client.send(command);
96
+ * /* response ==
97
+ * {
98
+ * "FacetNames": [
99
+ * "Legal_Entity",
100
+ * "Organization",
101
+ * "node1",
102
+ * "node2",
103
+ * "nodex",
104
+ * "policyfacet"
105
+ * ]
106
+ * }
107
+ * *\/
108
+ * // example id: to-list-facet-names-1508275974689
109
+ * ```
110
+ *
88
111
  */
89
112
  export declare class ListFacetNamesCommand extends ListFacetNamesCommand_base {
90
113
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/ListIncomingTypedLinksCommand.d.ts CHANGED
@@ -148,6 +148,87 @@ declare const ListIncomingTypedLinksCommand_base: {
148
148
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
149
149
  *
150
150
  * @public
151
+ * @example To list incoming typed links
152
+ * ```javascript
153
+ * //
154
+ * const input = {
155
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
156
+ * "ObjectReference": {
157
+ * "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
158
+ * }
159
+ * };
160
+ * const command = new ListIncomingTypedLinksCommand(input);
161
+ * const response = await client.send(command);
162
+ * /* response ==
163
+ * {
164
+ * "LinkSpecifiers": [
165
+ * {
166
+ * "IdentityAttributeValues": [
167
+ * {
168
+ * "AttributeName": "22",
169
+ * "Value": {
170
+ * "BinaryValue": ""
171
+ * }
172
+ * }
173
+ * ],
174
+ * "SourceObjectReference": {
175
+ * "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
176
+ * },
177
+ * "TargetObjectReference": {
178
+ * "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
179
+ * },
180
+ * "TypedLinkFacet": {
181
+ * "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1",
182
+ * "TypedLinkName": "exampletypedlink8"
183
+ * }
184
+ * },
185
+ * {
186
+ * "IdentityAttributeValues": [
187
+ * {
188
+ * "AttributeName": "22",
189
+ * "Value": {
190
+ * "BinaryValue": "MA=="
191
+ * }
192
+ * }
193
+ * ],
194
+ * "SourceObjectReference": {
195
+ * "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
196
+ * },
197
+ * "TargetObjectReference": {
198
+ * "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
199
+ * },
200
+ * "TypedLinkFacet": {
201
+ * "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1",
202
+ * "TypedLinkName": "exampletypedlink8"
203
+ * }
204
+ * },
205
+ * {
206
+ * "IdentityAttributeValues": [
207
+ * {
208
+ * "AttributeName": "22",
209
+ * "Value": {
210
+ * "BinaryValue": "c3Ry"
211
+ * }
212
+ * }
213
+ * ],
214
+ * "SourceObjectReference": {
215
+ * "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
216
+ * },
217
+ * "TargetObjectReference": {
218
+ * "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
219
+ * },
220
+ * "TypedLinkFacet": {
221
+ * "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1",
222
+ * "TypedLinkName": "exampletypedlink8"
223
+ * }
224
+ * }
225
+ * ],
226
+ * "NextToken": ""
227
+ * }
228
+ * *\/
229
+ * // example id: to-list-incoming-typed-links-1508276145750
230
+ * ```
231
+ *
151
232
  */
152
233
  export declare class ListIncomingTypedLinksCommand extends ListIncomingTypedLinksCommand_base {
153
234
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/ListIndexCommand.d.ts CHANGED
@@ -144,6 +144,39 @@ declare const ListIndexCommand_base: {
144
144
  * <p>Base exception class for all service exceptions from CloudDirectory service.</p>
145
145
  *
146
146
  * @public
147
+ * @example To list an index
148
+ * ```javascript
149
+ * //
150
+ * const input = {
151
+ * "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
152
+ * "IndexReference": {
153
+ * "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q"
154
+ * }
155
+ * };
156
+ * const command = new ListIndexCommand(input);
157
+ * const response = await client.send(command);
158
+ * /* response ==
159
+ * {
160
+ * "IndexAttachments": [
161
+ * {
162
+ * "IndexedAttributes": [
163
+ * {
164
+ * "Key": {
165
+ * "FacetName": "Organization",
166
+ * "Name": "description",
167
+ * "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
168
+ * },
169
+ * "Value": {}
170
+ * }
171
+ * ],
172
+ * "ObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
173
+ * }
174
+ * ]
175
+ * }
176
+ * *\/
177
+ * // example id: to-list-an-index-1508281185950
178
+ * ```
179
+ *
147
180
  */
148
181
  export declare class ListIndexCommand extends ListIndexCommand_base {
149
182
  /** @internal type navigation helper, not in runtime. */