@aws-sdk/client-clouddirectory 3.775.0 → 3.777.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 +13 -10
- package/dist-types/commands/ApplySchemaCommand.d.ts +7 -7
- package/dist-types/commands/AttachObjectCommand.d.ts +10 -10
- package/dist-types/commands/AttachPolicyCommand.d.ts +11 -8
- package/dist-types/commands/AttachToIndexCommand.d.ts +9 -9
- package/dist-types/commands/AttachTypedLinkCommand.d.ts +27 -27
- package/dist-types/commands/BatchReadCommand.d.ts +7 -7
- package/dist-types/commands/BatchWriteCommand.d.ts +6 -6
- package/dist-types/commands/CreateDirectoryCommand.d.ts +9 -9
- package/dist-types/commands/CreateFacetCommand.d.ts +9 -6
- package/dist-types/commands/CreateIndexCommand.d.ts +9 -9
- package/dist-types/commands/CreateObjectCommand.d.ts +8 -8
- package/dist-types/commands/CreateSchemaCommand.d.ts +5 -5
- package/dist-types/commands/CreateTypedLinkFacetCommand.d.ts +14 -11
- package/dist-types/commands/DeleteDirectoryCommand.d.ts +5 -5
- package/dist-types/commands/DeleteFacetCommand.d.ts +8 -5
- package/dist-types/commands/DeleteObjectCommand.d.ts +9 -6
- package/dist-types/commands/DeleteSchemaCommand.d.ts +5 -5
- package/dist-types/commands/DeleteTypedLinkFacetCommand.d.ts +8 -5
- package/dist-types/commands/DetachFromIndexCommand.d.ts +9 -9
- package/dist-types/commands/DetachObjectCommand.d.ts +8 -8
- package/dist-types/commands/DetachPolicyCommand.d.ts +11 -8
- package/dist-types/commands/DetachTypedLinkCommand.d.ts +19 -16
- package/dist-types/commands/DisableDirectoryCommand.d.ts +5 -5
- package/dist-types/commands/EnableDirectoryCommand.d.ts +5 -5
- package/dist-types/commands/GetAppliedSchemaVersionCommand.d.ts +1 -0
- package/dist-types/commands/GetDirectoryCommand.d.ts +9 -9
- package/dist-types/commands/GetFacetCommand.d.ts +8 -8
- package/dist-types/commands/GetLinkAttributesCommand.d.ts +1 -0
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +1 -0
- package/dist-types/commands/GetObjectInformationCommand.d.ts +11 -11
- package/dist-types/commands/GetSchemaAsJsonCommand.d.ts +6 -6
- package/dist-types/commands/GetTypedLinkFacetInformationCommand.d.ts +6 -6
- package/dist-types/commands/ListAppliedSchemaArnsCommand.d.ts +5 -5
- package/dist-types/commands/ListAttachedIndicesCommand.d.ts +9 -9
- package/dist-types/commands/ListDevelopmentSchemaArnsCommand.d.ts +5 -5
- package/dist-types/commands/ListDirectoriesCommand.d.ts +25 -25
- package/dist-types/commands/ListFacetAttributesCommand.d.ts +117 -117
- package/dist-types/commands/ListFacetNamesCommand.d.ts +5 -5
- package/dist-types/commands/ListIncomingTypedLinksCommand.d.ts +41 -41
- package/dist-types/commands/ListIndexCommand.d.ts +14 -14
- package/dist-types/commands/ListManagedSchemaArnsCommand.d.ts +1 -0
- package/dist-types/commands/ListObjectAttributesCommand.d.ts +19 -19
- package/dist-types/commands/ListObjectChildrenCommand.d.ts +8 -8
- package/dist-types/commands/ListObjectParentPathsCommand.d.ts +1 -0
- package/dist-types/commands/ListObjectParentsCommand.d.ts +1 -0
- package/dist-types/commands/ListObjectPoliciesCommand.d.ts +1 -0
- package/dist-types/commands/ListOutgoingTypedLinksCommand.d.ts +1 -0
- package/dist-types/commands/ListPolicyAttachmentsCommand.d.ts +1 -0
- package/dist-types/commands/ListPublishedSchemaArnsCommand.d.ts +1 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -0
- package/dist-types/commands/ListTypedLinkFacetAttributesCommand.d.ts +1 -0
- package/dist-types/commands/ListTypedLinkFacetNamesCommand.d.ts +1 -0
- package/dist-types/commands/LookupPolicyCommand.d.ts +1 -0
- package/dist-types/commands/PublishSchemaCommand.d.ts +1 -0
- package/dist-types/commands/PutSchemaFromJsonCommand.d.ts +1 -0
- package/dist-types/commands/RemoveFacetFromObjectCommand.d.ts +1 -0
- package/dist-types/commands/TagResourceCommand.d.ts +1 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -0
- package/dist-types/commands/UpdateFacetCommand.d.ts +1 -0
- package/dist-types/commands/UpdateLinkAttributesCommand.d.ts +1 -0
- package/dist-types/commands/UpdateObjectAttributesCommand.d.ts +1 -0
- package/dist-types/commands/UpdateSchemaCommand.d.ts +1 -0
- package/dist-types/commands/UpdateTypedLinkFacetCommand.d.ts +1 -0
- package/dist-types/commands/UpgradeAppliedSchemaCommand.d.ts +1 -0
- package/dist-types/commands/UpgradePublishedSchemaCommand.d.ts +1 -0
- package/package.json +2 -2
|
@@ -85,21 +85,24 @@ declare const DeleteObjectCommand_base: {
|
|
|
85
85
|
* @throws {@link CloudDirectoryServiceException}
|
|
86
86
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
87
87
|
*
|
|
88
|
-
*
|
|
88
|
+
*
|
|
89
89
|
* @example To delete an object
|
|
90
90
|
* ```javascript
|
|
91
91
|
* //
|
|
92
92
|
* const input = {
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
93
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI",
|
|
94
|
+
* ObjectReference: {
|
|
95
|
+
* Selector: "$AQHzK-KsptZGU78KjmnwGH6i8H-voMZDSNCqfx-fRUcBFg"
|
|
96
96
|
* }
|
|
97
97
|
* };
|
|
98
98
|
* const command = new DeleteObjectCommand(input);
|
|
99
|
-
* await client.send(command);
|
|
100
|
-
*
|
|
99
|
+
* const response = await client.send(command);
|
|
100
|
+
* /* response is
|
|
101
|
+
* { /* empty *\/ }
|
|
102
|
+
* *\/
|
|
101
103
|
* ```
|
|
102
104
|
*
|
|
105
|
+
* @public
|
|
103
106
|
*/
|
|
104
107
|
export declare class DeleteObjectCommand extends DeleteObjectCommand_base {
|
|
105
108
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -80,23 +80,23 @@ declare const DeleteSchemaCommand_base: {
|
|
|
80
80
|
* @throws {@link CloudDirectoryServiceException}
|
|
81
81
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
82
82
|
*
|
|
83
|
-
*
|
|
83
|
+
*
|
|
84
84
|
* @example To delete a schema
|
|
85
85
|
* ```javascript
|
|
86
86
|
* //
|
|
87
87
|
* const input = {
|
|
88
|
-
*
|
|
88
|
+
* SchemaArn: "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest"
|
|
89
89
|
* };
|
|
90
90
|
* const command = new DeleteSchemaCommand(input);
|
|
91
91
|
* const response = await client.send(command);
|
|
92
|
-
* /* response
|
|
92
|
+
* /* response is
|
|
93
93
|
* {
|
|
94
|
-
*
|
|
94
|
+
* SchemaArn: "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest"
|
|
95
95
|
* }
|
|
96
96
|
* *\/
|
|
97
|
-
* // example id: to-delete-a-schema-1507575230059
|
|
98
97
|
* ```
|
|
99
98
|
*
|
|
99
|
+
* @public
|
|
100
100
|
*/
|
|
101
101
|
export declare class DeleteSchemaCommand extends DeleteSchemaCommand_base {
|
|
102
102
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -78,19 +78,22 @@ declare const DeleteTypedLinkFacetCommand_base: {
|
|
|
78
78
|
* @throws {@link CloudDirectoryServiceException}
|
|
79
79
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
80
80
|
*
|
|
81
|
-
*
|
|
81
|
+
*
|
|
82
82
|
* @example To delete a typed link facet
|
|
83
83
|
* ```javascript
|
|
84
84
|
* //
|
|
85
85
|
* const input = {
|
|
86
|
-
*
|
|
87
|
-
*
|
|
86
|
+
* Name: "ExampleFacet",
|
|
87
|
+
* SchemaArn: "arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschematest"
|
|
88
88
|
* };
|
|
89
89
|
* const command = new DeleteTypedLinkFacetCommand(input);
|
|
90
|
-
* await client.send(command);
|
|
91
|
-
*
|
|
90
|
+
* const response = await client.send(command);
|
|
91
|
+
* /* response is
|
|
92
|
+
* { /* empty *\/ }
|
|
93
|
+
* *\/
|
|
92
94
|
* ```
|
|
93
95
|
*
|
|
96
|
+
* @public
|
|
94
97
|
*/
|
|
95
98
|
export declare class DeleteTypedLinkFacetCommand extends DeleteTypedLinkFacetCommand_base {
|
|
96
99
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -91,29 +91,29 @@ declare const DetachFromIndexCommand_base: {
|
|
|
91
91
|
* @throws {@link CloudDirectoryServiceException}
|
|
92
92
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
93
93
|
*
|
|
94
|
-
*
|
|
94
|
+
*
|
|
95
95
|
* @example To detach an object from an index
|
|
96
96
|
* ```javascript
|
|
97
97
|
* //
|
|
98
98
|
* const input = {
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
99
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
100
|
+
* IndexReference: {
|
|
101
|
+
* Selector: "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q"
|
|
102
102
|
* },
|
|
103
|
-
*
|
|
104
|
-
*
|
|
103
|
+
* TargetReference: {
|
|
104
|
+
* Selector: "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
105
105
|
* }
|
|
106
106
|
* };
|
|
107
107
|
* const command = new DetachFromIndexCommand(input);
|
|
108
108
|
* const response = await client.send(command);
|
|
109
|
-
* /* response
|
|
109
|
+
* /* response is
|
|
110
110
|
* {
|
|
111
|
-
*
|
|
111
|
+
* DetachedObjectIdentifier: "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
112
112
|
* }
|
|
113
113
|
* *\/
|
|
114
|
-
* // example id: to-detach-an-object-from-an-index-1507579662964
|
|
115
114
|
* ```
|
|
116
115
|
*
|
|
116
|
+
* @public
|
|
117
117
|
*/
|
|
118
118
|
export declare class DetachFromIndexCommand extends DetachFromIndexCommand_base {
|
|
119
119
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -88,27 +88,27 @@ declare const DetachObjectCommand_base: {
|
|
|
88
88
|
* @throws {@link CloudDirectoryServiceException}
|
|
89
89
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
90
90
|
*
|
|
91
|
-
*
|
|
91
|
+
*
|
|
92
92
|
* @example To detach an object from its parent object
|
|
93
93
|
* ```javascript
|
|
94
94
|
* //
|
|
95
95
|
* const input = {
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
96
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
97
|
+
* LinkName: "link2",
|
|
98
|
+
* ParentReference: {
|
|
99
|
+
* Selector: "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
100
100
|
* }
|
|
101
101
|
* };
|
|
102
102
|
* const command = new DetachObjectCommand(input);
|
|
103
103
|
* const response = await client.send(command);
|
|
104
|
-
* /* response
|
|
104
|
+
* /* response is
|
|
105
105
|
* {
|
|
106
|
-
*
|
|
106
|
+
* DetachedObjectIdentifier: "AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
|
|
107
107
|
* }
|
|
108
108
|
* *\/
|
|
109
|
-
* // example id: to-detach-an-object-from-its-parent-object-1508196401149
|
|
110
109
|
* ```
|
|
111
110
|
*
|
|
111
|
+
* @public
|
|
112
112
|
*/
|
|
113
113
|
export declare class DetachObjectCommand extends DetachObjectCommand_base {
|
|
114
114
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -86,24 +86,27 @@ declare const DetachPolicyCommand_base: {
|
|
|
86
86
|
* @throws {@link CloudDirectoryServiceException}
|
|
87
87
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
88
88
|
*
|
|
89
|
-
*
|
|
89
|
+
*
|
|
90
90
|
* @example To detach a policy from an object
|
|
91
91
|
* ```javascript
|
|
92
92
|
* //
|
|
93
93
|
* const input = {
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
94
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
95
|
+
* ObjectReference: {
|
|
96
|
+
* Selector: "$AQGG_ADlfNZBzYHY_JgDt3TWQoovm1s3Ts2v0NKrzdVnPw"
|
|
97
97
|
* },
|
|
98
|
-
*
|
|
99
|
-
*
|
|
98
|
+
* PolicyReference: {
|
|
99
|
+
* Selector: "$AQGG_ADlfNZBzYHY_JgDt3TWgcBsTVmcQEWs6jlygfhuew"
|
|
100
100
|
* }
|
|
101
101
|
* };
|
|
102
102
|
* const command = new DetachPolicyCommand(input);
|
|
103
|
-
* await client.send(command);
|
|
104
|
-
*
|
|
103
|
+
* const response = await client.send(command);
|
|
104
|
+
* /* response is
|
|
105
|
+
* { /* empty *\/ }
|
|
106
|
+
* *\/
|
|
105
107
|
* ```
|
|
106
108
|
*
|
|
109
|
+
* @public
|
|
107
110
|
*/
|
|
108
111
|
export declare class DetachPolicyCommand extends DetachPolicyCommand_base {
|
|
109
112
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -105,38 +105,41 @@ declare const DetachTypedLinkCommand_base: {
|
|
|
105
105
|
* @throws {@link CloudDirectoryServiceException}
|
|
106
106
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
107
107
|
*
|
|
108
|
-
*
|
|
108
|
+
*
|
|
109
109
|
* @example To detach a typed link from an object
|
|
110
110
|
* ```javascript
|
|
111
111
|
* //
|
|
112
112
|
* const input = {
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
113
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
114
|
+
* TypedLinkSpecifier: {
|
|
115
|
+
* IdentityAttributeValues: [
|
|
116
116
|
* {
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
117
|
+
* AttributeName: "22",
|
|
118
|
+
* Value: {
|
|
119
|
+
* BinaryValue: "c3Ry"
|
|
120
120
|
* }
|
|
121
121
|
* }
|
|
122
122
|
* ],
|
|
123
|
-
*
|
|
124
|
-
*
|
|
123
|
+
* SourceObjectReference: {
|
|
124
|
+
* Selector: "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
|
|
125
125
|
* },
|
|
126
|
-
*
|
|
127
|
-
*
|
|
126
|
+
* TargetObjectReference: {
|
|
127
|
+
* Selector: "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
|
|
128
128
|
* },
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
129
|
+
* TypedLinkFacet: {
|
|
130
|
+
* SchemaArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1",
|
|
131
|
+
* TypedLinkName: "exampletypedlink8"
|
|
132
132
|
* }
|
|
133
133
|
* }
|
|
134
134
|
* };
|
|
135
135
|
* const command = new DetachTypedLinkCommand(input);
|
|
136
|
-
* await client.send(command);
|
|
137
|
-
*
|
|
136
|
+
* const response = await client.send(command);
|
|
137
|
+
* /* response is
|
|
138
|
+
* { /* metadata only *\/ }
|
|
139
|
+
* *\/
|
|
138
140
|
* ```
|
|
139
141
|
*
|
|
142
|
+
* @public
|
|
140
143
|
*/
|
|
141
144
|
export declare class DetachTypedLinkCommand extends DetachTypedLinkCommand_base {
|
|
142
145
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -81,23 +81,23 @@ declare const DisableDirectoryCommand_base: {
|
|
|
81
81
|
* @throws {@link CloudDirectoryServiceException}
|
|
82
82
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
83
83
|
*
|
|
84
|
-
*
|
|
84
|
+
*
|
|
85
85
|
* @example To disable a directory
|
|
86
86
|
* ```javascript
|
|
87
87
|
* //
|
|
88
88
|
* const input = {
|
|
89
|
-
*
|
|
89
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
|
|
90
90
|
* };
|
|
91
91
|
* const command = new DisableDirectoryCommand(input);
|
|
92
92
|
* const response = await client.send(command);
|
|
93
|
-
* /* response
|
|
93
|
+
* /* response is
|
|
94
94
|
* {
|
|
95
|
-
*
|
|
95
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
|
|
96
96
|
* }
|
|
97
97
|
* *\/
|
|
98
|
-
* // example id: to-disable-a-directory-1507253386265
|
|
99
98
|
* ```
|
|
100
99
|
*
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
export declare class DisableDirectoryCommand extends DisableDirectoryCommand_base {
|
|
103
103
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -81,23 +81,23 @@ declare const EnableDirectoryCommand_base: {
|
|
|
81
81
|
* @throws {@link CloudDirectoryServiceException}
|
|
82
82
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
83
83
|
*
|
|
84
|
-
*
|
|
84
|
+
*
|
|
85
85
|
* @example To enable a disabled directory
|
|
86
86
|
* ```javascript
|
|
87
87
|
* //
|
|
88
88
|
* const input = {
|
|
89
|
-
*
|
|
89
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
|
|
90
90
|
* };
|
|
91
91
|
* const command = new EnableDirectoryCommand(input);
|
|
92
92
|
* const response = await client.send(command);
|
|
93
|
-
* /* response
|
|
93
|
+
* /* response is
|
|
94
94
|
* {
|
|
95
|
-
*
|
|
95
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8"
|
|
96
96
|
* }
|
|
97
97
|
* *\/
|
|
98
|
-
* // example id: to-enable-a-disabled-directory-1507253506378
|
|
99
98
|
* ```
|
|
100
99
|
*
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
export declare class EnableDirectoryCommand extends EnableDirectoryCommand_base {
|
|
103
103
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -76,6 +76,7 @@ declare const GetAppliedSchemaVersionCommand_base: {
|
|
|
76
76
|
* @throws {@link CloudDirectoryServiceException}
|
|
77
77
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
78
78
|
*
|
|
79
|
+
*
|
|
79
80
|
* @public
|
|
80
81
|
*/
|
|
81
82
|
export declare class GetAppliedSchemaVersionCommand extends GetAppliedSchemaVersionCommand_base {
|
|
@@ -78,28 +78,28 @@ declare const GetDirectoryCommand_base: {
|
|
|
78
78
|
* @throws {@link CloudDirectoryServiceException}
|
|
79
79
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
80
80
|
*
|
|
81
|
-
*
|
|
81
|
+
*
|
|
82
82
|
* @example To get information about a directory
|
|
83
83
|
* ```javascript
|
|
84
84
|
* //
|
|
85
85
|
* const input = {
|
|
86
|
-
*
|
|
86
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY"
|
|
87
87
|
* };
|
|
88
88
|
* const command = new GetDirectoryCommand(input);
|
|
89
89
|
* const response = await client.send(command);
|
|
90
|
-
* /* response
|
|
90
|
+
* /* response is
|
|
91
91
|
* {
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
92
|
+
* Directory: {
|
|
93
|
+
* CreationDateTime: 1.506115781186E9,
|
|
94
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
95
|
+
* Name: "ExampleCD",
|
|
96
|
+
* State: "ENABLED"
|
|
97
97
|
* }
|
|
98
98
|
* }
|
|
99
99
|
* *\/
|
|
100
|
-
* // example id: to-get-information-about-a-directory-1507235667410
|
|
101
100
|
* ```
|
|
102
101
|
*
|
|
102
|
+
* @public
|
|
103
103
|
*/
|
|
104
104
|
export declare class GetDirectoryCommand extends GetDirectoryCommand_base {
|
|
105
105
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -85,27 +85,27 @@ declare const GetFacetCommand_base: {
|
|
|
85
85
|
* @throws {@link CloudDirectoryServiceException}
|
|
86
86
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
87
87
|
*
|
|
88
|
-
*
|
|
88
|
+
*
|
|
89
89
|
* @example To get information about a facet
|
|
90
90
|
* ```javascript
|
|
91
91
|
* //
|
|
92
92
|
* const input = {
|
|
93
|
-
*
|
|
94
|
-
*
|
|
93
|
+
* Name: "node2",
|
|
94
|
+
* SchemaArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
|
|
95
95
|
* };
|
|
96
96
|
* const command = new GetFacetCommand(input);
|
|
97
97
|
* const response = await client.send(command);
|
|
98
|
-
* /* response
|
|
98
|
+
* /* response is
|
|
99
99
|
* {
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
100
|
+
* Facet: {
|
|
101
|
+
* Name: "node2",
|
|
102
|
+
* ObjectType: "NODE"
|
|
103
103
|
* }
|
|
104
104
|
* }
|
|
105
105
|
* *\/
|
|
106
|
-
* // example id: to-get-information-about-a-facet-1507234748374
|
|
107
106
|
* ```
|
|
108
107
|
*
|
|
108
|
+
* @public
|
|
109
109
|
*/
|
|
110
110
|
export declare class GetFacetCommand extends GetFacetCommand_base {
|
|
111
111
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -126,6 +126,7 @@ declare const GetLinkAttributesCommand_base: {
|
|
|
126
126
|
* @throws {@link CloudDirectoryServiceException}
|
|
127
127
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
128
128
|
*
|
|
129
|
+
*
|
|
129
130
|
* @public
|
|
130
131
|
*/
|
|
131
132
|
export declare class GetLinkAttributesCommand extends GetLinkAttributesCommand_base {
|
|
@@ -109,6 +109,7 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
109
109
|
* @throws {@link CloudDirectoryServiceException}
|
|
110
110
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
111
111
|
*
|
|
112
|
+
*
|
|
112
113
|
* @public
|
|
113
114
|
*/
|
|
114
115
|
export declare class GetObjectAttributesCommand extends GetObjectAttributesCommand_base {
|
|
@@ -89,33 +89,33 @@ declare const GetObjectInformationCommand_base: {
|
|
|
89
89
|
* @throws {@link CloudDirectoryServiceException}
|
|
90
90
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
91
91
|
*
|
|
92
|
-
*
|
|
92
|
+
*
|
|
93
93
|
* @example To get information about an object
|
|
94
94
|
* ```javascript
|
|
95
95
|
* //
|
|
96
96
|
* const input = {
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
97
|
+
* ConsistencyLevel: "SERIALIZABLE",
|
|
98
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
|
|
99
|
+
* ObjectReference: {
|
|
100
|
+
* Selector: "$AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ"
|
|
101
101
|
* }
|
|
102
102
|
* };
|
|
103
103
|
* const command = new GetObjectInformationCommand(input);
|
|
104
104
|
* const response = await client.send(command);
|
|
105
|
-
* /* response
|
|
105
|
+
* /* response is
|
|
106
106
|
* {
|
|
107
|
-
*
|
|
108
|
-
*
|
|
107
|
+
* ObjectIdentifier: "AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ",
|
|
108
|
+
* SchemaFacets: [
|
|
109
109
|
* {
|
|
110
|
-
*
|
|
111
|
-
*
|
|
110
|
+
* FacetName: "node2",
|
|
111
|
+
* SchemaArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
|
|
112
112
|
* }
|
|
113
113
|
* ]
|
|
114
114
|
* }
|
|
115
115
|
* *\/
|
|
116
|
-
* // example id: to-get-information-about-an-object-1507228370573
|
|
117
116
|
* ```
|
|
118
117
|
*
|
|
118
|
+
* @public
|
|
119
119
|
*/
|
|
120
120
|
export declare class GetObjectInformationCommand extends GetObjectInformationCommand_base {
|
|
121
121
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -77,24 +77,24 @@ declare const GetSchemaAsJsonCommand_base: {
|
|
|
77
77
|
* @throws {@link CloudDirectoryServiceException}
|
|
78
78
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
79
79
|
*
|
|
80
|
-
*
|
|
80
|
+
*
|
|
81
81
|
* @example To get schema information and display it in JSON format
|
|
82
82
|
* ```javascript
|
|
83
83
|
* //
|
|
84
84
|
* const input = {
|
|
85
|
-
*
|
|
85
|
+
* SchemaArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
|
|
86
86
|
* };
|
|
87
87
|
* const command = new GetSchemaAsJsonCommand(input);
|
|
88
88
|
* const response = await client.send(command);
|
|
89
|
-
* /* response
|
|
89
|
+
* /* response is
|
|
90
90
|
* {
|
|
91
|
-
*
|
|
92
|
-
*
|
|
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
93
|
* }
|
|
94
94
|
* *\/
|
|
95
|
-
* // example id: to-get-schema-information-and-display-it-in-json-format-1507249604181
|
|
96
95
|
* ```
|
|
97
96
|
*
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
export declare class GetSchemaAsJsonCommand extends GetSchemaAsJsonCommand_base {
|
|
100
100
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -85,26 +85,26 @@ declare const GetTypedLinkFacetInformationCommand_base: {
|
|
|
85
85
|
* @throws {@link CloudDirectoryServiceException}
|
|
86
86
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
87
87
|
*
|
|
88
|
-
*
|
|
88
|
+
*
|
|
89
89
|
* @example To get information about a typed link facet
|
|
90
90
|
* ```javascript
|
|
91
91
|
* //
|
|
92
92
|
* const input = {
|
|
93
|
-
*
|
|
94
|
-
*
|
|
93
|
+
* Name: "exampletypedlink8",
|
|
94
|
+
* SchemaArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
|
|
95
95
|
* };
|
|
96
96
|
* const command = new GetTypedLinkFacetInformationCommand(input);
|
|
97
97
|
* const response = await client.send(command);
|
|
98
|
-
* /* response
|
|
98
|
+
* /* response is
|
|
99
99
|
* {
|
|
100
|
-
*
|
|
100
|
+
* IdentityAttributeOrder: [
|
|
101
101
|
* "22"
|
|
102
102
|
* ]
|
|
103
103
|
* }
|
|
104
104
|
* *\/
|
|
105
|
-
* // example id: to-get-information-about-a-typed-link-facet-1507251423121
|
|
106
105
|
* ```
|
|
107
106
|
*
|
|
107
|
+
* @public
|
|
108
108
|
*/
|
|
109
109
|
export declare class GetTypedLinkFacetInformationCommand extends GetTypedLinkFacetInformationCommand_base {
|
|
110
110
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -85,25 +85,25 @@ declare const ListAppliedSchemaArnsCommand_base: {
|
|
|
85
85
|
* @throws {@link CloudDirectoryServiceException}
|
|
86
86
|
* <p>Base exception class for all service exceptions from CloudDirectory service.</p>
|
|
87
87
|
*
|
|
88
|
-
*
|
|
88
|
+
*
|
|
89
89
|
* @example To list applied schema ARNs for a specified directory
|
|
90
90
|
* ```javascript
|
|
91
91
|
* //
|
|
92
92
|
* const input = {
|
|
93
|
-
*
|
|
93
|
+
* DirectoryArn: "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY"
|
|
94
94
|
* };
|
|
95
95
|
* const command = new ListAppliedSchemaArnsCommand(input);
|
|
96
96
|
* const response = await client.send(command);
|
|
97
|
-
* /* response
|
|
97
|
+
* /* response is
|
|
98
98
|
* {
|
|
99
|
-
*
|
|
99
|
+
* SchemaArns: [
|
|
100
100
|
* "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
|
|
101
101
|
* ]
|
|
102
102
|
* }
|
|
103
103
|
* *\/
|
|
104
|
-
* // example id: to-list-applied-schema-arns-for-a-specified-directory-1508194900072
|
|
105
104
|
* ```
|
|
106
105
|
*
|
|
106
|
+
* @public
|
|
107
107
|
*/
|
|
108
108
|
export declare class ListAppliedSchemaArnsCommand extends ListAppliedSchemaArnsCommand_base {
|
|
109
109
|
/** @internal type navigation helper, not in runtime. */
|