@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.
- package/dist-types/commands/AddFacetToObjectCommand.d.ts +19 -0
- package/dist-types/commands/ApplySchemaCommand.d.ts +18 -0
- package/dist-types/commands/AttachObjectCommand.d.ts +23 -0
- package/dist-types/commands/AttachPolicyCommand.d.ts +17 -0
- package/dist-types/commands/AttachToIndexCommand.d.ts +22 -0
- package/dist-types/commands/AttachTypedLinkCommand.d.ts +53 -0
- package/dist-types/commands/BatchReadCommand.d.ts +18 -0
- package/dist-types/commands/BatchWriteCommand.d.ts +17 -0
- package/dist-types/commands/CreateDirectoryCommand.d.ts +20 -0
- package/dist-types/commands/CreateFacetCommand.d.ts +13 -0
- package/dist-types/commands/CreateIndexCommand.d.ts +20 -0
- package/dist-types/commands/CreateObjectCommand.d.ts +22 -0
- package/dist-types/commands/CreateSchemaCommand.d.ts +16 -0
- package/dist-types/commands/CreateTypedLinkFacetCommand.d.ts +24 -0
- package/dist-types/commands/DeleteDirectoryCommand.d.ts +16 -0
- package/dist-types/commands/DeleteFacetCommand.d.ts +12 -0
- package/dist-types/commands/DeleteObjectCommand.d.ts +14 -0
- package/dist-types/commands/DeleteSchemaCommand.d.ts +16 -0
- package/dist-types/commands/DeleteTypedLinkFacetCommand.d.ts +12 -0
- package/dist-types/commands/DetachFromIndexCommand.d.ts +22 -0
- package/dist-types/commands/DetachObjectCommand.d.ts +20 -0
- package/dist-types/commands/DetachPolicyCommand.d.ts +17 -0
- package/dist-types/commands/DetachTypedLinkCommand.d.ts +31 -0
- package/dist-types/commands/DisableDirectoryCommand.d.ts +16 -0
- package/dist-types/commands/EnableDirectoryCommand.d.ts +16 -0
- package/dist-types/commands/GetDirectoryCommand.d.ts +21 -0
- package/dist-types/commands/GetFacetCommand.d.ts +20 -0
- package/dist-types/commands/GetObjectInformationCommand.d.ts +26 -0
- package/dist-types/commands/GetSchemaAsJsonCommand.d.ts +17 -0
- package/dist-types/commands/GetTypedLinkFacetInformationCommand.d.ts +19 -0
- package/dist-types/commands/ListAppliedSchemaArnsCommand.d.ts +18 -0
- package/dist-types/commands/ListAttachedIndicesCommand.d.ts +24 -0
- package/dist-types/commands/ListDevelopmentSchemaArnsCommand.d.ts +21 -0
- package/dist-types/commands/ListDirectoriesCommand.d.ts +45 -0
- package/dist-types/commands/ListFacetAttributesCommand.d.ts +189 -0
- package/dist-types/commands/ListFacetNamesCommand.d.ts +23 -0
- package/dist-types/commands/ListIncomingTypedLinksCommand.d.ts +81 -0
- package/dist-types/commands/ListIndexCommand.d.ts +33 -0
- package/dist-types/commands/ListObjectAttributesCommand.d.ts +40 -0
- package/dist-types/commands/ListObjectChildrenCommand.d.ts +21 -0
- package/package.json +35 -35
|
@@ -105,6 +105,25 @@ declare const AddFacetToObjectCommand_base: {
|
|
|
105
105
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
106
106
|
*
|
|
107
107
|
* @public
|
|
108
|
+
* @example To add a facet to an object
|
|
109
|
+
* ```javascript
|
|
110
|
+
* //
|
|
111
|
+
* const input = {
|
|
112
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
113
|
+
* "ObjectAttributeList": [],
|
|
114
|
+
* "ObjectReference": {
|
|
115
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ"
|
|
116
|
+
* },
|
|
117
|
+
* "SchemaFacet": {
|
|
118
|
+
* "FacetName": "node1",
|
|
119
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
|
|
120
|
+
* }
|
|
121
|
+
* };
|
|
122
|
+
* const command = new AddFacetToObjectCommand(input);
|
|
123
|
+
* await client.send(command);
|
|
124
|
+
* // example id: to-add-a-facet-to-an-object-1507568792747
|
|
125
|
+
* ```
|
|
126
|
+
*
|
|
108
127
|
*/
|
|
109
128
|
export declare class AddFacetToObjectCommand extends AddFacetToObjectCommand_base {
|
|
110
129
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -88,6 +88,24 @@ declare const ApplySchemaCommand_base: {
|
|
|
88
88
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
89
89
|
*
|
|
90
90
|
* @public
|
|
91
|
+
* @example To apply a schema
|
|
92
|
+
* ```javascript
|
|
93
|
+
* //
|
|
94
|
+
* const input = {
|
|
95
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI",
|
|
96
|
+
* "PublishedSchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/published/org/1"
|
|
97
|
+
* };
|
|
98
|
+
* const command = new ApplySchemaCommand(input);
|
|
99
|
+
* const response = await client.send(command);
|
|
100
|
+
* /* response ==
|
|
101
|
+
* {
|
|
102
|
+
* "AppliedSchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI/schema/org/1",
|
|
103
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI"
|
|
104
|
+
* }
|
|
105
|
+
* *\/
|
|
106
|
+
* // example id: to-apply-a-schema-1507061899015
|
|
107
|
+
* ```
|
|
108
|
+
*
|
|
91
109
|
*/
|
|
92
110
|
export declare class ApplySchemaCommand extends ApplySchemaCommand_base {
|
|
93
111
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -109,6 +109,29 @@ declare const AttachObjectCommand_base: {
|
|
|
109
109
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
110
110
|
*
|
|
111
111
|
* @public
|
|
112
|
+
* @example To attach an object
|
|
113
|
+
* ```javascript
|
|
114
|
+
* //
|
|
115
|
+
* const input = {
|
|
116
|
+
* "ChildReference": {
|
|
117
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
|
|
118
|
+
* },
|
|
119
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
120
|
+
* "LinkName": "link2",
|
|
121
|
+
* "ParentReference": {
|
|
122
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
123
|
+
* }
|
|
124
|
+
* };
|
|
125
|
+
* const command = new AttachObjectCommand(input);
|
|
126
|
+
* const response = await client.send(command);
|
|
127
|
+
* /* response ==
|
|
128
|
+
* {
|
|
129
|
+
* "AttachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
|
|
130
|
+
* }
|
|
131
|
+
* *\/
|
|
132
|
+
* // example id: to-attach-an-object-1507060976164
|
|
133
|
+
* ```
|
|
134
|
+
*
|
|
112
135
|
*/
|
|
113
136
|
export declare class AttachObjectCommand extends AttachObjectCommand_base {
|
|
114
137
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -88,6 +88,23 @@ declare const AttachPolicyCommand_base: {
|
|
|
88
88
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
89
89
|
*
|
|
90
90
|
* @public
|
|
91
|
+
* @example To attach a policy to an object
|
|
92
|
+
* ```javascript
|
|
93
|
+
* //
|
|
94
|
+
* const input = {
|
|
95
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
96
|
+
* "ObjectReference": {
|
|
97
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWQoovm1s3Ts2v0NKrzdVnPw"
|
|
98
|
+
* },
|
|
99
|
+
* "PolicyReference": {
|
|
100
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWgcBsTVmcQEWs6jlygfhuew"
|
|
101
|
+
* }
|
|
102
|
+
* };
|
|
103
|
+
* const command = new AttachPolicyCommand(input);
|
|
104
|
+
* await client.send(command);
|
|
105
|
+
* // example id: to-attach-a-policy-to-an-object-1508268194724
|
|
106
|
+
* ```
|
|
107
|
+
*
|
|
91
108
|
*/
|
|
92
109
|
export declare class AttachPolicyCommand extends AttachPolicyCommand_base {
|
|
93
110
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -100,6 +100,28 @@ declare const AttachToIndexCommand_base: {
|
|
|
100
100
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
101
101
|
*
|
|
102
102
|
* @public
|
|
103
|
+
* @example To attach a index to an object
|
|
104
|
+
* ```javascript
|
|
105
|
+
* //
|
|
106
|
+
* const input = {
|
|
107
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
108
|
+
* "IndexReference": {
|
|
109
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q"
|
|
110
|
+
* },
|
|
111
|
+
* "TargetReference": {
|
|
112
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
113
|
+
* }
|
|
114
|
+
* };
|
|
115
|
+
* const command = new AttachToIndexCommand(input);
|
|
116
|
+
* const response = await client.send(command);
|
|
117
|
+
* /* response ==
|
|
118
|
+
* {
|
|
119
|
+
* "AttachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
120
|
+
* }
|
|
121
|
+
* *\/
|
|
122
|
+
* // example id: to-attach-a-index-to-an-object-1506532855758
|
|
123
|
+
* ```
|
|
124
|
+
*
|
|
103
125
|
*/
|
|
104
126
|
export declare class AttachToIndexCommand extends AttachToIndexCommand_base {
|
|
105
127
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -133,6 +133,59 @@ declare const AttachTypedLinkCommand_base: {
|
|
|
133
133
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
134
134
|
*
|
|
135
135
|
* @public
|
|
136
|
+
* @example To attach a typed link to an object
|
|
137
|
+
* ```javascript
|
|
138
|
+
* //
|
|
139
|
+
* const input = {
|
|
140
|
+
* "Attributes": [
|
|
141
|
+
* {
|
|
142
|
+
* "AttributeName": "22",
|
|
143
|
+
* "Value": {
|
|
144
|
+
* "BinaryValue": "c3Ry"
|
|
145
|
+
* }
|
|
146
|
+
* }
|
|
147
|
+
* ],
|
|
148
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
149
|
+
* "SourceObjectReference": {
|
|
150
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
|
|
151
|
+
* },
|
|
152
|
+
* "TargetObjectReference": {
|
|
153
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
154
|
+
* },
|
|
155
|
+
* "TypedLinkFacet": {
|
|
156
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1",
|
|
157
|
+
* "TypedLinkName": "exampletypedlink8"
|
|
158
|
+
* }
|
|
159
|
+
* };
|
|
160
|
+
* const command = new AttachTypedLinkCommand(input);
|
|
161
|
+
* const response = await client.send(command);
|
|
162
|
+
* /* response ==
|
|
163
|
+
* {
|
|
164
|
+
* "TypedLinkSpecifier": {
|
|
165
|
+
* "IdentityAttributeValues": [
|
|
166
|
+
* {
|
|
167
|
+
* "AttributeName": "22",
|
|
168
|
+
* "Value": {
|
|
169
|
+
* "BinaryValue": "c3Ry"
|
|
170
|
+
* }
|
|
171
|
+
* }
|
|
172
|
+
* ],
|
|
173
|
+
* "SourceObjectReference": {
|
|
174
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
|
|
175
|
+
* },
|
|
176
|
+
* "TargetObjectReference": {
|
|
177
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
178
|
+
* },
|
|
179
|
+
* "TypedLinkFacet": {
|
|
180
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1",
|
|
181
|
+
* "TypedLinkName": "exampletypedlink8"
|
|
182
|
+
* }
|
|
183
|
+
* }
|
|
184
|
+
* }
|
|
185
|
+
* *\/
|
|
186
|
+
* // example id: to-attach-a-typed-link-to-an-object-1506559900588
|
|
187
|
+
* ```
|
|
188
|
+
*
|
|
136
189
|
*/
|
|
137
190
|
export declare class AttachTypedLinkCommand extends AttachTypedLinkCommand_base {
|
|
138
191
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -478,6 +478,24 @@ declare const BatchReadCommand_base: {
|
|
|
478
478
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
479
479
|
*
|
|
480
480
|
* @public
|
|
481
|
+
* @example To run a batch read command
|
|
482
|
+
* ```javascript
|
|
483
|
+
* //
|
|
484
|
+
* const input = {
|
|
485
|
+
* "ConsistencyLevel": "EVENTUAL",
|
|
486
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
487
|
+
* "Operations": []
|
|
488
|
+
* };
|
|
489
|
+
* const command = new BatchReadCommand(input);
|
|
490
|
+
* const response = await client.send(command);
|
|
491
|
+
* /* response ==
|
|
492
|
+
* {
|
|
493
|
+
* "Responses": []
|
|
494
|
+
* }
|
|
495
|
+
* *\/
|
|
496
|
+
* // example id: to-run-a-batch-read-command-1506123433380
|
|
497
|
+
* ```
|
|
498
|
+
*
|
|
481
499
|
*/
|
|
482
500
|
export declare class BatchReadCommand extends BatchReadCommand_base {
|
|
483
501
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -344,6 +344,23 @@ declare const BatchWriteCommand_base: {
|
|
|
344
344
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
345
345
|
*
|
|
346
346
|
* @public
|
|
347
|
+
* @example To run a batch write command
|
|
348
|
+
* ```javascript
|
|
349
|
+
* //
|
|
350
|
+
* const input = {
|
|
351
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
352
|
+
* "Operations": []
|
|
353
|
+
* };
|
|
354
|
+
* const command = new BatchWriteCommand(input);
|
|
355
|
+
* const response = await client.send(command);
|
|
356
|
+
* /* response ==
|
|
357
|
+
* {
|
|
358
|
+
* "Responses": []
|
|
359
|
+
* }
|
|
360
|
+
* *\/
|
|
361
|
+
* // example id: to-run-a-batch-write-command-1506122878964
|
|
362
|
+
* ```
|
|
363
|
+
*
|
|
347
364
|
*/
|
|
348
365
|
export declare class BatchWriteCommand extends BatchWriteCommand_base {
|
|
349
366
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -88,6 +88,26 @@ declare const CreateDirectoryCommand_base: {
|
|
|
88
88
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
89
89
|
*
|
|
90
90
|
* @public
|
|
91
|
+
* @example To create a new Cloud Directory
|
|
92
|
+
* ```javascript
|
|
93
|
+
* //
|
|
94
|
+
* const input = {
|
|
95
|
+
* "Name": "ExampleCD",
|
|
96
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/published/person/1"
|
|
97
|
+
* };
|
|
98
|
+
* const command = new CreateDirectoryCommand(input);
|
|
99
|
+
* const response = await client.send(command);
|
|
100
|
+
* /* response ==
|
|
101
|
+
* {
|
|
102
|
+
* "AppliedSchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI/schema/person/1",
|
|
103
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI",
|
|
104
|
+
* "Name": "ExampleCD",
|
|
105
|
+
* "ObjectIdentifier": "AQHzK-KsptZGU78KjmnwGH6i-4guCM3uQFOTA9_NjeHDrg"
|
|
106
|
+
* }
|
|
107
|
+
* *\/
|
|
108
|
+
* // example id: to-create-a-new-cloud-directory-1506119878996
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
91
111
|
*/
|
|
92
112
|
export declare class CreateDirectoryCommand extends CreateDirectoryCommand_base {
|
|
93
113
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -118,6 +118,19 @@ declare const CreateFacetCommand_base: {
|
|
|
118
118
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
119
119
|
*
|
|
120
120
|
* @public
|
|
121
|
+
* @example To create a facet
|
|
122
|
+
* ```javascript
|
|
123
|
+
* //
|
|
124
|
+
* const input = {
|
|
125
|
+
* "Name": "node1",
|
|
126
|
+
* "ObjectType": "NODE",
|
|
127
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
|
|
128
|
+
* };
|
|
129
|
+
* const command = new CreateFacetCommand(input);
|
|
130
|
+
* await client.send(command);
|
|
131
|
+
* // example id: to-create-a-facet-1506112442334
|
|
132
|
+
* ```
|
|
133
|
+
*
|
|
121
134
|
*/
|
|
122
135
|
export declare class CreateFacetCommand extends CreateFacetCommand_base {
|
|
123
136
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -103,6 +103,26 @@ declare const CreateIndexCommand_base: {
|
|
|
103
103
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
104
104
|
*
|
|
105
105
|
* @public
|
|
106
|
+
* @example To create an index
|
|
107
|
+
* ```javascript
|
|
108
|
+
* //
|
|
109
|
+
* const input = {
|
|
110
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8",
|
|
111
|
+
* "IsUnique": true,
|
|
112
|
+
* "LinkName": "Examplelink",
|
|
113
|
+
* "OrderedIndexedAttributeList": [],
|
|
114
|
+
* "ParentReference": {}
|
|
115
|
+
* };
|
|
116
|
+
* const command = new CreateIndexCommand(input);
|
|
117
|
+
* const response = await client.send(command);
|
|
118
|
+
* /* response ==
|
|
119
|
+
* {
|
|
120
|
+
* "ObjectIdentifier": "AQF0Fw173YJDlpLUV1eB50WvYsWFtVoUSmOzZjz_BLULIA"
|
|
121
|
+
* }
|
|
122
|
+
* *\/
|
|
123
|
+
* // example id: to-create-an-index-1505339563796
|
|
124
|
+
* ```
|
|
125
|
+
*
|
|
106
126
|
*/
|
|
107
127
|
export declare class CreateIndexCommand extends CreateIndexCommand_base {
|
|
108
128
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -120,6 +120,28 @@ declare const CreateObjectCommand_base: {
|
|
|
120
120
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
121
121
|
*
|
|
122
122
|
* @public
|
|
123
|
+
* @example To create an object
|
|
124
|
+
* ```javascript
|
|
125
|
+
* //
|
|
126
|
+
* const input = {
|
|
127
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8",
|
|
128
|
+
* "SchemaFacets": [
|
|
129
|
+
* {
|
|
130
|
+
* "FacetName": "Organization_Person",
|
|
131
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8/schema/ExampleOrgPersonSchema/1"
|
|
132
|
+
* }
|
|
133
|
+
* ]
|
|
134
|
+
* };
|
|
135
|
+
* const command = new CreateObjectCommand(input);
|
|
136
|
+
* const response = await client.send(command);
|
|
137
|
+
* /* response ==
|
|
138
|
+
* {
|
|
139
|
+
* "ObjectIdentifier": "AQF0Fw173YJDlpLUV1eB50WvScvjsYXcS3K2nP1HwDuuYQ"
|
|
140
|
+
* }
|
|
141
|
+
* *\/
|
|
142
|
+
* // example id: to-create-an-object-1494010287120
|
|
143
|
+
* ```
|
|
144
|
+
*
|
|
123
145
|
*/
|
|
124
146
|
export declare class CreateObjectCommand extends CreateObjectCommand_base {
|
|
125
147
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -98,6 +98,22 @@ declare const CreateSchemaCommand_base: {
|
|
|
98
98
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
99
99
|
*
|
|
100
100
|
* @public
|
|
101
|
+
* @example To create a schema
|
|
102
|
+
* ```javascript
|
|
103
|
+
* //
|
|
104
|
+
* const input = {
|
|
105
|
+
* "Name": "Customers"
|
|
106
|
+
* };
|
|
107
|
+
* const command = new CreateSchemaCommand(input);
|
|
108
|
+
* const response = await client.send(command);
|
|
109
|
+
* /* response ==
|
|
110
|
+
* {
|
|
111
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/Customers"
|
|
112
|
+
* }
|
|
113
|
+
* *\/
|
|
114
|
+
* // example id: to-create-a-schema-1506530911949
|
|
115
|
+
* ```
|
|
116
|
+
*
|
|
101
117
|
*/
|
|
102
118
|
export declare class CreateSchemaCommand extends CreateSchemaCommand_base {
|
|
103
119
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -114,6 +114,30 @@ declare const CreateTypedLinkFacetCommand_base: {
|
|
|
114
114
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
115
115
|
*
|
|
116
116
|
* @public
|
|
117
|
+
* @example To create a typed link facet
|
|
118
|
+
* ```javascript
|
|
119
|
+
* //
|
|
120
|
+
* const input = {
|
|
121
|
+
* "Facet": {
|
|
122
|
+
* "Attributes": [
|
|
123
|
+
* {
|
|
124
|
+
* "Name": "1",
|
|
125
|
+
* "RequiredBehavior": "REQUIRED_ALWAYS",
|
|
126
|
+
* "Type": "BINARY"
|
|
127
|
+
* }
|
|
128
|
+
* ],
|
|
129
|
+
* "IdentityAttributeOrder": [
|
|
130
|
+
* "1"
|
|
131
|
+
* ],
|
|
132
|
+
* "Name": "FacetExample"
|
|
133
|
+
* },
|
|
134
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschema"
|
|
135
|
+
* };
|
|
136
|
+
* const command = new CreateTypedLinkFacetCommand(input);
|
|
137
|
+
* await client.send(command);
|
|
138
|
+
* // example id: to-create-a-typed-link-facet-1506127699199
|
|
139
|
+
* ```
|
|
140
|
+
*
|
|
117
141
|
*/
|
|
118
142
|
export declare class CreateTypedLinkFacetCommand extends CreateTypedLinkFacetCommand_base {
|
|
119
143
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -86,6 +86,22 @@ declare const DeleteDirectoryCommand_base: {
|
|
|
86
86
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
87
87
|
*
|
|
88
88
|
* @public
|
|
89
|
+
* @example To delete a directory
|
|
90
|
+
* ```javascript
|
|
91
|
+
* //
|
|
92
|
+
* const input = {
|
|
93
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
|
|
94
|
+
* };
|
|
95
|
+
* const command = new DeleteDirectoryCommand(input);
|
|
96
|
+
* const response = await client.send(command);
|
|
97
|
+
* /* response ==
|
|
98
|
+
* {
|
|
99
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
|
|
100
|
+
* }
|
|
101
|
+
* *\/
|
|
102
|
+
* // example id: to-delete-a-directory-1507570867859
|
|
103
|
+
* ```
|
|
104
|
+
*
|
|
89
105
|
*/
|
|
90
106
|
export declare class DeleteDirectoryCommand extends DeleteDirectoryCommand_base {
|
|
91
107
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -85,6 +85,18 @@ declare const DeleteFacetCommand_base: {
|
|
|
85
85
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
86
86
|
*
|
|
87
87
|
* @public
|
|
88
|
+
* @example To delete a facet
|
|
89
|
+
* ```javascript
|
|
90
|
+
* //
|
|
91
|
+
* const input = {
|
|
92
|
+
* "Name": "Organization",
|
|
93
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest"
|
|
94
|
+
* };
|
|
95
|
+
* const command = new DeleteFacetCommand(input);
|
|
96
|
+
* await client.send(command);
|
|
97
|
+
* // example id: to-delete-a-facet-1507573383449
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
88
100
|
*/
|
|
89
101
|
export declare class DeleteFacetCommand extends DeleteFacetCommand_base {
|
|
90
102
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -86,6 +86,20 @@ declare const DeleteObjectCommand_base: {
|
|
|
86
86
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
87
87
|
*
|
|
88
88
|
* @public
|
|
89
|
+
* @example To delete an object
|
|
90
|
+
* ```javascript
|
|
91
|
+
* //
|
|
92
|
+
* const input = {
|
|
93
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI",
|
|
94
|
+
* "ObjectReference": {
|
|
95
|
+
* "Selector": "$AQHzK-KsptZGU78KjmnwGH6i8H-voMZDSNCqfx-fRUcBFg"
|
|
96
|
+
* }
|
|
97
|
+
* };
|
|
98
|
+
* const command = new DeleteObjectCommand(input);
|
|
99
|
+
* await client.send(command);
|
|
100
|
+
* // example id: to-delete-an-object-1507574607158
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
89
103
|
*/
|
|
90
104
|
export declare class DeleteObjectCommand extends DeleteObjectCommand_base {
|
|
91
105
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -81,6 +81,22 @@ declare const DeleteSchemaCommand_base: {
|
|
|
81
81
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
82
82
|
*
|
|
83
83
|
* @public
|
|
84
|
+
* @example To delete a schema
|
|
85
|
+
* ```javascript
|
|
86
|
+
* //
|
|
87
|
+
* const input = {
|
|
88
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest"
|
|
89
|
+
* };
|
|
90
|
+
* const command = new DeleteSchemaCommand(input);
|
|
91
|
+
* const response = await client.send(command);
|
|
92
|
+
* /* response ==
|
|
93
|
+
* {
|
|
94
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest"
|
|
95
|
+
* }
|
|
96
|
+
* *\/
|
|
97
|
+
* // example id: to-delete-a-schema-1507575230059
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
84
100
|
*/
|
|
85
101
|
export declare class DeleteSchemaCommand extends DeleteSchemaCommand_base {
|
|
86
102
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -79,6 +79,18 @@ declare const DeleteTypedLinkFacetCommand_base: {
|
|
|
79
79
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
80
80
|
*
|
|
81
81
|
* @public
|
|
82
|
+
* @example To delete a typed link facet
|
|
83
|
+
* ```javascript
|
|
84
|
+
* //
|
|
85
|
+
* const input = {
|
|
86
|
+
* "Name": "ExampleFacet",
|
|
87
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschematest"
|
|
88
|
+
* };
|
|
89
|
+
* const command = new DeleteTypedLinkFacetCommand(input);
|
|
90
|
+
* await client.send(command);
|
|
91
|
+
* // example id: to-delete-a-typed-link-facet-1507576290714
|
|
92
|
+
* ```
|
|
93
|
+
*
|
|
82
94
|
*/
|
|
83
95
|
export declare class DeleteTypedLinkFacetCommand extends DeleteTypedLinkFacetCommand_base {
|
|
84
96
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -92,6 +92,28 @@ declare const DetachFromIndexCommand_base: {
|
|
|
92
92
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
93
93
|
*
|
|
94
94
|
* @public
|
|
95
|
+
* @example To detach an object from an index
|
|
96
|
+
* ```javascript
|
|
97
|
+
* //
|
|
98
|
+
* const input = {
|
|
99
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
100
|
+
* "IndexReference": {
|
|
101
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q"
|
|
102
|
+
* },
|
|
103
|
+
* "TargetReference": {
|
|
104
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
105
|
+
* }
|
|
106
|
+
* };
|
|
107
|
+
* const command = new DetachFromIndexCommand(input);
|
|
108
|
+
* const response = await client.send(command);
|
|
109
|
+
* /* response ==
|
|
110
|
+
* {
|
|
111
|
+
* "DetachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
112
|
+
* }
|
|
113
|
+
* *\/
|
|
114
|
+
* // example id: to-detach-an-object-from-an-index-1507579662964
|
|
115
|
+
* ```
|
|
116
|
+
*
|
|
95
117
|
*/
|
|
96
118
|
export declare class DetachFromIndexCommand extends DetachFromIndexCommand_base {
|
|
97
119
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -89,6 +89,26 @@ declare const DetachObjectCommand_base: {
|
|
|
89
89
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
90
90
|
*
|
|
91
91
|
* @public
|
|
92
|
+
* @example To detach an object from its parent object
|
|
93
|
+
* ```javascript
|
|
94
|
+
* //
|
|
95
|
+
* const input = {
|
|
96
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
97
|
+
* "LinkName": "link2",
|
|
98
|
+
* "ParentReference": {
|
|
99
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
100
|
+
* }
|
|
101
|
+
* };
|
|
102
|
+
* const command = new DetachObjectCommand(input);
|
|
103
|
+
* const response = await client.send(command);
|
|
104
|
+
* /* response ==
|
|
105
|
+
* {
|
|
106
|
+
* "DetachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
|
|
107
|
+
* }
|
|
108
|
+
* *\/
|
|
109
|
+
* // example id: to-detach-an-object-from-its-parent-object-1508196401149
|
|
110
|
+
* ```
|
|
111
|
+
*
|
|
92
112
|
*/
|
|
93
113
|
export declare class DetachObjectCommand extends DetachObjectCommand_base {
|
|
94
114
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -87,6 +87,23 @@ declare const DetachPolicyCommand_base: {
|
|
|
87
87
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
88
88
|
*
|
|
89
89
|
* @public
|
|
90
|
+
* @example To detach a policy from an object
|
|
91
|
+
* ```javascript
|
|
92
|
+
* //
|
|
93
|
+
* const input = {
|
|
94
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
95
|
+
* "ObjectReference": {
|
|
96
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWQoovm1s3Ts2v0NKrzdVnPw"
|
|
97
|
+
* },
|
|
98
|
+
* "PolicyReference": {
|
|
99
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWgcBsTVmcQEWs6jlygfhuew"
|
|
100
|
+
* }
|
|
101
|
+
* };
|
|
102
|
+
* const command = new DetachPolicyCommand(input);
|
|
103
|
+
* await client.send(command);
|
|
104
|
+
* // example id: to-detach-a-policy-from-an-object-1508268395318
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
90
107
|
*/
|
|
91
108
|
export declare class DetachPolicyCommand extends DetachPolicyCommand_base {
|
|
92
109
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -106,6 +106,37 @@ declare const DetachTypedLinkCommand_base: {
|
|
|
106
106
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
107
107
|
*
|
|
108
108
|
* @public
|
|
109
|
+
* @example To detach a typed link from an object
|
|
110
|
+
* ```javascript
|
|
111
|
+
* //
|
|
112
|
+
* const input = {
|
|
113
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
114
|
+
* "TypedLinkSpecifier": {
|
|
115
|
+
* "IdentityAttributeValues": [
|
|
116
|
+
* {
|
|
117
|
+
* "AttributeName": "22",
|
|
118
|
+
* "Value": {
|
|
119
|
+
* "BinaryValue": "c3Ry"
|
|
120
|
+
* }
|
|
121
|
+
* }
|
|
122
|
+
* ],
|
|
123
|
+
* "SourceObjectReference": {
|
|
124
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
|
|
125
|
+
* },
|
|
126
|
+
* "TargetObjectReference": {
|
|
127
|
+
* "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
128
|
+
* },
|
|
129
|
+
* "TypedLinkFacet": {
|
|
130
|
+
* "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1",
|
|
131
|
+
* "TypedLinkName": "exampletypedlink8"
|
|
132
|
+
* }
|
|
133
|
+
* }
|
|
134
|
+
* };
|
|
135
|
+
* const command = new DetachTypedLinkCommand(input);
|
|
136
|
+
* await client.send(command);
|
|
137
|
+
* // example id: to-detach-a-typed-link-from-an-object-1506540145856
|
|
138
|
+
* ```
|
|
139
|
+
*
|
|
109
140
|
*/
|
|
110
141
|
export declare class DetachTypedLinkCommand extends DetachTypedLinkCommand_base {
|
|
111
142
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -82,6 +82,22 @@ declare const DisableDirectoryCommand_base: {
|
|
|
82
82
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
83
83
|
*
|
|
84
84
|
* @public
|
|
85
|
+
* @example To disable a directory
|
|
86
|
+
* ```javascript
|
|
87
|
+
* //
|
|
88
|
+
* const input = {
|
|
89
|
+
* "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
|
|
90
|
+
* };
|
|
91
|
+
* const command = new DisableDirectoryCommand(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-disable-a-directory-1507253386265
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
85
101
|
*/
|
|
86
102
|
export declare class DisableDirectoryCommand extends DisableDirectoryCommand_base {
|
|
87
103
|
/** @internal type navigation helper, not in runtime. */
|