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.
Indicates that the provided ARN value is not valid.