Amazon Cloud Directory
API Reference
Amazon Cloud Directory: API Reference
Copyright © 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.
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
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
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
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
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
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
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
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
Request Body ... 218
Response Syntax ... 219
Response Elements ... 219
Errors ... 219
See Also ... 220
ListTypedLinkFacetNames ... 222
Request Syntax ... 222
URI Request Parameters ... 222
Request Body ... 222
Response Syntax ... 222
Response Elements ... 223
Errors ... 223
See Also ... 224
LookupPolicy ... 225
Request Syntax ... 225
URI Request Parameters ... 225
Request Body ... 225
Response Syntax ... 226
Response Elements ... 226
Errors ... 226
See Also ... 227
PublishSchema ... 229
Request Syntax ... 229
URI Request Parameters ... 229
Request Body ... 229
Response Syntax ... 230
Response Elements ... 230
Errors ... 230
See Also ... 231
PutSchemaFromJson ... 232
Request Syntax ... 232
URI Request Parameters ... 232
Request Body ... 232
Response Syntax ... 232
Response Elements ... 232
Errors ... 233
See Also ... 234
RemoveFacetFromObject ... 235
Request Syntax ... 235
URI Request Parameters ... 235
Request Body ... 235
Response Syntax ... 235
Response Elements ... 236
Errors ... 236
See Also ... 237
TagResource ... 238
Request Syntax ... 238
URI Request Parameters ... 238
Request Body ... 238
Response Syntax ... 238
Response Elements ... 238
Errors ... 238
See Also ... 239
UntagResource ... 241
Request Syntax ... 241
URI Request Parameters ... 241
Request Body ... 241
Response Syntax ... 241
Response Elements ... 241
Errors ... 241
See Also ... 242
UpdateFacet ... 244
Request Syntax ... 244
URI Request Parameters ... 244
Request Body ... 245
Response Syntax ... 245
Response Elements ... 245
Errors ... 245
See Also ... 247
UpdateLinkAttributes ... 248
Request Syntax ... 248
URI Request Parameters ... 248
Request Body ... 249
Response Syntax ... 249
Response Elements ... 249
Errors ... 249
See Also ... 250
UpdateObjectAttributes ... 251
Request Syntax ... 251
URI Request Parameters ... 251
Request Body ... 251
Response Syntax ... 252
Response Elements ... 252
Errors ... 252
See Also ... 253
UpdateSchema ... 254
Request Syntax ... 254
URI Request Parameters ... 254
Request Body ... 254
Response Syntax ... 254
Response Elements ... 254
Errors ... 255
See Also ... 256
UpdateTypedLinkFacet ... 257
Request Syntax ... 257
URI Request Parameters ... 257
Request Body ... 257
Response Syntax ... 258
Response Elements ... 258
Errors ... 258
See Also ... 259
UpgradeAppliedSchema ... 261
Request Syntax ... 261
URI Request Parameters ... 261
Request Body ... 261
Response Syntax ... 261
Response Elements ... 262
Errors ... 262
See Also ... 263
UpgradePublishedSchema ... 264
Request Syntax ... 264
URI Request Parameters ... 264
Request Body ... 264
Response Syntax ... 265
Response Elements ... 265
Errors ... 265
See Also ... 266
Data Types ... 267
AttributeKey ... 270
Contents ... 270
See Also ... 270
AttributeKeyAndValue ... 271
Contents ... 271
See Also ... 271
AttributeNameAndValue ... 272
Contents ... 272
See Also ... 272
BatchAddFacetToObject ... 273
Contents ... 273
See Also ... 273
BatchAddFacetToObjectResponse ... 274
Contents ... 274
See Also ... 274
BatchAttachObject ... 275
Contents ... 275
See Also ... 275
BatchAttachObjectResponse ... 276
Contents ... 276
See Also ... 276
BatchAttachPolicy ... 277
Contents ... 277
See Also ... 277
BatchAttachPolicyResponse ... 278
Contents ... 278
See Also ... 278
BatchAttachToIndex ... 279
Contents ... 279
See Also ... 279
BatchAttachToIndexResponse ... 280
Contents ... 280
See Also ... 280
BatchAttachTypedLink ... 281
Contents ... 281
See Also ... 281
BatchAttachTypedLinkResponse ... 282
Contents ... 282
See Also ... 282
BatchCreateIndex ... 283
Contents ... 283
See Also ... 283
BatchCreateIndexResponse ... 285
Contents ... 285
See Also ... 285
BatchCreateObject ... 286
Contents ... 286
See Also ... 286
BatchCreateObjectResponse ... 288
Contents ... 288
See Also ... 288
BatchDeleteObject ... 289
Contents ... 289
See Also ... 289
BatchDeleteObjectResponse ... 290
Contents ... 290
See Also ... 290
BatchDetachFromIndex ... 291
Contents ... 291
See Also ... 291
BatchDetachFromIndexResponse ... 292
Contents ... 292
See Also ... 292
BatchDetachObject ... 293
Contents ... 293
See Also ... 293
BatchDetachObjectResponse ... 294
Contents ... 294
See Also ... 294
BatchDetachPolicy ... 295
Contents ... 295
See Also ... 295
BatchDetachPolicyResponse ... 296
Contents ... 296
See Also ... 296
BatchDetachTypedLink ... 297
Contents ... 297
See Also ... 297
BatchDetachTypedLinkResponse ... 298
Contents ... 298
See Also ... 298
BatchGetLinkAttributes ... 299
Contents ... 299
See Also ... 299
BatchGetLinkAttributesResponse ... 300
Contents ... 300
See Also ... 300
BatchGetObjectAttributes ... 301
Contents ... 301
See Also ... 301
BatchGetObjectAttributesResponse ... 302
Contents ... 302
See Also ... 302
BatchGetObjectInformation ... 303
Contents ... 303
See Also ... 303
BatchGetObjectInformationResponse ... 304
Contents ... 304
See Also ... 304
BatchListAttachedIndices ... 305
Contents ... 305
See Also ... 305
BatchListAttachedIndicesResponse ... 306
Contents ... 306
See Also ... 306
BatchListIncomingTypedLinks ... 307
Contents ... 307
See Also ... 307
BatchListIncomingTypedLinksResponse ... 309
Contents ... 309
See Also ... 309
BatchListIndex ... 310
Contents ... 310
See Also ... 310
BatchListIndexResponse ... 311
Contents ... 311
See Also ... 311
BatchListObjectAttributes ... 312
Contents ... 312
See Also ... 312
BatchListObjectAttributesResponse ... 313
Contents ... 313
See Also ... 313
BatchListObjectChildren ... 314
Contents ... 314
See Also ... 314
BatchListObjectChildrenResponse ... 315
Contents ... 315
See Also ... 315
BatchListObjectParentPaths ... 316
Contents ... 316
See Also ... 316
BatchListObjectParentPathsResponse ... 317
Contents ... 317
See Also ... 317
BatchListObjectParents ... 318
Contents ... 318
See Also ... 318
BatchListObjectParentsResponse ... 319
Contents ... 319
See Also ... 319
BatchListObjectPolicies ... 320
Contents ... 320
See Also ... 320
BatchListObjectPoliciesResponse ... 321
Contents ... 321
See Also ... 321
BatchListOutgoingTypedLinks ... 322
Contents ... 322
See Also ... 322
BatchListOutgoingTypedLinksResponse ... 324
Contents ... 324
See Also ... 324
BatchListPolicyAttachments ... 325
Contents ... 325
See Also ... 325
BatchListPolicyAttachmentsResponse ... 326
Contents ... 326
See Also ... 326
BatchLookupPolicy ... 327
Contents ... 327
See Also ... 327
BatchLookupPolicyResponse ... 328
Contents ... 328
See Also ... 328
BatchReadException ... 329
Contents ... 329
See Also ... 329
BatchReadOperation ... 330
Contents ... 330
See Also ... 331
BatchReadOperationResponse ... 333
Contents ... 333
See Also ... 333
BatchReadSuccessfulResponse ... 334
Contents ... 334
See Also ... 335
BatchRemoveFacetFromObject ... 337
Contents ... 337
See Also ... 337
BatchRemoveFacetFromObjectResponse ... 338
Contents ... 338
See Also ... 338
BatchUpdateLinkAttributes ... 339
Contents ... 339
See Also ... 339
BatchUpdateLinkAttributesResponse ... 340
Contents ... 340
See Also ... 340
BatchUpdateObjectAttributes ... 341
Contents ... 341
See Also ... 341
BatchUpdateObjectAttributesResponse ... 342
Contents ... 342
See Also ... 342
BatchWriteOperation ... 343
Contents ... 343
See Also ... 344
BatchWriteOperationResponse ... 346
Contents ... 346
See Also ... 347
Directory ... 349
Contents ... 349
See Also ... 349
Facet ... 350
Contents ... 350
See Also ... 350
FacetAttribute ... 351
Contents ... 351
See Also ... 351
FacetAttributeDefinition ... 352
Contents ... 352
See Also ... 352
FacetAttributeReference ... 353
Contents ... 353
See Also ... 353
FacetAttributeUpdate ... 354
Contents ... 354
See Also ... 354
IndexAttachment ... 355
Contents ... 355
See Also ... 355
LinkAttributeAction ... 356
Contents ... 356
See Also ... 356
LinkAttributeUpdate ... 357
Contents ... 357
See Also ... 357
ObjectAttributeAction ... 358
Contents ... 358
See Also ... 358
ObjectAttributeRange ... 359
Contents ... 359
See Also ... 359
ObjectAttributeUpdate ... 360
Contents ... 360
See Also ... 360
ObjectIdentifierAndLinkNameTuple ... 361
Contents ... 361
See Also ... 361
ObjectReference ... 362
Contents ... 362
See Also ... 362
PathToObjectIdentifiers ... 363
Contents ... 363
See Also ... 363
PolicyAttachment ... 364
Contents ... 364
See Also ... 364
PolicyToPath ... 365
Contents ... 365
See Also ... 365
Rule ... 366
Contents ... 366
See Also ... 366
SchemaFacet ... 367
Contents ... 367
See Also ... 367
Tag ... 368
Contents ... 368
See Also ... 368
TypedAttributeValue ... 369
Contents ... 369
See Also ... 369
TypedAttributeValueRange ... 370
Contents ... 370
See Also ... 370
TypedLinkAttributeDefinition ... 371
Contents ... 371
See Also ... 372
TypedLinkAttributeRange ... 373
Contents ... 373
See Also ... 373
TypedLinkFacet ... 374
Contents ... 374
See Also ... 374
TypedLinkFacetAttributeUpdate ... 375
Contents ... 375
See Also ... 375
TypedLinkSchemaAndFacetName ... 376
Contents ... 376
See Also ... 376
TypedLinkSpecifier ... 377
Contents ... 377
See Also ... 377
Arn Examples ... 378
Schema Arns ... 378
Directory Arns ... 379
CloudTrail Logging ... 380
Cloud Directory Information in CloudTrail ... 380
Understanding Cloud Directory Log File Entries ... 381
Common Parameters ... 384
Common Errors ... 386
Document History ... 388
Welcome to the Amazon Cloud Directory API Reference
Amazon Cloud Directory is a highly scalable, high performance, multitenant directory service in the cloud. Its web-based directories make it easy for you to organize and manage application resources such as users, groups, locations, devices, policies, and the rich relationships between them. Cloud Directory is a foundational building block for developers to create directory-based solutions easily and without having to worry about deployment, global scale, availability, and performance.
With Cloud Directory, you can organize directory objects into multiple hierarchies to support multiple organizational pivots and relationships across directory information. For example, a directory of users could provide a hierarchical view based on reporting structure, location, and project affiliation. Similarly, a directory of devices might have multiple hierarchical views based on its manufacturer, current owner, and physical location. For more information, see Amazon Cloud Directory in the AWS Directory Service Admin Guide.
This guide describes the Cloud Directory operations that you can call programatically and includes detailed information on data types and errors.
NoteAWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
Actions
The following actions are supported:
• AddFacetToObject (p. 4)
• ApplySchema (p. 8)
• AttachObject (p. 12)
• AttachPolicy (p. 16)
• AttachToIndex (p. 20)
• AttachTypedLink (p. 24)
• BatchRead (p. 29)
• BatchWrite (p. 39)
• CreateDirectory (p. 47)
• CreateFacet (p. 51)
• CreateIndex (p. 56)
• CreateObject (p. 61)
• CreateSchema (p. 66)
• CreateTypedLinkFacet (p. 70)
• DeleteDirectory (p. 74)
• DeleteFacet (p. 77)
• DeleteObject (p. 80)
• DeleteSchema (p. 83)
• DeleteTypedLinkFacet (p. 86)
• DetachFromIndex (p. 89)
• DetachObject (p. 93)
• DetachPolicy (p. 97)
• DetachTypedLink (p. 101)
• DisableDirectory (p. 105)
• EnableDirectory (p. 108)
• GetAppliedSchemaVersion (p. 111)
• GetDirectory (p. 114)
• GetFacet (p. 117)
• GetLinkAttributes (p. 121)
• GetObjectAttributes (p. 125)
• GetObjectInformation (p. 129)
• GetSchemaAsJson (p. 133)
• GetTypedLinkFacetInformation (p. 138)
• ListAppliedSchemaArns (p. 142)
• ListAttachedIndices (p. 146)
• ListDevelopmentSchemaArns (p. 150)
• ListDirectories (p. 154)
• ListFacetAttributes (p. 158)
• ListFacetNames (p. 165)
• ListIncomingTypedLinks (p. 169)
• ListIndex (p. 175)
• ListManagedSchemaArns (p. 180)
• ListObjectAttributes (p. 183)
• ListObjectChildren (p. 188)
• ListObjectParentPaths (p. 192)
• ListObjectParents (p. 196)
• ListObjectPolicies (p. 200)
• ListOutgoingTypedLinks (p. 203)
• ListPolicyAttachments (p. 208)
• ListPublishedSchemaArns (p. 212)
• ListTagsForResource (p. 215)
• ListTypedLinkFacetAttributes (p. 218)
• ListTypedLinkFacetNames (p. 222)
• LookupPolicy (p. 225)
• PublishSchema (p. 229)
• PutSchemaFromJson (p. 232)
• RemoveFacetFromObject (p. 235)
• TagResource (p. 238)
• UntagResource (p. 241)
• UpdateFacet (p. 244)
• UpdateLinkAttributes (p. 248)
• UpdateObjectAttributes (p. 251)
• UpdateSchema (p. 254)
• UpdateTypedLinkFacet (p. 257)
• UpgradeAppliedSchema (p. 261)
• UpgradePublishedSchema (p. 264)
AddFacetToObject
AddFacetToObject
Adds a new Facet (p. 350) to an object. An object can have more than one facet applied on it.
Request Syntax
PUT /amazonclouddirectory/2017-01-11/object/facets HTTP/1.1 x-amz-data-partition: DirectoryArn
Content-type: application/json {
"ObjectAttributeList": [ {
"Key": {
"FacetName": "string", "Name": "string", "SchemaArn": "string"
},
"Value": {
"BinaryValue": blob, "BooleanValue": boolean, "DatetimeValue": number, "NumberValue": "string", "StringValue": "string"
} } ],
"ObjectReference": { "Selector": "string"
},
"SchemaFacet": {
"FacetName": "string", "SchemaArn": "string"
}}
URI Request Parameters
The request uses the following URI parameters.
DirectoryArn (p. 4)
The Amazon Resource Name (ARN) that is associated with the Directory (p. 349) where the object resides. For more information, see Arn Examples (p. 378).
Required: Yes
Request Body
The request accepts the following data in JSON format.
ObjectAttributeList (p. 4)
Attributes on the facet that you are adding to the object.
Type: Array of AttributeKeyAndValue (p. 271) objects Required: No
Response Syntax
ObjectReference (p. 4)
A reference to the object you are adding the specified facet to.
Type: ObjectReference (p. 362) object Required: Yes
SchemaFacet (p. 4)
Identifiers for the facet that you are adding to the object. See SchemaFacet (p. 367) for details.
Type: SchemaFacet (p. 367) object Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 386).
AccessDeniedException
Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories (p. 154) and check your permissions.
HTTP Status Code: 403 DirectoryNotEnabledException
Operations are only permitted on enabled directories.
HTTP Status Code: 400 FacetValidationException
The Facet (p. 350) that you provided was not well formed or could not be validated with the schema.
HTTP Status Code: 400 InternalServiceException
Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
HTTP Status Code: 500 InvalidArnException
Indicates that the provided ARN value is not valid.
HTTP Status Code: 400
Examples
LimitExceededException
Indicates that limits are exceeded. See Limits for more information.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource could not be found.
HTTP Status Code: 404 RetryableConflictException
Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE”
consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
HTTP Status Code: 409 ValidationException
Indicates that your request is malformed in some manner. See the exception message.
HTTP Status Code: 400
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of AddFacetToObject.
PUT /amazonclouddirectory/2017-01-11/object/facets HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com
Accept-Encoding: identity Content-Length: 232
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171009/us-west-2/
clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=2cf0b34e6e7305c27f7ec762255196d937ef036d0e665e452a0e1bd79ae25106 x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/
AYb8AOV81kHNgdj8mAO3dNY X-Amz-Date: 20171009T164125Z
User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 {
"ObjectReference": {
"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ"
}, "SchemaFacet": {
"SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/
AYb8AOV81kHNgdj8mAO3dNY/schema/org/1", "FacetName": "node1"
}}
Example Response
This example illustrates one usage of AddFacetToObject.
See Also
HTTP/1.1 200 OK
x-amzn-RequestId: b21ee371-ad10-11e7-9e13-5b6a00750e59 Date: Mon, 09 Oct 2017 16:41:26 GMT
x-amzn-RequestId: b21ee371-ad10-11e7-9e13-5b6a00750e59 Content-Type: application/json
Content-Length: 2 {}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ApplySchema
ApplySchema
Copies the input published schema, at the specified version, into the Directory (p. 349) with the same name and version as that of the published schema.
Request Syntax
PUT /amazonclouddirectory/2017-01-11/schema/apply HTTP/1.1 x-amz-data-partition: DirectoryArn
Content-type: application/json { "PublishedSchemaArn": "string"
}
URI Request Parameters
The request uses the following URI parameters.
DirectoryArn (p. 8)
The Amazon Resource Name (ARN) that is associated with the Directory (p. 349) into which the schema is copied. For more information, see Arn Examples (p. 378).
Required: Yes
Request Body
The request accepts the following data in JSON format.
PublishedSchemaArn (p. 8)
Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see Arn Examples (p. 378).
Type: String Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "AppliedSchemaArn": "string", "DirectoryArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
Errors
The following data is returned in JSON format by the service.
AppliedSchemaArn (p. 8)
The applied schema ARN that is associated with the copied schema in the Directory (p. 349).
You can use this ARN to describe the schema information applied on this directory. For more information, see Arn Examples (p. 378).
Type: String DirectoryArn (p. 8)
The ARN that is associated with the Directory (p. 349). For more information, see Arn Examples (p. 378).
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 386).
AccessDeniedException
Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories (p. 154) and check your permissions.
HTTP Status Code: 403 InternalServiceException
Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
HTTP Status Code: 500 InvalidArnException
Indicates that the provided ARN value is not valid.
HTTP Status Code: 400 InvalidAttachmentException
Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
HTTP Status Code: 400 LimitExceededException
Indicates that limits are exceeded. See Limits for more information.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource could not be found.
HTTP Status Code: 404 RetryableConflictException
Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE”
Examples
consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
HTTP Status Code: 409 SchemaAlreadyExistsException
Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.
HTTP Status Code: 400 ValidationException
Indicates that your request is malformed in some manner. See the exception message.
HTTP Status Code: 400
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of ApplySchema.
PUT /amazonclouddirectory/2017-01-11/schema/apply HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com
Accept-Encoding: identity Content-Length: 94
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171003/us-west-2/
clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=ac58e3d2d25b85cd1869f7a845a0e97cebfce28d15e8f8df34c0ee89a197f042 x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/
AfMr4qym1kZTvwqOafAYfqI X-Amz-Date: 20171003T201513Z
User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 {
"PublishedSchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/published/
org/1"
}
Example Response
This example illustrates one usage of ApplySchema.
HTTP/1.1 200 OK
x-amzn-RequestId: 90d60895-a877-11e7-81c0-7b48a7696e76 Date: Tue, 03 Oct 2017 20:15:13 GMT
x-amzn-RequestId: 90d60895-a877-11e7-81c0-7b48a7696e76 Content-Type: application/json
Content-Length: 212
{ "AppliedSchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/
AfMr4qym1kZTvwqOafAYfqI/schema/org/1",
"DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/
AfMr4qym1kZTvwqOafAYfqI"
See Also
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AttachObject
AttachObject
Attaches an existing object to another object. An object can be accessed in two ways:
1. Using the path
2. Using ObjectIdentifier
Request Syntax
PUT /amazonclouddirectory/2017-01-11/object/attach HTTP/1.1 x-amz-data-partition: DirectoryArn
Content-type: application/json {
"ChildReference": { "Selector": "string"
},
"LinkName": "string", "ParentReference": { "Selector": "string"
} }
URI Request Parameters
The request uses the following URI parameters.
DirectoryArn (p. 12)
Amazon Resource Name (ARN) that is associated with the Directory (p. 349) where both objects reside. For more information, see Arn Examples (p. 378).
Required: Yes
Request Body
The request accepts the following data in JSON format.
ChildReference (p. 12)
The child object reference to be attached to the object.
Type: ObjectReference (p. 362) object Required: Yes
LinkName (p. 12)
The link name with which the child object is attached to the parent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [^\/\[\]\(\):\{\}#@!?\s\\;]+
Response Syntax
Required: Yes ParentReference (p. 12)
The parent object reference.
Type: ObjectReference (p. 362) object Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{ "AttachedObjectIdentifier": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AttachedObjectIdentifier (p. 13)
The attached ObjectIdentifier, which is the child ObjectIdentifier.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 386).
AccessDeniedException
Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories (p. 154) and check your permissions.
HTTP Status Code: 403 DirectoryNotEnabledException
Operations are only permitted on enabled directories.
HTTP Status Code: 400 FacetValidationException
The Facet (p. 350) that you provided was not well formed or could not be validated with the schema.
HTTP Status Code: 400 InternalServiceException
Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
Examples
HTTP Status Code: 500 InvalidArnException
Indicates that the provided ARN value is not valid.
HTTP Status Code: 400 InvalidAttachmentException
Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
HTTP Status Code: 400 LimitExceededException
Indicates that limits are exceeded. See Limits for more information.
HTTP Status Code: 400 LinkNameAlreadyInUseException
Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource could not be found.
HTTP Status Code: 404 RetryableConflictException
Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE”
consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
HTTP Status Code: 409 ValidationException
Indicates that your request is malformed in some manner. See the exception message.
HTTP Status Code: 400 ValidationException
Indicates that your request is malformed in some manner. See the exception message.
HTTP Status Code: 400
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of AttachObject.
See Also
PUT /amazonclouddirectory/2017-01-11/object/attach HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com
Accept-Encoding: identity Content-Length: 188
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171003/us-west-2/
clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=2ce97afc4ac4d1fd4826861fa366d6d8674d1399b1a666e59cc53b8310aacf6a x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/
AYb8AOV81kHNgdj8mAO3dNY X-Amz-Date: 20171003T195605Z
User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 { "ParentReference": {
"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
}, "LinkName": "link2", "ChildReference": {
"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
}}
Example Response
This example illustrates one usage of AttachObject.
HTTP/1.1 200 OK
x-amzn-RequestId: e4be5146-a874-11e7-a169-c5bf0acd39f4 Date: Tue, 03 Oct 2017 19:56:06 GMT
x-amzn-RequestId: e4be5146-a874-11e7-a169-c5bf0acd39f4 Content-Type: application/json
Content-Length: 77
{ "AttachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AttachPolicy
AttachPolicy
Attaches a policy object to a regular object. An object can have a limited number of attached policies.
Request Syntax
PUT /amazonclouddirectory/2017-01-11/policy/attach HTTP/1.1 x-amz-data-partition: DirectoryArn
Content-type: application/json {
"ObjectReference": { "Selector": "string"
},
"PolicyReference": { "Selector": "string"
}}
URI Request Parameters
The request uses the following URI parameters.
DirectoryArn (p. 16)
The Amazon Resource Name (ARN) that is associated with the Directory (p. 349) where both objects reside. For more information, see Arn Examples (p. 378).
Required: Yes
Request Body
The request accepts the following data in JSON format.
ObjectReference (p. 16)
The reference that identifies the object to which the policy will be attached.
Type: ObjectReference (p. 362) object Required: Yes
PolicyReference (p. 16)
The reference that is associated with the policy object.
Type: ObjectReference (p. 362) object Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 386).
AccessDeniedException
Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories (p. 154) and check your permissions.
HTTP Status Code: 403 DirectoryNotEnabledException
Operations are only permitted on enabled directories.
HTTP Status Code: 400 InternalServiceException
Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
HTTP Status Code: 500 InvalidArnException
Indicates that the provided ARN value is not valid.
HTTP Status Code: 400 LimitExceededException
Indicates that limits are exceeded. See Limits for more information.
HTTP Status Code: 400 NotPolicyException
Indicates that the requested operation can only operate on policy objects.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource could not be found.
HTTP Status Code: 404 RetryableConflictException
Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE”
consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
HTTP Status Code: 409 ValidationException
Indicates that your request is malformed in some manner. See the exception message.
Examples
HTTP Status Code: 400
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of AttachPolicy.
PUT /amazonclouddirectory/2017-01-11/policy/attach HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com
Accept-Encoding: identity Content-Length: 168
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171017/us-west-2/
clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=d6ba55fbae53295150b69a92946e542ad08f7557492c5862d70d6a8c62fa24b0 x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/
AYb8AOV81kHNgdj8mAO3dNY X-Amz-Date: 20171017T185436Z
User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 { "PolicyReference": {
"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWgcBsTVmcQEWs6jlygfhuew"
}, "ObjectReference": {
"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWQoovm1s3Ts2v0NKrzdVnPw"
} }
Example Response
This example illustrates one usage of AttachPolicy.
HTTP/1.1 200 OK
x-amzn-RequestId: 9ff9d709-b36c-11e7-843e-9fad359f817f Date: Tue, 17 Oct 2017 18:54:37 GMT
x-amzn-RequestId: 9ff9d709-b36c-11e7-843e-9fad359f817f Content-Type: application/json
Content-Length: 2 {}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
See Also
• AWS SDK for Python
• AWS SDK for Ruby V3
AttachToIndex
AttachToIndex
Attaches the specified object to the specified index.
Request Syntax
PUT /amazonclouddirectory/2017-01-11/index/attach HTTP/1.1 x-amz-data-partition: DirectoryArn
Content-type: application/json {
"IndexReference": { "Selector": "string"
},
"TargetReference": { "Selector": "string"
}}
URI Request Parameters
The request uses the following URI parameters.
DirectoryArn (p. 20)
The Amazon Resource Name (ARN) of the directory where the object and index exist.
Required: Yes
Request Body
The request accepts the following data in JSON format.
IndexReference (p. 20)
A reference to the index that you are attaching the object to.
Type: ObjectReference (p. 362) object Required: Yes
TargetReference (p. 20)
A reference to the object that you are attaching to the index.
Type: ObjectReference (p. 362) object Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{ "AttachedObjectIdentifier": "string"
Response Elements
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AttachedObjectIdentifier (p. 20)
The ObjectIdentifier of the object that was attached to the index.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 386).
AccessDeniedException
Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories (p. 154) and check your permissions.
HTTP Status Code: 403 DirectoryNotEnabledException
Operations are only permitted on enabled directories.
HTTP Status Code: 400
IndexedAttributeMissingException
An object has been attempted to be attached to an object that does not have the appropriate attribute value.
HTTP Status Code: 400 InternalServiceException
Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
HTTP Status Code: 500 InvalidArnException
Indicates that the provided ARN value is not valid.
HTTP Status Code: 400 InvalidAttachmentException
Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
HTTP Status Code: 400 LimitExceededException
Indicates that limits are exceeded. See Limits for more information.
Examples
HTTP Status Code: 400 LinkNameAlreadyInUseException
Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
HTTP Status Code: 400 NotIndexException
Indicates that the requested operation can only operate on index objects.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource could not be found.
HTTP Status Code: 404 RetryableConflictException
Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE”
consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
HTTP Status Code: 409 ValidationException
Indicates that your request is malformed in some manner. See the exception message.
HTTP Status Code: 400
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of AttachToIndex.
PUT /amazonclouddirectory/2017-01-11/index/attach HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com
Accept-Encoding: identity Content-Length: 167
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20170927/us-west-2/
clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=78d785ce666b33aa8624c62c59be1dca60c49062f91eb216909450ea214c5a56 x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/
AYb8AOV81kHNgdj8mAO3dNY X-Amz-Date: 20170927T171118Z
User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 {
"IndexReference": {
"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q"
},
"TargetReference": {
"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
See Also
} }
Example Response
This example illustrates one usage of AttachToIndex.
HTTP/1.1 200 OK
x-amzn-RequestId: e1458e29-a3a6-11e7-a169-c5bf0acd39f4 Date: Wed, 27 Sep 2017 17:11:18 GMT
x-amzn-RequestId: e1458e29-a3a6-11e7-a169-c5bf0acd39f4 Content-Type: application/json
Content-Length: 77 {
"AttachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AttachTypedLink
AttachTypedLink
Attaches a typed link to a specified source and target object. For more information, see Typed Links.
Request Syntax
PUT /amazonclouddirectory/2017-01-11/typedlink/attach HTTP/1.1 x-amz-data-partition: DirectoryArn
Content-type: application/json { "Attributes": [
{
"AttributeName": "string", "Value": {
"BinaryValue": blob, "BooleanValue": boolean, "DatetimeValue": number, "NumberValue": "string", "StringValue": "string"
} } ],
"SourceObjectReference": { "Selector": "string"
},
"TargetObjectReference": { "Selector": "string"
},
"TypedLinkFacet": { "SchemaArn": "string", "TypedLinkName": "string"
} }
URI Request Parameters
The request uses the following URI parameters.
DirectoryArn (p. 24)
The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.
Required: Yes
Request Body
The request accepts the following data in JSON format.
Attributes (p. 24)
A set of attributes that are associated with the typed link.
Type: Array of AttributeNameAndValue (p. 272) objects Required: Yes
Response Syntax
SourceObjectReference (p. 24)
Identifies the source object that the typed link will attach to.
Type: ObjectReference (p. 362) object Required: Yes
TargetObjectReference (p. 24)
Identifies the target object that the typed link will attach to.
Type: ObjectReference (p. 362) object Required: Yes
TypedLinkFacet (p. 24)
Identifies the typed link facet that is associated with the typed link.
Type: TypedLinkSchemaAndFacetName (p. 376) object Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "TypedLinkSpecifier": {
"IdentityAttributeValues": [ {
"AttributeName": "string", "Value": {
"BinaryValue": blob, "BooleanValue": boolean, "DatetimeValue": number, "NumberValue": "string", "StringValue": "string"
} } ],
"SourceObjectReference": { "Selector": "string"
},
"TargetObjectReference": { "Selector": "string"
},
"TypedLinkFacet": { "SchemaArn": "string", "TypedLinkName": "string"
} } }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
TypedLinkSpecifier (p. 25)
Returns a typed link specifier as output.
Type: TypedLinkSpecifier (p. 377) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 386).
AccessDeniedException
Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories (p. 154) and check your permissions.
HTTP Status Code: 403 DirectoryNotEnabledException
Operations are only permitted on enabled directories.
HTTP Status Code: 400 FacetValidationException
The Facet (p. 350) that you provided was not well formed or could not be validated with the schema.
HTTP Status Code: 400 InternalServiceException
Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
HTTP Status Code: 500 InvalidArnException
Indicates that the provided ARN value is not valid.
HTTP Status Code: 400 InvalidAttachmentException
Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
HTTP Status Code: 400 LimitExceededException
Indicates that limits are exceeded. See Limits for more information.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource could not be found.
HTTP Status Code: 404
Examples
RetryableConflictException
Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE”
consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
HTTP Status Code: 409 ValidationException
Indicates that your request is malformed in some manner. See the exception message.
HTTP Status Code: 400 ValidationException
Indicates that your request is malformed in some manner. See the exception message.
HTTP Status Code: 400
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of AttachTypedLink.
PUT /amazonclouddirectory/2017-01-11/typedlink/attach HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com
Accept-Encoding: identity Content-Length: 422
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20170928/us-west-2/
clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=d1b63e72fd13cafb5af77d621891a58849c146c2654d046366d420527a659b48 x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/
AYb8AOV81kHNgdj8mAO3dNY X-Amz-Date: 20170928T003543Z
User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 {
"SourceObjectReference": {
"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
},
"Attributes": [{
"AttributeName": "22", "Value": {
"BinaryValue": "c3Ry"
}
}], "TargetObjectReference": {
"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
}, "TypedLinkFacet": {
"TypedLinkName": "exampletypedlink8",
"SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/
AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
}}
See Also
Example Response
This example illustrates one usage of AttachTypedLink.
HTTP/1.1 200 OK
x-amzn-RequestId: f6f0b320-a3e4-11e7-b86b-239c40918c06 Date: Thu, 28 Sep 2017 00:35:44 GMT
x-amzn-RequestId: f6f0b320-a3e4-11e7-b86b-239c40918c06 Content-Type: application/json
Content-Length: 521 { "TypedLinkSpecifier": { "IdentityAttributeValues": [{
"AttributeName": "22", "Value": {
"BinaryValue": "c3Ry", "BooleanValue": null, "DatetimeValue": null, "NumberValue": null, "StringValue": null } }],
"SourceObjectReference": {
"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
}, "TargetObjectReference": {
"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
}, "TypedLinkFacet": {
"SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/
AYb8AOV81kHNgdj8mAO3dNY/schema/org/1", "TypedLinkName": "exampletypedlink8"
} } }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
BatchRead
BatchRead
Performs all the read operations in a batch.
Request Syntax
POST /amazonclouddirectory/2017-01-11/batchread HTTP/1.1 x-amz-data-partition: DirectoryArn
x-amz-consistency-level: ConsistencyLevel Content-type: application/json
{ "Operations": [ {
"GetLinkAttributes": {
"AttributeNames": [ "string" ], "TypedLinkSpecifier": {
"IdentityAttributeValues": [ {
"AttributeName": "string", "Value": {
"BinaryValue": blob, "BooleanValue": boolean, "DatetimeValue": number, "NumberValue": "string", "StringValue": "string"
} } ],
"SourceObjectReference": { "Selector": "string"
},
"TargetObjectReference": { "Selector": "string"
},
"TypedLinkFacet": { "SchemaArn": "string", "TypedLinkName": "string"
} } },
"GetObjectAttributes": {
"AttributeNames": [ "string" ], "ObjectReference": {
"Selector": "string"
},
"SchemaFacet": {
"FacetName": "string", "SchemaArn": "string"
} },
"GetObjectInformation": { "ObjectReference": { "Selector": "string"
} },
"ListAttachedIndices": { "MaxResults": number, "NextToken": "string", "TargetReference": { "Selector": "string"
} },