{ "version":"2.0", "metadata":{ "apiVersion":"2016-05-10", "endpointPrefix":"clouddirectory", "protocol":"rest-json", "serviceFullName":"Amazon CloudDirectory", "serviceId":"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":"

Adds a new Facet to an object. An object can have more than one facet applied on it.

" }, "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":"

Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.

" }, "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"}, {"shape":"FacetValidationException"} ], "documentation":"

Attaches an existing object to another object. An object can be accessed in two ways:

  1. Using the path

  2. Using ObjectIdentifier

" }, "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":"ResourceNotFoundException"}, {"shape":"NotPolicyException"} ], "documentation":"

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

" }, "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":"InvalidAttachmentException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LinkNameAlreadyInUseException"}, {"shape":"IndexedAttributeMissingException"}, {"shape":"NotIndexException"} ], "documentation":"

Attaches the specified object to the specified index.

" }, "AttachTypedLink":{ "name":"AttachTypedLink", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attach", "responseCode":200 }, "input":{"shape":"AttachTypedLinkRequest"}, "output":{"shape":"AttachTypedLinkResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidAttachmentException"}, {"shape":"ValidationException"}, {"shape":"FacetValidationException"} ], "documentation":"

Attaches a typed link to a specified source and target object. For more information, see Typed link.

" }, "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":"

Performs all the read operations in a batch.

" }, "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":"

Performs all the write operations in a batch. Either all the operations succeed or none.

" }, "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":"ResourceNotFoundException"} ], "documentation":"

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

" }, "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"}, {"shape":"FacetValidationException"} ], "documentation":"

Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

" }, "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":"

Creates an index object. See Indexing for more information.

" }, "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":"ResourceNotFoundException"}, {"shape":"FacetValidationException"}, {"shape":"LinkNameAlreadyInUseException"}, {"shape":"UnsupportedIndexTypeException"} ], "documentation":"

Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet 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.

" }, "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":"

Creates a new schema in a development state. A schema can exist in three phases:

" }, "CreateTypedLinkFacet":{ "name":"CreateTypedLinkFacet", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/create", "responseCode":200 }, "input":{"shape":"CreateTypedLinkFacetRequest"}, "output":{"shape":"CreateTypedLinkFacetResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetAlreadyExistsException"}, {"shape":"InvalidRuleException"}, {"shape":"FacetValidationException"} ], "documentation":"

Creates a TypedLinkFacet. For more information, see Typed link.

" }, "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"}, {"shape":"RetryableConflictException"}, {"shape":"InvalidArnException"} ], "documentation":"

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

" }, "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":"

Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.

" }, "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":"

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.

" }, "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":"

Deletes a given schema. Schemas in a development and published state can only be deleted.

" }, "DeleteTypedLinkFacet":{ "name":"DeleteTypedLinkFacet", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/delete", "responseCode":200 }, "input":{"shape":"DeleteTypedLinkFacetRequest"}, "output":{"shape":"DeleteTypedLinkFacetResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetNotFoundException"} ], "documentation":"

Deletes a TypedLinkFacet. For more information, see Typed link.

" }, "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":"

Detaches the specified object from the specified index.

" }, "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"}, {"shape":"NotNodeException"} ], "documentation":"

Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.

" }, "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":"ResourceNotFoundException"}, {"shape":"NotPolicyException"} ], "documentation":"

Detaches a policy from an object.

" }, "DetachTypedLink":{ "name":"DetachTypedLink", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/detach", "responseCode":200 }, "input":{"shape":"DetachTypedLinkRequest"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetValidationException"} ], "documentation":"

Detaches a typed link from a specified source and target object. For more information, see Typed link.

" }, "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"}, {"shape":"RetryableConflictException"}, {"shape":"InvalidArnException"} ], "documentation":"

Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

" }, "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"}, {"shape":"RetryableConflictException"}, {"shape":"InvalidArnException"} ], "documentation":"

Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

" }, "GetAppliedSchemaVersion":{ "name":"GetAppliedSchemaVersion", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/schema/getappliedschema", "responseCode":200 }, "input":{"shape":"GetAppliedSchemaVersionRequest"}, "output":{"shape":"GetAppliedSchemaVersionResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns current applied schema version ARN, including the minor version in use.

" }, "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":"

Retrieves metadata about a directory.

" }, "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":"

Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.

" }, "GetLinkAttributes":{ "name":"GetLinkAttributes", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/get", "responseCode":200 }, "input":{"shape":"GetLinkAttributesRequest"}, "output":{"shape":"GetLinkAttributesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetValidationException"} ], "documentation":"

Retrieves attributes that are associated with a typed link.

" }, "GetObjectAttributes":{ "name":"GetObjectAttributes", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/object/attributes/get", "responseCode":200 }, "input":{"shape":"GetObjectAttributesRequest"}, "output":{"shape":"GetObjectAttributesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetValidationException"} ], "documentation":"

Retrieves attributes within a facet that are associated with an object.

" }, "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":"

Retrieves metadata about an object.

" }, "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":"

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

" }, "GetTypedLinkFacetInformation":{ "name":"GetTypedLinkFacetInformation", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/get", "responseCode":200 }, "input":{"shape":"GetTypedLinkFacetInformationRequest"}, "output":{"shape":"GetTypedLinkFacetInformationResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"}, {"shape":"FacetNotFoundException"} ], "documentation":"

Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed link.

" }, "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":"

Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

" }, "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":"

Lists indices attached to the specified object.

" }, "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":"

Retrieves each Amazon Resource Name (ARN) of schemas in the development state.

" }, "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":"

Lists directories created within an account.

" }, "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":"

Retrieves attributes attached to the facet.

" }, "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":"

Retrieves the names of facets that exist in a schema.

" }, "ListIncomingTypedLinks":{ "name":"ListIncomingTypedLinks", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/incoming", "responseCode":200 }, "input":{"shape":"ListIncomingTypedLinksRequest"}, "output":{"shape":"ListIncomingTypedLinksResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"}, {"shape":"FacetValidationException"} ], "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" }, "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":"FacetValidationException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotIndexException"} ], "documentation":"

Lists objects attached to the specified index.

" }, "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":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"}, {"shape":"FacetValidationException"} ], "documentation":"

Lists all attributes that are associated with an object.

" }, "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":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"}, {"shape":"NotNodeException"} ], "documentation":"

Returns a paginated list of child objects that are associated with a given object.

" }, "ListObjectParentPaths":{ "name":"ListObjectParentPaths", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/object/parentpaths", "responseCode":200 }, "input":{"shape":"ListObjectParentPathsRequest"}, "output":{"shape":"ListObjectParentPathsResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.

" }, "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":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"}, {"shape":"CannotListParentOfRootException"} ], "documentation":"

Lists parent objects that are associated with a given object in pagination fashion.

" }, "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":"

Returns policies attached to an object in pagination fashion.

" }, "ListOutgoingTypedLinks":{ "name":"ListOutgoingTypedLinks", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/outgoing", "responseCode":200 }, "input":{"shape":"ListOutgoingTypedLinksRequest"}, "output":{"shape":"ListOutgoingTypedLinksResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"}, {"shape":"FacetValidationException"} ], "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" }, "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":"InvalidNextTokenException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotPolicyException"} ], "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached.

" }, "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":"

Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

" }, "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":"

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.

" }, "ListTypedLinkFacetAttributes":{ "name":"ListTypedLinkFacetAttributes", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/attributes", "responseCode":200 }, "input":{"shape":"ListTypedLinkFacetAttributesRequest"}, "output":{"shape":"ListTypedLinkFacetAttributesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetNotFoundException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed link.

" }, "ListTypedLinkFacetNames":{ "name":"ListTypedLinkFacetNames", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/list", "responseCode":200 }, "input":{"shape":"ListTypedLinkFacetNamesRequest"}, "output":{"shape":"ListTypedLinkFacetNamesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed link.

" }, "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":"InvalidNextTokenException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists all policies from the root of the Directory 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. For more information, see Policies.

" }, "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":"

Publishes a development schema with a major version and a recommended minor version.

" }, "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":"

Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.

" }, "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":"

Removes the specified facet from the specified object.

" }, "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":"

An API operation for adding tags to a resource.

" }, "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":"

An API operation for removing tags from a resource.

" }, "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":"

Does the following:

  1. Adds new Attributes, Rules, or ObjectTypes.

  2. Updates existing Attributes, Rules, or ObjectTypes.

  3. Deletes existing Attributes, Rules, or ObjectTypes.

" }, "UpdateLinkAttributes":{ "name":"UpdateLinkAttributes", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/update", "responseCode":200 }, "input":{"shape":"UpdateLinkAttributesRequest"}, "output":{"shape":"UpdateLinkAttributesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetValidationException"} ], "documentation":"

Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder.

" }, "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":"LinkNameAlreadyInUseException"}, {"shape":"FacetValidationException"} ], "documentation":"

Updates a given object's attributes.

" }, "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":"

Updates the schema name with a new name. Only development schema names can be updated.

" }, "UpdateTypedLinkFacet":{ "name":"UpdateTypedLinkFacet", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet", "responseCode":200 }, "input":{"shape":"UpdateTypedLinkFacetRequest"}, "output":{"shape":"UpdateTypedLinkFacetResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"FacetValidationException"}, {"shape":"InvalidFacetUpdateException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetNotFoundException"}, {"shape":"InvalidRuleException"} ], "documentation":"

Updates a TypedLinkFacet. For more information, see Typed link.

" }, "UpgradeAppliedSchema":{ "name":"UpgradeAppliedSchema", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradeapplied", "responseCode":200 }, "input":{"shape":"UpgradeAppliedSchemaRequest"}, "output":{"shape":"UpgradeAppliedSchemaResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"IncompatibleSchemaException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidAttachmentException"} ], "documentation":"

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.

" }, "UpgradePublishedSchema":{ "name":"UpgradePublishedSchema", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradepublished", "responseCode":200 }, "input":{"shape":"UpgradePublishedSchemaRequest"}, "output":{"shape":"UpgradePublishedSchemaResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"IncompatibleSchemaException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidAttachmentException"}, {"shape":"LimitExceededException"} ], "documentation":"

Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Access denied. Check your permissions.

", "error":{"httpStatusCode":403}, "exception":true }, "AddFacetToObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "SchemaFacet", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "SchemaFacet":{ "shape":"SchemaFacet", "documentation":"

Identifiers for the facet that you are adding to the object. See SchemaFacet for details.

" }, "ObjectAttributeList":{ "shape":"AttributeKeyAndValueList", "documentation":"

Attributes on the facet that you are adding to the object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object you are adding the specified facet to.

" } } }, "AddFacetToObjectResponse":{ "type":"structure", "members":{ } }, "ApplySchemaRequest":{ "type":"structure", "required":[ "PublishedSchemaArn", "DirectoryArn" ], "members":{ "PublishedSchemaArn":{ "shape":"Arn", "documentation":"

Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see arns.

" }, "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory into which the schema is copied. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "ApplySchemaResponse":{ "type":"structure", "members":{ "AppliedSchemaArn":{ "shape":"Arn", "documentation":"

The applied schema ARN that is associated with the copied schema in the Directory. You can use this ARN to describe the schema information applied on this directory. For more information, see arns.

" }, "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN that is associated with the Directory. For more information, see arns.

" } } }, "Arn":{"type":"string"}, "Arns":{ "type":"list", "member":{"shape":"Arn"} }, "AttachObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "ParentReference", "ChildReference", "LinkName" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ParentReference":{ "shape":"ObjectReference", "documentation":"

The parent object reference.

" }, "ChildReference":{ "shape":"ObjectReference", "documentation":"

The child object reference to be attached to the object.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The link name with which the child object is attached to the parent.

" } } }, "AttachObjectResponse":{ "type":"structure", "members":{ "AttachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The attached ObjectIdentifier, which is the child ObjectIdentifier.

" } } }, "AttachPolicyRequest":{ "type":"structure", "required":[ "DirectoryArn", "PolicyReference", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "PolicyReference":{ "shape":"ObjectReference", "documentation":"

The reference that is associated with the policy object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object to which the policy will be attached.

" } } }, "AttachPolicyResponse":{ "type":"structure", "members":{ } }, "AttachToIndexRequest":{ "type":"structure", "required":[ "DirectoryArn", "IndexReference", "TargetReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the directory where the object and index exist.

", "location":"header", "locationName":"x-amz-data-partition" }, "IndexReference":{ "shape":"ObjectReference", "documentation":"

A reference to the index that you are attaching the object to.

" }, "TargetReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object that you are attaching to the index.

" } } }, "AttachToIndexResponse":{ "type":"structure", "members":{ "AttachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the object that was attached to the index.

" } } }, "AttachTypedLinkRequest":{ "type":"structure", "required":[ "DirectoryArn", "SourceObjectReference", "TargetObjectReference", "TypedLinkFacet", "Attributes" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.

", "location":"header", "locationName":"x-amz-data-partition" }, "SourceObjectReference":{ "shape":"ObjectReference", "documentation":"

Identifies the source object that the typed link will attach to.

" }, "TargetObjectReference":{ "shape":"ObjectReference", "documentation":"

Identifies the target object that the typed link will attach to.

" }, "TypedLinkFacet":{ "shape":"TypedLinkSchemaAndFacetName", "documentation":"

Identifies the typed link facet that is associated with the typed link.

" }, "Attributes":{ "shape":"AttributeNameAndValueList", "documentation":"

A set of attributes that are associated with the typed link.

" } } }, "AttachTypedLinkResponse":{ "type":"structure", "members":{ "TypedLinkSpecifier":{ "shape":"TypedLinkSpecifier", "documentation":"

Returns a typed link specifier as output.

" } } }, "AttributeKey":{ "type":"structure", "required":[ "SchemaArn", "FacetName", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

" }, "FacetName":{ "shape":"FacetName", "documentation":"

The name of the facet that the attribute exists within.

" }, "Name":{ "shape":"AttributeName", "documentation":"

The name of the attribute.

" } }, "documentation":"

A unique identifier for an attribute.

" }, "AttributeKeyAndValue":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"AttributeKey", "documentation":"

The key of the attribute.

" }, "Value":{ "shape":"TypedAttributeValue", "documentation":"

The value of the attribute.

" } }, "documentation":"

The combination of an attribute key and an attribute value.

" }, "AttributeKeyAndValueList":{ "type":"list", "member":{"shape":"AttributeKeyAndValue"} }, "AttributeKeyList":{ "type":"list", "member":{"shape":"AttributeKey"} }, "AttributeName":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9._-]*$" }, "AttributeNameAndValue":{ "type":"structure", "required":[ "AttributeName", "Value" ], "members":{ "AttributeName":{ "shape":"AttributeName", "documentation":"

The attribute name of the typed link.

" }, "Value":{ "shape":"TypedAttributeValue", "documentation":"

The value for the typed link.

" } }, "documentation":"

Identifies the attribute name and value for a typed link.

" }, "AttributeNameAndValueList":{ "type":"list", "member":{"shape":"AttributeNameAndValue"} }, "AttributeNameList":{ "type":"list", "member":{"shape":"AttributeName"} }, "BatchAddFacetToObject":{ "type":"structure", "required":[ "SchemaFacet", "ObjectAttributeList", "ObjectReference" ], "members":{ "SchemaFacet":{ "shape":"SchemaFacet", "documentation":"

Represents the facet being added to the object.

" }, "ObjectAttributeList":{ "shape":"AttributeKeyAndValueList", "documentation":"

The attributes to set on the object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object being mutated.

" } }, "documentation":"

Represents the output of a batch add facet to object operation.

" }, "BatchAddFacetToObjectResponse":{ "type":"structure", "members":{ }, "documentation":"

The result of a batch add facet to object operation.

" }, "BatchAttachObject":{ "type":"structure", "required":[ "ParentReference", "ChildReference", "LinkName" ], "members":{ "ParentReference":{ "shape":"ObjectReference", "documentation":"

The parent object reference.

" }, "ChildReference":{ "shape":"ObjectReference", "documentation":"

The child object reference that is to be attached to the object.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The name of the link.

" } }, "documentation":"

Represents the output of an AttachObject operation.

" }, "BatchAttachObjectResponse":{ "type":"structure", "members":{ "attachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the object that has been attached.

" } }, "documentation":"

Represents the output batch AttachObject response operation.

" }, "BatchAttachPolicy":{ "type":"structure", "required":[ "PolicyReference", "ObjectReference" ], "members":{ "PolicyReference":{ "shape":"ObjectReference", "documentation":"

The reference that is associated with the policy object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object to which the policy will be attached.

" } }, "documentation":"

Attaches a policy object to a regular object inside a BatchRead operation. For more information, see AttachPolicy and BatchReadRequest$Operations.

" }, "BatchAttachPolicyResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the output of an AttachPolicy response operation.

" }, "BatchAttachToIndex":{ "type":"structure", "required":[ "IndexReference", "TargetReference" ], "members":{ "IndexReference":{ "shape":"ObjectReference", "documentation":"

A reference to the index that you are attaching the object to.

" }, "TargetReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object that you are attaching to the index.

" } }, "documentation":"

Attaches the specified object to the specified index inside a BatchRead operation. For more information, see AttachToIndex and BatchReadRequest$Operations.

" }, "BatchAttachToIndexResponse":{ "type":"structure", "members":{ "AttachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the object that was attached to the index.

" } }, "documentation":"

Represents the output of a AttachToIndex response operation.

" }, "BatchAttachTypedLink":{ "type":"structure", "required":[ "SourceObjectReference", "TargetObjectReference", "TypedLinkFacet", "Attributes" ], "members":{ "SourceObjectReference":{ "shape":"ObjectReference", "documentation":"

Identifies the source object that the typed link will attach to.

" }, "TargetObjectReference":{ "shape":"ObjectReference", "documentation":"

Identifies the target object that the typed link will attach to.

" }, "TypedLinkFacet":{ "shape":"TypedLinkSchemaAndFacetName", "documentation":"

Identifies the typed link facet that is associated with the typed link.

" }, "Attributes":{ "shape":"AttributeNameAndValueList", "documentation":"

A set of attributes that are associated with the typed link.

" } }, "documentation":"

Attaches a typed link to a specified source and target object inside a BatchRead operation. For more information, see AttachTypedLink and BatchReadRequest$Operations.

" }, "BatchAttachTypedLinkResponse":{ "type":"structure", "members":{ "TypedLinkSpecifier":{ "shape":"TypedLinkSpecifier", "documentation":"

Returns a typed link specifier as output.

" } }, "documentation":"

Represents the output of a AttachTypedLink response operation.

" }, "BatchCreateIndex":{ "type":"structure", "required":[ "OrderedIndexedAttributeList", "IsUnique" ], "members":{ "OrderedIndexedAttributeList":{ "shape":"AttributeKeyList", "documentation":"

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

" }, "IsUnique":{ "shape":"Bool", "documentation":"

Indicates whether the attribute that is being indexed has unique values or not.

" }, "ParentReference":{ "shape":"ObjectReference", "documentation":"

A reference to the parent object that contains the index object.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The name of the link between the parent object and the index object.

" }, "BatchReferenceName":{ "shape":"BatchReferenceName", "documentation":"

The batch reference name. See Batches for more information.

" } }, "documentation":"

Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.

" }, "BatchCreateIndexResponse":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the index created by this operation.

" } }, "documentation":"

Represents the output of a CreateIndex response operation.

" }, "BatchCreateObject":{ "type":"structure", "required":[ "SchemaFacet", "ObjectAttributeList" ], "members":{ "SchemaFacet":{ "shape":"SchemaFacetList", "documentation":"

A list of FacetArns that will be associated with the object. For more information, see arns.

" }, "ObjectAttributeList":{ "shape":"AttributeKeyAndValueList", "documentation":"

An attribute map, which contains an attribute ARN as the key and attribute value as the map value.

" }, "ParentReference":{ "shape":"ObjectReference", "documentation":"

If specified, the parent reference to which this object will be attached.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The name of the link.

" }, "BatchReferenceName":{ "shape":"BatchReferenceName", "documentation":"

The batch reference name. See Batches for more information.

" } }, "documentation":"

Represents the output of a CreateObject operation.

" }, "BatchCreateObjectResponse":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ID that is associated with the object.

" } }, "documentation":"

Represents the output of a CreateObject response operation.

" }, "BatchDeleteObject":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object.

" } }, "documentation":"

Represents the output of a DeleteObject operation.

" }, "BatchDeleteObjectResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the output of a DeleteObject response operation.

" }, "BatchDetachFromIndex":{ "type":"structure", "required":[ "IndexReference", "TargetReference" ], "members":{ "IndexReference":{ "shape":"ObjectReference", "documentation":"

A reference to the index object.

" }, "TargetReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object being detached from the index.

" } }, "documentation":"

Detaches the specified object from the specified index inside a BatchRead operation. For more information, see DetachFromIndex and BatchReadRequest$Operations.

" }, "BatchDetachFromIndexResponse":{ "type":"structure", "members":{ "DetachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the object that was detached from the index.

" } }, "documentation":"

Represents the output of a DetachFromIndex response operation.

" }, "BatchDetachObject":{ "type":"structure", "required":[ "ParentReference", "LinkName" ], "members":{ "ParentReference":{ "shape":"ObjectReference", "documentation":"

Parent reference from which the object with the specified link name is detached.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The name of the link.

" }, "BatchReferenceName":{ "shape":"BatchReferenceName", "documentation":"

The batch reference name. See Batches for more information.

" } }, "documentation":"

Represents the output of a DetachObject operation.

" }, "BatchDetachObjectResponse":{ "type":"structure", "members":{ "detachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the detached object.

" } }, "documentation":"

Represents the output of a DetachObject response operation.

" }, "BatchDetachPolicy":{ "type":"structure", "required":[ "PolicyReference", "ObjectReference" ], "members":{ "PolicyReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the policy object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object whose policy object will be detached.

" } }, "documentation":"

Detaches the specified policy from the specified directory inside a BatchWrite operation. For more information, see DetachPolicy and BatchWriteRequest$Operations.

" }, "BatchDetachPolicyResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the output of a DetachPolicy response operation.

" }, "BatchDetachTypedLink":{ "type":"structure", "required":["TypedLinkSpecifier"], "members":{ "TypedLinkSpecifier":{ "shape":"TypedLinkSpecifier", "documentation":"

Used to accept a typed link specifier as input.

" } }, "documentation":"

Detaches a typed link from a specified source and target object inside a BatchRead operation. For more information, see DetachTypedLink and BatchReadRequest$Operations.

" }, "BatchDetachTypedLinkResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the output of a DetachTypedLink response operation.

" }, "BatchGetLinkAttributes":{ "type":"structure", "required":[ "TypedLinkSpecifier", "AttributeNames" ], "members":{ "TypedLinkSpecifier":{ "shape":"TypedLinkSpecifier", "documentation":"

Allows a typed link specifier to be accepted as input.

" }, "AttributeNames":{ "shape":"AttributeNameList", "documentation":"

A list of attribute names whose values will be retrieved.

" } }, "documentation":"

Retrieves attributes that are associated with a typed link inside a BatchRead operation. For more information, see GetLinkAttributes and BatchReadRequest$Operations.

" }, "BatchGetLinkAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeKeyAndValueList", "documentation":"

The attributes that are associated with the typed link.

" } }, "documentation":"

Represents the output of a GetLinkAttributes response operation.

" }, "BatchGetObjectAttributes":{ "type":"structure", "required":[ "ObjectReference", "SchemaFacet", "AttributeNames" ], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object whose attributes will be retrieved.

" }, "SchemaFacet":{ "shape":"SchemaFacet", "documentation":"

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

" }, "AttributeNames":{ "shape":"AttributeNameList", "documentation":"

List of attribute names whose values will be retrieved.

" } }, "documentation":"

Retrieves attributes within a facet that are associated with an object inside an BatchRead operation. For more information, see GetObjectAttributes and BatchReadRequest$Operations.

" }, "BatchGetObjectAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeKeyAndValueList", "documentation":"

The attribute values that are associated with an object.

" } }, "documentation":"

Represents the output of a GetObjectAttributes response operation.

" }, "BatchGetObjectInformation":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object.

" } }, "documentation":"

Retrieves metadata about an object inside a BatchRead operation. For more information, see GetObjectInformation and BatchReadRequest$Operations.

" }, "BatchGetObjectInformationResponse":{ "type":"structure", "members":{ "SchemaFacets":{ "shape":"SchemaFacetList", "documentation":"

The facets attached to the specified object.

" }, "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the specified object.

" } }, "documentation":"

Represents the output of a GetObjectInformation response operation.

" }, "BatchListAttachedIndices":{ "type":"structure", "required":["TargetReference"], "members":{ "TargetReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object that has indices attached.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } }, "documentation":"

Lists indices attached to an object inside a BatchRead operation. For more information, see ListAttachedIndices and BatchReadRequest$Operations.

" }, "BatchListAttachedIndicesResponse":{ "type":"structure", "members":{ "IndexAttachments":{ "shape":"IndexAttachmentList", "documentation":"

The indices attached to the specified object.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } }, "documentation":"

Represents the output of a ListAttachedIndices response operation.

" }, "BatchListIncomingTypedLinks":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object whose attributes will be listed.

" }, "FilterAttributeRanges":{ "shape":"TypedLinkAttributeRangeList", "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" }, "FilterTypedLink":{ "shape":"TypedLinkSchemaAndFacetName", "documentation":"

Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } }, "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListIncomingTypedLinks and BatchReadRequest$Operations.

" }, "BatchListIncomingTypedLinksResponse":{ "type":"structure", "members":{ "LinkSpecifiers":{ "shape":"TypedLinkSpecifierList", "documentation":"

Returns one or more typed link specifiers as output.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } }, "documentation":"

Represents the output of a ListIncomingTypedLinks response operation.

" }, "BatchListIndex":{ "type":"structure", "required":["IndexReference"], "members":{ "RangesOnIndexedValues":{ "shape":"ObjectAttributeRangeList", "documentation":"

Specifies the ranges of indexed values that you want to query.

" }, "IndexReference":{ "shape":"ObjectReference", "documentation":"

The reference to the index to list.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } }, "documentation":"

Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations.

" }, "BatchListIndexResponse":{ "type":"structure", "members":{ "IndexAttachments":{ "shape":"IndexAttachmentList", "documentation":"

The objects and indexed values attached to the index.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } }, "documentation":"

Represents the output of a ListIndex response operation.

" }, "BatchListObjectAttributes":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference of the object whose attributes need to be listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" }, "FacetFilter":{ "shape":"SchemaFacet", "documentation":"

Used to filter the list of object attributes that are associated with a certain facet.

" } }, "documentation":"

Represents the output of a ListObjectAttributes operation.

" }, "BatchListObjectAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeKeyAndValueList", "documentation":"

The attributes map that is associated with the object. AttributeArn is the key; attribute value is the value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } }, "documentation":"

Represents the output of a ListObjectAttributes response operation.

" }, "BatchListObjectChildren":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference of the object for which child objects are being listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

Maximum number of items to be retrieved in a single call. This is an approximate number.

" } }, "documentation":"

Represents the output of a ListObjectChildren operation.

" }, "BatchListObjectChildrenResponse":{ "type":"structure", "members":{ "Children":{ "shape":"LinkNameToObjectIdentifierMap", "documentation":"

The children structure, which is a map with the key as the LinkName and ObjectIdentifier as the value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } }, "documentation":"

Represents the output of a ListObjectChildren response operation.

" }, "BatchListObjectParentPaths":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object whose attributes will be listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } }, "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a BatchRead operation. For more information, see ListObjectParentPaths and BatchReadRequest$Operations.

" }, "BatchListObjectParentPathsResponse":{ "type":"structure", "members":{ "PathToObjectIdentifiersList":{ "shape":"PathToObjectIdentifiersList", "documentation":"

Returns the path to the ObjectIdentifiers that are associated with the directory.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } }, "documentation":"

Represents the output of a ListObjectParentPaths response operation.

" }, "BatchListObjectPolicies":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object whose attributes will be listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } }, "documentation":"

Returns policies attached to an object in pagination fashion inside a BatchRead operation. For more information, see ListObjectPolicies and BatchReadRequest$Operations.

" }, "BatchListObjectPoliciesResponse":{ "type":"structure", "members":{ "AttachedPolicyIds":{ "shape":"ObjectIdentifierList", "documentation":"

A list of policy ObjectIdentifiers, that are attached to the object.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } }, "documentation":"

Represents the output of a ListObjectPolicies response operation.

" }, "BatchListOutgoingTypedLinks":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object whose attributes will be listed.

" }, "FilterAttributeRanges":{ "shape":"TypedLinkAttributeRangeList", "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" }, "FilterTypedLink":{ "shape":"TypedLinkSchemaAndFacetName", "documentation":"

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } }, "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListOutgoingTypedLinks and BatchReadRequest$Operations.

" }, "BatchListOutgoingTypedLinksResponse":{ "type":"structure", "members":{ "TypedLinkSpecifiers":{ "shape":"TypedLinkSpecifierList", "documentation":"

Returns a typed link specifier as output.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } }, "documentation":"

Represents the output of a ListOutgoingTypedLinks response operation.

" }, "BatchListPolicyAttachments":{ "type":"structure", "required":["PolicyReference"], "members":{ "PolicyReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the policy object.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } }, "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached inside a BatchRead operation. For more information, see ListPolicyAttachments and BatchReadRequest$Operations.

" }, "BatchListPolicyAttachmentsResponse":{ "type":"structure", "members":{ "ObjectIdentifiers":{ "shape":"ObjectIdentifierList", "documentation":"

A list of ObjectIdentifiers to which the policy is attached.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } }, "documentation":"

Represents the output of a ListPolicyAttachments response operation.

" }, "BatchLookupPolicy":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object whose policies will be looked up.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } }, "documentation":"

Lists all policies from the root of the Directory to the object specified inside a BatchRead operation. For more information, see LookupPolicy and BatchReadRequest$Operations.

" }, "BatchLookupPolicyResponse":{ "type":"structure", "members":{ "PolicyToPathList":{ "shape":"PolicyToPathList", "documentation":"

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } }, "documentation":"

Represents the output of a LookupPolicy response operation.

" }, "BatchOperationIndex":{"type":"integer"}, "BatchReadException":{ "type":"structure", "members":{ "Type":{ "shape":"BatchReadExceptionType", "documentation":"

A type of exception, such as InvalidArnException.

" }, "Message":{ "shape":"ExceptionMessage", "documentation":"

An exception message that is associated with the failure.

" } }, "documentation":"

The batch read exception structure, which contains the exception type and message.

" }, "BatchReadExceptionType":{ "type":"string", "enum":[ "ValidationException", "InvalidArnException", "ResourceNotFoundException", "InvalidNextTokenException", "AccessDeniedException", "NotNodeException", "FacetValidationException", "CannotListParentOfRootException", "NotIndexException", "NotPolicyException", "DirectoryNotEnabledException", "LimitExceededException", "InternalServiceException" ] }, "BatchReadOperation":{ "type":"structure", "members":{ "ListObjectAttributes":{ "shape":"BatchListObjectAttributes", "documentation":"

Lists all attributes that are associated with an object.

" }, "ListObjectChildren":{ "shape":"BatchListObjectChildren", "documentation":"

Returns a paginated list of child objects that are associated with a given object.

" }, "ListAttachedIndices":{ "shape":"BatchListAttachedIndices", "documentation":"

Lists indices attached to an object.

" }, "ListObjectParentPaths":{ "shape":"BatchListObjectParentPaths", "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

" }, "GetObjectInformation":{ "shape":"BatchGetObjectInformation", "documentation":"

Retrieves metadata about an object.

" }, "GetObjectAttributes":{ "shape":"BatchGetObjectAttributes", "documentation":"

Retrieves attributes within a facet that are associated with an object.

" }, "ListObjectPolicies":{ "shape":"BatchListObjectPolicies", "documentation":"

Returns policies attached to an object in pagination fashion.

" }, "ListPolicyAttachments":{ "shape":"BatchListPolicyAttachments", "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached.

" }, "LookupPolicy":{ "shape":"BatchLookupPolicy", "documentation":"

Lists all policies from the root of the Directory 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. For more information, see Policies.

" }, "ListIndex":{ "shape":"BatchListIndex", "documentation":"

Lists objects attached to the specified index.

" }, "ListOutgoingTypedLinks":{ "shape":"BatchListOutgoingTypedLinks", "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" }, "ListIncomingTypedLinks":{ "shape":"BatchListIncomingTypedLinks", "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" }, "GetLinkAttributes":{ "shape":"BatchGetLinkAttributes", "documentation":"

Retrieves attributes that are associated with a typed link.

" } }, "documentation":"

Represents the output of a BatchRead operation.

" }, "BatchReadOperationList":{ "type":"list", "member":{"shape":"BatchReadOperation"} }, "BatchReadOperationResponse":{ "type":"structure", "members":{ "SuccessfulResponse":{ "shape":"BatchReadSuccessfulResponse", "documentation":"

Identifies which operation in a batch has succeeded.

" }, "ExceptionResponse":{ "shape":"BatchReadException", "documentation":"

Identifies which operation in a batch has failed.

" } }, "documentation":"

Represents the output of a BatchRead response operation.

" }, "BatchReadOperationResponseList":{ "type":"list", "member":{"shape":"BatchReadOperationResponse"} }, "BatchReadRequest":{ "type":"structure", "required":[ "DirectoryArn", "Operations" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Operations":{ "shape":"BatchReadOperationList", "documentation":"

A list of operations that are part of the batch.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

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.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "BatchReadResponse":{ "type":"structure", "members":{ "Responses":{ "shape":"BatchReadOperationResponseList", "documentation":"

A list of all the responses for each batch read.

" } } }, "BatchReadSuccessfulResponse":{ "type":"structure", "members":{ "ListObjectAttributes":{ "shape":"BatchListObjectAttributesResponse", "documentation":"

Lists all attributes that are associated with an object.

" }, "ListObjectChildren":{ "shape":"BatchListObjectChildrenResponse", "documentation":"

Returns a paginated list of child objects that are associated with a given object.

" }, "GetObjectInformation":{ "shape":"BatchGetObjectInformationResponse", "documentation":"

Retrieves metadata about an object.

" }, "GetObjectAttributes":{ "shape":"BatchGetObjectAttributesResponse", "documentation":"

Retrieves attributes within a facet that are associated with an object.

" }, "ListAttachedIndices":{ "shape":"BatchListAttachedIndicesResponse", "documentation":"

Lists indices attached to an object.

" }, "ListObjectParentPaths":{ "shape":"BatchListObjectParentPathsResponse", "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

" }, "ListObjectPolicies":{ "shape":"BatchListObjectPoliciesResponse", "documentation":"

Returns policies attached to an object in pagination fashion.

" }, "ListPolicyAttachments":{ "shape":"BatchListPolicyAttachmentsResponse", "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached.

" }, "LookupPolicy":{ "shape":"BatchLookupPolicyResponse", "documentation":"

Lists all policies from the root of the Directory 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. For more information, see Policies.

" }, "ListIndex":{ "shape":"BatchListIndexResponse", "documentation":"

Lists objects attached to the specified index.

" }, "ListOutgoingTypedLinks":{ "shape":"BatchListOutgoingTypedLinksResponse", "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" }, "ListIncomingTypedLinks":{ "shape":"BatchListIncomingTypedLinksResponse", "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" }, "GetLinkAttributes":{ "shape":"BatchGetLinkAttributesResponse", "documentation":"

The list of attributes to retrieve from the typed link.

" } }, "documentation":"

Represents the output of a BatchRead success response operation.

" }, "BatchReferenceName":{"type":"string"}, "BatchRemoveFacetFromObject":{ "type":"structure", "required":[ "SchemaFacet", "ObjectReference" ], "members":{ "SchemaFacet":{ "shape":"SchemaFacet", "documentation":"

The facet to remove from the object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object whose facet will be removed.

" } }, "documentation":"

A batch operation to remove a facet from an object.

" }, "BatchRemoveFacetFromObjectResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty result that represents success.

" }, "BatchUpdateLinkAttributes":{ "type":"structure", "required":[ "TypedLinkSpecifier", "AttributeUpdates" ], "members":{ "TypedLinkSpecifier":{ "shape":"TypedLinkSpecifier", "documentation":"

Allows a typed link specifier to be accepted as input.

" }, "AttributeUpdates":{ "shape":"LinkAttributeUpdateList", "documentation":"

The attributes update structure.

" } }, "documentation":"

Updates a given typed link’s attributes inside a BatchRead operation. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder. For more information, see UpdateLinkAttributes and BatchReadRequest$Operations.

" }, "BatchUpdateLinkAttributesResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the output of a UpdateLinkAttributes response operation.

" }, "BatchUpdateObjectAttributes":{ "type":"structure", "required":[ "ObjectReference", "AttributeUpdates" ], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object.

" }, "AttributeUpdates":{ "shape":"ObjectAttributeUpdateList", "documentation":"

Attributes update structure.

" } }, "documentation":"

Represents the output of a BatchUpdate operation.

" }, "BatchUpdateObjectAttributesResponse":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

ID that is associated with the object.

" } }, "documentation":"

Represents the output of a BatchUpdate response operation.

" }, "BatchWriteException":{ "type":"structure", "members":{ "Index":{"shape":"BatchOperationIndex"}, "Type":{"shape":"BatchWriteExceptionType"}, "Message":{"shape":"ExceptionMessage"} }, "documentation":"

A BatchWrite exception has occurred.

", "exception":true }, "BatchWriteExceptionType":{ "type":"string", "enum":[ "InternalServiceException", "ValidationException", "InvalidArnException", "LinkNameAlreadyInUseException", "StillContainsLinksException", "FacetValidationException", "ObjectNotDetachedException", "ResourceNotFoundException", "AccessDeniedException", "InvalidAttachmentException", "NotIndexException", "NotNodeException", "IndexedAttributeMissingException", "ObjectAlreadyDetachedException", "NotPolicyException", "DirectoryNotEnabledException", "LimitExceededException", "UnsupportedIndexTypeException" ] }, "BatchWriteOperation":{ "type":"structure", "members":{ "CreateObject":{ "shape":"BatchCreateObject", "documentation":"

Creates an object.

" }, "AttachObject":{ "shape":"BatchAttachObject", "documentation":"

Attaches an object to a Directory.

" }, "DetachObject":{ "shape":"BatchDetachObject", "documentation":"

Detaches an object from a Directory.

" }, "UpdateObjectAttributes":{ "shape":"BatchUpdateObjectAttributes", "documentation":"

Updates a given object's attributes.

" }, "DeleteObject":{ "shape":"BatchDeleteObject", "documentation":"

Deletes an object in a Directory.

" }, "AddFacetToObject":{ "shape":"BatchAddFacetToObject", "documentation":"

A batch operation that adds a facet to an object.

" }, "RemoveFacetFromObject":{ "shape":"BatchRemoveFacetFromObject", "documentation":"

A batch operation that removes a facet from an object.

" }, "AttachPolicy":{ "shape":"BatchAttachPolicy", "documentation":"

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

" }, "DetachPolicy":{ "shape":"BatchDetachPolicy", "documentation":"

Detaches a policy from a Directory.

" }, "CreateIndex":{ "shape":"BatchCreateIndex", "documentation":"

Creates an index object. See Indexing for more information.

" }, "AttachToIndex":{ "shape":"BatchAttachToIndex", "documentation":"

Attaches the specified object to the specified index.

" }, "DetachFromIndex":{ "shape":"BatchDetachFromIndex", "documentation":"

Detaches the specified object from the specified index.

" }, "AttachTypedLink":{ "shape":"BatchAttachTypedLink", "documentation":"

Attaches a typed link to a specified source and target object. For more information, see Typed link.

" }, "DetachTypedLink":{ "shape":"BatchDetachTypedLink", "documentation":"

Detaches a typed link from a specified source and target object. For more information, see Typed link.

" }, "UpdateLinkAttributes":{ "shape":"BatchUpdateLinkAttributes", "documentation":"

Updates a given object's attributes.

" } }, "documentation":"

Represents the output of a BatchWrite operation.

" }, "BatchWriteOperationList":{ "type":"list", "member":{"shape":"BatchWriteOperation"} }, "BatchWriteOperationResponse":{ "type":"structure", "members":{ "CreateObject":{ "shape":"BatchCreateObjectResponse", "documentation":"

Creates an object in a Directory.

" }, "AttachObject":{ "shape":"BatchAttachObjectResponse", "documentation":"

Attaches an object to a Directory.

" }, "DetachObject":{ "shape":"BatchDetachObjectResponse", "documentation":"

Detaches an object from a Directory.

" }, "UpdateObjectAttributes":{ "shape":"BatchUpdateObjectAttributesResponse", "documentation":"

Updates a given object’s attributes.

" }, "DeleteObject":{ "shape":"BatchDeleteObjectResponse", "documentation":"

Deletes an object in a Directory.

" }, "AddFacetToObject":{ "shape":"BatchAddFacetToObjectResponse", "documentation":"

The result of an add facet to object batch operation.

" }, "RemoveFacetFromObject":{ "shape":"BatchRemoveFacetFromObjectResponse", "documentation":"

The result of a batch remove facet from object operation.

" }, "AttachPolicy":{ "shape":"BatchAttachPolicyResponse", "documentation":"

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

" }, "DetachPolicy":{ "shape":"BatchDetachPolicyResponse", "documentation":"

Detaches a policy from a Directory.

" }, "CreateIndex":{ "shape":"BatchCreateIndexResponse", "documentation":"

Creates an index object. See Indexing for more information.

" }, "AttachToIndex":{ "shape":"BatchAttachToIndexResponse", "documentation":"

Attaches the specified object to the specified index.

" }, "DetachFromIndex":{ "shape":"BatchDetachFromIndexResponse", "documentation":"

Detaches the specified object from the specified index.

" }, "AttachTypedLink":{ "shape":"BatchAttachTypedLinkResponse", "documentation":"

Attaches a typed link to a specified source and target object. For more information, see Typed link.

" }, "DetachTypedLink":{ "shape":"BatchDetachTypedLinkResponse", "documentation":"

Detaches a typed link from a specified source and target object. For more information, see Typed link.

" }, "UpdateLinkAttributes":{ "shape":"BatchUpdateLinkAttributesResponse", "documentation":"

Represents the output of a BatchWrite response operation.

" } }, "documentation":"

Represents the output of a BatchWrite response operation.

" }, "BatchWriteOperationResponseList":{ "type":"list", "member":{"shape":"BatchWriteOperationResponse"} }, "BatchWriteRequest":{ "type":"structure", "required":[ "DirectoryArn", "Operations" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Operations":{ "shape":"BatchWriteOperationList", "documentation":"

A list of operations that are part of the batch.

" } } }, "BatchWriteResponse":{ "type":"structure", "members":{ "Responses":{ "shape":"BatchWriteOperationResponseList", "documentation":"

A list of all the responses for each batch write.

" } } }, "BinaryAttributeValue":{"type":"blob"}, "Bool":{"type":"boolean"}, "BooleanAttributeValue":{"type":"boolean"}, "CannotListParentOfRootException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Cannot list the parents of a Directory root.

", "error":{"httpStatusCode":400}, "exception":true }, "ConsistencyLevel":{ "type":"string", "enum":[ "SERIALIZABLE", "EVENTUAL" ] }, "CreateDirectoryRequest":{ "type":"structure", "required":[ "Name", "SchemaArn" ], "members":{ "Name":{ "shape":"DirectoryName", "documentation":"

The name of the Directory. Should be unique per account, per region.

" }, "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "CreateDirectoryResponse":{ "type":"structure", "required":[ "DirectoryArn", "Name", "ObjectIdentifier", "AppliedSchemaArn" ], "members":{ "DirectoryArn":{ "shape":"DirectoryArn", "documentation":"

The ARN that is associated with the Directory. For more information, see arns.

" }, "Name":{ "shape":"DirectoryName", "documentation":"

The name of the Directory.

" }, "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The root object node of the created directory.

" }, "AppliedSchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the published schema in the Directory. 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 arns.

" } } }, "CreateFacetRequest":{ "type":"structure", "required":[ "SchemaArn", "Name", "ObjectType" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The schema ARN in which the new Facet will be created. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"FacetName", "documentation":"

The name of the Facet, which is unique for a given schema.

" }, "Attributes":{ "shape":"FacetAttributeList", "documentation":"

The attributes that are associated with the Facet.

" }, "ObjectType":{ "shape":"ObjectType", "documentation":"

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

" } } }, "CreateFacetResponse":{ "type":"structure", "members":{ } }, "CreateIndexRequest":{ "type":"structure", "required":[ "DirectoryArn", "OrderedIndexedAttributeList", "IsUnique" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory where the index should be created.

", "location":"header", "locationName":"x-amz-data-partition" }, "OrderedIndexedAttributeList":{ "shape":"AttributeKeyList", "documentation":"

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

" }, "IsUnique":{ "shape":"Bool", "documentation":"

Indicates whether the attribute that is being indexed has unique values or not.

" }, "ParentReference":{ "shape":"ObjectReference", "documentation":"

A reference to the parent object that contains the index object.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The name of the link between the parent object and the index object.

" } } }, "CreateIndexResponse":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the index created by this operation.

" } } }, "CreateObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "SchemaFacets" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "SchemaFacets":{ "shape":"SchemaFacetList", "documentation":"

A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details.

" }, "ObjectAttributeList":{ "shape":"AttributeKeyAndValueList", "documentation":"

The attribute map whose attribute ARN contains the key and attribute value as the map value.

" }, "ParentReference":{ "shape":"ObjectReference", "documentation":"

If specified, the parent reference to which this object will be attached.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The name of link that is used to attach this object to a parent.

" } } }, "CreateObjectResponse":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The identifier that is associated with the object.

" } } }, "CreateSchemaRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"SchemaName", "documentation":"

The name that is associated with the schema. This is unique to each account and in each region.

" } } }, "CreateSchemaResponse":{ "type":"structure", "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

" } } }, "CreateTypedLinkFacetRequest":{ "type":"structure", "required":[ "SchemaArn", "Facet" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Facet":{ "shape":"TypedLinkFacet", "documentation":"

Facet structure that is associated with the typed link facet.

" } } }, "CreateTypedLinkFacetResponse":{ "type":"structure", "members":{ } }, "Date":{"type":"timestamp"}, "DatetimeAttributeValue":{"type":"timestamp"}, "DeleteDirectoryRequest":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory to delete.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "DeleteDirectoryResponse":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the deleted directory.

" } } }, "DeleteFacetRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"FacetName", "documentation":"

The name of the facet to delete.

" } } }, "DeleteFacetResponse":{ "type":"structure", "members":{ } }, "DeleteObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference that identifies the object.

" } } }, "DeleteObjectResponse":{ "type":"structure", "members":{ } }, "DeleteSchemaRequest":{ "type":"structure", "required":["SchemaArn"], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "DeleteSchemaResponse":{ "type":"structure", "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The input ARN that is returned as part of the response. For more information, see arns.

" } } }, "DeleteTypedLinkFacetRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"TypedLinkName", "documentation":"

The unique name of the typed link facet.

" } } }, "DeleteTypedLinkFacetResponse":{ "type":"structure", "members":{ } }, "DetachFromIndexRequest":{ "type":"structure", "required":[ "DirectoryArn", "IndexReference", "TargetReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the directory the index and object exist in.

", "location":"header", "locationName":"x-amz-data-partition" }, "IndexReference":{ "shape":"ObjectReference", "documentation":"

A reference to the index object.

" }, "TargetReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object being detached from the index.

" } } }, "DetachFromIndexResponse":{ "type":"structure", "members":{ "DetachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the object that was detached from the index.

" } } }, "DetachObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "ParentReference", "LinkName" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ParentReference":{ "shape":"ObjectReference", "documentation":"

The parent reference from which the object with the specified link name is detached.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The link name associated with the object that needs to be detached.

" } } }, "DetachObjectResponse":{ "type":"structure", "members":{ "DetachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier that was detached from the object.

" } } }, "DetachPolicyRequest":{ "type":"structure", "required":[ "DirectoryArn", "PolicyReference", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "PolicyReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the policy object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object whose policy object will be detached.

" } } }, "DetachPolicyResponse":{ "type":"structure", "members":{ } }, "DetachTypedLinkRequest":{ "type":"structure", "required":[ "DirectoryArn", "TypedLinkSpecifier" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.

", "location":"header", "locationName":"x-amz-data-partition" }, "TypedLinkSpecifier":{ "shape":"TypedLinkSpecifier", "documentation":"

Used to accept a typed link specifier as input.

" } } }, "Directory":{ "type":"structure", "members":{ "Name":{ "shape":"DirectoryName", "documentation":"

The name of the directory.

" }, "DirectoryArn":{ "shape":"DirectoryArn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns.

" }, "State":{ "shape":"DirectoryState", "documentation":"

The state of the directory. Can be either Enabled, Disabled, or Deleted.

" }, "CreationDateTime":{ "shape":"Date", "documentation":"

The date and time when the directory was created.

" } }, "documentation":"

Directory structure that includes the directory name and directory ARN.

" }, "DirectoryAlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.

", "error":{"httpStatusCode":400}, "exception":true }, "DirectoryArn":{"type":"string"}, "DirectoryDeletedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.

", "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":"

An operation can only operate on a disabled directory.

", "error":{"httpStatusCode":400}, "exception":true }, "DirectoryNotEnabledException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Operations are only permitted on enabled directories.

", "error":{"httpStatusCode":400}, "exception":true }, "DirectoryState":{ "type":"string", "enum":[ "ENABLED", "DISABLED", "DELETED" ] }, "DisableDirectoryRequest":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory to disable.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "DisableDirectoryResponse":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory that has been disabled.

" } } }, "EnableDirectoryRequest":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory to enable.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "EnableDirectoryResponse":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the enabled directory.

" } } }, "ExceptionMessage":{"type":"string"}, "Facet":{ "type":"structure", "members":{ "Name":{ "shape":"FacetName", "documentation":"

The name of the Facet.

" }, "ObjectType":{ "shape":"ObjectType", "documentation":"

The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

" } }, "documentation":"

A structure that contains Name, ARN, Attributes, Rules, and ObjectTypes. See Facets for more information.

" }, "FacetAlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

A facet with the same name already exists.

", "error":{"httpStatusCode":400}, "exception":true }, "FacetAttribute":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"AttributeName", "documentation":"

The name of the facet attribute.

" }, "AttributeDefinition":{ "shape":"FacetAttributeDefinition", "documentation":"

A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

" }, "AttributeReference":{ "shape":"FacetAttributeReference", "documentation":"

An attribute reference that is associated with the attribute. See Attribute References for more information.

" }, "RequiredBehavior":{ "shape":"RequiredAttributeBehavior", "documentation":"

The required behavior of the FacetAttribute.

" } }, "documentation":"

An attribute that is associated with the Facet.

" }, "FacetAttributeDefinition":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"FacetAttributeType", "documentation":"

The type of the attribute.

" }, "DefaultValue":{ "shape":"TypedAttributeValue", "documentation":"

The default value of the attribute (if configured).

" }, "IsImmutable":{ "shape":"Bool", "documentation":"

Whether the attribute is mutable or not.

" }, "Rules":{ "shape":"RuleMap", "documentation":"

Validation rules attached to the attribute definition.

" } }, "documentation":"

A facet attribute definition. See Attribute References for more information.

" }, "FacetAttributeList":{ "type":"list", "member":{"shape":"FacetAttribute"} }, "FacetAttributeReference":{ "type":"structure", "required":[ "TargetFacetName", "TargetAttributeName" ], "members":{ "TargetFacetName":{ "shape":"FacetName", "documentation":"

The target facet name that is associated with the facet reference. See Attribute References for more information.

" }, "TargetAttributeName":{ "shape":"AttributeName", "documentation":"

The target attribute name that is associated with the facet reference. See Attribute References for more information.

" } }, "documentation":"

The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.

" }, "FacetAttributeType":{ "type":"string", "enum":[ "STRING", "BINARY", "BOOLEAN", "NUMBER", "DATETIME" ] }, "FacetAttributeUpdate":{ "type":"structure", "members":{ "Attribute":{ "shape":"FacetAttribute", "documentation":"

The attribute to update.

" }, "Action":{ "shape":"UpdateActionType", "documentation":"

The action to perform when updating the attribute.

" } }, "documentation":"

A structure that contains information used to update an attribute.

" }, "FacetAttributeUpdateList":{ "type":"list", "member":{"shape":"FacetAttributeUpdate"} }, "FacetInUseException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.

", "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":"

The specified Facet could not be found.

", "error":{"httpStatusCode":400}, "exception":true }, "FacetValidationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

The Facet that you provided was not well formed or could not be validated with the schema.

", "error":{"httpStatusCode":400}, "exception":true }, "GetAppliedSchemaVersionRequest":{ "type":"structure", "required":["SchemaArn"], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the applied schema.

" } } }, "GetAppliedSchemaVersionResponse":{ "type":"structure", "members":{ "AppliedSchemaArn":{ "shape":"Arn", "documentation":"

Current applied schema ARN, including the minor version in use if one was provided.

" } } }, "GetDirectoryRequest":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"DirectoryArn", "documentation":"

The ARN of the directory.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "GetDirectoryResponse":{ "type":"structure", "required":["Directory"], "members":{ "Directory":{ "shape":"Directory", "documentation":"

Metadata about the directory.

" } } }, "GetFacetRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"FacetName", "documentation":"

The name of the facet to retrieve.

" } } }, "GetFacetResponse":{ "type":"structure", "members":{ "Facet":{ "shape":"Facet", "documentation":"

The Facet structure that is associated with the facet.

" } } }, "GetLinkAttributesRequest":{ "type":"structure", "required":[ "DirectoryArn", "TypedLinkSpecifier", "AttributeNames" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see arns or Typed link.

", "location":"header", "locationName":"x-amz-data-partition" }, "TypedLinkSpecifier":{ "shape":"TypedLinkSpecifier", "documentation":"

Allows a typed link specifier to be accepted as input.

" }, "AttributeNames":{ "shape":"AttributeNameList", "documentation":"

A list of attribute names whose values will be retrieved.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

The consistency level at which to retrieve the attributes on a typed link.

" } } }, "GetLinkAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeKeyAndValueList", "documentation":"

The attributes that are associated with the typed link.

" } } }, "GetObjectAttributesRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference", "SchemaFacet", "AttributeNames" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object whose attributes will be retrieved.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

The consistency level at which to retrieve the attributes on an object.

", "location":"header", "locationName":"x-amz-consistency-level" }, "SchemaFacet":{ "shape":"SchemaFacet", "documentation":"

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

" }, "AttributeNames":{ "shape":"AttributeNameList", "documentation":"

List of attribute names whose values will be retrieved.

" } } }, "GetObjectAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeKeyAndValueList", "documentation":"

The attributes that are associated with the object.

" } } }, "GetObjectInformationRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory being retrieved.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

The consistency level at which to retrieve the object information.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "GetObjectInformationResponse":{ "type":"structure", "members":{ "SchemaFacets":{ "shape":"SchemaFacetList", "documentation":"

The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See GetAppliedSchemaVersion for details.

" }, "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the specified object.

" } } }, "GetSchemaAsJsonRequest":{ "type":"structure", "required":["SchemaArn"], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the schema to retrieve.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "GetSchemaAsJsonResponse":{ "type":"structure", "members":{ "Name":{ "shape":"SchemaName", "documentation":"

The name of the retrieved schema.

" }, "Document":{ "shape":"SchemaJsonDocument", "documentation":"

The JSON representation of the schema document.

" } } }, "GetTypedLinkFacetInformationRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"TypedLinkName", "documentation":"

The unique name of the typed link facet.

" } } }, "GetTypedLinkFacetInformationResponse":{ "type":"structure", "members":{ "IdentityAttributeOrder":{ "shape":"AttributeNameList", "documentation":"

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed link.

" } } }, "IncompatibleSchemaException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.

", "error":{"httpStatusCode":400}, "exception":true }, "IndexAttachment":{ "type":"structure", "members":{ "IndexedAttributes":{ "shape":"AttributeKeyAndValueList", "documentation":"

The indexed attribute values.

" }, "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

In response to ListIndex, the ObjectIdentifier of the object attached to the index. In response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object. This field will always contain the ObjectIdentifier of the object on the opposite side of the attachment specified in the query.

" } }, "documentation":"

Represents an index and an attached object.

" }, "IndexAttachmentList":{ "type":"list", "member":{"shape":"IndexAttachment"} }, "IndexedAttributeMissingException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

An object has been attempted to be attached to an object that does not have the appropriate attribute value.

", "error":{"httpStatusCode":400}, "exception":true }, "InternalServiceException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

", "error":{"httpStatusCode":500}, "exception":true }, "InvalidArnException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that the provided ARN value is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidAttachmentException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that an attempt to attach an object with the same link name or to apply a schema with the same name has occurred. Rename the link or the schema and then try again.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidFacetUpdateException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

An attempt to modify a Facet resulted in an invalid schema exception.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that the NextToken value is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRuleException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Occurs when any of the rule parameter keys or values are invalid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidSchemaDocException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that the provided SchemaDoc value is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidTaggingRequestException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

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.

", "error":{"httpStatusCode":400}, "exception":true }, "LimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that limits are exceeded. See Limits for more information.

", "error":{"httpStatusCode":400}, "exception":true }, "LinkAttributeAction":{ "type":"structure", "members":{ "AttributeActionType":{ "shape":"UpdateActionType", "documentation":"

A type that can be either UPDATE_OR_CREATE or DELETE.

" }, "AttributeUpdateValue":{ "shape":"TypedAttributeValue", "documentation":"

The value that you want to update to.

" } }, "documentation":"

The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.

" }, "LinkAttributeUpdate":{ "type":"structure", "members":{ "AttributeKey":{ "shape":"AttributeKey", "documentation":"

The key of the attribute being updated.

" }, "AttributeAction":{ "shape":"LinkAttributeAction", "documentation":"

The action to perform as part of the attribute update.

" } }, "documentation":"

Structure that contains attribute update information.

" }, "LinkAttributeUpdateList":{ "type":"list", "member":{"shape":"LinkAttributeUpdate"} }, "LinkName":{ "type":"string", "max":64, "min":1, "pattern":"[^\\/\\[\\]\\(\\):\\{\\}#@!?\\s\\\\;]+" }, "LinkNameAlreadyInUseException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.

", "error":{"httpStatusCode":400}, "exception":true }, "LinkNameToObjectIdentifierMap":{ "type":"map", "key":{"shape":"LinkName"}, "value":{"shape":"ObjectIdentifier"} }, "ListAppliedSchemaArnsRequest":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory you are listing.

" }, "SchemaArn":{ "shape":"Arn", "documentation":"

The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } } }, "ListAppliedSchemaArnsResponse":{ "type":"structure", "members":{ "SchemaArns":{ "shape":"Arns", "documentation":"

The ARNs of schemas that are applied to the directory.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListAttachedIndicesRequest":{ "type":"structure", "required":[ "DirectoryArn", "TargetReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory.

", "location":"header", "locationName":"x-amz-data-partition" }, "TargetReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object that has indices attached.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

The consistency level to use for this operation.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListAttachedIndicesResponse":{ "type":"structure", "members":{ "IndexAttachments":{ "shape":"IndexAttachmentList", "documentation":"

The indices attached to the specified object.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListDevelopmentSchemaArnsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } } }, "ListDevelopmentSchemaArnsResponse":{ "type":"structure", "members":{ "SchemaArns":{ "shape":"Arns", "documentation":"

The ARNs of retrieved development schemas.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListDirectoriesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" }, "state":{ "shape":"DirectoryState", "documentation":"

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

" } } }, "ListDirectoriesResponse":{ "type":"structure", "required":["Directories"], "members":{ "Directories":{ "shape":"DirectoryList", "documentation":"

Lists all directories that are associated with your account in pagination fashion.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListFacetAttributesRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the schema where the facet resides.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"FacetName", "documentation":"

The name of the facet whose attributes will be retrieved.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } } }, "ListFacetAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"FacetAttributeList", "documentation":"

The attributes attached to the facet.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListFacetNamesRequest":{ "type":"structure", "required":["SchemaArn"], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) to retrieve facet names from.

", "location":"header", "locationName":"x-amz-data-partition" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } } }, "ListFacetNamesResponse":{ "type":"structure", "members":{ "FacetNames":{ "shape":"FacetNameList", "documentation":"

The names of facets that exist within the schema.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListIncomingTypedLinksRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object whose attributes will be listed.

" }, "FilterAttributeRanges":{ "shape":"TypedLinkAttributeRangeList", "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" }, "FilterTypedLink":{ "shape":"TypedLinkSchemaAndFacetName", "documentation":"

Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

The consistency level to execute the request at.

" } } }, "ListIncomingTypedLinksResponse":{ "type":"structure", "members":{ "LinkSpecifiers":{ "shape":"TypedLinkSpecifierList", "documentation":"

Returns one or more typed link specifiers as output.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListIndexRequest":{ "type":"structure", "required":[ "DirectoryArn", "IndexReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory that the index exists in.

", "location":"header", "locationName":"x-amz-data-partition" }, "RangesOnIndexedValues":{ "shape":"ObjectAttributeRangeList", "documentation":"

Specifies the ranges of indexed values that you want to query.

" }, "IndexReference":{ "shape":"ObjectReference", "documentation":"

The reference to the index to list.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see AWS Directory Service Limits.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

The consistency level to execute the request at.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListIndexResponse":{ "type":"structure", "members":{ "IndexAttachments":{ "shape":"IndexAttachmentList", "documentation":"

The objects and indexed values attached to the index.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListObjectAttributesRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object whose attributes will be listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

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.

", "location":"header", "locationName":"x-amz-consistency-level" }, "FacetFilter":{ "shape":"SchemaFacet", "documentation":"

Used to filter the list of object attributes that are associated with a certain facet.

" } } }, "ListObjectAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeKeyAndValueList", "documentation":"

Attributes map that is associated with the object. AttributeArn is the key, and attribute value is the value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListObjectChildrenRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object for which child objects are being listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

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.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListObjectChildrenResponse":{ "type":"structure", "members":{ "Children":{ "shape":"LinkNameToObjectIdentifierMap", "documentation":"

Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListObjectParentPathsRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory to which the parent path applies.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object whose parent paths are listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" } } }, "ListObjectParentPathsResponse":{ "type":"structure", "members":{ "PathToObjectIdentifiersList":{ "shape":"PathToObjectIdentifiersList", "documentation":"

Returns the path to the ObjectIdentifiers that are associated with the directory.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListObjectParentsRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object for which parent objects are being listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

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.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListObjectParentsResponse":{ "type":"structure", "members":{ "Parents":{ "shape":"ObjectIdentifierToLinkNameMap", "documentation":"

The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListObjectPoliciesRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object for which policies will be listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

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.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListObjectPoliciesResponse":{ "type":"structure", "members":{ "AttachedPolicyIds":{ "shape":"ObjectIdentifierList", "documentation":"

A list of policy ObjectIdentifiers, that are attached to the object.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListOutgoingTypedLinksRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference that identifies the object whose attributes will be listed.

" }, "FilterAttributeRanges":{ "shape":"TypedLinkAttributeRangeList", "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" }, "FilterTypedLink":{ "shape":"TypedLinkSchemaAndFacetName", "documentation":"

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

The consistency level to execute the request at.

" } } }, "ListOutgoingTypedLinksResponse":{ "type":"structure", "members":{ "TypedLinkSpecifiers":{ "shape":"TypedLinkSpecifierList", "documentation":"

Returns a typed link specifier as output.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListPolicyAttachmentsRequest":{ "type":"structure", "required":[ "DirectoryArn", "PolicyReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "PolicyReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the policy object.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

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.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListPolicyAttachmentsResponse":{ "type":"structure", "members":{ "ObjectIdentifiers":{ "shape":"ObjectIdentifierList", "documentation":"

A list of ObjectIdentifiers to which the policy is attached.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListPublishedSchemaArnsRequest":{ "type":"structure", "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The response for ListPublishedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } } }, "ListPublishedSchemaArnsResponse":{ "type":"structure", "members":{ "SchemaArns":{ "shape":"Arns", "documentation":"

The ARNs of published schemas.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token. This is for future use. Currently pagination is not supported for tagging.

" }, "MaxResults":{ "shape":"TagsNumberResults", "documentation":"

The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"

A list of tag key value pairs that are associated with the response.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "ListTypedLinkFacetAttributesRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"TypedLinkName", "documentation":"

The unique name of the typed link facet.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } } }, "ListTypedLinkFacetAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"TypedLinkAttributeDefinitionList", "documentation":"

An ordered set of attributes associate with the typed link.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListTypedLinkFacetNamesRequest":{ "type":"structure", "required":["SchemaArn"], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } } }, "ListTypedLinkFacetNamesResponse":{ "type":"structure", "members":{ "FacetNames":{ "shape":"TypedLinkNameList", "documentation":"

The names of typed link facets that exist within the schema.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "LookupPolicyRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object whose policies will be looked up.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to request the next page of results.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" } } }, "LookupPolicyResponse":{ "type":"structure", "members":{ "PolicyToPathList":{ "shape":"PolicyToPathList", "documentation":"

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "NextToken":{"type":"string"}, "NotIndexException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that the requested operation can only operate on index objects.

", "error":{"httpStatusCode":400}, "exception":true }, "NotNodeException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.

", "error":{"httpStatusCode":400}, "exception":true }, "NotPolicyException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that the requested operation can only operate on policy objects.

", "error":{"httpStatusCode":400}, "exception":true }, "NumberAttributeValue":{"type":"string"}, "NumberResults":{ "type":"integer", "min":1 }, "ObjectAlreadyDetachedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that the object is not attached to the index.

", "error":{"httpStatusCode":400}, "exception":true }, "ObjectAttributeAction":{ "type":"structure", "members":{ "ObjectAttributeActionType":{ "shape":"UpdateActionType", "documentation":"

A type that can be either Update or Delete.

" }, "ObjectAttributeUpdateValue":{ "shape":"TypedAttributeValue", "documentation":"

The value that you want to update to.

" } }, "documentation":"

The action to take on the object attribute.

" }, "ObjectAttributeRange":{ "type":"structure", "members":{ "AttributeKey":{ "shape":"AttributeKey", "documentation":"

The key of the attribute that the attribute range covers.

" }, "Range":{ "shape":"TypedAttributeValueRange", "documentation":"

The range of attribute values being selected.

" } }, "documentation":"

A range of attributes.

" }, "ObjectAttributeRangeList":{ "type":"list", "member":{"shape":"ObjectAttributeRange"} }, "ObjectAttributeUpdate":{ "type":"structure", "members":{ "ObjectAttributeKey":{ "shape":"AttributeKey", "documentation":"

The key of the attribute being updated.

" }, "ObjectAttributeAction":{ "shape":"ObjectAttributeAction", "documentation":"

The action to perform as part of the attribute update.

" } }, "documentation":"

Structure that contains attribute update information.

" }, "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":"

Indicates that the requested operation cannot be completed because the object has not been detached from the tree.

", "error":{"httpStatusCode":400}, "exception":true }, "ObjectReference":{ "type":"structure", "members":{ "Selector":{ "shape":"SelectorObjectReference", "documentation":"

A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Accessing Objects. You can identify an object in one of the following ways:

" } }, "documentation":"

The reference that identifies an object.

" }, "ObjectType":{ "type":"string", "enum":[ "NODE", "LEAF_NODE", "POLICY", "INDEX" ] }, "PathString":{"type":"string"}, "PathToObjectIdentifiers":{ "type":"structure", "members":{ "Path":{ "shape":"PathString", "documentation":"

The path that is used to identify the object starting from directory root.

" }, "ObjectIdentifiers":{ "shape":"ObjectIdentifierList", "documentation":"

Lists ObjectIdentifiers starting from directory root to the object in the request.

" } }, "documentation":"

Returns the path to the ObjectIdentifiers that is associated with the directory.

" }, "PathToObjectIdentifiersList":{ "type":"list", "member":{"shape":"PathToObjectIdentifiers"} }, "PolicyAttachment":{ "type":"structure", "members":{ "PolicyId":{ "shape":"ObjectIdentifier", "documentation":"

The ID of PolicyAttachment.

" }, "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier that is associated with PolicyAttachment.

" }, "PolicyType":{ "shape":"PolicyType", "documentation":"

The type of policy that can be associated with PolicyAttachment.

" } }, "documentation":"

Contains the PolicyType, PolicyId, and the ObjectIdentifier to which it is attached. For more information, see Policies.

" }, "PolicyAttachmentList":{ "type":"list", "member":{"shape":"PolicyAttachment"} }, "PolicyToPath":{ "type":"structure", "members":{ "Path":{ "shape":"PathString", "documentation":"

The path that is referenced from the root.

" }, "Policies":{ "shape":"PolicyAttachmentList", "documentation":"

List of policy objects.

" } }, "documentation":"

Used when a regular object exists in a Directory and you want to find all of the policies that are associated with that object and the parent to that object.

" }, "PolicyToPathList":{ "type":"list", "member":{"shape":"PolicyToPath"} }, "PolicyType":{"type":"string"}, "PublishSchemaRequest":{ "type":"structure", "required":[ "DevelopmentSchemaArn", "Version" ], "members":{ "DevelopmentSchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Version":{ "shape":"Version", "documentation":"

The major version under which the schema will be published. Schemas have both a major and minor version associated with them.

" }, "MinorVersion":{ "shape":"Version", "documentation":"

The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.

" }, "Name":{ "shape":"SchemaName", "documentation":"

The new name under which the schema will be published. If this is not provided, the development schema is considered.

" } } }, "PublishSchemaResponse":{ "type":"structure", "members":{ "PublishedSchemaArn":{ "shape":"Arn", "documentation":"

The ARN that is associated with the published schema. For more information, see arns.

" } } }, "PutSchemaFromJsonRequest":{ "type":"structure", "required":[ "SchemaArn", "Document" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the schema to update.

", "location":"header", "locationName":"x-amz-data-partition" }, "Document":{ "shape":"SchemaJsonDocument", "documentation":"

The replacement JSON schema.

" } } }, "PutSchemaFromJsonResponse":{ "type":"structure", "members":{ "Arn":{ "shape":"Arn", "documentation":"

The ARN of the schema to update.

" } } }, "RangeMode":{ "type":"string", "enum":[ "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE", "EXCLUSIVE" ] }, "RemoveFacetFromObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "SchemaFacet", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory in which the object resides.

", "location":"header", "locationName":"x-amz-data-partition" }, "SchemaFacet":{ "shape":"SchemaFacet", "documentation":"

The facet to remove. See SchemaFacet for details.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object to remove the facet from.

" } } }, "RemoveFacetFromObjectResponse":{ "type":"structure", "members":{ } }, "RequiredAttributeBehavior":{ "type":"string", "enum":[ "REQUIRED_ALWAYS", "NOT_REQUIRED" ] }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

The specified resource could not be found.

", "error":{"httpStatusCode":404}, "exception":true }, "RetryableConflictException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

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.

", "error":{"httpStatusCode":409}, "exception":true }, "Rule":{ "type":"structure", "members":{ "Type":{ "shape":"RuleType", "documentation":"

The type of attribute validation rule.

" }, "Parameters":{ "shape":"RuleParameterMap", "documentation":"

The minimum and maximum parameters that are associated with the rule.

" } }, "documentation":"

Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.

" }, "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":"

Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.

", "error":{"httpStatusCode":400}, "exception":true }, "SchemaAlreadyPublishedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that a schema is already published.

", "error":{"httpStatusCode":400}, "exception":true }, "SchemaFacet":{ "type":"structure", "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions.

" }, "FacetName":{ "shape":"FacetName", "documentation":"

The name of the facet.

" } }, "documentation":"

A facet.

" }, "SchemaFacetList":{ "type":"list", "member":{"shape":"SchemaFacet"} }, "SchemaJsonDocument":{"type":"string"}, "SchemaName":{ "type":"string", "max":32, "min":1, "pattern":"^[a-zA-Z0-9._-]*$" }, "SelectorObjectReference":{"type":"string"}, "StillContainsLinksException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

The object could not be deleted because links still exist. Remove the links and then try the operation again.

", "error":{"httpStatusCode":400}, "exception":true }, "StringAttributeValue":{"type":"string"}, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key that is associated with the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value that is associated with the tag.

" } }, "documentation":"

The tag structure that contains a tag key and value.

" }, "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":"

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tag key-value pairs.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{"type":"string"}, "TagsNumberResults":{ "type":"integer", "min":50 }, "TypedAttributeValue":{ "type":"structure", "members":{ "StringValue":{ "shape":"StringAttributeValue", "documentation":"

A string data value.

" }, "BinaryValue":{ "shape":"BinaryAttributeValue", "documentation":"

A binary data value.

" }, "BooleanValue":{ "shape":"BooleanAttributeValue", "documentation":"

A Boolean data value.

" }, "NumberValue":{ "shape":"NumberAttributeValue", "documentation":"

A number data value.

" }, "DatetimeValue":{ "shape":"DatetimeAttributeValue", "documentation":"

A date and time value.

" } }, "documentation":"

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.

" }, "TypedAttributeValueRange":{ "type":"structure", "required":[ "StartMode", "EndMode" ], "members":{ "StartMode":{ "shape":"RangeMode", "documentation":"

The inclusive or exclusive range start.

" }, "StartValue":{ "shape":"TypedAttributeValue", "documentation":"

The value to start the range at.

" }, "EndMode":{ "shape":"RangeMode", "documentation":"

The inclusive or exclusive range end.

" }, "EndValue":{ "shape":"TypedAttributeValue", "documentation":"

The attribute value to terminate the range at.

" } }, "documentation":"

A range of attribute values. For more information, see Range Filters.

" }, "TypedLinkAttributeDefinition":{ "type":"structure", "required":[ "Name", "Type", "RequiredBehavior" ], "members":{ "Name":{ "shape":"AttributeName", "documentation":"

The unique name of the typed link attribute.

" }, "Type":{ "shape":"FacetAttributeType", "documentation":"

The type of the attribute.

" }, "DefaultValue":{ "shape":"TypedAttributeValue", "documentation":"

The default value of the attribute (if configured).

" }, "IsImmutable":{ "shape":"Bool", "documentation":"

Whether the attribute is mutable or not.

" }, "Rules":{ "shape":"RuleMap", "documentation":"

Validation rules that are attached to the attribute definition.

" }, "RequiredBehavior":{ "shape":"RequiredAttributeBehavior", "documentation":"

The required behavior of the TypedLinkAttributeDefinition.

" } }, "documentation":"

A typed link attribute definition.

" }, "TypedLinkAttributeDefinitionList":{ "type":"list", "member":{"shape":"TypedLinkAttributeDefinition"} }, "TypedLinkAttributeRange":{ "type":"structure", "required":["Range"], "members":{ "AttributeName":{ "shape":"AttributeName", "documentation":"

The unique name of the typed link attribute.

" }, "Range":{ "shape":"TypedAttributeValueRange", "documentation":"

The range of attribute values that are being selected.

" } }, "documentation":"

Identifies the range of attributes that are used by a specified filter.

" }, "TypedLinkAttributeRangeList":{ "type":"list", "member":{"shape":"TypedLinkAttributeRange"} }, "TypedLinkFacet":{ "type":"structure", "required":[ "Name", "Attributes", "IdentityAttributeOrder" ], "members":{ "Name":{ "shape":"TypedLinkName", "documentation":"

The unique name of the typed link facet.

" }, "Attributes":{ "shape":"TypedLinkAttributeDefinitionList", "documentation":"

A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

" }, "IdentityAttributeOrder":{ "shape":"AttributeNameList", "documentation":"

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

" } }, "documentation":"

Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.

" }, "TypedLinkFacetAttributeUpdate":{ "type":"structure", "required":[ "Attribute", "Action" ], "members":{ "Attribute":{ "shape":"TypedLinkAttributeDefinition", "documentation":"

The attribute to update.

" }, "Action":{ "shape":"UpdateActionType", "documentation":"

The action to perform when updating the attribute.

" } }, "documentation":"

A typed link facet attribute update.

" }, "TypedLinkFacetAttributeUpdateList":{ "type":"list", "member":{"shape":"TypedLinkFacetAttributeUpdate"} }, "TypedLinkName":{ "type":"string", "pattern":"^[a-zA-Z0-9._-]*$" }, "TypedLinkNameList":{ "type":"list", "member":{"shape":"TypedLinkName"} }, "TypedLinkSchemaAndFacetName":{ "type":"structure", "required":[ "SchemaArn", "TypedLinkName" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

" }, "TypedLinkName":{ "shape":"TypedLinkName", "documentation":"

The unique name of the typed link facet.

" } }, "documentation":"

Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.

" }, "TypedLinkSpecifier":{ "type":"structure", "required":[ "TypedLinkFacet", "SourceObjectReference", "TargetObjectReference", "IdentityAttributeValues" ], "members":{ "TypedLinkFacet":{ "shape":"TypedLinkSchemaAndFacetName", "documentation":"

Identifies the typed link facet that is associated with the typed link.

" }, "SourceObjectReference":{ "shape":"ObjectReference", "documentation":"

Identifies the source object that the typed link will attach to.

" }, "TargetObjectReference":{ "shape":"ObjectReference", "documentation":"

Identifies the target object that the typed link will attach to.

" }, "IdentityAttributeValues":{ "shape":"AttributeNameAndValueList", "documentation":"

Identifies the attribute value to update.

" } }, "documentation":"

Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The AttachTypedLink API returns a typed link specifier while the DetachTypedLink API accepts one as input. Similarly, the ListIncomingTypedLinks and ListOutgoingTypedLinks API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.

" }, "TypedLinkSpecifierList":{ "type":"list", "member":{"shape":"TypedLinkSpecifier"} }, "UnsupportedIndexTypeException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that the requested index type is not supported.

", "error":{"httpStatusCode":400}, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

Keys of the tag that need to be removed from the resource.

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateActionType":{ "type":"string", "enum":[ "CREATE_OR_UPDATE", "DELETE" ] }, "UpdateFacetRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"FacetName", "documentation":"

The name of the facet.

" }, "AttributeUpdates":{ "shape":"FacetAttributeUpdateList", "documentation":"

List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

" }, "ObjectType":{ "shape":"ObjectType", "documentation":"

The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

" } } }, "UpdateFacetResponse":{ "type":"structure", "members":{ } }, "UpdateLinkAttributesRequest":{ "type":"structure", "required":[ "DirectoryArn", "TypedLinkSpecifier", "AttributeUpdates" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see arns or Typed link.

", "location":"header", "locationName":"x-amz-data-partition" }, "TypedLinkSpecifier":{ "shape":"TypedLinkSpecifier", "documentation":"

Allows a typed link specifier to be accepted as input.

" }, "AttributeUpdates":{ "shape":"LinkAttributeUpdateList", "documentation":"

The attributes update structure.

" } } }, "UpdateLinkAttributesResponse":{ "type":"structure", "members":{ } }, "UpdateObjectAttributesRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference", "AttributeUpdates" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

The reference that identifies the object.

" }, "AttributeUpdates":{ "shape":"ObjectAttributeUpdateList", "documentation":"

The attributes update structure.

" } } }, "UpdateObjectAttributesResponse":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the updated object.

" } } }, "UpdateSchemaRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"SchemaName", "documentation":"

The name of the schema.

" } } }, "UpdateSchemaResponse":{ "type":"structure", "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN that is associated with the updated schema. For more information, see arns.

" } } }, "UpdateTypedLinkFacetRequest":{ "type":"structure", "required":[ "SchemaArn", "Name", "AttributeUpdates", "IdentityAttributeOrder" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"TypedLinkName", "documentation":"

The unique name of the typed link facet.

" }, "AttributeUpdates":{ "shape":"TypedLinkFacetAttributeUpdateList", "documentation":"

Attributes update structure.

" }, "IdentityAttributeOrder":{ "shape":"AttributeNameList", "documentation":"

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed link.

" } } }, "UpdateTypedLinkFacetResponse":{ "type":"structure", "members":{ } }, "UpgradeAppliedSchemaRequest":{ "type":"structure", "required":[ "PublishedSchemaArn", "DirectoryArn" ], "members":{ "PublishedSchemaArn":{ "shape":"Arn", "documentation":"

The revision of the published schema to upgrade the directory to.

" }, "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN for the directory to which the upgraded schema will be applied.

" }, "DryRun":{ "shape":"Bool", "documentation":"

Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

" } } }, "UpgradeAppliedSchemaResponse":{ "type":"structure", "members":{ "UpgradedSchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the upgraded schema that is returned as part of the response.

" }, "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory that is returned as part of the response.

" } } }, "UpgradePublishedSchemaRequest":{ "type":"structure", "required":[ "DevelopmentSchemaArn", "PublishedSchemaArn", "MinorVersion" ], "members":{ "DevelopmentSchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the development schema with the changes used for the upgrade.

" }, "PublishedSchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the published schema to be upgraded.

" }, "MinorVersion":{ "shape":"Version", "documentation":"

Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

" }, "DryRun":{ "shape":"Bool", "documentation":"

Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.

" } } }, "UpgradePublishedSchemaResponse":{ "type":"structure", "members":{ "UpgradedSchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the upgraded schema that is returned as part of the response.

" } } }, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that your request is malformed in some manner. See the exception message.

", "error":{"httpStatusCode":400}, "exception":true }, "Version":{ "type":"string", "max":10, "min":1, "pattern":"^[a-zA-Z0-9._-]*$" } }, "documentation":"Amazon Cloud Directory

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 programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

" }