dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/clouddirectory/2016-05-10/service-2.json
TANIGUCHI Takaki a73c3c192a New upstream version 1.5.7
2017-02-02 17:27:08 +09:00

3931 lines
135 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"version":"2.0",
"metadata":{
"apiVersion":"2016-05-10",
"endpointPrefix":"clouddirectory",
"protocol":"rest-json",
"serviceFullName":"Amazon CloudDirectory",
"signatureVersion":"v4",
"signingName":"clouddirectory",
"uid":"clouddirectory-2016-05-10"
},
"operations":{
"AddFacetToObject":{
"name":"AddFacetToObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/facets",
"responseCode":200
},
"input":{"shape":"AddFacetToObjectRequest"},
"output":{"shape":"AddFacetToObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Adds a new <a>Facet</a> to an object.</p>"
},
"ApplySchema":{
"name":"ApplySchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/apply",
"responseCode":200
},
"input":{"shape":"ApplySchemaRequest"},
"output":{"shape":"ApplySchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAttachmentException"}
],
"documentation":"<p>Copies input published schema into <a>Directory</a> with same name and version as that of published schema .</p>"
},
"AttachObject":{
"name":"AttachObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/attach",
"responseCode":200
},
"input":{"shape":"AttachObjectRequest"},
"output":{"shape":"AttachObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LinkNameAlreadyInUseException"},
{"shape":"InvalidAttachmentException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Attaches an existing object to another object. An object can be accessed in two ways:</p> <ol> <li> <p>Using the path</p> </li> <li> <p>Using ObjectIdentifier</p> </li> </ol>"
},
"AttachPolicy":{
"name":"AttachPolicy",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/policy/attach",
"responseCode":200
},
"input":{"shape":"AttachPolicyRequest"},
"output":{"shape":"AttachPolicyResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotPolicyException"}
],
"documentation":"<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>"
},
"AttachToIndex":{
"name":"AttachToIndex",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/index/attach",
"responseCode":200
},
"input":{"shape":"AttachToIndexRequest"},
"output":{"shape":"AttachToIndexResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LinkNameAlreadyInUseException"},
{"shape":"IndexedAttributeMissingException"},
{"shape":"NotIndexException"}
],
"documentation":"<p>Attaches the specified object to the specified index.</p>"
},
"BatchRead":{
"name":"BatchRead",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/batchread",
"responseCode":200
},
"input":{"shape":"BatchReadRequest"},
"output":{"shape":"BatchReadResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"}
],
"documentation":"<p>Performs all the read operations in a batch. </p>"
},
"BatchWrite":{
"name":"BatchWrite",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/batchwrite",
"responseCode":200
},
"input":{"shape":"BatchWriteRequest"},
"output":{"shape":"BatchWriteResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"BatchWriteException"}
],
"documentation":"<p>Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.</p>"
},
"CreateDirectory":{
"name":"CreateDirectory",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/directory/create",
"responseCode":200
},
"input":{"shape":"CreateDirectoryRequest"},
"output":{"shape":"CreateDirectoryResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryAlreadyExistsException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Creates a <a>Directory</a> by copying the published schema into the directory. A directory cannot be created without a schema.</p>"
},
"CreateFacet":{
"name":"CreateFacet",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/facet/create",
"responseCode":200
},
"input":{"shape":"CreateFacetRequest"},
"output":{"shape":"CreateFacetResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetAlreadyExistsException"},
{"shape":"InvalidRuleException"}
],
"documentation":"<p>Creates a new <a>Facet</a> in a schema. Facet creation is allowed only in development or applied schemas.</p>"
},
"CreateIndex":{
"name":"CreateIndex",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/index",
"responseCode":200
},
"input":{"shape":"CreateIndexRequest"},
"output":{"shape":"CreateIndexResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"},
{"shape":"LinkNameAlreadyInUseException"},
{"shape":"UnsupportedIndexTypeException"}
],
"documentation":"<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>"
},
"CreateObject":{
"name":"CreateObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object",
"responseCode":200
},
"input":{"shape":"CreateObjectRequest"},
"output":{"shape":"CreateObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"},
{"shape":"LinkNameAlreadyInUseException"},
{"shape":"UnsupportedIndexTypeException"}
],
"documentation":"<p>Creates an object in a <a>Directory</a>. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of <a>Facet</a> attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet. </p>"
},
"CreateSchema":{
"name":"CreateSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/create",
"responseCode":200
},
"input":{"shape":"CreateSchemaRequest"},
"output":{"shape":"CreateSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"SchemaAlreadyExistsException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates a new schema in a development state. A schema can exist in three phases:</p> <ul> <li> <p> <i>Development:</i> This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.</p> </li> <li> <p> <i>Published:</i> Published schemas are immutable and have a version associated with them.</p> </li> <li> <p> <i>Applied:</i> Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories. </p> </li> </ul>"
},
"DeleteDirectory":{
"name":"DeleteDirectory",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/directory",
"responseCode":200
},
"input":{"shape":"DeleteDirectoryRequest"},
"output":{"shape":"DeleteDirectoryResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"DirectoryNotDisabledException"},
{"shape":"InternalServiceException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryDeletedException"}
],
"documentation":"<p>Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.</p>"
},
"DeleteFacet":{
"name":"DeleteFacet",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/facet/delete",
"responseCode":200
},
"input":{"shape":"DeleteFacetRequest"},
"output":{"shape":"DeleteFacetResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetNotFoundException"},
{"shape":"FacetInUseException"}
],
"documentation":"<p>Deletes a given <a>Facet</a>. All attributes and <a>Rule</a>s associated with the facet will be deleted. Only development schema facets are allowed deletion.</p>"
},
"DeleteObject":{
"name":"DeleteObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/delete",
"responseCode":200
},
"input":{"shape":"DeleteObjectRequest"},
"output":{"shape":"DeleteObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ObjectNotDetachedException"}
],
"documentation":"<p>Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.</p>"
},
"DeleteSchema":{
"name":"DeleteSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema",
"responseCode":200
},
"input":{"shape":"DeleteSchemaRequest"},
"output":{"shape":"DeleteSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"StillContainsLinksException"}
],
"documentation":"<p>Deletes a given schema. Schemas in a development and published state can only be deleted. </p>"
},
"DetachFromIndex":{
"name":"DetachFromIndex",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/index/detach",
"responseCode":200
},
"input":{"shape":"DetachFromIndexRequest"},
"output":{"shape":"DetachFromIndexResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ObjectAlreadyDetachedException"},
{"shape":"NotIndexException"}
],
"documentation":"<p>Detaches the specified object from the specified index.</p>"
},
"DetachObject":{
"name":"DetachObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/detach",
"responseCode":200
},
"input":{"shape":"DetachObjectRequest"},
"output":{"shape":"DetachObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.</p>"
},
"DetachPolicy":{
"name":"DetachPolicy",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/policy/detach",
"responseCode":200
},
"input":{"shape":"DetachPolicyRequest"},
"output":{"shape":"DetachPolicyResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotPolicyException"}
],
"documentation":"<p>Detaches a policy from an object.</p>"
},
"DisableDirectory":{
"name":"DisableDirectory",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/directory/disable",
"responseCode":200
},
"input":{"shape":"DisableDirectoryRequest"},
"output":{"shape":"DisableDirectoryResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"DirectoryDeletedException"},
{"shape":"InternalServiceException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.</p>"
},
"EnableDirectory":{
"name":"EnableDirectory",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/directory/enable",
"responseCode":200
},
"input":{"shape":"EnableDirectoryRequest"},
"output":{"shape":"EnableDirectoryResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"DirectoryDeletedException"},
{"shape":"InternalServiceException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.</p>"
},
"GetDirectory":{
"name":"GetDirectory",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/directory/get",
"responseCode":200
},
"input":{"shape":"GetDirectoryRequest"},
"output":{"shape":"GetDirectoryResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves metadata about a directory.</p>"
},
"GetFacet":{
"name":"GetFacet",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/facet",
"responseCode":200
},
"input":{"shape":"GetFacetRequest"},
"output":{"shape":"GetFacetResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetNotFoundException"}
],
"documentation":"<p>Gets details of the <a>Facet</a>, such as Facet Name, Attributes, <a>Rule</a>s, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.</p>"
},
"GetObjectInformation":{
"name":"GetObjectInformation",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/information",
"responseCode":200
},
"input":{"shape":"GetObjectInformationRequest"},
"output":{"shape":"GetObjectInformationResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Retrieves metadata about an object.</p>"
},
"GetSchemaAsJson":{
"name":"GetSchemaAsJson",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/json",
"responseCode":200
},
"input":{"shape":"GetSchemaAsJsonRequest"},
"output":{"shape":"GetSchemaAsJsonResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Retrieves a JSON representation of the schema. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>"
},
"ListAppliedSchemaArns":{
"name":"ListAppliedSchemaArns",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/applied",
"responseCode":200
},
"input":{"shape":"ListAppliedSchemaArnsRequest"},
"output":{"shape":"ListAppliedSchemaArnsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists schemas applied to a directory.</p>"
},
"ListAttachedIndices":{
"name":"ListAttachedIndices",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/indices",
"responseCode":200
},
"input":{"shape":"ListAttachedIndicesRequest"},
"output":{"shape":"ListAttachedIndicesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists indices attached to an object.</p>"
},
"ListDevelopmentSchemaArns":{
"name":"ListDevelopmentSchemaArns",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/development",
"responseCode":200
},
"input":{"shape":"ListDevelopmentSchemaArnsRequest"},
"output":{"shape":"ListDevelopmentSchemaArnsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves the ARNs of schemas in the development state.</p>"
},
"ListDirectories":{
"name":"ListDirectories",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/directory/list",
"responseCode":200
},
"input":{"shape":"ListDirectoriesRequest"},
"output":{"shape":"ListDirectoriesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists directories created within an account.</p>"
},
"ListFacetAttributes":{
"name":"ListFacetAttributes",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/facet/attributes",
"responseCode":200
},
"input":{"shape":"ListFacetAttributesRequest"},
"output":{"shape":"ListFacetAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves attributes attached to the facet.</p>"
},
"ListFacetNames":{
"name":"ListFacetNames",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/facet/list",
"responseCode":200
},
"input":{"shape":"ListFacetNamesRequest"},
"output":{"shape":"ListFacetNamesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves the names of facets that exist in a schema.</p>"
},
"ListIndex":{
"name":"ListIndex",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/index/targets",
"responseCode":200
},
"input":{"shape":"ListIndexRequest"},
"output":{"shape":"ListIndexResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotIndexException"}
],
"documentation":"<p>Lists objects attached to the specified index.</p>"
},
"ListObjectAttributes":{
"name":"ListObjectAttributes",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/attributes",
"responseCode":200
},
"input":{"shape":"ListObjectAttributesRequest"},
"output":{"shape":"ListObjectAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists all attributes associated with an object. This also supports common namespace prefix (key) listing. For example, if you want to retrieve all attributes associated with facet1, key can be <code>facet1</code>. If key is empty, all attributes are returned in a paginated list.</p>"
},
"ListObjectChildren":{
"name":"ListObjectChildren",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/children",
"responseCode":200
},
"input":{"shape":"ListObjectChildrenRequest"},
"output":{"shape":"ListObjectChildrenResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"NotNodeException"}
],
"documentation":"<p>Returns a paginated list of child objects associated with a given object.</p>"
},
"ListObjectParents":{
"name":"ListObjectParents",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/parent",
"responseCode":200
},
"input":{"shape":"ListObjectParentsRequest"},
"output":{"shape":"ListObjectParentsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"CannotListParentOfRootException"}
],
"documentation":"<p>Lists parent objects associated with a given object in pagination fashion.</p>"
},
"ListObjectPolicies":{
"name":"ListObjectPolicies",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/policy",
"responseCode":200
},
"input":{"shape":"ListObjectPoliciesRequest"},
"output":{"shape":"ListObjectPoliciesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Returns policies attached to an object in pagination fashion.</p>"
},
"ListPolicyAttachments":{
"name":"ListPolicyAttachments",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/policy/attachment",
"responseCode":200
},
"input":{"shape":"ListPolicyAttachmentsRequest"},
"output":{"shape":"ListPolicyAttachmentsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotPolicyException"}
],
"documentation":"<p>Returns all of the ObjectIdentifiers to which a given policy is attached.</p>"
},
"ListPublishedSchemaArns":{
"name":"ListPublishedSchemaArns",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/published",
"responseCode":200
},
"input":{"shape":"ListPublishedSchemaArnsRequest"},
"output":{"shape":"ListPublishedSchemaArnsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves published schema ARNs.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/tags",
"responseCode":200
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidTaggingRequestException"}
],
"documentation":"<p>Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.</p>"
},
"LookupPolicy":{
"name":"LookupPolicy",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/policy/lookup",
"responseCode":200
},
"input":{"shape":"LookupPolicyRequest"},
"output":{"shape":"LookupPolicyResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the objectIdentifier for such objects. If policies are present, it returns objectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored.</p>"
},
"PublishSchema":{
"name":"PublishSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/publish",
"responseCode":200
},
"input":{"shape":"PublishSchemaRequest"},
"output":{"shape":"PublishSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"SchemaAlreadyPublishedException"}
],
"documentation":"<p>Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.</p>"
},
"PutSchemaFromJson":{
"name":"PutSchemaFromJson",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/json",
"responseCode":200
},
"input":{"shape":"PutSchemaFromJsonRequest"},
"output":{"shape":"PutSchemaFromJsonResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidSchemaDocException"},
{"shape":"InvalidRuleException"}
],
"documentation":"<p>Allows a schema to be updated using JSON upload. Only available for development schemas. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>"
},
"RemoveFacetFromObject":{
"name":"RemoveFacetFromObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/facets/delete",
"responseCode":200
},
"input":{"shape":"RemoveFacetFromObjectRequest"},
"output":{"shape":"RemoveFacetFromObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Removes the specified facet from the specified object.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/tags/add",
"responseCode":200
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidTaggingRequestException"}
],
"documentation":"<p>API for adding tags to a resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/tags/remove",
"responseCode":200
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidTaggingRequestException"}
],
"documentation":"<p>API for removing tags from a resource.</p>"
},
"UpdateFacet":{
"name":"UpdateFacet",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/facet",
"responseCode":200
},
"input":{"shape":"UpdateFacetRequest"},
"output":{"shape":"UpdateFacetResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidFacetUpdateException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetNotFoundException"},
{"shape":"InvalidRuleException"}
],
"documentation":"<p>Does the following:</p> <ol> <li> <p>Adds new Attributes, Rules, or ObjectTypes.</p> </li> <li> <p>Updates existing Attributes, Rules, or ObjectTypes.</p> </li> <li> <p>Deletes existing Attributes, Rules, or ObjectTypes.</p> </li> </ol>"
},
"UpdateObjectAttributes":{
"name":"UpdateObjectAttributes",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/update",
"responseCode":200
},
"input":{"shape":"UpdateObjectAttributesRequest"},
"output":{"shape":"UpdateObjectAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Updates a given object's attributes.</p>"
},
"UpdateSchema":{
"name":"UpdateSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/update",
"responseCode":200
},
"input":{"shape":"UpdateSchemaRequest"},
"output":{"shape":"UpdateSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates the schema name with a new name. Only development schema names can be updated.</p>"
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Access denied. Check your permissions.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"AddFacetToObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"SchemaFacet",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"SchemaFacet":{
"shape":"SchemaFacet",
"documentation":"<p>Identifiers for the facet that you are adding to the object.</p>"
},
"ObjectAttributeList":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>Attributes on the facet you are adding to the object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object you are adding the specified facet to.</p>"
}
}
},
"AddFacetToObjectResponse":{
"type":"structure",
"members":{
}
},
"ApplySchemaRequest":{
"type":"structure",
"required":[
"PublishedSchemaArn",
"DirectoryArn"
],
"members":{
"PublishedSchemaArn":{
"shape":"Arn",
"documentation":"<p>Published schema ARN that needs to be copied. For more information, see <a>arns</a>.</p>"
},
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> into which the schema is copied. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"ApplySchemaResponse":{
"type":"structure",
"members":{
"AppliedSchemaArn":{
"shape":"Arn",
"documentation":"<p>Applied schema ARN associated with the copied schema in the <a>Directory</a>. You can use this ARN to describe the schema information applied on this directory. For more information, see <a>arns</a>.</p>"
},
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>"
}
}
},
"Arn":{"type":"string"},
"Arns":{
"type":"list",
"member":{"shape":"Arn"}
},
"AttachObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ParentReference",
"ChildReference",
"LinkName"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>Parent object reference.</p>"
},
"ChildReference":{
"shape":"ObjectReference",
"documentation":"<p>Child object reference to be attached to the object.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>Link name with which the child object is attached to the parent.</p>"
}
}
},
"AttachObjectResponse":{
"type":"structure",
"members":{
"AttachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>Attached ObjectIdentifier, which is the child ObjectIdentifier.</p>"
}
}
},
"AttachPolicyRequest":{
"type":"structure",
"required":[
"PolicyReference",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"PolicyReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference associated with the policy object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object to which the policy will be attached.</p>"
}
}
},
"AttachPolicyResponse":{
"type":"structure",
"members":{
}
},
"AttachToIndexRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"IndexReference",
"TargetReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory where the object and index exist.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the index that you are attaching the object to.</p>"
},
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object that you are attaching to the index.</p>"
}
}
},
"AttachToIndexResponse":{
"type":"structure",
"members":{
"AttachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ObjectIdentifier of the object that was attached to the index.</p>"
}
}
},
"AttributeKey":{
"type":"structure",
"required":[
"SchemaArn",
"FacetName",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the schema that contains the facet and attribute.</p>"
},
"FacetName":{
"shape":"FacetName",
"documentation":"<p>The name of the facet the attribute exists within.</p>"
},
"Name":{
"shape":"AttributeName",
"documentation":"<p>The name of the attribute.</p>"
}
},
"documentation":"<p>A unique identifier for an attribute.</p>"
},
"AttributeKeyAndValue":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"AttributeKey",
"documentation":"<p>The key of the attribute.</p>"
},
"Value":{
"shape":"TypedAttributeValue",
"documentation":"<p>The value of the attribute.</p>"
}
},
"documentation":"<p>The combination of an attribute key and an attribute value.</p>"
},
"AttributeKeyAndValueList":{
"type":"list",
"member":{"shape":"AttributeKeyAndValue"}
},
"AttributeKeyList":{
"type":"list",
"member":{"shape":"AttributeKey"}
},
"AttributeName":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
},
"BatchAddFacetToObject":{
"type":"structure",
"required":[
"SchemaFacet",
"ObjectAttributeList",
"ObjectReference"
],
"members":{
"SchemaFacet":{
"shape":"SchemaFacet",
"documentation":"<p>Represents the facet being added to the object.</p>"
},
"ObjectAttributeList":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attributes to set on the object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object being mutated.</p>"
}
},
"documentation":"<p>Represents the output of a batch add facet to object operation.</p>"
},
"BatchAddFacetToObjectResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>The result of a batch add facet to object operation.</p>"
},
"BatchAttachObject":{
"type":"structure",
"required":[
"ParentReference",
"ChildReference",
"LinkName"
],
"members":{
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>Parent object reference.</p>"
},
"ChildReference":{
"shape":"ObjectReference",
"documentation":"<p>Child object reference to be attached to the object.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link.</p>"
}
},
"documentation":"<p>Represents the output of an AttachObject operation.</p>"
},
"BatchAttachObjectResponse":{
"type":"structure",
"members":{
"attachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ObjectIdentifier of the object that has been attached.</p>"
}
},
"documentation":"<p>Represents the output batch AttachObject response operation.</p>"
},
"BatchCreateObject":{
"type":"structure",
"required":[
"SchemaFacet",
"ObjectAttributeList",
"ParentReference",
"LinkName",
"BatchReferenceName"
],
"members":{
"SchemaFacet":{
"shape":"SchemaFacetList",
"documentation":"<p>List of FacetArns that will be associated with the object. For more information, see <a>arns</a>.</p>"
},
"ObjectAttributeList":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>Attribute map, which contains an attribute ARN as the key and attribute value as the map value.</p>"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>If specified, the parent reference to which this object will be attached.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link.</p>"
},
"BatchReferenceName":{
"shape":"BatchReferenceName",
"documentation":"<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
}
},
"documentation":"<p>Represents the output of a CreateObject operation.</p>"
},
"BatchCreateObjectResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>ID associated with the object.</p>"
}
},
"documentation":"<p>Represents the output of a CreateObject response operation.</p>"
},
"BatchDeleteObject":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object.</p>"
}
},
"documentation":"<p>Represents the output of a DeleteObject operation.</p>"
},
"BatchDeleteObjectResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>Represents the output of a DeleteObject response operation.</p>"
},
"BatchDetachObject":{
"type":"structure",
"required":[
"ParentReference",
"LinkName",
"BatchReferenceName"
],
"members":{
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>Parent reference from which the object with the specified link name is detached.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link.</p>"
},
"BatchReferenceName":{
"shape":"BatchReferenceName",
"documentation":"<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
}
},
"documentation":"<p>Represents the output of a DetachObject operation.</p>"
},
"BatchDetachObjectResponse":{
"type":"structure",
"members":{
"detachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ObjectIdentifier of the detached object.</p>"
}
},
"documentation":"<p>Represents the output of a DetachObject response operation.</p>"
},
"BatchListObjectAttributes":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference of the object whose attributes need to be listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
}
},
"documentation":"<p>Represents the output of a ListObjectAttributes operation.</p>"
},
"BatchListObjectAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>Attributes map associated with the object. AttributeArn is the key; attribute value is the value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
}
},
"documentation":"<p>Represents the output of a ListObjectAttributes response operation.</p>"
},
"BatchListObjectChildren":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference of the object for which child objects are being listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
}
},
"documentation":"<p>Represents the output of a ListObjectChildren operation.</p>"
},
"BatchListObjectChildrenResponse":{
"type":"structure",
"members":{
"Children":{
"shape":"LinkNameToObjectIdentifierMap",
"documentation":"<p>Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
}
},
"documentation":"<p>Represents the output of a ListObjectChildren response operation.</p>"
},
"BatchOperationIndex":{"type":"integer"},
"BatchReadException":{
"type":"structure",
"members":{
"Type":{
"shape":"BatchReadExceptionType",
"documentation":"<p>Type of exception, such as InvalidArnException.</p>"
},
"Message":{
"shape":"ExceptionMessage",
"documentation":"<p>Exception message associated with the failure.</p>"
}
},
"documentation":"<p>Batch Read Exception structure, which contains exception type and message.</p>"
},
"BatchReadExceptionType":{
"type":"string",
"enum":[
"ValidationException",
"InvalidArnException",
"ResourceNotFoundException",
"InvalidNextTokenException",
"AccessDeniedException",
"NotNodeException"
]
},
"BatchReadOperation":{
"type":"structure",
"members":{
"ListObjectAttributes":{
"shape":"BatchListObjectAttributes",
"documentation":"<p>Lists all attributes associated with an object.</p>"
},
"ListObjectChildren":{
"shape":"BatchListObjectChildren",
"documentation":"<p>Returns a paginated list of child objects that are associated with a given object.</p>"
}
},
"documentation":"<p>Represents the output of a BatchRead operation.</p>"
},
"BatchReadOperationList":{
"type":"list",
"member":{"shape":"BatchReadOperation"}
},
"BatchReadOperationResponse":{
"type":"structure",
"members":{
"SuccessfulResponse":{
"shape":"BatchReadSuccessfulResponse",
"documentation":"<p>Identifies which operation in a batch has succeeded.</p>"
},
"ExceptionResponse":{
"shape":"BatchReadException",
"documentation":"<p>Identifies which operation in a batch has failed.</p>"
}
},
"documentation":"<p>Represents the output of a BatchRead response operation.</p>"
},
"BatchReadOperationResponseList":{
"type":"list",
"member":{"shape":"BatchReadOperationResponse"}
},
"BatchReadRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"Operations"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Operations":{
"shape":"BatchReadOperationList",
"documentation":"<p>List of operations that are part of the batch.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"BatchReadResponse":{
"type":"structure",
"members":{
"Responses":{
"shape":"BatchReadOperationResponseList",
"documentation":"<p>List of all the responses for each batch read.</p>"
}
}
},
"BatchReadSuccessfulResponse":{
"type":"structure",
"members":{
"ListObjectAttributes":{
"shape":"BatchListObjectAttributesResponse",
"documentation":"<p>Lists all attributes associated with an object.</p>"
},
"ListObjectChildren":{
"shape":"BatchListObjectChildrenResponse",
"documentation":"<p>Returns a paginated list of child objects associated with a given object.</p>"
}
},
"documentation":"<p>Represents the output of a BatchRead success response operation.</p>"
},
"BatchReferenceName":{"type":"string"},
"BatchRemoveFacetFromObject":{
"type":"structure",
"required":[
"SchemaFacet",
"ObjectReference"
],
"members":{
"SchemaFacet":{
"shape":"SchemaFacet",
"documentation":"<p>The facet to remove from the object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object whose facet will be removed.</p>"
}
},
"documentation":"<p>Batch operation to remove a facet from an object.</p>"
},
"BatchRemoveFacetFromObjectResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>Empty result representing success.</p>"
},
"BatchUpdateObjectAttributes":{
"type":"structure",
"required":[
"ObjectReference",
"AttributeUpdates"
],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object.</p>"
},
"AttributeUpdates":{
"shape":"ObjectAttributeUpdateList",
"documentation":"<p>Attributes update structure.</p>"
}
},
"documentation":"<p>Represents the output of a BatchUpdate operation. </p>"
},
"BatchUpdateObjectAttributesResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>ID associated with the object.</p>"
}
},
"documentation":"<p>Represents the output of a BatchUpdate response operation.</p>"
},
"BatchWriteException":{
"type":"structure",
"members":{
"Index":{"shape":"BatchOperationIndex"},
"Type":{"shape":"BatchWriteExceptionType"},
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>A BatchWrite exception has occurred.</p>",
"exception":true
},
"BatchWriteExceptionType":{
"type":"string",
"enum":[
"InternalServiceException",
"ValidationException",
"InvalidArnException",
"LinkNameAlreadyInUseException",
"StillContainsLinksException",
"FacetValidationException",
"ObjectNotDetachedException",
"ResourceNotFoundException",
"AccessDeniedException"
]
},
"BatchWriteOperation":{
"type":"structure",
"members":{
"CreateObject":{
"shape":"BatchCreateObject",
"documentation":"<p>Creates an object.</p>"
},
"AttachObject":{
"shape":"BatchAttachObject",
"documentation":"<p>Attaches an object to a <a>Directory</a>.</p>"
},
"DetachObject":{
"shape":"BatchDetachObject",
"documentation":"<p>Detaches an object from a <a>Directory</a>.</p>"
},
"UpdateObjectAttributes":{
"shape":"BatchUpdateObjectAttributes",
"documentation":"<p>Update a given object's attributes.</p>"
},
"DeleteObject":{
"shape":"BatchDeleteObject",
"documentation":"<p>Deletes an object in a <a>Directory</a>.</p>"
},
"AddFacetToObject":{
"shape":"BatchAddFacetToObject",
"documentation":"<p>Batch operation adding a facet to an object.</p>"
},
"RemoveFacetFromObject":{
"shape":"BatchRemoveFacetFromObject",
"documentation":"<p>Batch operation removing a facet from an object.</p>"
}
},
"documentation":"<p>Represents the output of a BatchWrite operation. </p>"
},
"BatchWriteOperationList":{
"type":"list",
"member":{"shape":"BatchWriteOperation"}
},
"BatchWriteOperationResponse":{
"type":"structure",
"members":{
"CreateObject":{
"shape":"BatchCreateObjectResponse",
"documentation":"<p>Creates an object in a <a>Directory</a>.</p>"
},
"AttachObject":{
"shape":"BatchAttachObjectResponse",
"documentation":"<p>Attaches an object to a <a>Directory</a>.</p>"
},
"DetachObject":{
"shape":"BatchDetachObjectResponse",
"documentation":"<p>Detaches an object from a <a>Directory</a>.</p>"
},
"UpdateObjectAttributes":{
"shape":"BatchUpdateObjectAttributesResponse",
"documentation":"<p>Updates a given object’s attributes.</p>"
},
"DeleteObject":{
"shape":"BatchDeleteObjectResponse",
"documentation":"<p>Deletes an object in a <a>Directory</a>.</p>"
},
"AddFacetToObject":{
"shape":"BatchAddFacetToObjectResponse",
"documentation":"<p>Result of an add facet to object batch operation.</p>"
},
"RemoveFacetFromObject":{
"shape":"BatchRemoveFacetFromObjectResponse",
"documentation":"<p>Result of a batch remove facet from object operation.</p>"
}
},
"documentation":"<p>Represents the output of a BatchWrite response operation.</p>"
},
"BatchWriteOperationResponseList":{
"type":"list",
"member":{"shape":"BatchWriteOperationResponse"}
},
"BatchWriteRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"Operations"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Operations":{
"shape":"BatchWriteOperationList",
"documentation":"<p>List of operations that are part of the batch.</p>"
}
}
},
"BatchWriteResponse":{
"type":"structure",
"members":{
"Responses":{
"shape":"BatchWriteOperationResponseList",
"documentation":"<p>List of all the responses for each batch write.</p>"
}
}
},
"BinaryAttributeValue":{"type":"blob"},
"Bool":{"type":"boolean"},
"BooleanAttributeValue":{"type":"boolean"},
"CannotListParentOfRootException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Cannot list the parents of a <a>Directory</a> root.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ConsistencyLevel":{
"type":"string",
"enum":[
"SERIALIZABLE",
"EVENTUAL"
]
},
"CreateDirectoryRequest":{
"type":"structure",
"required":[
"Name",
"SchemaArn"
],
"members":{
"Name":{
"shape":"DirectoryName",
"documentation":"<p>Name of the <a>Directory</a>. Should be unique per account, per region.</p>"
},
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>ARN of the published schema that will be copied into the data <a>Directory</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"CreateDirectoryResponse":{
"type":"structure",
"required":[
"DirectoryArn",
"Name",
"ObjectIdentifier",
"AppliedSchemaArn"
],
"members":{
"DirectoryArn":{
"shape":"DirectoryArn",
"documentation":"<p>ARN associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>"
},
"Name":{
"shape":"DirectoryName",
"documentation":"<p>Name of the <a>Directory</a>.</p>"
},
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The root object node of the created directory.</p>"
},
"AppliedSchemaArn":{
"shape":"Arn",
"documentation":"<p>ARN of the published schema in the <a>Directory</a>. Once a published schema is copied into the directory, it has its own ARN which is referred to applied schema ARN. For more information, see <a>arns</a>.</p>"
}
}
},
"CreateFacetRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name",
"ObjectType"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>Schema ARN in which the new <a>Facet</a> will be created. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"FacetName",
"documentation":"<p>Name of the <a>Facet</a>, which is unique for a given schema.</p>"
},
"Attributes":{
"shape":"FacetAttributeList",
"documentation":"<p>Attributes associated with the <a>Facet</a>.e</p>"
},
"ObjectType":{
"shape":"ObjectType",
"documentation":"<p>Specifies whether a given object created from this facet is of type Node, Leaf Node, Policy or Index.</p> <ul> <li> <p>Node: Can have multiple children but one parent.</p> </li> </ul> <ul> <li> <p>Leaf Node: Cannot have children but can have multiple parents.</p> </li> </ul> <ul> <li> <p>Policy: Allows you to store a policy document and policy type. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p> </li> </ul> <ul> <li> <p>Index: Can be created with the Index API.</p> </li> </ul>"
}
}
},
"CreateFacetResponse":{
"type":"structure",
"members":{
}
},
"CreateIndexRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"OrderedIndexedAttributeList",
"IsUnique"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory where the index should be created.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"OrderedIndexedAttributeList":{
"shape":"AttributeKeyList",
"documentation":"<p>Specifies the Attributes that should be indexed on. Currently only a single attribute is supported.</p>"
},
"IsUnique":{
"shape":"Bool",
"documentation":"<p>Indicates whether objects with the same indexed attribute value can be added to the index.</p>"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the parent object that contains the index object.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link between the parent object and the index object.</p>"
}
}
},
"CreateIndexResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ObjectIdentifier of the index created by this operation.</p>"
}
}
},
"CreateObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"SchemaFacets"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> in which the object will be created. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"SchemaFacets":{
"shape":"SchemaFacetList",
"documentation":"<p>List of facet ARNs to be associated with the object. For more information, see <a>arns</a>.</p>"
},
"ObjectAttributeList":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>Attribute map whose attribute ARN contains the key and attribute value as the map value.</p>"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>If specified, the parent reference to which this object will be attached.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of link that is used to attach this object to a parent.</p>"
}
}
},
"CreateObjectResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>Identifier associated with the object.</p>"
}
}
},
"CreateSchemaRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"SchemaName",
"documentation":"<p>Name associated with the schema. This is unique to each account and in each region.</p>"
}
}
},
"CreateSchemaResponse":{
"type":"structure",
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the schema. For more information, see <a>arns</a>.</p>"
}
}
},
"Date":{"type":"timestamp"},
"DatetimeAttributeValue":{"type":"timestamp"},
"DeleteDirectoryRequest":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory to delete.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"DeleteDirectoryResponse":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the deleted directory.</p>"
}
}
},
"DeleteFacetRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"FacetName",
"documentation":"<p>The name of the facet to delete.</p>"
}
}
},
"DeleteFacetResponse":{
"type":"structure",
"members":{
}
},
"DeleteObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object.</p>"
}
}
},
"DeleteObjectResponse":{
"type":"structure",
"members":{
}
},
"DeleteSchemaRequest":{
"type":"structure",
"required":["SchemaArn"],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>ARN of the development schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"DeleteSchemaResponse":{
"type":"structure",
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>Input ARN that is returned as part of the response. For more information, see <a>arns</a>.</p>"
}
}
},
"DetachFromIndexRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"IndexReference",
"TargetReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory the index and object exist in.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the index object.</p>"
},
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object being detached from the index.</p>"
}
}
},
"DetachFromIndexResponse":{
"type":"structure",
"members":{
"DetachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ObjectIdentifier of the object that was detached from the index.</p>"
}
}
},
"DetachObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ParentReference",
"LinkName"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>Parent reference from which the object with the specified link name is detached.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>Link name associated with the object that needs to be detached.</p>"
}
}
},
"DetachObjectResponse":{
"type":"structure",
"members":{
"DetachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ObjectIdentifier that was detached from the object.</p>"
}
}
},
"DetachPolicyRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"PolicyReference",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"PolicyReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the policy object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose policy object will be detached.</p>"
}
}
},
"DetachPolicyResponse":{
"type":"structure",
"members":{
}
},
"Directory":{
"type":"structure",
"members":{
"Name":{
"shape":"DirectoryName",
"documentation":"<p>The name of the directory.</p>"
},
"DirectoryArn":{
"shape":"DirectoryArn",
"documentation":"<p>ARN associated with the directory. For more information, see <a>arns</a>.</p>"
},
"State":{
"shape":"DirectoryState",
"documentation":"<p>The state of the directory. Can be either Enabled, Disabled, or Deleted.</p>"
},
"CreationDateTime":{
"shape":"Date",
"documentation":"<p>The date and time when the directory was created.</p>"
}
},
"documentation":"<p>Directory structure that includes the directory name and directory ARN.</p>"
},
"DirectoryAlreadyExistsException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that a <a>Directory</a> could not be created due to a naming conflict. Choose a different name and try again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"DirectoryArn":{"type":"string"},
"DirectoryDeletedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>A directory that has been deleted has been attempted to be accessed. Note: The requested resource will eventually cease to exist.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"DirectoryList":{
"type":"list",
"member":{"shape":"Directory"}
},
"DirectoryName":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
},
"DirectoryNotDisabledException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>An operation can only operate on a disabled directory.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"DirectoryNotEnabledException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>An operation can only operate on a directory that is not enabled.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"DirectoryState":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED",
"DELETED"
]
},
"DisableDirectoryRequest":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory to disable.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"DisableDirectoryResponse":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory that has been disabled.</p>"
}
}
},
"EnableDirectoryRequest":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory to enable.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"EnableDirectoryResponse":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the enabled directory.</p>"
}
}
},
"ExceptionMessage":{"type":"string"},
"Facet":{
"type":"structure",
"members":{
"Name":{
"shape":"FacetName",
"documentation":"<p>The name of the <a>Facet</a>.</p>"
},
"ObjectType":{
"shape":"ObjectType",
"documentation":"<p>Object type associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>"
}
},
"documentation":"<p>A structure that contains Name, ARN, Attributes, <a>Rule</a>s, and ObjectTypes.</p>"
},
"FacetAlreadyExistsException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>A facet with the same name already exists.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"FacetAttribute":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"AttributeName",
"documentation":"<p>The name of the facet attribute.</p>"
},
"AttributeDefinition":{
"shape":"FacetAttributeDefinition",
"documentation":"<p>A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
},
"AttributeReference":{
"shape":"FacetAttributeReference",
"documentation":"<p>Attribute reference associated with the attribute. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
},
"RequiredBehavior":{
"shape":"RequiredAttributeBehavior",
"documentation":"<p>The required behavior of the FacetAttribute.</p>"
}
},
"documentation":"<p>Attribute associated with the <a>Facet</a>.</p>"
},
"FacetAttributeDefinition":{
"type":"structure",
"required":["Type"],
"members":{
"Type":{
"shape":"FacetAttributeType",
"documentation":"<p>The type of the attribute.</p>"
},
"DefaultValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The default value of the attribute (if configured).</p>"
},
"IsImmutable":{
"shape":"Bool",
"documentation":"<p>Whether the attribute is mutable or not.</p>"
},
"Rules":{
"shape":"RuleMap",
"documentation":"<p>Validation rules attached to the attribute definition.</p>"
}
},
"documentation":"<p>A facet attribute definition. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
},
"FacetAttributeList":{
"type":"list",
"member":{"shape":"FacetAttribute"}
},
"FacetAttributeReference":{
"type":"structure",
"required":[
"TargetFacetName",
"TargetAttributeName"
],
"members":{
"TargetFacetName":{
"shape":"FacetName",
"documentation":"<p>Target facet name associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
},
"TargetAttributeName":{
"shape":"AttributeName",
"documentation":"<p>Target attribute name associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
}
},
"documentation":"<p>Facet attribute reference that specifies the attribute definition which contains attribute facet name and attribute name.</p>"
},
"FacetAttributeType":{
"type":"string",
"enum":[
"STRING",
"BINARY",
"BOOLEAN",
"NUMBER",
"DATETIME"
]
},
"FacetAttributeUpdate":{
"type":"structure",
"members":{
"Attribute":{
"shape":"FacetAttribute",
"documentation":"<p>The attribute to update.</p>"
},
"Action":{
"shape":"UpdateActionType",
"documentation":"<p>The action to perform when updating the attribute.</p>"
}
},
"documentation":"<p>A structure that contains information used to update an attribute.</p>"
},
"FacetAttributeUpdateList":{
"type":"list",
"member":{"shape":"FacetAttributeUpdate"}
},
"FacetInUseException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Occurs when deleting a facet that contains an attribute which is a target to an attribute reference in a different facet.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"FacetName":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
},
"FacetNameList":{
"type":"list",
"member":{"shape":"FacetName"}
},
"FacetNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified <a>Facet</a> could not be found.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"FacetValidationException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The <a>Facet</a> you provided was not well formed or could not be validated with the schema.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"GetDirectoryRequest":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"DirectoryArn",
"documentation":"<p>The ARN of the directory.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"GetDirectoryResponse":{
"type":"structure",
"required":["Directory"],
"members":{
"Directory":{
"shape":"Directory",
"documentation":"<p>Metadata about the directory.</p>"
}
}
},
"GetFacetRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"FacetName",
"documentation":"<p>The name of the facet to retrieve.</p>"
}
}
},
"GetFacetResponse":{
"type":"structure",
"members":{
"Facet":{
"shape":"Facet",
"documentation":"<p> <a>Facet</a> structure associated with the facet.</p>"
}
}
},
"GetObjectInformationRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory being retrieved.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level at which to retrieve the object information.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"GetObjectInformationResponse":{
"type":"structure",
"members":{
"SchemaFacets":{
"shape":"SchemaFacetList",
"documentation":"<p>The facets attached to the specified object.</p>"
},
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ObjectIdentifier of the specified object.</p>"
}
}
},
"GetSchemaAsJsonRequest":{
"type":"structure",
"required":["SchemaArn"],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the schema to retrieve.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"GetSchemaAsJsonResponse":{
"type":"structure",
"members":{
"Name":{
"shape":"SchemaName",
"documentation":"<p>The name of the retrieved schema.</p>"
},
"Document":{
"shape":"SchemaJsonDocument",
"documentation":"<p>The JSON representation of the schema document.</p>"
}
}
},
"IndexAttachment":{
"type":"structure",
"members":{
"IndexedAttributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The indexed attribute values.</p>"
},
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ObjectIdentifier of the object attached to the index.</p>"
}
},
"documentation":"<p>Represents an index and an attached object.</p>"
},
"IndexAttachmentList":{
"type":"list",
"member":{"shape":"IndexAttachment"}
},
"IndexedAttributeMissingException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>An object has been attempted to be attached to an object that does not have the appropriate attribute value.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InternalServiceException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>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 <a href=\"http://status.aws.amazon.com/\">AWS Service Health Dashboard</a> site to see if there are any operational issues with the service.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
"InvalidArnException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the provided ARN value is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidAttachmentException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that an attempt to attach an object with the same link name or to apply a schema with same name has occurred. Rename the link or the schema and then try again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidFacetUpdateException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>An attempt to modify a <a>Facet</a> resulted in an invalid schema exception.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the NextToken value is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidRuleException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Occurs when any of the rule parameter keys or values are invalid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidSchemaDocException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the provided SchemaDoc value is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidTaggingRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates limits are exceeded. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html\">Limits</a> for more information.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"LinkName":{
"type":"string",
"max":64
},
"LinkNameAlreadyInUseException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"LinkNameToObjectIdentifierMap":{
"type":"map",
"key":{"shape":"LinkName"},
"value":{"shape":"ObjectIdentifier"}
},
"ListAppliedSchemaArnsRequest":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory you are listing.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListAppliedSchemaArnsResponse":{
"type":"structure",
"members":{
"SchemaArns":{
"shape":"Arns",
"documentation":"<p>The ARNs of schemas that are applied to the directory.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListAttachedIndicesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"TargetReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object to that has indices attached.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level to use for this operation.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListAttachedIndicesResponse":{
"type":"structure",
"members":{
"IndexAttachments":{
"shape":"IndexAttachmentList",
"documentation":"<p>The indices attached to the specified object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListDevelopmentSchemaArnsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListDevelopmentSchemaArnsResponse":{
"type":"structure",
"members":{
"SchemaArns":{
"shape":"Arns",
"documentation":"<p>The ARNs of retrieved development schemas.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListDirectoriesRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
},
"state":{
"shape":"DirectoryState",
"documentation":"<p>The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.</p>"
}
}
},
"ListDirectoriesResponse":{
"type":"structure",
"required":["Directories"],
"members":{
"Directories":{
"shape":"DirectoryList",
"documentation":"<p>Lists all directories associated with your account in pagination fashion.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListFacetAttributesRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the schema where the facet resides.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"FacetName",
"documentation":"<p>The name of the facet whose attributes will be retrieved.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListFacetAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"FacetAttributeList",
"documentation":"<p>The attributes attached to the facet.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListFacetNamesRequest":{
"type":"structure",
"required":["SchemaArn"],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN to retrieve facet names from.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve</p>"
}
}
},
"ListFacetNamesResponse":{
"type":"structure",
"members":{
"FacetNames":{
"shape":"FacetNameList",
"documentation":"<p>The names of facets that exist within the schema.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListIndexRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"IndexReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory that the index exists in.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"RangesOnIndexedValues":{
"shape":"ObjectAttributeRangeList",
"documentation":"<p>Specifies the ranges of indexed values that you want to query.</p>"
},
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference to the index to list.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve from the index.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level to execute the request at.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListIndexResponse":{
"type":"structure",
"members":{
"IndexAttachments":{
"shape":"IndexAttachmentList",
"documentation":"<p>The objects and indexed values attached to the index.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListObjectAttributesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose attributes will be listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListObjectAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>Attributes map associated with the object. AttributeArn is the key, and attribute value is the value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
}
}
},
"ListObjectChildrenRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object for which child objects are being listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListObjectChildrenResponse":{
"type":"structure",
"members":{
"Children":{
"shape":"LinkNameToObjectIdentifierMap",
"documentation":"<p>Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
}
}
},
"ListObjectParentsRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object for which parent objects are being listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListObjectParentsResponse":{
"type":"structure",
"members":{
"Parents":{
"shape":"ObjectIdentifierToLinkNameMap",
"documentation":"<p>Parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
}
}
},
"ListObjectPoliciesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object for which policies will be listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListObjectPoliciesResponse":{
"type":"structure",
"members":{
"AttachedPolicyIds":{
"shape":"ObjectIdentifierList",
"documentation":"<p>List of policy ObjectIdentifiers, that are attached to the object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
}
}
},
"ListPolicyAttachmentsRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"PolicyReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"PolicyReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the policy object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListPolicyAttachmentsResponse":{
"type":"structure",
"members":{
"ObjectIdentifiers":{
"shape":"ObjectIdentifierList",
"documentation":"<p>List of ObjectIdentifiers to which the policy is attached.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
}
}
},
"ListPublishedSchemaArnsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListPublishedSchemaArnsResponse":{
"type":"structure",
"members":{
"SchemaArns":{
"shape":"Arns",
"documentation":"<p>The ARNs of published schemas.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>ARN of the resource. Tagging is only supported for directories.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Next token used for pagination. This is for future use. Currently pagination is not supported for tagging.</p>"
},
"MaxResults":{
"shape":"TagsNumberResults",
"documentation":"<p>The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.</p>"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>List of tag key value pairs associated with the response.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return.</p>"
}
}
},
"LookupPolicyRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose policies will be looked up.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token to request the next page of results.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
}
}
},
"LookupPolicyResponse":{
"type":"structure",
"members":{
"PolicyToPathList":{
"shape":"PolicyToPathList",
"documentation":"<p>Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Token used for pagination.</p>"
}
}
},
"NextToken":{"type":"string"},
"NotIndexException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates the requested operation can only operate on index objects.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"NotNodeException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Occurs when any invalid operations are performed on an object which is not a node, such as calling ListObjectChildren for a leaf node object.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"NotPolicyException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates the requested operation can only operate on policy objects.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"NumberAttributeValue":{"type":"string"},
"NumberResults":{
"type":"integer",
"min":0
},
"ObjectAlreadyDetachedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates the object is not attached to the index.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ObjectAttributeAction":{
"type":"structure",
"members":{
"ObjectAttributeActionType":{
"shape":"UpdateActionType",
"documentation":"<p>Type can be either Update or Delete.</p>"
},
"ObjectAttributeUpdateValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The value that you want to update to.</p>"
}
},
"documentation":"<p>The action to take on the object attribute.</p>"
},
"ObjectAttributeRange":{
"type":"structure",
"members":{
"AttributeKey":{
"shape":"AttributeKey",
"documentation":"<p>The key of the attribute the attribute range covers.</p>"
},
"Range":{
"shape":"TypedAttributeValueRange",
"documentation":"<p>The range of attribute values being selected.</p>"
}
},
"documentation":"<p>A range of attributes.</p>"
},
"ObjectAttributeRangeList":{
"type":"list",
"member":{"shape":"ObjectAttributeRange"}
},
"ObjectAttributeUpdate":{
"type":"structure",
"members":{
"ObjectAttributeKey":{
"shape":"AttributeKey",
"documentation":"<p>The key of the attribute being updated.</p>"
},
"ObjectAttributeAction":{
"shape":"ObjectAttributeAction",
"documentation":"<p>The action to perform as part of the attribute update.</p>"
}
},
"documentation":"<p>Structure that contains attribute update information.</p>"
},
"ObjectAttributeUpdateList":{
"type":"list",
"member":{"shape":"ObjectAttributeUpdate"}
},
"ObjectIdentifier":{"type":"string"},
"ObjectIdentifierList":{
"type":"list",
"member":{"shape":"ObjectIdentifier"}
},
"ObjectIdentifierToLinkNameMap":{
"type":"map",
"key":{"shape":"ObjectIdentifier"},
"value":{"shape":"LinkName"}
},
"ObjectNotDetachedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates the requested operation cannot be completed because the object has not been detached from the tree.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ObjectReference":{
"type":"structure",
"members":{
"Selector":{
"shape":"SelectorObjectReference",
"documentation":"<p>Allows you to specify an object. You can identify an object in one of the following ways:</p> <ul> <li> <p> <i>$ObjectIdentifier</i> - Identifies the object by ObjectIdentifier</p> </li> <li> <p> <i>/some/path</i> - Identifies the object based on path</p> </li> <li> <p> <i>#SomeBatchReference</i> - Identifies the object in a batch call</p> </li> </ul>"
}
},
"documentation":"<p>Reference that identifies an object.</p>"
},
"ObjectType":{
"type":"string",
"enum":[
"NODE",
"LEAF_NODE",
"POLICY",
"INDEX"
]
},
"PathString":{"type":"string"},
"PolicyAttachment":{
"type":"structure",
"members":{
"PolicyId":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ID of PolicyAttachment.</p>"
},
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ObjectIdentifier associated with PolicyAttachment.</p>"
},
"PolicyType":{
"shape":"PolicyType",
"documentation":"<p>The type of policy that can be associated with PolicyAttachment.</p>"
}
},
"documentation":"<p>Contains the PolicyType, PolicyId, and the ObjectIdentifier to which it is attached.</p>"
},
"PolicyAttachmentList":{
"type":"list",
"member":{"shape":"PolicyAttachment"}
},
"PolicyToPath":{
"type":"structure",
"members":{
"Path":{
"shape":"PathString",
"documentation":"<p>The path that is referenced from the root.</p>"
},
"Policies":{
"shape":"PolicyAttachmentList",
"documentation":"<p>List of policy objects.</p>"
}
},
"documentation":"<p>Used when a regular object exists in a <a>Directory</a> and you want to find all of the policies associated with that object and the parent to that object.</p>"
},
"PolicyToPathList":{
"type":"list",
"member":{"shape":"PolicyToPath"}
},
"PolicyType":{"type":"string"},
"PublishSchemaRequest":{
"type":"structure",
"required":[
"DevelopmentSchemaArn",
"Version"
],
"members":{
"DevelopmentSchemaArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the development schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Version":{
"shape":"Version",
"documentation":"<p>Version under which the schema will be published.</p>"
},
"Name":{
"shape":"SchemaName",
"documentation":"<p>New name under which the schema will be published. If this is not provided, the development schema is considered.</p>"
}
}
},
"PublishSchemaResponse":{
"type":"structure",
"members":{
"PublishedSchemaArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the published schema. For more information, see <a>arns</a>.</p>"
}
}
},
"PutSchemaFromJsonRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Document"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the schema to update.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Document":{
"shape":"SchemaJsonDocument",
"documentation":"<p>The replacement JSON schema.</p>"
}
}
},
"PutSchemaFromJsonResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN of the schema to update.</p>"
}
}
},
"RangeMode":{
"type":"string",
"enum":[
"FIRST",
"LAST",
"LAST_BEFORE_MISSING_VALUES",
"INCLUSIVE",
"EXCLUSIVE"
]
},
"RemoveFacetFromObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"SchemaFacet",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory in which the object resides.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"SchemaFacet":{
"shape":"SchemaFacet",
"documentation":"<p>The facet to remove.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object to remove the facet from.</p>"
}
}
},
"RemoveFacetFromObjectResponse":{
"type":"structure",
"members":{
}
},
"RequiredAttributeBehavior":{
"type":"string",
"enum":[
"REQUIRED_ALWAYS",
"NOT_REQUIRED"
]
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified resource could not be found.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"RetryableConflictException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>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.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"Rule":{
"type":"structure",
"members":{
"Type":{
"shape":"RuleType",
"documentation":"<p>The type of attribute validation rule.</p>"
},
"Parameters":{
"shape":"RuleParameterMap",
"documentation":"<p>Min and max parameters associated with the rule.</p>"
}
},
"documentation":"<p>Contains an ARN and parameters associated with the rule.</p>"
},
"RuleKey":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
},
"RuleMap":{
"type":"map",
"key":{"shape":"RuleKey"},
"value":{"shape":"Rule"}
},
"RuleParameterKey":{"type":"string"},
"RuleParameterMap":{
"type":"map",
"key":{"shape":"RuleParameterKey"},
"value":{"shape":"RuleParameterValue"}
},
"RuleParameterValue":{"type":"string"},
"RuleType":{
"type":"string",
"enum":[
"BINARY_LENGTH",
"NUMBER_COMPARISON",
"STRING_FROM_SET",
"STRING_LENGTH"
]
},
"SchemaAlreadyExistsException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"SchemaAlreadyPublishedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates a schema is already published.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"SchemaFacet":{
"type":"structure",
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the schema that contains the facet.</p>"
},
"FacetName":{
"shape":"FacetName",
"documentation":"<p>The name of the facet.</p>"
}
},
"documentation":"<p>A facet.</p>"
},
"SchemaFacetList":{
"type":"list",
"member":{"shape":"SchemaFacet"}
},
"SchemaJsonDocument":{"type":"string"},
"SchemaName":{
"type":"string",
"max":50,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
},
"SelectorObjectReference":{"type":"string"},
"StillContainsLinksException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The object could not be deleted because links still exist. Remove the links and then try the operation again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"StringAttributeValue":{"type":"string"},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>Key associated with the tag.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>Value associated with the tag.</p>"
}
},
"documentation":"<p>Tag structure which contains tag key and value.</p>"
},
"TagKey":{"type":"string"},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"}
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"}
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>ARN of the resource. Tagging is only supported for directories.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>List of tag key value pairs.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{"type":"string"},
"TagsNumberResults":{
"type":"integer",
"min":50
},
"TypedAttributeValue":{
"type":"structure",
"members":{
"StringValue":{
"shape":"StringAttributeValue",
"documentation":"<p>A string data value.</p>"
},
"BinaryValue":{
"shape":"BinaryAttributeValue",
"documentation":"<p>A binary data value.</p>"
},
"BooleanValue":{
"shape":"BooleanAttributeValue",
"documentation":"<p>A Boolean data value.</p>"
},
"NumberValue":{
"shape":"NumberAttributeValue",
"documentation":"<p>A number data value.</p>"
},
"DatetimeValue":{
"shape":"DatetimeAttributeValue",
"documentation":"<p>A date and time value.</p>"
}
},
"documentation":"<p>Represents the data for a typed attribute. You can set one, and only one, of the elements. Each attribute in an item is a name-value pair. Attributes have a single value.</p>"
},
"TypedAttributeValueRange":{
"type":"structure",
"required":[
"StartMode",
"EndMode"
],
"members":{
"StartMode":{
"shape":"RangeMode",
"documentation":"<p>Inclusive or exclusive range start.</p>"
},
"StartValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The value to start the range at.</p>"
},
"EndMode":{
"shape":"RangeMode",
"documentation":"<p>Inclusive or exclusive range end.</p>"
},
"EndValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The attribute value to terminate the range at.</p>"
}
},
"documentation":"<p>A range of attribute values.</p>"
},
"UnsupportedIndexTypeException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates the requested index type is not supported.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>ARN of the resource. Tagging is only supported for directories.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>Keys of the tag that needs to be removed from the resource.</p>"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateActionType":{
"type":"string",
"enum":[
"CREATE_OR_UPDATE",
"DELETE"
]
},
"UpdateFacetRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"FacetName",
"documentation":"<p> </p>"
},
"AttributeUpdates":{
"shape":"FacetAttributeUpdateList",
"documentation":"<p>List of attributes that need to be updated in a given schema <a>Facet</a>. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform. </p>"
},
"ObjectType":{
"shape":"ObjectType",
"documentation":"<p>Object type associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>"
}
}
},
"UpdateFacetResponse":{
"type":"structure",
"members":{
}
},
"UpdateObjectAttributesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference",
"AttributeUpdates"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object.</p>"
},
"AttributeUpdates":{
"shape":"ObjectAttributeUpdateList",
"documentation":"<p>Attributes update structure.</p>"
}
}
},
"UpdateObjectAttributesResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>ObjectIdentifier of the updated object.</p>"
}
}
},
"UpdateSchemaRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>ARN of the development schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"SchemaName",
"documentation":"<p>Name of the schema.</p>"
}
}
},
"UpdateSchemaResponse":{
"type":"structure",
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>ARN associated with the updated schema. For more information, see <a>arns</a>.</p>"
}
}
},
"ValidationException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates your request is malformed in some manner. See the exception message.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"Version":{
"type":"string",
"max":10,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
}
},
"documentation":"<fullname>Amazon Cloud Directory</fullname> <p>Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile and IoT applications. This guide describes the Cloud Directory operations that you can call programatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see <a href=\"https://aws.amazon.com/directoryservice/\">AWS Directory Service</a> and the <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html\">AWS Directory Service Administration Guide</a>.</p>"
}
Reference in a new issue View git blame Copy permalink