Amazon Cloud Directory API Reference Amazon Cloud Directory API Reference Amazon Cloud Directory: API Reference Copyright © 2023 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon Cloud Directory API Reference Table of Contents Welcome........................................................................................................................................... 1 Actions............................................................................................................................................. 2 AddFacetToObject...................................................................................................................... 4 Request Syntax.................................................................................................................. 4 URI Request Parameters ...................................................................................................... 4 Request Body.................................................................................................................... 4 Response Syntax................................................................................................................ 5 Response Elements............................................................................................................. 5 Errors............................................................................................................................... 5 Examples........................................................................................................................... 6 See Also............................................................................................................................ 7 ApplySchema............................................................................................................................. 8 Request Syntax.................................................................................................................. 8 URI Request Parameters ...................................................................................................... 8 Request Body.................................................................................................................... 8 Response Syntax................................................................................................................ 8 Response Elements............................................................................................................. 8 Errors............................................................................................................................... 9 Examples......................................................................................................................... 10 See Also.......................................................................................................................... 11 AttachObject............................................................................................................................ 12 Request Syntax................................................................................................................ 12 URI Request Parameters .................................................................................................... 12 Request Body................................................................................................................... 12 Response Syntax.............................................................................................................. 13 Response Elements........................................................................................................... 13 Errors.............................................................................................................................. 13 Examples......................................................................................................................... 14 See Also.......................................................................................................................... 15 AttachPolicy............................................................................................................................ 16 Request Syntax................................................................................................................ 16 URI Request Parameters .................................................................................................... 16 Request Body................................................................................................................... 16 Response Syntax.............................................................................................................. 16 Response Elements........................................................................................................... 17 Errors.............................................................................................................................. 17 Examples......................................................................................................................... 18 See Also.......................................................................................................................... 18 AttachToIndex.......................................................................................................................... 20 Request Syntax................................................................................................................ 20 URI Request Parameters .................................................................................................... 20 Request Body................................................................................................................... 20 Response Syntax.............................................................................................................. 20 Response Elements........................................................................................................... 21 Errors.............................................................................................................................. 21 Examples......................................................................................................................... 22 See Also.......................................................................................................................... 23 AttachTypedLink...................................................................................................................... 24 Request Syntax................................................................................................................ 24 URI Request Parameters .................................................................................................... 24 Request Body................................................................................................................... 24 Response Syntax.............................................................................................................. 25 Response Elements........................................................................................................... 25 Errors.............................................................................................................................. 26 iii Amazon Cloud Directory API Reference Examples......................................................................................................................... 27 See Also.......................................................................................................................... 28 BatchRead............................................................................................................................... 29 Request Syntax................................................................................................................ 29 URI Request Parameters .................................................................................................... 32 Request Body................................................................................................................... 32 Response Syntax.............................................................................................................. 32 Response Elements........................................................................................................... 36 Errors.............................................................................................................................. 36 Examples......................................................................................................................... 37 See Also.......................................................................................................................... 38 BatchWrite............................................................................................................................... 39 Request Syntax................................................................................................................ 39 URI Request Parameters .................................................................................................... 43 Request Body................................................................................................................... 43 Response Syntax.............................................................................................................. 43 Response Elements........................................................................................................... 44 Errors.............................................................................................................................. 44 Examples......................................................................................................................... 45 See Also.......................................................................................................................... 46 CreateDirectory........................................................................................................................ 47 Request Syntax................................................................................................................ 47 URI Request Parameters .................................................................................................... 47 Request Body................................................................................................................... 47 Response Syntax.............................................................................................................. 47 Response Elements........................................................................................................... 48 Errors.............................................................................................................................. 48 Examples......................................................................................................................... 49 See Also.......................................................................................................................... 50 CreateFacet.............................................................................................................................. 51 Request Syntax................................................................................................................ 51 URI Request Parameters .................................................................................................... 51 Request Body................................................................................................................... 52 Response Syntax.............................................................................................................. 52 Response Elements........................................................................................................... 52 Errors.............................................................................................................................. 53 Examples......................................................................................................................... 54 See Also.......................................................................................................................... 54 CreateIndex............................................................................................................................. 56 Request Syntax................................................................................................................ 56 URI Request Parameters .................................................................................................... 56 Request Body................................................................................................................... 56 Response Syntax.............................................................................................................. 57 Response Elements........................................................................................................... 57 Errors.............................................................................................................................. 57 Examples......................................................................................................................... 58 See Also.......................................................................................................................... 59 CreateObject............................................................................................................................ 61 Request Syntax................................................................................................................ 61 URI Request Parameters .................................................................................................... 61 Request Body................................................................................................................... 61 Response Syntax.............................................................................................................. 62 Response Elements........................................................................................................... 62 Errors.............................................................................................................................. 62 Examples......................................................................................................................... 64 See Also.......................................................................................................................... 64 CreateSchema.......................................................................................................................... 66 iv Amazon Cloud Directory API Reference Request Syntax................................................................................................................ 66 URI Request Parameters .................................................................................................... 66 Request Body................................................................................................................... 66 Response Syntax.............................................................................................................. 66 Response Elements........................................................................................................... 66 Errors.............................................................................................................................. 67 Examples......................................................................................................................... 68 See Also.......................................................................................................................... 68 CreateTypedLinkFacet............................................................................................................... 70 Request Syntax................................................................................................................ 70 URI Request Parameters .................................................................................................... 70 Request Body................................................................................................................... 70 Response Syntax.............................................................................................................. 71 Response Elements........................................................................................................... 71 Errors.............................................................................................................................. 71 Examples......................................................................................................................... 72 See Also.......................................................................................................................... 73 DeleteDirectory........................................................................................................................ 74 Request Syntax................................................................................................................ 74 URI Request Parameters .................................................................................................... 74 Request Body................................................................................................................... 74 Response Syntax.............................................................................................................. 74 Response Elements........................................................................................................... 74 Errors.............................................................................................................................. 74 Examples......................................................................................................................... 75 See Also.......................................................................................................................... 76 DeleteFacet.............................................................................................................................. 77 Request Syntax................................................................................................................ 77 URI Request Parameters .................................................................................................... 77 Request Body................................................................................................................... 77 Response Syntax.............................................................................................................. 77 Response Elements........................................................................................................... 77 Errors.............................................................................................................................. 77 Examples......................................................................................................................... 78 See Also.......................................................................................................................... 79 DeleteObject............................................................................................................................ 80 Request Syntax................................................................................................................ 80 URI Request Parameters .................................................................................................... 80 Request Body................................................................................................................... 80 Response Syntax.............................................................................................................. 80 Response Elements........................................................................................................... 80 Errors.............................................................................................................................. 80 Examples......................................................................................................................... 81 See Also.......................................................................................................................... 82 DeleteSchema.......................................................................................................................... 83 Request Syntax................................................................................................................ 83 URI Request Parameters .................................................................................................... 83 Request Body................................................................................................................... 83 Response Syntax.............................................................................................................. 83 Response Elements........................................................................................................... 83 Errors.............................................................................................................................. 83 Examples......................................................................................................................... 84 See Also.......................................................................................................................... 85 DeleteTypedLinkFacet............................................................................................................... 86 Request Syntax................................................................................................................ 86 URI Request Parameters .................................................................................................... 86 Request Body................................................................................................................... 86 v Amazon Cloud Directory API Reference Response Syntax.............................................................................................................. 86 Response Elements........................................................................................................... 86 Errors.............................................................................................................................. 86 Examples......................................................................................................................... 87 See Also.......................................................................................................................... 88 DetachFromIndex..................................................................................................................... 89 Request Syntax................................................................................................................ 89 URI Request Parameters .................................................................................................... 89 Request Body................................................................................................................... 89 Response Syntax.............................................................................................................. 89 Response Elements........................................................................................................... 90 Errors.............................................................................................................................. 90 Examples......................................................................................................................... 91 See Also.......................................................................................................................... 92 DetachObject........................................................................................................................... 93 Request Syntax................................................................................................................ 93 URI Request Parameters .................................................................................................... 93 Request Body................................................................................................................... 93 Response Syntax.............................................................................................................. 93 Response Elements........................................................................................................... 94 Errors.............................................................................................................................. 94 Examples......................................................................................................................... 95 See Also.......................................................................................................................... 96 DetachPolicy............................................................................................................................ 97 Request Syntax................................................................................................................ 97 URI Request Parameters .................................................................................................... 97 Request Body................................................................................................................... 97 Response Syntax.............................................................................................................. 97 Response Elements........................................................................................................... 98 Errors.............................................................................................................................. 98 Examples......................................................................................................................... 99 See Also.......................................................................................................................... 99 DetachTypedLink.................................................................................................................... 101 Request Syntax.............................................................................................................. 101 URI Request Parameters .................................................................................................. 101 Request Body................................................................................................................. 101 Response Syntax............................................................................................................ 102 Response Elements......................................................................................................... 102 Errors............................................................................................................................ 102 Examples....................................................................................................................... 103 See Also........................................................................................................................ 104 DisableDirectory..................................................................................................................... 105 Request Syntax.............................................................................................................. 105 URI Request Parameters .................................................................................................. 105 Request Body................................................................................................................. 105 Response Syntax............................................................................................................ 105 Response Elements......................................................................................................... 105 Errors............................................................................................................................ 105 Examples....................................................................................................................... 106 See Also........................................................................................................................ 107 EnableDirectory...................................................................................................................... 108 Request Syntax.............................................................................................................. 108 URI Request Parameters .................................................................................................. 108 Request Body................................................................................................................. 108 Response Syntax............................................................................................................ 108 Response Elements......................................................................................................... 108 Errors............................................................................................................................ 108 vi Amazon Cloud Directory API Reference Examples....................................................................................................................... 109 See Also........................................................................................................................ 110 GetAppliedSchemaVersion....................................................................................................... 111 Request Syntax.............................................................................................................. 111 URI Request Parameters .................................................................................................. 111 Request Body................................................................................................................. 111 Response Syntax............................................................................................................ 111 Response Elements......................................................................................................... 111 Errors............................................................................................................................ 111 See Also........................................................................................................................ 112 GetDirectory.......................................................................................................................... 114 Request Syntax.............................................................................................................. 114 URI Request Parameters .................................................................................................. 114 Request Body................................................................................................................. 114 Response Syntax............................................................................................................ 114 Response Elements......................................................................................................... 114 Errors............................................................................................................................ 114 Examples....................................................................................................................... 115 See Also........................................................................................................................ 116 GetFacet................................................................................................................................ 117 Request Syntax.............................................................................................................. 117 URI Request Parameters .................................................................................................. 117 Request Body................................................................................................................. 117 Response Syntax............................................................................................................ 117 Response Elements......................................................................................................... 118 Errors............................................................................................................................ 118 Examples....................................................................................................................... 119 See Also........................................................................................................................ 119 GetLinkAttributes................................................................................................................... 121 Request Syntax.............................................................................................................. 121 URI Request Parameters .................................................................................................. 121 Request Body................................................................................................................. 121 Response Syntax............................................................................................................ 122 Response Elements......................................................................................................... 122 Errors............................................................................................................................ 123 See Also........................................................................................................................ 124 GetObjectAttributes................................................................................................................ 125 Request Syntax.............................................................................................................. 125 URI Request Parameters .................................................................................................. 125 Request Body................................................................................................................. 125 Response Syntax............................................................................................................ 126 Response Elements......................................................................................................... 126 Errors............................................................................................................................ 126 See Also........................................................................................................................ 127 GetObjectInformation............................................................................................................. 129 Request Syntax.............................................................................................................. 129 URI Request Parameters .................................................................................................. 129 Request Body................................................................................................................. 129 Response Syntax............................................................................................................ 129 Response Elements......................................................................................................... 130 Errors............................................................................................................................ 130 Examples....................................................................................................................... 131 See Also........................................................................................................................ 132 GetSchemaAsJson................................................................................................................... 133 Request Syntax.............................................................................................................. 133 URI Request Parameters .................................................................................................. 133 Request Body................................................................................................................. 133 vii Amazon Cloud Directory API Reference Response Syntax............................................................................................................ 133 Response Elements......................................................................................................... 133 Errors............................................................................................................................ 134 Examples....................................................................................................................... 134 See Also........................................................................................................................ 136 GetTypedLinkFacetInformation................................................................................................. 138 Request Syntax.............................................................................................................. 138 URI Request Parameters .................................................................................................. 138 Request Body................................................................................................................. 138 Response Syntax............................................................................................................ 138 Response Elements......................................................................................................... 138 Errors............................................................................................................................ 139 Examples....................................................................................................................... 140 See Also........................................................................................................................ 140 ListAppliedSchemaArns........................................................................................................... 142 Request Syntax.............................................................................................................. 142 URI Request Parameters .................................................................................................. 142 Request Body................................................................................................................. 142 Response Syntax............................................................................................................ 143 Response Elements......................................................................................................... 143 Errors............................................................................................................................ 143 Examples....................................................................................................................... 144 See Also........................................................................................................................ 145 ListAttachedIndices................................................................................................................. 146 Request Syntax.............................................................................................................. 146 URI Request Parameters .................................................................................................. 146 Request Body................................................................................................................. 146 Response Syntax............................................................................................................ 147 Response Elements......................................................................................................... 147 Errors............................................................................................................................ 147 Examples....................................................................................................................... 148 See Also........................................................................................................................ 149 ListDevelopmentSchemaArns................................................................................................... 150 Request Syntax.............................................................................................................. 150 URI Request Parameters .................................................................................................. 150 Request Body................................................................................................................. 150 Response Syntax............................................................................................................ 150 Response Elements......................................................................................................... 150 Errors............................................................................................................................ 151 Examples....................................................................................................................... 152 See Also........................................................................................................................ 152 ListDirectories........................................................................................................................ 154 Request Syntax.............................................................................................................. 154 URI Request Parameters .................................................................................................. 154 Request Body................................................................................................................. 154 Response Syntax............................................................................................................ 154 Response Elements......................................................................................................... 155 Errors............................................................................................................................ 155 Examples....................................................................................................................... 156 See Also........................................................................................................................ 157 ListFacetAttributes.................................................................................................................. 158 Request Syntax.............................................................................................................. 158 URI Request Parameters .................................................................................................. 158 Request Body................................................................................................................. 158 Response Syntax............................................................................................................ 159 Response Elements......................................................................................................... 159 Errors............................................................................................................................ 159 viii Amazon Cloud Directory API Reference Examples....................................................................................................................... 160 See Also........................................................................................................................ 164 ListFacetNames...................................................................................................................... 165 Request Syntax.............................................................................................................. 165 URI Request Parameters .................................................................................................. 165 Request Body................................................................................................................. 165 Response Syntax............................................................................................................ 165 Response Elements......................................................................................................... 166 Errors............................................................................................................................ 166 Examples....................................................................................................................... 167 See Also........................................................................................................................ 167 ListIncomingTypedLinks........................................................................................................... 169 Request Syntax.............................................................................................................. 169 URI Request Parameters .................................................................................................. 169 Request Body................................................................................................................. 170 Response Syntax............................................................................................................ 170 Response Elements......................................................................................................... 171 Errors............................................................................................................................ 171 Examples....................................................................................................................... 172 See Also........................................................................................................................ 174 ListIndex................................................................................................................................ 175 Request Syntax.............................................................................................................. 175 URI Request Parameters .................................................................................................. 175 Request Body................................................................................................................. 176 Response Syntax............................................................................................................ 176 Response Elements......................................................................................................... 177 Errors............................................................................................................................ 177 Examples....................................................................................................................... 178 See Also........................................................................................................................ 179 ListManagedSchemaArns......................................................................................................... 180 Request Syntax.............................................................................................................. 180 URI Request Parameters .................................................................................................. 180 Request Body................................................................................................................. 180 Response Syntax............................................................................................................ 180 Response Elements......................................................................................................... 181 Errors............................................................................................................................ 181 See Also........................................................................................................................ 182 ListObjectAttributes................................................................................................................ 183 Request Syntax.............................................................................................................. 183 URI Request Parameters .................................................................................................. 183 Request Body................................................................................................................. 183 Response Syntax............................................................................................................ 184 Response Elements......................................................................................................... 184 Errors............................................................................................................................ 185 Examples....................................................................................................................... 186 See Also........................................................................................................................ 187 ListObjectChildren.................................................................................................................. 188 Request Syntax.............................................................................................................. 188 URI Request Parameters .................................................................................................. 188 Request Body................................................................................................................. 188 Response Syntax............................................................................................................ 189 Response Elements......................................................................................................... 189 Errors............................................................................................................................ 189 Examples....................................................................................................................... 190 See Also........................................................................................................................ 191 ListObjectParentPaths............................................................................................................. 192 Request Syntax.............................................................................................................. 192 ix Amazon Cloud Directory API Reference URI Request Parameters .................................................................................................. 192 Request Body................................................................................................................. 192 Response Syntax............................................................................................................ 193 Response Elements......................................................................................................... 193 Errors............................................................................................................................ 193 See Also........................................................................................................................ 194 ListObjectParents.................................................................................................................... 196 Request Syntax.............................................................................................................. 196 URI Request Parameters .................................................................................................. 196 Request Body................................................................................................................. 196 Response Syntax............................................................................................................ 197 Response Elements......................................................................................................... 197 Errors............................................................................................................................ 198 See Also........................................................................................................................ 199 ListObjectPolicies.................................................................................................................... 200 Request Syntax.............................................................................................................. 200 URI Request Parameters .................................................................................................. 200 Request Body................................................................................................................. 200 Response Syntax............................................................................................................ 201 Response Elements......................................................................................................... 201 Errors............................................................................................................................ 201 See Also........................................................................................................................ 202 ListOutgoingTypedLinks.......................................................................................................... 203 Request Syntax.............................................................................................................. 203 URI Request Parameters .................................................................................................. 203 Request Body................................................................................................................. 204 Response Syntax............................................................................................................ 204 Response Elements......................................................................................................... 205 Errors............................................................................................................................ 205 See Also........................................................................................................................ 206 ListPolicyAttachments............................................................................................................. 208 Request Syntax.............................................................................................................. 208 URI Request Parameters .................................................................................................. 208 Request Body................................................................................................................. 208 Response Syntax............................................................................................................ 209 Response Elements......................................................................................................... 209 Errors............................................................................................................................ 209 See Also........................................................................................................................ 210 ListPublishedSchemaArns........................................................................................................ 212 Request Syntax.............................................................................................................. 212 URI Request Parameters .................................................................................................. 212 Request Body................................................................................................................. 212 Response Syntax............................................................................................................ 212 Response Elements......................................................................................................... 213 Errors............................................................................................................................ 213 See Also........................................................................................................................ 214 ListTagsForResource................................................................................................................ 215 Request Syntax.............................................................................................................. 215 URI Request Parameters .................................................................................................. 215 Request Body................................................................................................................. 215 Response Syntax............................................................................................................ 215 Response Elements......................................................................................................... 216 Errors............................................................................................................................ 216 See Also........................................................................................................................ 217 ListTypedLinkFacetAttributes.................................................................................................... 218 Request Syntax.............................................................................................................. 218 URI Request Parameters .................................................................................................. 218 x