"documentation":"<p>Copies the input published schema, at the specified version, into the <a>Directory</a> with the same name and version as that of the published schema.</p>"
"documentation":"<p>Attaches an existing object to another object. An object can be accessed in two ways:</p> <ol> <li> <p>Using the path</p> </li> <li> <p>Using <code>ObjectIdentifier</code> </p> </li> </ol>"
"documentation":"<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Creates a <a>Directory</a> by copying the published schema into the directory. A directory cannot be created without a schema.</p>"
"documentation":"<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>"
"documentation":"<p>Creates an object in a <a>Directory</a>. Additionally attaches the object to a parent, if a parent reference and <code>LinkName</code> is specified. An object is simply a collection of <a>Facet</a> attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet. </p>"
"documentation":"<p>Creates a new schema in a development state. A schema can exist in three phases:</p> <ul> <li> <p> <i>Development:</i> This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.</p> </li> <li> <p> <i>Published:</i> Published schemas are immutable and have a version associated with them.</p> </li> <li> <p> <i>Applied:</i> Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories. </p> </li> </ul>"
"documentation":"<p>Creates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.</p>"
"documentation":"<p>Deletes a given <a>Facet</a>. All attributes and <a>Rule</a>s that are associated with the facet will be deleted. Only development schema facets are allowed deletion.</p>"
"documentation":"<p>Deletes a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.</p>"
"documentation":"<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.</p>"
"documentation":"<p>Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.</p>"
"documentation":"<p>Gets details of the <a>Facet</a>, such as facet name, attributes, <a>Rule</a>s, or <code>ObjectType</code>. You can call this on all kinds of schema facets -- published, development, or applied.</p>"
"documentation":"<p>Retrieves a JSON representation of the schema. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>"
"documentation":"<p>Returns the identity attribute order for a specific <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p> <p>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 <code>MaxResults</code>, 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.</p>"
"documentation":"<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Lists the major version families of each published schema. If a major version ARN is provided as <code>SchemaArn</code>, the minor version revisions in that family are listed instead.</p>"
"documentation":"<p>Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.</p>"
"documentation":"<p>Returns a paginated list of all attribute definitions for a particular <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Returns a paginated list of <code>TypedLink</code> facet names for a particular schema. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
"documentation":"<p>Allows a schema to be updated using JSON upload. Only available for development schemas. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>"
"documentation":"<p>Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its <code>IdentityAttributeOrder</code>.</p>"
"documentation":"<p>Updates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Upgrades a single directory in-place using the <code>PublishedSchemaArn</code> with schema updates found in <code>MinorVersion</code>. 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.</p>"
"documentation":"<p>Upgrades a published schema under a new minor version revision using the current contents of <code>DevelopmentSchemaArn</code>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> into which the schema is copied. For more information, see <a>arns</a>.</p>",
"documentation":"<p>The applied schema ARN that is associated with the copied schema in the <a>Directory</a>. You can use this ARN to describe the schema information applied on this directory. For more information, see <a>arns</a>.</p>"
"documentation":"<p>Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
"documentation":"<p>Represents the output batch <a>AttachObject</a> response operation.</p>"
},
"BatchAttachPolicy":{
"type":"structure",
"required":[
"PolicyReference",
"ObjectReference"
],
"members":{
"PolicyReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that is associated with the policy object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object to which the policy will be attached.</p>"
}
},
"documentation":"<p>Attaches a policy object to a regular object inside a <a>BatchRead</a> operation.For more information, see <a>AttachPolicy</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchAttachPolicyResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>Represents the output of an <a>AttachPolicy</a> response operation.</p>"
},
"BatchAttachToIndex":{
"type":"structure",
"required":[
"IndexReference",
"TargetReference"
],
"members":{
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the index that you are attaching the object to.</p>"
},
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object that you are attaching to the index.</p>"
}
},
"documentation":"<p>Attaches the specified object to the specified index inside a <a>BatchRead</a> operation. For more information, see <a>AttachToIndex</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchAttachToIndexResponse":{
"type":"structure",
"members":{
"AttachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the object that was attached to the index.</p>"
}
},
"documentation":"<p>Represents the output of a <a>AttachToIndex</a> response operation.</p>"
},
"BatchAttachTypedLink":{
"type":"structure",
"required":[
"SourceObjectReference",
"TargetObjectReference",
"TypedLinkFacet",
"Attributes"
],
"members":{
"SourceObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Identifies the source object that the typed link will attach to.</p>"
},
"TargetObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Identifies the target object that the typed link will attach to.</p>"
},
"TypedLinkFacet":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>Identifies the typed link facet that is associated with the typed link.</p>"
},
"Attributes":{
"shape":"AttributeNameAndValueList",
"documentation":"<p>A set of attributes that are associated with the typed link.</p>"
}
},
"documentation":"<p>Attaches a typed link to a specified source and target object inside a <a>BatchRead</a> operation. For more information, see <a>AttachTypedLink</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchAttachTypedLinkResponse":{
"type":"structure",
"members":{
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Returns a typed link specifier as output.</p>"
}
},
"documentation":"<p>Represents the output of a <a>AttachTypedLink</a> response operation.</p>"
},
"BatchCreateIndex":{
"type":"structure",
"required":[
"OrderedIndexedAttributeList",
"IsUnique"
],
"members":{
"OrderedIndexedAttributeList":{
"shape":"AttributeKeyList",
"documentation":"<p>Specifies the attributes that should be indexed on. Currently only a single attribute is supported.</p>"
},
"IsUnique":{
"shape":"Bool",
"documentation":"<p>Indicates whether the attribute that is being indexed has unique values or not.</p>"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the parent object that contains the index object.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link between the parent object and the index object.</p>"
},
"BatchReferenceName":{
"shape":"BatchReferenceName",
"documentation":"<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
}
},
"documentation":"<p>Creates an index object inside of a <a>BatchRead</a> operation. For more information, see <a>CreateIndex</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchCreateIndexResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the index created by this operation.</p>"
}
},
"documentation":"<p>Represents the output of a <a>CreateIndex</a> response operation.</p>"
"documentation":"<p>If specified, the parent reference to which this object will be attached.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link.</p>"
},
"BatchReferenceName":{
"shape":"BatchReferenceName",
"documentation":"<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
"documentation":"<p>Represents the output of a <a>DeleteObject</a> response operation.</p>"
},
"BatchDetachFromIndex":{
"type":"structure",
"required":[
"IndexReference",
"TargetReference"
],
"members":{
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the index object.</p>"
},
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object being detached from the index.</p>"
}
},
"documentation":"<p>Detaches the specified object from the specified index inside a <a>BatchRead</a> operation. For more information, see <a>DetachFromIndex</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchDetachFromIndexResponse":{
"type":"structure",
"members":{
"DetachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the object that was detached from the index.</p>"
}
},
"documentation":"<p>Represents the output of a <a>DetachFromIndex</a> response operation.</p>"
"documentation":"<p>Parent reference from which the object with the specified link name is detached.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link.</p>"
},
"BatchReferenceName":{
"shape":"BatchReferenceName",
"documentation":"<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
"documentation":"<p>Detaches the specified policy from the specified directory inside a <a>BatchWrite</a> operation. For more information, see <a>DetachPolicy</a> and <a>BatchWriteRequest$Operations</a>.</p>"
"documentation":"<p>Represents the output of a <a>DetachPolicy</a> response operation.</p>"
},
"BatchDetachTypedLink":{
"type":"structure",
"required":["TypedLinkSpecifier"],
"members":{
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Used to accept a typed link specifier as input.</p>"
}
},
"documentation":"<p>Detaches a typed link from a specified source and target object inside a <a>BatchRead</a> operation. For more information, see <a>DetachTypedLink</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchDetachTypedLinkResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>Represents the output of a <a>DetachTypedLink</a> response operation.</p>"
"documentation":"<p>Allows a typed link specifier to be accepted as input.</p>"
},
"AttributeNames":{
"shape":"AttributeNameList",
"documentation":"<p>A list of attribute names whose values will be retrieved.</p>"
}
},
"documentation":"<p>Retrieves attributes that are associated with a typed link inside a <a>BatchRead</a> operation. For more information, see <a>GetLinkAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchGetLinkAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attributes that are associated with the typed link.</p>"
}
},
"documentation":"<p>Represents the output of a <a>GetLinkAttributes</a> response operation.</p>"
"documentation":"<p>Reference that identifies the object whose attributes will be retrieved.</p>"
},
"SchemaFacet":{
"shape":"SchemaFacet",
"documentation":"<p>Identifier for the facet whose attributes will be retrieved. See <a>SchemaFacet</a> for details.</p>"
},
"AttributeNames":{
"shape":"AttributeNameList",
"documentation":"<p>List of attribute names whose values will be retrieved.</p>"
}
},
"documentation":"<p>Retrieves attributes within a facet that are associated with an object inside an <a>BatchRead</a> operation. For more information, see <a>GetObjectAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchGetObjectAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attribute values that are associated with an object.</p>"
}
},
"documentation":"<p>Represents the output of a <a>GetObjectAttributes</a> response operation.</p>"
"documentation":"<p>A reference to the object.</p>"
}
},
"documentation":"<p>Retrieves metadata about an object inside a <a>BatchRead</a> operation. For more information, see <a>GetObjectInformation</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchGetObjectInformationResponse":{
"type":"structure",
"members":{
"SchemaFacets":{
"shape":"SchemaFacetList",
"documentation":"<p>The facets attached to the specified object.</p>"
},
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the specified object.</p>"
}
},
"documentation":"<p>Represents the output of a <a>GetObjectInformation</a> response operation.</p>"
},
"BatchListAttachedIndices":{
"type":"structure",
"required":["TargetReference"],
"members":{
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object that has indices attached.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Lists indices attached to an object inside a <a>BatchRead</a> operation. For more information, see <a>ListAttachedIndices</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListAttachedIndicesResponse":{
"type":"structure",
"members":{
"IndexAttachments":{
"shape":"IndexAttachmentList",
"documentation":"<p>The indices attached to the specified object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListAttachedIndices</a> response operation.</p>"
},
"BatchListIncomingTypedLinks":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object whose attributes will be listed.</p>"
},
"FilterAttributeRanges":{
"shape":"TypedLinkAttributeRangeList",
"documentation":"<p>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.</p>"
},
"FilterTypedLink":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>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.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object inside a <a>BatchRead</a> operation. For more information, see <a>ListIncomingTypedLinks</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListIncomingTypedLinksResponse":{
"type":"structure",
"members":{
"LinkSpecifiers":{
"shape":"TypedLinkSpecifierList",
"documentation":"<p>Returns one or more typed link specifiers as output.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListIncomingTypedLinks</a> response operation.</p>"
},
"BatchListIndex":{
"type":"structure",
"required":["IndexReference"],
"members":{
"RangesOnIndexedValues":{
"shape":"ObjectAttributeRangeList",
"documentation":"<p>Specifies the ranges of indexed values that you want to query.</p>"
},
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference to the index to list.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Lists objects attached to the specified index inside a <a>BatchRead</a> operation. For more information, see <a>ListIndex</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListIndexResponse":{
"type":"structure",
"members":{
"IndexAttachments":{
"shape":"IndexAttachmentList",
"documentation":"<p>The objects and indexed values attached to the index.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListIndex</a> response operation.</p>"
"documentation":"<p>The children structure, which is a map with the key as the <code>LinkName</code> and <code>ObjectIdentifier</code> as the value.</p>"
"documentation":"<p>Represents the output of a <a>ListObjectChildren</a> response operation.</p>"
},
"BatchListObjectParentPaths":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object whose attributes will be listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a <a>BatchRead</a> operation. For more information, see <a>ListObjectParentPaths</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListObjectParentPathsResponse":{
"type":"structure",
"members":{
"PathToObjectIdentifiersList":{
"shape":"PathToObjectIdentifiersList",
"documentation":"<p>Returns the path to the <code>ObjectIdentifiers</code> that are associated with the directory.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListObjectParentPaths</a> response operation.</p>"
},
"BatchListObjectPolicies":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object whose attributes will be listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Returns policies attached to an object in pagination fashion inside a <a>BatchRead</a> operation. For more information, see <a>ListObjectPolicies</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListObjectPoliciesResponse":{
"type":"structure",
"members":{
"AttachedPolicyIds":{
"shape":"ObjectIdentifierList",
"documentation":"<p>A list of policy <code>ObjectIdentifiers</code>, that are attached to the object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListObjectPolicies</a> response operation.</p>"
},
"BatchListOutgoingTypedLinks":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object whose attributes will be listed.</p>"
},
"FilterAttributeRanges":{
"shape":"TypedLinkAttributeRangeList",
"documentation":"<p>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.</p>"
},
"FilterTypedLink":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>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.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object inside a <a>BatchRead</a> operation. For more information, see <a>ListOutgoingTypedLinks</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListOutgoingTypedLinksResponse":{
"type":"structure",
"members":{
"TypedLinkSpecifiers":{
"shape":"TypedLinkSpecifierList",
"documentation":"<p>Returns a typed link specifier as output.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListOutgoingTypedLinks</a> response operation.</p>"
},
"BatchListPolicyAttachments":{
"type":"structure",
"required":["PolicyReference"],
"members":{
"PolicyReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the policy object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached inside a <a>BatchRead</a> operation. For more information, see <a>ListPolicyAttachments</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListPolicyAttachmentsResponse":{
"type":"structure",
"members":{
"ObjectIdentifiers":{
"shape":"ObjectIdentifierList",
"documentation":"<p>A list of <code>ObjectIdentifiers</code> to which the policy is attached.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListPolicyAttachments</a> response operation.</p>"
},
"BatchLookupPolicy":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose policies will be looked up.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Lists all policies from the root of the Directory to the object specified inside a <a>BatchRead</a> operation. For more information, see <a>LookupPolicy</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchLookupPolicyResponse":{
"type":"structure",
"members":{
"PolicyToPathList":{
"shape":"PolicyToPathList",
"documentation":"<p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and <code>PolicyType</code>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>LookupPolicy</a> response operation.</p>"
"documentation":"<p>Lists indices attached to an object.</p>"
},
"ListObjectParentPaths":{
"shape":"BatchListObjectParentPaths",
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p>"
},
"GetObjectInformation":{
"shape":"BatchGetObjectInformation",
"documentation":"<p>Retrieves metadata about an object.</p>"
"documentation":"<p>Returns policies attached to an object in pagination fashion.</p>"
},
"ListPolicyAttachments":{
"shape":"BatchListPolicyAttachments",
"documentation":"<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>"
},
"LookupPolicy":{
"shape":"BatchLookupPolicy",
"documentation":"<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
},
"ListIndex":{
"shape":"BatchListIndex",
"documentation":"<p>Lists objects attached to the specified index.</p>"
},
"ListOutgoingTypedLinks":{
"shape":"BatchListOutgoingTypedLinks",
"documentation":"<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"ListIncomingTypedLinks":{
"shape":"BatchListIncomingTypedLinks",
"documentation":"<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"documentation":"<p>Lists indices attached to an object.</p>"
},
"ListObjectParentPaths":{
"shape":"BatchListObjectParentPathsResponse",
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p>"
},
"ListObjectPolicies":{
"shape":"BatchListObjectPoliciesResponse",
"documentation":"<p>Returns policies attached to an object in pagination fashion.</p>"
},
"ListPolicyAttachments":{
"shape":"BatchListPolicyAttachmentsResponse",
"documentation":"<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>"
},
"LookupPolicy":{
"shape":"BatchLookupPolicyResponse",
"documentation":"<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
},
"ListIndex":{
"shape":"BatchListIndexResponse",
"documentation":"<p>Lists objects attached to the specified index.</p>"
},
"ListOutgoingTypedLinks":{
"shape":"BatchListOutgoingTypedLinksResponse",
"documentation":"<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"ListIncomingTypedLinks":{
"shape":"BatchListIncomingTypedLinksResponse",
"documentation":"<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Updates a given typed link’s attributes inside a <a>BatchRead</a> operation. Attributes to be updated must not contribute to the typed link’s identity, as defined by its <code>IdentityAttributeOrder</code>. For more information, see <a>UpdateLinkAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchUpdateLinkAttributesResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>Represents the output of a <a>UpdateLinkAttributes</a> response operation.</p>"
"documentation":"<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>"
},
"DetachPolicy":{
"shape":"BatchDetachPolicy",
"documentation":"<p>Detaches a policy from a <a>Directory</a>.</p>"
},
"CreateIndex":{
"shape":"BatchCreateIndex",
"documentation":"<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>"
},
"AttachToIndex":{
"shape":"BatchAttachToIndex",
"documentation":"<p>Attaches the specified object to the specified index.</p>"
},
"DetachFromIndex":{
"shape":"BatchDetachFromIndex",
"documentation":"<p>Detaches the specified object from the specified index.</p>"
},
"AttachTypedLink":{
"shape":"BatchAttachTypedLink",
"documentation":"<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"DetachTypedLink":{
"shape":"BatchDetachTypedLink",
"documentation":"<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>"
},
"DetachPolicy":{
"shape":"BatchDetachPolicyResponse",
"documentation":"<p>Detaches a policy from a <a>Directory</a>.</p>"
},
"CreateIndex":{
"shape":"BatchCreateIndexResponse",
"documentation":"<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>"
},
"AttachToIndex":{
"shape":"BatchAttachToIndexResponse",
"documentation":"<p>Attaches the specified object to the specified index.</p>"
},
"DetachFromIndex":{
"shape":"BatchDetachFromIndexResponse",
"documentation":"<p>Detaches the specified object from the specified index.</p>"
},
"AttachTypedLink":{
"shape":"BatchAttachTypedLinkResponse",
"documentation":"<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"DetachTypedLink":{
"shape":"BatchDetachTypedLinkResponse",
"documentation":"<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the published schema that will be copied into the data <a>Directory</a>. For more information, see <a>arns</a>.</p>",
"documentation":"<p>The ARN of the published schema in the <a>Directory</a>. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see <a>arns</a>.</p>"
"documentation":"<p>Specifies whether a given object created from this facet is of type node, leaf node, policy or index.</p> <ul> <li> <p>Node: Can have multiple children but one parent.</p> </li> </ul> <ul> <li> <p>Leaf node: Cannot have children but can have multiple parents.</p> </li> </ul> <ul> <li> <p>Policy: Allows you to store a policy document and policy type. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p> </li> </ul> <ul> <li> <p>Index: Can be created with the Index API.</p> </li> </ul>"
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> in which the object will be created. For more information, see <a>arns</a>.</p>",
"documentation":"<p>A list of schema facets to be associated with the object. Do not provide minor version components. See <a>SchemaFacet</a> for details.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
"documentation":"<p>A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.</p>",
"documentation":"<p>A structure that contains <code>Name</code>, <code>ARN</code>, <code>Attributes</code>, <code> <a>Rule</a>s</code>, and <code>ObjectTypes</code>. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/whatarefacets.html\">Facets</a> for more information.</p>"
"documentation":"<p>A facet with the same name already exists.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"FacetAttribute":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"AttributeName",
"documentation":"<p>The name of the facet attribute.</p>"
},
"AttributeDefinition":{
"shape":"FacetAttributeDefinition",
"documentation":"<p>A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
"documentation":"<p>An attribute reference that is associated with the attribute. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
"documentation":"<p>The type of the attribute.</p>"
},
"DefaultValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The default value of the attribute (if configured).</p>"
},
"IsImmutable":{
"shape":"Bool",
"documentation":"<p>Whether the attribute is mutable or not.</p>"
},
"Rules":{
"shape":"RuleMap",
"documentation":"<p>Validation rules attached to the attribute definition.</p>"
}
},
"documentation":"<p>A facet attribute definition. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
"documentation":"<p>The target facet name that is associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
"documentation":"<p>The target attribute name that is associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
"documentation":"<p>The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see <a>arns</a> or <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Allows a typed link specifier to be accepted as input.</p>"
},
"AttributeNames":{
"shape":"AttributeNameList",
"documentation":"<p>A list of attribute names whose values will be retrieved.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level at which to retrieve the attributes on a typed link.</p>"
}
}
},
"GetLinkAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attributes that are associated with the typed link.</p>"
"documentation":"<p>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 <a>GetAppliedSchemaVersion</a> for details.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"TypedLinkName",
"documentation":"<p>The unique name of the typed link facet.</p>"
}
}
},
"GetTypedLinkFacetInformationResponse":{
"type":"structure",
"members":{
"IdentityAttributeOrder":{
"shape":"AttributeNameList",
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>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.</p>",
"documentation":"<p>In response to <a>ListIndex</a>, the <code>ObjectIdentifier</code> of the object attached to the index. In response to <a>ListAttachedIndices</a>, the <code>ObjectIdentifier</code> of the index attached to the object. This field will always contain the <code>ObjectIdentifier</code> of the object on the opposite side of the attachment specified in the query.</p>"
"documentation":"<p>Represents an index and an attached object.</p>"
},
"IndexAttachmentList":{
"type":"list",
"member":{"shape":"IndexAttachment"}
},
"IndexedAttributeMissingException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>An object has been attempted to be attached to an object that does not have the appropriate attribute value.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InternalServiceException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the <a href=\"http://status.aws.amazon.com/\">AWS Service Health Dashboard</a> site to see if there are any operational issues with the service.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
"InvalidArnException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the provided ARN value is not valid.</p>",
"documentation":"<p>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.</p>",
"documentation":"<p>Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.</p>",
"documentation":"<p>Indicates that limits are exceeded. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html\">Limits</a> for more information.</p>",
"documentation":"<p>A type that can be either <code>UPDATE_OR_CREATE</code> or <code>DELETE</code>.</p>"
},
"AttributeUpdateValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The value that you want to update to.</p>"
}
},
"documentation":"<p>The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.</p>"
},
"LinkAttributeUpdate":{
"type":"structure",
"members":{
"AttributeKey":{
"shape":"AttributeKey",
"documentation":"<p>The key of the attribute being updated.</p>"
},
"AttributeAction":{
"shape":"LinkAttributeAction",
"documentation":"<p>The action to perform as part of the attribute update.</p>"
}
},
"documentation":"<p>Structure that contains attribute update information.</p>"
"documentation":"<p>The response for <code>ListAppliedSchemaArns</code> when this parameter is used will list all minor version ARNs for a major version.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where you want to list the typed links.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose attributes will be listed.</p>"
},
"FilterAttributeRanges":{
"shape":"TypedLinkAttributeRangeList",
"documentation":"<p>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.</p>"
},
"FilterTypedLink":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>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.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level to execute the request at.</p>"
}
}
},
"ListIncomingTypedLinksResponse":{
"type":"structure",
"members":{
"LinkSpecifiers":{
"shape":"TypedLinkSpecifierList",
"documentation":"<p>Returns one or more typed link specifiers as output.</p>"
"documentation":"<p>The maximum number of objects in a single page to retrieve from the index during a request. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html#limits_cd\">AWS Directory Service Limits</a>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"documentation":"<p>A list of policy <code>ObjectIdentifiers</code>, that are attached to the object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListOutgoingTypedLinksRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where you want to list the typed links.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference that identifies the object whose attributes will be listed.</p>"
},
"FilterAttributeRanges":{
"shape":"TypedLinkAttributeRangeList",
"documentation":"<p>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.</p>"
},
"FilterTypedLink":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>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.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"documentation":"<p>The response for <code>ListPublishedSchemaArns</code> when this parameter is used will list all minor version ARNs for a major version.</p>"
"documentation":"<p>The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.</p>"
"documentation":"<p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and <code>PolicyType</code>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
"documentation":"<p>Occurs when any invalid operations are performed on an object that is not a node, such as calling <code>ListObjectChildren</code> for a leaf node object.</p>",
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#accessingobjects\">Accessing Objects</a>. You can identify an object in one of the following ways:</p> <ul> <li> <p> <i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier</p> </li> <li> <p> <i>/some/path</i> - Identifies the object based on path</p> </li> <li> <p> <i>#SomeBatchReference</i> - Identifies the object in a batch call</p> </li> </ul>"
"documentation":"<p>Contains the <code>PolicyType</code>, <code>PolicyId</code>, and the <code>ObjectIdentifier</code> to which it is attached. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
"documentation":"<p>Used when a regular object exists in a <a>Directory</a> and you want to find all of the policies that are associated with that object and the parent to that object.</p>"
"documentation":"<p>The major version under which the schema will be published. Schemas have both a major and minor version associated with them.</p>"
},
"MinorVersion":{
"shape":"Version",
"documentation":"<p>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.</p>"
"documentation":"<p>A reference to the object to remove the facet from.</p>"
}
}
},
"RemoveFacetFromObjectResponse":{
"type":"structure",
"members":{
}
},
"RequiredAttributeBehavior":{
"type":"string",
"enum":[
"REQUIRED_ALWAYS",
"NOT_REQUIRED"
]
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified resource could not be found.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"RetryableConflictException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"Rule":{
"type":"structure",
"members":{
"Type":{
"shape":"RuleType",
"documentation":"<p>The type of attribute validation rule.</p>"
"documentation":"<p>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/inplaceschemaupgrade.html\">In-Place Schema Upgrade</a> for a description of when to provide minor versions.</p>"
"documentation":"<p>Represents the data for a typed attribute. You can set one, and only one, of the elements. Each attribute in an item is a name-value pair. Attributes have a single value.</p>"
"documentation":"<p>A range of attribute values. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#rangefilters\">Range Filters</a>.</p>"
"documentation":"<p>The unique name of the typed link attribute.</p>"
},
"Type":{
"shape":"FacetAttributeType",
"documentation":"<p>The type of the attribute.</p>"
},
"DefaultValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The default value of the attribute (if configured).</p>"
},
"IsImmutable":{
"shape":"Bool",
"documentation":"<p>Whether the attribute is mutable or not.</p>"
},
"Rules":{
"shape":"RuleMap",
"documentation":"<p>Validation rules that are attached to the attribute definition.</p>"
},
"RequiredBehavior":{
"shape":"RequiredAttributeBehavior",
"documentation":"<p>The required behavior of the <code>TypedLinkAttributeDefinition</code>.</p>"
}
},
"documentation":"<p>A typed link attribute definition.</p>"
},
"TypedLinkAttributeDefinitionList":{
"type":"list",
"member":{"shape":"TypedLinkAttributeDefinition"}
},
"TypedLinkAttributeRange":{
"type":"structure",
"required":["Range"],
"members":{
"AttributeName":{
"shape":"AttributeName",
"documentation":"<p>The unique name of the typed link attribute.</p>"
},
"Range":{
"shape":"TypedAttributeValueRange",
"documentation":"<p>The range of attribute values that are being selected.</p>"
}
},
"documentation":"<p>Identifies the range of attributes that are used by a specified filter.</p>"
},
"TypedLinkAttributeRangeList":{
"type":"list",
"member":{"shape":"TypedLinkAttributeRange"}
},
"TypedLinkFacet":{
"type":"structure",
"required":[
"Name",
"Attributes",
"IdentityAttributeOrder"
],
"members":{
"Name":{
"shape":"TypedLinkName",
"documentation":"<p>The unique name of the typed link facet.</p>"
},
"Attributes":{
"shape":"TypedLinkAttributeDefinitionList",
"documentation":"<p>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.</p>"
"documentation":"<p>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 <a>ListOutgoingTypedLinks</a> and <a>ListIncomingTypedLinks</a> for details.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>"
},
"TypedLinkName":{
"shape":"TypedLinkName",
"documentation":"<p>The unique name of the typed link facet.</p>"
}
},
"documentation":"<p>Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.</p>"
},
"TypedLinkSpecifier":{
"type":"structure",
"required":[
"TypedLinkFacet",
"SourceObjectReference",
"TargetObjectReference",
"IdentityAttributeValues"
],
"members":{
"TypedLinkFacet":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>Identifies the typed link facet that is associated with the typed link.</p>"
},
"SourceObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Identifies the source object that the typed link will attach to.</p>"
},
"TargetObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Identifies the target object that the typed link will attach to.</p>"
},
"IdentityAttributeValues":{
"shape":"AttributeNameAndValueList",
"documentation":"<p>Identifies the attribute value to update.</p>"
}
},
"documentation":"<p>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 <a>AttachTypedLink</a> API returns a typed link specifier while the <a>DetachTypedLink</a> API accepts one as input. Similarly, the <a>ListIncomingTypedLinks</a> and <a>ListOutgoingTypedLinks</a> API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.</p>"
"documentation":"<p>List of attributes that need to be updated in a given schema <a>Facet</a>. Each attribute is followed by <code>AttributeAction</code>, which specifies the type of update operation to perform. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see <a>arns</a> or <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Allows a typed link specifier to be accepted as input.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"documentation":"<p>The revision of the published schema to upgrade the directory to.</p>"
},
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the directory to which the upgraded schema will be applied.</p>"
},
"DryRun":{
"shape":"Bool",
"documentation":"<p>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.</p>"
}
}
},
"UpgradeAppliedSchemaResponse":{
"type":"structure",
"members":{
"UpgradedSchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the upgraded schema that is returned as part of the response.</p>"
},
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory that is returned as part of the response.</p>"
}
}
},
"UpgradePublishedSchemaRequest":{
"type":"structure",
"required":[
"DevelopmentSchemaArn",
"PublishedSchemaArn",
"MinorVersion"
],
"members":{
"DevelopmentSchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the development schema with the changes used for the upgrade.</p>"
},
"PublishedSchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the published schema to be upgraded.</p>"
},
"MinorVersion":{
"shape":"Version",
"documentation":"<p>Identifies the minor version of the published schema that will be created. This parameter is NOT optional.</p>"
},
"DryRun":{
"shape":"Bool",
"documentation":"<p>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.</p>"
}
}
},
"UpgradePublishedSchemaResponse":{
"type":"structure",
"members":{
"UpgradedSchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the upgraded schema that is returned as part of the response.</p>"
"documentation":"<fullname>Amazon Cloud Directory</fullname> <p>Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see <a href=\"https://aws.amazon.com/directoryservice/\">AWS Directory Service</a> and the <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html\">AWS Directory Service Administration Guide</a>.</p>"