{
"version": "2.0",
"service": "
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.
", "operations": { "AddFacetToObject": "Adds a new Facet to an object.
", "ApplySchema": "Copies the input published schema into the Directory with the same name and version as that of the published schema .
", "AttachObject": "Attaches an existing object to another object. An object can be accessed in two ways:
Using the path
Using ObjectIdentifier
Attaches a policy object to a regular object. An object can have a limited number of attached policies.
", "AttachToIndex": "Attaches the specified object to the specified index.
", "AttachTypedLink": "Attaches a typed link to a specified source and target object. For more information, see Typed link.
", "BatchRead": "Performs all the read operations in a batch.
", "BatchWrite": "Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.
", "CreateDirectory": "Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.
", "CreateFacet": "Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
", "CreateIndex": "Creates an index object. See Indexing for more information.
", "CreateObject": "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.
Creates a new schema in a development state. A schema can exist in three phases:
Development: 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.
Published: Published schemas are immutable and have a version associated with them.
Applied: 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.
Creates a TypedLinkFacet. For more information, see Typed link.
", "DeleteDirectory": "Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.
", "DeleteFacet": "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": "Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.
", "DeleteSchema": "Deletes a given schema. Schemas in a development and published state can only be deleted.
", "DeleteTypedLinkFacet": "Deletes a TypedLinkFacet. For more information, see Typed link.
", "DetachFromIndex": "Detaches the specified object from the specified index.
", "DetachObject": "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": "Detaches a policy from an object.
", "DetachTypedLink": "Detaches a typed link from a specified source and target object. For more information, see Typed link.
", "DisableDirectory": "Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.
", "EnableDirectory": "Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.
", "GetDirectory": "Retrieves metadata about a directory.
", "GetFacet": "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.
Retrieves metadata about an object.
", "GetSchemaAsJson": "Retrieves a JSON representation of the schema. See JSON Schema Format for more information.
", "GetTypedLinkFacetInformation": "Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed link.
", "ListAppliedSchemaArns": "Lists schemas applied to a directory.
", "ListAttachedIndices": "Lists indices attached to an object.
", "ListDevelopmentSchemaArns": "Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
", "ListDirectories": "Lists directories created within an account.
", "ListFacetAttributes": "Retrieves attributes attached to the facet.
", "ListFacetNames": "Retrieves the names of facets that exist in a schema.
", "ListIncomingTypedLinks": "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": "Lists objects attached to the specified index.
", "ListObjectAttributes": "Lists all attributes that are associated with an object.
", "ListObjectChildren": "Returns a paginated list of child objects that are associated with a given object.
", "ListObjectParentPaths": "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.
Lists parent objects that are associated with a given object in pagination fashion.
", "ListObjectPolicies": "Returns policies attached to an object in pagination fashion.
", "ListOutgoingTypedLinks": "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": "Returns all of the ObjectIdentifiers
to which a given policy is attached.
Retrieves each published schema Amazon Resource Name (ARN).
", "ListTagsForResource": "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": "Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed link.
", "ListTypedLinkFacetNames": "Returns a paginated list of TypedLink
facet names for a particular schema. For more information, see Typed link.
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.
Publishes a development schema with a version. If description and attributes are specified, PublishSchema
overrides the development schema description and attributes. If not, the development schema description and attributes are used.
Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.
", "RemoveFacetFromObject": "Removes the specified facet from the specified object.
", "TagResource": "An API operation for adding tags to a resource.
", "UntagResource": "An API operation for removing tags from a resource.
", "UpdateFacet": "Does the following:
Adds new Attributes
, Rules
, or ObjectTypes
.
Updates existing Attributes
, Rules
, or ObjectTypes
.
Deletes existing Attributes
, Rules
, or ObjectTypes
.
Updates a given object's attributes.
", "UpdateSchema": "Updates the schema name with a new name. Only development schema names can be updated.
", "UpdateTypedLinkFacet": "Updates a TypedLinkFacet. For more information, see Typed link.
" }, "shapes": { "AccessDeniedException": { "base": "Access denied. Check your permissions.
", "refs": { } }, "AddFacetToObjectRequest": { "base": null, "refs": { } }, "AddFacetToObjectResponse": { "base": null, "refs": { } }, "ApplySchemaRequest": { "base": null, "refs": { } }, "ApplySchemaResponse": { "base": null, "refs": { } }, "Arn": { "base": null, "refs": { "AddFacetToObjectRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.
", "ApplySchemaRequest$PublishedSchemaArn": "Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see arns.
", "ApplySchemaRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory into which the schema is copied. For more information, see arns.
", "ApplySchemaResponse$AppliedSchemaArn": "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.
", "ApplySchemaResponse$DirectoryArn": "The ARN that is associated with the Directory. For more information, see arns.
", "Arns$member": null, "AttachObjectRequest$DirectoryArn": "Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.
", "AttachPolicyRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.
", "AttachToIndexRequest$DirectoryArn": "The Amazon Resource Name (ARN) of the directory where the object and index exist.
", "AttachTypedLinkRequest$DirectoryArn": "The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.
", "AttributeKey$SchemaArn": "The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.
", "BatchReadRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.
", "BatchWriteRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.
", "CreateDirectoryRequest$SchemaArn": "The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.
", "CreateDirectoryResponse$AppliedSchemaArn": "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$SchemaArn": "The schema ARN in which the new Facet will be created. For more information, see arns.
", "CreateIndexRequest$DirectoryArn": "The ARN of the directory where the index should be created.
", "CreateObjectRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns.
", "CreateSchemaResponse$SchemaArn": "The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
", "CreateTypedLinkFacetRequest$SchemaArn": "The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
", "DeleteDirectoryRequest$DirectoryArn": "The ARN of the directory to delete.
", "DeleteDirectoryResponse$DirectoryArn": "The ARN of the deleted directory.
", "DeleteFacetRequest$SchemaArn": "The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.
", "DeleteObjectRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.
", "DeleteSchemaRequest$SchemaArn": "The Amazon Resource Name (ARN) of the development schema. For more information, see arns.
", "DeleteSchemaResponse$SchemaArn": "The input ARN that is returned as part of the response. For more information, see arns.
", "DeleteTypedLinkFacetRequest$SchemaArn": "The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
", "DetachFromIndexRequest$DirectoryArn": "The Amazon Resource Name (ARN) of the directory the index and object exist in.
", "DetachObjectRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.
", "DetachPolicyRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.
", "DetachTypedLinkRequest$DirectoryArn": "The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.
", "DisableDirectoryRequest$DirectoryArn": "The ARN of the directory to disable.
", "DisableDirectoryResponse$DirectoryArn": "The ARN of the directory that has been disabled.
", "EnableDirectoryRequest$DirectoryArn": "The ARN of the directory to enable.
", "EnableDirectoryResponse$DirectoryArn": "The ARN of the enabled directory.
", "GetFacetRequest$SchemaArn": "The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.
", "GetObjectInformationRequest$DirectoryArn": "The ARN of the directory being retrieved.
", "GetSchemaAsJsonRequest$SchemaArn": "The ARN of the schema to retrieve.
", "GetTypedLinkFacetInformationRequest$SchemaArn": "The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
", "ListAppliedSchemaArnsRequest$DirectoryArn": "The ARN of the directory you are listing.
", "ListAttachedIndicesRequest$DirectoryArn": "The ARN of the directory.
", "ListFacetAttributesRequest$SchemaArn": "The ARN of the schema where the facet resides.
", "ListFacetNamesRequest$SchemaArn": "The Amazon Resource Name (ARN) to retrieve facet names from.
", "ListIncomingTypedLinksRequest$DirectoryArn": "The Amazon Resource Name (ARN) of the directory where you want to list the typed links.
", "ListIndexRequest$DirectoryArn": "The ARN of the directory that the index exists in.
", "ListObjectAttributesRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.
", "ListObjectChildrenRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.
", "ListObjectParentPathsRequest$DirectoryArn": "The ARN of the directory to which the parent path applies.
", "ListObjectParentsRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.
", "ListObjectPoliciesRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.
", "ListOutgoingTypedLinksRequest$DirectoryArn": "The Amazon Resource Name (ARN) of the directory where you want to list the typed links.
", "ListPolicyAttachmentsRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.
", "ListTagsForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.
", "ListTypedLinkFacetAttributesRequest$SchemaArn": "The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
", "ListTypedLinkFacetNamesRequest$SchemaArn": "The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
", "LookupPolicyRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.
", "PublishSchemaRequest$DevelopmentSchemaArn": "The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see arns.
", "PublishSchemaResponse$PublishedSchemaArn": "The ARN that is associated with the published schema. For more information, see arns.
", "PutSchemaFromJsonRequest$SchemaArn": "The ARN of the schema to update.
", "PutSchemaFromJsonResponse$Arn": "The ARN of the schema to update.
", "RemoveFacetFromObjectRequest$DirectoryArn": "The ARN of the directory in which the object resides.
", "SchemaFacet$SchemaArn": "The ARN of the schema that contains the facet.
", "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.
", "TypedLinkSchemaAndFacetName$SchemaArn": "The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
", "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.
", "UpdateFacetRequest$SchemaArn": "The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.
", "UpdateObjectAttributesRequest$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.
", "UpdateSchemaRequest$SchemaArn": "The Amazon Resource Name (ARN) of the development schema. For more information, see arns.
", "UpdateSchemaResponse$SchemaArn": "The ARN that is associated with the updated schema. For more information, see arns.
", "UpdateTypedLinkFacetRequest$SchemaArn": "The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
" } }, "Arns": { "base": null, "refs": { "ListAppliedSchemaArnsResponse$SchemaArns": "The ARNs of schemas that are applied to the directory.
", "ListDevelopmentSchemaArnsResponse$SchemaArns": "The ARNs of retrieved development schemas.
", "ListPublishedSchemaArnsResponse$SchemaArns": "The ARNs of published schemas.
" } }, "AttachObjectRequest": { "base": null, "refs": { } }, "AttachObjectResponse": { "base": null, "refs": { } }, "AttachPolicyRequest": { "base": null, "refs": { } }, "AttachPolicyResponse": { "base": null, "refs": { } }, "AttachToIndexRequest": { "base": null, "refs": { } }, "AttachToIndexResponse": { "base": null, "refs": { } }, "AttachTypedLinkRequest": { "base": null, "refs": { } }, "AttachTypedLinkResponse": { "base": null, "refs": { } }, "AttributeKey": { "base": "A unique identifier for an attribute.
", "refs": { "AttributeKeyAndValue$Key": "The key of the attribute.
", "AttributeKeyList$member": null, "ObjectAttributeRange$AttributeKey": "The key of the attribute that the attribute range covers.
", "ObjectAttributeUpdate$ObjectAttributeKey": "The key of the attribute being updated.
" } }, "AttributeKeyAndValue": { "base": "The combination of an attribute key and an attribute value.
", "refs": { "AttributeKeyAndValueList$member": null } }, "AttributeKeyAndValueList": { "base": null, "refs": { "AddFacetToObjectRequest$ObjectAttributeList": "Attributes on the facet that you are adding to the object.
", "BatchAddFacetToObject$ObjectAttributeList": "The attributes to set on the object.
", "BatchCreateObject$ObjectAttributeList": "An attribute map, which contains an attribute ARN as the key and attribute value as the map value.
", "BatchListObjectAttributesResponse$Attributes": "The attributes map that is associated with the object. AttributeArn
is the key; attribute value is the value.
The attribute map whose attribute ARN contains the key and attribute value as the map value.
", "IndexAttachment$IndexedAttributes": "The indexed attribute values.
", "ListObjectAttributesResponse$Attributes": "Attributes map that is associated with the object. AttributeArn
is the key, and attribute value is the value.
Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
", "CreateIndexRequest$OrderedIndexedAttributeList": "Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
" } }, "AttributeName": { "base": null, "refs": { "AttributeKey$Name": "The name of the attribute.
", "AttributeNameAndValue$AttributeName": "The attribute name of the typed link.
", "AttributeNameList$member": null, "FacetAttribute$Name": "The name of the facet attribute.
", "FacetAttributeReference$TargetAttributeName": "The target attribute name that is associated with the facet reference. See Attribute References for more information.
", "TypedLinkAttributeDefinition$Name": "The unique name of the typed link attribute.
", "TypedLinkAttributeRange$AttributeName": "The unique name of the typed link attribute.
" } }, "AttributeNameAndValue": { "base": "Identifies the attribute name and value for a typed link.
", "refs": { "AttributeNameAndValueList$member": null } }, "AttributeNameAndValueList": { "base": null, "refs": { "AttachTypedLinkRequest$Attributes": "A set of attributes that are associated with the typed link.
", "BatchAttachTypedLink$Attributes": "A set of attributes that are associated with the typed link.
", "TypedLinkSpecifier$IdentityAttributeValues": "Identifies the attribute value to update.
" } }, "AttributeNameList": { "base": null, "refs": { "GetTypedLinkFacetInformationResponse$IdentityAttributeOrder": "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.
", "TypedLinkFacet$IdentityAttributeOrder": "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.
", "UpdateTypedLinkFacetRequest$IdentityAttributeOrder": "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.
" } }, "BatchAddFacetToObject": { "base": "Represents the output of a batch add facet to object operation.
", "refs": { "BatchWriteOperation$AddFacetToObject": "A batch operation that adds a facet to an object.
" } }, "BatchAddFacetToObjectResponse": { "base": "The result of a batch add facet to object operation.
", "refs": { "BatchWriteOperationResponse$AddFacetToObject": "The result of an add facet to object batch operation.
" } }, "BatchAttachObject": { "base": "Represents the output of an AttachObject operation.
", "refs": { "BatchWriteOperation$AttachObject": "Attaches an object to a Directory.
" } }, "BatchAttachObjectResponse": { "base": "Represents the output batch AttachObject response operation.
", "refs": { "BatchWriteOperationResponse$AttachObject": "Attaches an object to a Directory.
" } }, "BatchAttachPolicy": { "base": "Attaches a policy object to a regular object inside a BatchRead operation. For more information, see AttachPolicy and BatchReadRequest$Operations.
", "refs": { "BatchWriteOperation$AttachPolicy": "Attaches a policy object to a regular object. An object can have a limited number of attached policies.
" } }, "BatchAttachPolicyResponse": { "base": "Represents the output of an AttachPolicy response operation.
", "refs": { "BatchWriteOperationResponse$AttachPolicy": "Attaches a policy object to a regular object. An object can have a limited number of attached policies.
" } }, "BatchAttachToIndex": { "base": "Attaches the specified object to the specified index inside a BatchRead operation. For more information, see AttachToIndex and BatchReadRequest$Operations.
", "refs": { "BatchWriteOperation$AttachToIndex": "Attaches the specified object to the specified index.
" } }, "BatchAttachToIndexResponse": { "base": "Represents the output of a AttachToIndex response operation.
", "refs": { "BatchWriteOperationResponse$AttachToIndex": "Attaches the specified object to the specified index.
" } }, "BatchAttachTypedLink": { "base": "Attaches a typed link to a specified source and target object inside a BatchRead operation. For more information, see AttachTypedLink and BatchReadRequest$Operations.
", "refs": { "BatchWriteOperation$AttachTypedLink": "Attaches a typed link to a specified source and target object. For more information, see Typed link.
" } }, "BatchAttachTypedLinkResponse": { "base": "Represents the output of a AttachTypedLink response operation.
", "refs": { "BatchWriteOperationResponse$AttachTypedLink": "Attaches a typed link to a specified source and target object. For more information, see Typed link.
" } }, "BatchCreateIndex": { "base": "Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.
", "refs": { "BatchWriteOperation$CreateIndex": "Creates an index object. See Indexing for more information.
" } }, "BatchCreateIndexResponse": { "base": "Represents the output of a CreateIndex response operation.
", "refs": { "BatchWriteOperationResponse$CreateIndex": "Creates an index object. See Indexing for more information.
" } }, "BatchCreateObject": { "base": "Represents the output of a CreateObject operation.
", "refs": { "BatchWriteOperation$CreateObject": "Creates an object.
" } }, "BatchCreateObjectResponse": { "base": "Represents the output of a CreateObject response operation.
", "refs": { "BatchWriteOperationResponse$CreateObject": "Creates an object in a Directory.
" } }, "BatchDeleteObject": { "base": "Represents the output of a DeleteObject operation.
", "refs": { "BatchWriteOperation$DeleteObject": "Deletes an object in a Directory.
" } }, "BatchDeleteObjectResponse": { "base": "Represents the output of a DeleteObject response operation.
", "refs": { "BatchWriteOperationResponse$DeleteObject": "Deletes an object in a Directory.
" } }, "BatchDetachFromIndex": { "base": "Detaches the specified object from the specified index inside a BatchRead operation. For more information, see DetachFromIndex and BatchReadRequest$Operations.
", "refs": { "BatchWriteOperation$DetachFromIndex": "Detaches the specified object from the specified index.
" } }, "BatchDetachFromIndexResponse": { "base": "Represents the output of a DetachFromIndex response operation.
", "refs": { "BatchWriteOperationResponse$DetachFromIndex": "Detaches the specified object from the specified index.
" } }, "BatchDetachObject": { "base": "Represents the output of a DetachObject operation.
", "refs": { "BatchWriteOperation$DetachObject": "Detaches an object from a Directory.
" } }, "BatchDetachObjectResponse": { "base": "Represents the output of a DetachObject response operation.
", "refs": { "BatchWriteOperationResponse$DetachObject": "Detaches an object from a Directory.
" } }, "BatchDetachPolicy": { "base": "Detaches the specified policy from the specified directory inside a BatchRead operation. For more information, see DetachPolicy and BatchReadRequest$Operations.
", "refs": { "BatchWriteOperation$DetachPolicy": "Detaches a policy from a Directory.
" } }, "BatchDetachPolicyResponse": { "base": "Represents the output of a DetachPolicy response operation.
", "refs": { "BatchWriteOperationResponse$DetachPolicy": "Detaches a policy from a Directory.
" } }, "BatchDetachTypedLink": { "base": "Detaches a typed link from a specified source and target object inside a BatchRead operation. For more information, see DetachTypedLink and BatchReadRequest$Operations.
", "refs": { "BatchWriteOperation$DetachTypedLink": "Detaches a typed link from a specified source and target object. For more information, see Typed link.
" } }, "BatchDetachTypedLinkResponse": { "base": "Represents the output of a DetachTypedLink response operation.
", "refs": { "BatchWriteOperationResponse$DetachTypedLink": "Detaches a typed link from a specified source and target object. For more information, see Typed link.
" } }, "BatchGetObjectInformation": { "base": "Retrieves metadata about an object inside a BatchRead operation. For more information, see GetObjectInformation and BatchReadRequest$Operations.
", "refs": { "BatchReadOperation$GetObjectInformation": "Retrieves metadata about an object.
" } }, "BatchGetObjectInformationResponse": { "base": "Represents the output of a GetObjectInformation response operation.
", "refs": { "BatchReadSuccessfulResponse$GetObjectInformation": "Retrieves metadata about an object.
" } }, "BatchListAttachedIndices": { "base": "Lists indices attached to an object inside a BatchRead operation. For more information, see ListAttachedIndices and BatchReadRequest$Operations.
", "refs": { "BatchReadOperation$ListAttachedIndices": "Lists indices attached to an object.
" } }, "BatchListAttachedIndicesResponse": { "base": "Represents the output of a ListAttachedIndices response operation.
", "refs": { "BatchReadSuccessfulResponse$ListAttachedIndices": "Lists indices attached to an object.
" } }, "BatchListIncomingTypedLinks": { "base": "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.
", "refs": { "BatchReadOperation$ListIncomingTypedLinks": "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.
" } }, "BatchListIncomingTypedLinksResponse": { "base": "Represents the output of a ListIncomingTypedLinks response operation.
", "refs": { "BatchReadSuccessfulResponse$ListIncomingTypedLinks": "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.
" } }, "BatchListIndex": { "base": "Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations.
", "refs": { "BatchReadOperation$ListIndex": "Lists objects attached to the specified index.
" } }, "BatchListIndexResponse": { "base": "Represents the output of a ListIndex response operation.
", "refs": { "BatchReadSuccessfulResponse$ListIndex": "Lists objects attached to the specified index.
" } }, "BatchListObjectAttributes": { "base": "Represents the output of a ListObjectAttributes operation.
", "refs": { "BatchReadOperation$ListObjectAttributes": "Lists all attributes that are associated with an object.
" } }, "BatchListObjectAttributesResponse": { "base": "Represents the output of a ListObjectAttributes response operation.
", "refs": { "BatchReadSuccessfulResponse$ListObjectAttributes": "Lists all attributes that are associated with an object.
" } }, "BatchListObjectChildren": { "base": "Represents the output of a ListObjectChildren operation.
", "refs": { "BatchReadOperation$ListObjectChildren": "Returns a paginated list of child objects that are associated with a given object.
" } }, "BatchListObjectChildrenResponse": { "base": "Represents the output of a ListObjectChildren response operation.
", "refs": { "BatchReadSuccessfulResponse$ListObjectChildren": "Returns a paginated list of child objects that are associated with a given object.
" } }, "BatchListObjectParentPaths": { "base": "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.
", "refs": { "BatchReadOperation$ListObjectParentPaths": "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.
" } }, "BatchListObjectParentPathsResponse": { "base": "Represents the output of a ListObjectParentPaths response operation.
", "refs": { "BatchReadSuccessfulResponse$ListObjectParentPaths": "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.
" } }, "BatchListObjectPolicies": { "base": "Returns policies attached to an object in pagination fashion inside a BatchRead operation. For more information, see ListObjectPolicies and BatchReadRequest$Operations.
", "refs": { "BatchReadOperation$ListObjectPolicies": "Returns policies attached to an object in pagination fashion.
" } }, "BatchListObjectPoliciesResponse": { "base": "Represents the output of a ListObjectPolicies response operation.
", "refs": { "BatchReadSuccessfulResponse$ListObjectPolicies": "Returns policies attached to an object in pagination fashion.
" } }, "BatchListOutgoingTypedLinks": { "base": "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.
", "refs": { "BatchReadOperation$ListOutgoingTypedLinks": "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.
" } }, "BatchListOutgoingTypedLinksResponse": { "base": "Represents the output of a ListOutgoingTypedLinks response operation.
", "refs": { "BatchReadSuccessfulResponse$ListOutgoingTypedLinks": "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.
" } }, "BatchListPolicyAttachments": { "base": "Returns all of the ObjectIdentifiers
to which a given policy is attached inside a BatchRead operation. For more information, see ListPolicyAttachments and BatchReadRequest$Operations.
Returns all of the ObjectIdentifiers
to which a given policy is attached.
Represents the output of a ListPolicyAttachments response operation.
", "refs": { "BatchReadSuccessfulResponse$ListPolicyAttachments": "Returns all of the ObjectIdentifiers
to which a given policy is attached.
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.
", "refs": { "BatchReadOperation$LookupPolicy": "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.
Represents the output of a LookupPolicy response operation.
", "refs": { "BatchReadSuccessfulResponse$LookupPolicy": "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.
The batch read exception structure, which contains the exception type and message.
", "refs": { "BatchReadOperationResponse$ExceptionResponse": "Identifies which operation in a batch has failed.
" } }, "BatchReadExceptionType": { "base": null, "refs": { "BatchReadException$Type": "A type of exception, such as InvalidArnException
.
Represents the output of a BatchRead
operation.
A list of operations that are part of the batch.
" } }, "BatchReadOperationResponse": { "base": "Represents the output of a BatchRead
response operation.
A list of all the responses for each batch read.
" } }, "BatchReadRequest": { "base": null, "refs": { } }, "BatchReadResponse": { "base": null, "refs": { } }, "BatchReadSuccessfulResponse": { "base": "Represents the output of a BatchRead
success response operation.
Identifies which operation in a batch has succeeded.
" } }, "BatchReferenceName": { "base": null, "refs": { "BatchCreateIndex$BatchReferenceName": "The batch reference name. See Batches for more information.
", "BatchCreateObject$BatchReferenceName": "The batch reference name. See Batches for more information.
", "BatchDetachObject$BatchReferenceName": "The batch reference name. See Batches for more information.
" } }, "BatchRemoveFacetFromObject": { "base": "A batch operation to remove a facet from an object.
", "refs": { "BatchWriteOperation$RemoveFacetFromObject": "A batch operation that removes a facet from an object.
" } }, "BatchRemoveFacetFromObjectResponse": { "base": "An empty result that represents success.
", "refs": { "BatchWriteOperationResponse$RemoveFacetFromObject": "The result of a batch remove facet from object operation.
" } }, "BatchUpdateObjectAttributes": { "base": "Represents the output of a BatchUpdate
operation.
Updates a given object's attributes.
" } }, "BatchUpdateObjectAttributesResponse": { "base": "Represents the output of a BatchUpdate
response operation.
Updates a given object’s attributes.
" } }, "BatchWriteException": { "base": "A BatchWrite
exception has occurred.
Represents the output of a BatchWrite
operation.
A list of operations that are part of the batch.
" } }, "BatchWriteOperationResponse": { "base": "Represents the output of a BatchWrite
response operation.
A list of all the responses for each batch write.
" } }, "BatchWriteRequest": { "base": null, "refs": { } }, "BatchWriteResponse": { "base": null, "refs": { } }, "BinaryAttributeValue": { "base": null, "refs": { "TypedAttributeValue$BinaryValue": "A binary data value.
" } }, "Bool": { "base": null, "refs": { "BatchCreateIndex$IsUnique": "Indicates whether the attribute that is being indexed has unique values or not.
", "CreateIndexRequest$IsUnique": "Indicates whether the attribute that is being indexed has unique values or not.
", "FacetAttributeDefinition$IsImmutable": "Whether the attribute is mutable or not.
", "TypedLinkAttributeDefinition$IsImmutable": "Whether the attribute is mutable or not.
" } }, "BooleanAttributeValue": { "base": null, "refs": { "TypedAttributeValue$BooleanValue": "A Boolean data value.
" } }, "CannotListParentOfRootException": { "base": "Cannot list the parents of a Directory root.
", "refs": { } }, "ConsistencyLevel": { "base": null, "refs": { "BatchReadRequest$ConsistencyLevel": "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.
", "GetObjectInformationRequest$ConsistencyLevel": "The consistency level at which to retrieve the object information.
", "ListAttachedIndicesRequest$ConsistencyLevel": "The consistency level to use for this operation.
", "ListIncomingTypedLinksRequest$ConsistencyLevel": "The consistency level to execute the request at.
", "ListIndexRequest$ConsistencyLevel": "The consistency level to execute the request at.
", "ListObjectAttributesRequest$ConsistencyLevel": "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.
", "ListObjectChildrenRequest$ConsistencyLevel": "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.
", "ListObjectParentsRequest$ConsistencyLevel": "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.
", "ListObjectPoliciesRequest$ConsistencyLevel": "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.
", "ListOutgoingTypedLinksRequest$ConsistencyLevel": "The consistency level to execute the request at.
", "ListPolicyAttachmentsRequest$ConsistencyLevel": "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.
" } }, "CreateDirectoryRequest": { "base": null, "refs": { } }, "CreateDirectoryResponse": { "base": null, "refs": { } }, "CreateFacetRequest": { "base": null, "refs": { } }, "CreateFacetResponse": { "base": null, "refs": { } }, "CreateIndexRequest": { "base": null, "refs": { } }, "CreateIndexResponse": { "base": null, "refs": { } }, "CreateObjectRequest": { "base": null, "refs": { } }, "CreateObjectResponse": { "base": null, "refs": { } }, "CreateSchemaRequest": { "base": null, "refs": { } }, "CreateSchemaResponse": { "base": null, "refs": { } }, "CreateTypedLinkFacetRequest": { "base": null, "refs": { } }, "CreateTypedLinkFacetResponse": { "base": null, "refs": { } }, "Date": { "base": null, "refs": { "Directory$CreationDateTime": "The date and time when the directory was created.
" } }, "DatetimeAttributeValue": { "base": null, "refs": { "TypedAttributeValue$DatetimeValue": "A date and time value.
" } }, "DeleteDirectoryRequest": { "base": null, "refs": { } }, "DeleteDirectoryResponse": { "base": null, "refs": { } }, "DeleteFacetRequest": { "base": null, "refs": { } }, "DeleteFacetResponse": { "base": null, "refs": { } }, "DeleteObjectRequest": { "base": null, "refs": { } }, "DeleteObjectResponse": { "base": null, "refs": { } }, "DeleteSchemaRequest": { "base": null, "refs": { } }, "DeleteSchemaResponse": { "base": null, "refs": { } }, "DeleteTypedLinkFacetRequest": { "base": null, "refs": { } }, "DeleteTypedLinkFacetResponse": { "base": null, "refs": { } }, "DetachFromIndexRequest": { "base": null, "refs": { } }, "DetachFromIndexResponse": { "base": null, "refs": { } }, "DetachObjectRequest": { "base": null, "refs": { } }, "DetachObjectResponse": { "base": null, "refs": { } }, "DetachPolicyRequest": { "base": null, "refs": { } }, "DetachPolicyResponse": { "base": null, "refs": { } }, "DetachTypedLinkRequest": { "base": null, "refs": { } }, "Directory": { "base": "Directory structure that includes the directory name and directory ARN.
", "refs": { "DirectoryList$member": null, "GetDirectoryResponse$Directory": "Metadata about the directory.
" } }, "DirectoryAlreadyExistsException": { "base": "Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.
", "refs": { } }, "DirectoryArn": { "base": null, "refs": { "CreateDirectoryResponse$DirectoryArn": "The ARN that is associated with the Directory. For more information, see arns.
", "Directory$DirectoryArn": "The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns.
", "GetDirectoryRequest$DirectoryArn": "The ARN of the directory.
" } }, "DirectoryDeletedException": { "base": "A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.
", "refs": { } }, "DirectoryList": { "base": null, "refs": { "ListDirectoriesResponse$Directories": "Lists all directories that are associated with your account in pagination fashion.
" } }, "DirectoryName": { "base": null, "refs": { "CreateDirectoryRequest$Name": "The name of the Directory. Should be unique per account, per region.
", "CreateDirectoryResponse$Name": "The name of the Directory.
", "Directory$Name": "The name of the directory.
" } }, "DirectoryNotDisabledException": { "base": "An operation can only operate on a disabled directory.
", "refs": { } }, "DirectoryNotEnabledException": { "base": "An operation can only operate on a directory that is not enabled.
", "refs": { } }, "DirectoryState": { "base": null, "refs": { "Directory$State": "The state of the directory. Can be either Enabled
, Disabled
, or Deleted
.
The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.
" } }, "DisableDirectoryRequest": { "base": null, "refs": { } }, "DisableDirectoryResponse": { "base": null, "refs": { } }, "EnableDirectoryRequest": { "base": null, "refs": { } }, "EnableDirectoryResponse": { "base": null, "refs": { } }, "ExceptionMessage": { "base": null, "refs": { "AccessDeniedException$Message": null, "BatchReadException$Message": "An exception message that is associated with the failure.
", "BatchWriteException$Message": null, "CannotListParentOfRootException$Message": null, "DirectoryAlreadyExistsException$Message": null, "DirectoryDeletedException$Message": null, "DirectoryNotDisabledException$Message": null, "DirectoryNotEnabledException$Message": null, "FacetAlreadyExistsException$Message": null, "FacetInUseException$Message": null, "FacetNotFoundException$Message": null, "FacetValidationException$Message": null, "IndexedAttributeMissingException$Message": null, "InternalServiceException$Message": null, "InvalidArnException$Message": null, "InvalidAttachmentException$Message": null, "InvalidFacetUpdateException$Message": null, "InvalidNextTokenException$Message": null, "InvalidRuleException$Message": null, "InvalidSchemaDocException$Message": null, "InvalidTaggingRequestException$Message": null, "LimitExceededException$Message": null, "LinkNameAlreadyInUseException$Message": null, "NotIndexException$Message": null, "NotNodeException$Message": null, "NotPolicyException$Message": null, "ObjectAlreadyDetachedException$Message": null, "ObjectNotDetachedException$Message": null, "ResourceNotFoundException$Message": null, "RetryableConflictException$Message": null, "SchemaAlreadyExistsException$Message": null, "SchemaAlreadyPublishedException$Message": null, "StillContainsLinksException$Message": null, "UnsupportedIndexTypeException$Message": null, "ValidationException$Message": null } }, "Facet": { "base": "A structure that contains Name
, ARN
, Attributes
, Rules, and ObjectTypes
.
The Facet structure that is associated with the facet.
" } }, "FacetAlreadyExistsException": { "base": "A facet with the same name already exists.
", "refs": { } }, "FacetAttribute": { "base": "An attribute that is associated with the Facet.
", "refs": { "FacetAttributeList$member": null, "FacetAttributeUpdate$Attribute": "The attribute to update.
" } }, "FacetAttributeDefinition": { "base": "A facet attribute definition. See Attribute References for more information.
", "refs": { "FacetAttribute$AttributeDefinition": "A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.
" } }, "FacetAttributeList": { "base": null, "refs": { "CreateFacetRequest$Attributes": "The attributes that are associated with the Facet.
", "ListFacetAttributesResponse$Attributes": "The attributes attached to the facet.
" } }, "FacetAttributeReference": { "base": "The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.
", "refs": { "FacetAttribute$AttributeReference": "An attribute reference that is associated with the attribute. See Attribute References for more information.
" } }, "FacetAttributeType": { "base": null, "refs": { "FacetAttributeDefinition$Type": "The type of the attribute.
", "TypedLinkAttributeDefinition$Type": "The type of the attribute.
" } }, "FacetAttributeUpdate": { "base": "A structure that contains information used to update an attribute.
", "refs": { "FacetAttributeUpdateList$member": null } }, "FacetAttributeUpdateList": { "base": null, "refs": { "UpdateFacetRequest$AttributeUpdates": "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.
Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.
", "refs": { } }, "FacetName": { "base": null, "refs": { "AttributeKey$FacetName": "The name of the facet that the attribute exists within.
", "CreateFacetRequest$Name": "The name of the Facet, which is unique for a given schema.
", "DeleteFacetRequest$Name": "The name of the facet to delete.
", "Facet$Name": "The name of the Facet.
", "FacetAttributeReference$TargetFacetName": "The target facet name that is associated with the facet reference. See Attribute References for more information.
", "FacetNameList$member": null, "GetFacetRequest$Name": "The name of the facet to retrieve.
", "ListFacetAttributesRequest$Name": "The name of the facet whose attributes will be retrieved.
", "SchemaFacet$FacetName": "The name of the facet.
", "UpdateFacetRequest$Name": "The name of the facet.
" } }, "FacetNameList": { "base": null, "refs": { "ListFacetNamesResponse$FacetNames": "The names of facets that exist within the schema.
" } }, "FacetNotFoundException": { "base": "The specified Facet could not be found.
", "refs": { } }, "FacetValidationException": { "base": "The Facet that you provided was not well formed or could not be validated with the schema.
", "refs": { } }, "GetDirectoryRequest": { "base": null, "refs": { } }, "GetDirectoryResponse": { "base": null, "refs": { } }, "GetFacetRequest": { "base": null, "refs": { } }, "GetFacetResponse": { "base": null, "refs": { } }, "GetObjectInformationRequest": { "base": null, "refs": { } }, "GetObjectInformationResponse": { "base": null, "refs": { } }, "GetSchemaAsJsonRequest": { "base": null, "refs": { } }, "GetSchemaAsJsonResponse": { "base": null, "refs": { } }, "GetTypedLinkFacetInformationRequest": { "base": null, "refs": { } }, "GetTypedLinkFacetInformationResponse": { "base": null, "refs": { } }, "IndexAttachment": { "base": "Represents an index and an attached object.
", "refs": { "IndexAttachmentList$member": null } }, "IndexAttachmentList": { "base": null, "refs": { "BatchListAttachedIndicesResponse$IndexAttachments": "The indices attached to the specified object.
", "BatchListIndexResponse$IndexAttachments": "The objects and indexed values attached to the index.
", "ListAttachedIndicesResponse$IndexAttachments": "The indices attached to the specified object.
", "ListIndexResponse$IndexAttachments": "The objects and indexed values attached to the index.
" } }, "IndexedAttributeMissingException": { "base": "An object has been attempted to be attached to an object that does not have the appropriate attribute value.
", "refs": { } }, "InternalServiceException": { "base": "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.
", "refs": { } }, "InvalidArnException": { "base": "Indicates that the provided ARN value is not valid.
", "refs": { } }, "InvalidAttachmentException": { "base": "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.
", "refs": { } }, "InvalidFacetUpdateException": { "base": "An attempt to modify a Facet resulted in an invalid schema exception.
", "refs": { } }, "InvalidNextTokenException": { "base": "Indicates that the NextToken
value is not valid.
Occurs when any of the rule parameter keys or values are invalid.
", "refs": { } }, "InvalidSchemaDocException": { "base": "Indicates that the provided SchemaDoc
value is not valid.
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.
", "refs": { } }, "LimitExceededException": { "base": "Indicates that limits are exceeded. See Limits for more information.
", "refs": { } }, "LinkName": { "base": null, "refs": { "AttachObjectRequest$LinkName": "The link name with which the child object is attached to the parent.
", "BatchAttachObject$LinkName": "The name of the link.
", "BatchCreateIndex$LinkName": "The name of the link between the parent object and the index object.
", "BatchCreateObject$LinkName": "The name of the link.
", "BatchDetachObject$LinkName": "The name of the link.
", "CreateIndexRequest$LinkName": "The name of the link between the parent object and the index object.
", "CreateObjectRequest$LinkName": "The name of link that is used to attach this object to a parent.
", "DetachObjectRequest$LinkName": "The link name associated with the object that needs to be detached.
", "LinkNameToObjectIdentifierMap$key": null, "ObjectIdentifierToLinkNameMap$value": null } }, "LinkNameAlreadyInUseException": { "base": "Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
", "refs": { } }, "LinkNameToObjectIdentifierMap": { "base": null, "refs": { "BatchListObjectChildrenResponse$Children": "The children structure, which is a map with the key as the LinkName
and ObjectIdentifier
as the value.
Children structure, which is a map with key as the LinkName
and ObjectIdentifier
as the value.
The pagination token.
", "BatchListAttachedIndicesResponse$NextToken": "The pagination token.
", "BatchListIncomingTypedLinks$NextToken": "The pagination token.
", "BatchListIncomingTypedLinksResponse$NextToken": "The pagination token.
", "BatchListIndex$NextToken": "The pagination token.
", "BatchListIndexResponse$NextToken": "The pagination token.
", "BatchListObjectAttributes$NextToken": "The pagination token.
", "BatchListObjectAttributesResponse$NextToken": "The pagination token.
", "BatchListObjectChildren$NextToken": "The pagination token.
", "BatchListObjectChildrenResponse$NextToken": "The pagination token.
", "BatchListObjectParentPaths$NextToken": "The pagination token.
", "BatchListObjectParentPathsResponse$NextToken": "The pagination token.
", "BatchListObjectPolicies$NextToken": "The pagination token.
", "BatchListObjectPoliciesResponse$NextToken": "The pagination token.
", "BatchListOutgoingTypedLinks$NextToken": "The pagination token.
", "BatchListOutgoingTypedLinksResponse$NextToken": "The pagination token.
", "BatchListPolicyAttachments$NextToken": "The pagination token.
", "BatchListPolicyAttachmentsResponse$NextToken": "The pagination token.
", "BatchLookupPolicy$NextToken": "The pagination token.
", "BatchLookupPolicyResponse$NextToken": "The pagination token.
", "ListAppliedSchemaArnsRequest$NextToken": "The pagination token.
", "ListAppliedSchemaArnsResponse$NextToken": "The pagination token.
", "ListAttachedIndicesRequest$NextToken": "The pagination token.
", "ListAttachedIndicesResponse$NextToken": "The pagination token.
", "ListDevelopmentSchemaArnsRequest$NextToken": "The pagination token.
", "ListDevelopmentSchemaArnsResponse$NextToken": "The pagination token.
", "ListDirectoriesRequest$NextToken": "The pagination token.
", "ListDirectoriesResponse$NextToken": "The pagination token.
", "ListFacetAttributesRequest$NextToken": "The pagination token.
", "ListFacetAttributesResponse$NextToken": "The pagination token.
", "ListFacetNamesRequest$NextToken": "The pagination token.
", "ListFacetNamesResponse$NextToken": "The pagination token.
", "ListIncomingTypedLinksRequest$NextToken": "The pagination token.
", "ListIncomingTypedLinksResponse$NextToken": "The pagination token.
", "ListIndexRequest$NextToken": "The pagination token.
", "ListIndexResponse$NextToken": "The pagination token.
", "ListObjectAttributesRequest$NextToken": "The pagination token.
", "ListObjectAttributesResponse$NextToken": "The pagination token.
", "ListObjectChildrenRequest$NextToken": "The pagination token.
", "ListObjectChildrenResponse$NextToken": "The pagination token.
", "ListObjectParentPathsRequest$NextToken": "The pagination token.
", "ListObjectParentPathsResponse$NextToken": "The pagination token.
", "ListObjectParentsRequest$NextToken": "The pagination token.
", "ListObjectParentsResponse$NextToken": "The pagination token.
", "ListObjectPoliciesRequest$NextToken": "The pagination token.
", "ListObjectPoliciesResponse$NextToken": "The pagination token.
", "ListOutgoingTypedLinksRequest$NextToken": "The pagination token.
", "ListOutgoingTypedLinksResponse$NextToken": "The pagination token.
", "ListPolicyAttachmentsRequest$NextToken": "The pagination token.
", "ListPolicyAttachmentsResponse$NextToken": "The pagination token.
", "ListPublishedSchemaArnsRequest$NextToken": "The pagination token.
", "ListPublishedSchemaArnsResponse$NextToken": "The pagination token.
", "ListTagsForResourceRequest$NextToken": "The pagination token. This is for future use. Currently pagination is not supported for tagging.
", "ListTagsForResourceResponse$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
", "ListTypedLinkFacetAttributesRequest$NextToken": "The pagination token.
", "ListTypedLinkFacetAttributesResponse$NextToken": "The pagination token.
", "ListTypedLinkFacetNamesRequest$NextToken": "The pagination token.
", "ListTypedLinkFacetNamesResponse$NextToken": "The pagination token.
", "LookupPolicyRequest$NextToken": "The token to request the next page of results.
", "LookupPolicyResponse$NextToken": "The pagination token.
" } }, "NotIndexException": { "base": "Indicates that the requested operation can only operate on index objects.
", "refs": { } }, "NotNodeException": { "base": "Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren
for a leaf node object.
Indicates that the requested operation can only operate on policy objects.
", "refs": { } }, "NumberAttributeValue": { "base": null, "refs": { "TypedAttributeValue$NumberValue": "A number data value.
" } }, "NumberResults": { "base": null, "refs": { "BatchListAttachedIndices$MaxResults": "The maximum number of results to retrieve.
", "BatchListIncomingTypedLinks$MaxResults": "The maximum number of results to retrieve.
", "BatchListIndex$MaxResults": "The maximum number of results to retrieve.
", "BatchListObjectAttributes$MaxResults": "The maximum number of items to be retrieved in a single call. This is an approximate number.
", "BatchListObjectChildren$MaxResults": "Maximum number of items to be retrieved in a single call. This is an approximate number.
", "BatchListObjectParentPaths$MaxResults": "The maximum number of results to retrieve.
", "BatchListObjectPolicies$MaxResults": "The maximum number of results to retrieve.
", "BatchListOutgoingTypedLinks$MaxResults": "The maximum number of results to retrieve.
", "BatchListPolicyAttachments$MaxResults": "The maximum number of results to retrieve.
", "BatchLookupPolicy$MaxResults": "The maximum number of results to retrieve.
", "ListAppliedSchemaArnsRequest$MaxResults": "The maximum number of results to retrieve.
", "ListAttachedIndicesRequest$MaxResults": "The maximum number of results to retrieve.
", "ListDevelopmentSchemaArnsRequest$MaxResults": "The maximum number of results to retrieve.
", "ListDirectoriesRequest$MaxResults": "The maximum number of results to retrieve.
", "ListFacetAttributesRequest$MaxResults": "The maximum number of results to retrieve.
", "ListFacetNamesRequest$MaxResults": "The maximum number of results to retrieve.
", "ListIncomingTypedLinksRequest$MaxResults": "The maximum number of results to retrieve.
", "ListIndexRequest$MaxResults": "The maximum number of results to retrieve from the index.
", "ListObjectAttributesRequest$MaxResults": "The maximum number of items to be retrieved in a single call. This is an approximate number.
", "ListObjectChildrenRequest$MaxResults": "The maximum number of items to be retrieved in a single call. This is an approximate number.
", "ListObjectParentPathsRequest$MaxResults": "The maximum number of items to be retrieved in a single call. This is an approximate number.
", "ListObjectParentsRequest$MaxResults": "The maximum number of items to be retrieved in a single call. This is an approximate number.
", "ListObjectPoliciesRequest$MaxResults": "The maximum number of items to be retrieved in a single call. This is an approximate number.
", "ListOutgoingTypedLinksRequest$MaxResults": "The maximum number of results to retrieve.
", "ListPolicyAttachmentsRequest$MaxResults": "The maximum number of items to be retrieved in a single call. This is an approximate number.
", "ListPublishedSchemaArnsRequest$MaxResults": "The maximum number of results to retrieve.
", "ListTypedLinkFacetAttributesRequest$MaxResults": "The maximum number of results to retrieve.
", "ListTypedLinkFacetNamesRequest$MaxResults": "The maximum number of results to retrieve.
", "LookupPolicyRequest$MaxResults": "The maximum number of items to be retrieved in a single call. This is an approximate number.
" } }, "ObjectAlreadyDetachedException": { "base": "Indicates that the object is not attached to the index.
", "refs": { } }, "ObjectAttributeAction": { "base": "The action to take on the object attribute.
", "refs": { "ObjectAttributeUpdate$ObjectAttributeAction": "The action to perform as part of the attribute update.
" } }, "ObjectAttributeRange": { "base": "A range of attributes.
", "refs": { "ObjectAttributeRangeList$member": null } }, "ObjectAttributeRangeList": { "base": null, "refs": { "BatchListIndex$RangesOnIndexedValues": "Specifies the ranges of indexed values that you want to query.
", "ListIndexRequest$RangesOnIndexedValues": "Specifies the ranges of indexed values that you want to query.
" } }, "ObjectAttributeUpdate": { "base": "Structure that contains attribute update information.
", "refs": { "ObjectAttributeUpdateList$member": null } }, "ObjectAttributeUpdateList": { "base": null, "refs": { "BatchUpdateObjectAttributes$AttributeUpdates": "Attributes update structure.
", "UpdateObjectAttributesRequest$AttributeUpdates": "The attributes update structure.
" } }, "ObjectIdentifier": { "base": null, "refs": { "AttachObjectResponse$AttachedObjectIdentifier": "The attached ObjectIdentifier
, which is the child ObjectIdentifier
.
The ObjectIdentifier
of the object that was attached to the index.
The ObjectIdentifier
of the object that has been attached.
The ObjectIdentifier
of the object that was attached to the index.
The ObjectIdentifier
of the index created by this operation.
The ID that is associated with the object.
", "BatchDetachFromIndexResponse$DetachedObjectIdentifier": "The ObjectIdentifier
of the object that was detached from the index.
The ObjectIdentifier
of the detached object.
The ObjectIdentifier
of the specified object.
ID that is associated with the object.
", "CreateDirectoryResponse$ObjectIdentifier": "The root object node of the created directory.
", "CreateIndexResponse$ObjectIdentifier": "The ObjectIdentifier
of the index created by this operation.
The identifier that is associated with the object.
", "DetachFromIndexResponse$DetachedObjectIdentifier": "The ObjectIdentifier
of the object that was detached from the index.
The ObjectIdentifier
that was detached from the object.
The ObjectIdentifier
of the specified object.
The ObjectIdentifier
of the object attached to the index.
The ID of PolicyAttachment
.
The ObjectIdentifier
that is associated with PolicyAttachment
.
The ObjectIdentifier
of the updated object.
A list of policy ObjectIdentifiers
, that are attached to the object.
A list of ObjectIdentifiers
to which the policy is attached.
A list of policy ObjectIdentifiers
, that are attached to the object.
A list of ObjectIdentifiers
to which the policy is attached.
Lists ObjectIdentifiers
starting from directory root to the object in the request.
The parent structure, which is a map with key as the ObjectIdentifier
and LinkName as the value.
Indicates that the requested operation cannot be completed because the object has not been detached from the tree.
", "refs": { } }, "ObjectReference": { "base": "The reference that identifies an object.
", "refs": { "AddFacetToObjectRequest$ObjectReference": "A reference to the object you are adding the specified facet to.
", "AttachObjectRequest$ParentReference": "The parent object reference.
", "AttachObjectRequest$ChildReference": "The child object reference to be attached to the object.
", "AttachPolicyRequest$PolicyReference": "The reference that is associated with the policy object.
", "AttachPolicyRequest$ObjectReference": "The reference that identifies the object to which the policy will be attached.
", "AttachToIndexRequest$IndexReference": "A reference to the index that you are attaching the object to.
", "AttachToIndexRequest$TargetReference": "A reference to the object that you are attaching to the index.
", "AttachTypedLinkRequest$SourceObjectReference": "Identifies the source object that the typed link will attach to.
", "AttachTypedLinkRequest$TargetObjectReference": "Identifies the target object that the typed link will attach to.
", "BatchAddFacetToObject$ObjectReference": "A reference to the object being mutated.
", "BatchAttachObject$ParentReference": "The parent object reference.
", "BatchAttachObject$ChildReference": "The child object reference that is to be attached to the object.
", "BatchAttachPolicy$PolicyReference": "The reference that is associated with the policy object.
", "BatchAttachPolicy$ObjectReference": "The reference that identifies the object to which the policy will be attached.
", "BatchAttachToIndex$IndexReference": "A reference to the index that you are attaching the object to.
", "BatchAttachToIndex$TargetReference": "A reference to the object that you are attaching to the index.
", "BatchAttachTypedLink$SourceObjectReference": "Identifies the source object that the typed link will attach to.
", "BatchAttachTypedLink$TargetObjectReference": "Identifies the target object that the typed link will attach to.
", "BatchCreateIndex$ParentReference": "A reference to the parent object that contains the index object.
", "BatchCreateObject$ParentReference": "If specified, the parent reference to which this object will be attached.
", "BatchDeleteObject$ObjectReference": "The reference that identifies the object.
", "BatchDetachFromIndex$IndexReference": "A reference to the index object.
", "BatchDetachFromIndex$TargetReference": "A reference to the object being detached from the index.
", "BatchDetachObject$ParentReference": "Parent reference from which the object with the specified link name is detached.
", "BatchDetachPolicy$PolicyReference": "Reference that identifies the policy object.
", "BatchDetachPolicy$ObjectReference": "Reference that identifies the object whose policy object will be detached.
", "BatchGetObjectInformation$ObjectReference": "A reference to the object.
", "BatchListAttachedIndices$TargetReference": "A reference to the object that has indices attached.
", "BatchListIncomingTypedLinks$ObjectReference": "The reference that identifies the object whose attributes will be listed.
", "BatchListIndex$IndexReference": "The reference to the index to list.
", "BatchListObjectAttributes$ObjectReference": "Reference of the object whose attributes need to be listed.
", "BatchListObjectChildren$ObjectReference": "Reference of the object for which child objects are being listed.
", "BatchListObjectParentPaths$ObjectReference": "The reference that identifies the object whose attributes will be listed.
", "BatchListObjectPolicies$ObjectReference": "The reference that identifies the object whose attributes will be listed.
", "BatchListOutgoingTypedLinks$ObjectReference": "The reference that identifies the object whose attributes will be listed.
", "BatchListPolicyAttachments$PolicyReference": "The reference that identifies the policy object.
", "BatchLookupPolicy$ObjectReference": "Reference that identifies the object whose policies will be looked up.
", "BatchRemoveFacetFromObject$ObjectReference": "A reference to the object whose facet will be removed.
", "BatchUpdateObjectAttributes$ObjectReference": "Reference that identifies the object.
", "CreateIndexRequest$ParentReference": "A reference to the parent object that contains the index object.
", "CreateObjectRequest$ParentReference": "If specified, the parent reference to which this object will be attached.
", "DeleteObjectRequest$ObjectReference": "A reference that identifies the object.
", "DetachFromIndexRequest$IndexReference": "A reference to the index object.
", "DetachFromIndexRequest$TargetReference": "A reference to the object being detached from the index.
", "DetachObjectRequest$ParentReference": "The parent reference from which the object with the specified link name is detached.
", "DetachPolicyRequest$PolicyReference": "Reference that identifies the policy object.
", "DetachPolicyRequest$ObjectReference": "Reference that identifies the object whose policy object will be detached.
", "GetObjectInformationRequest$ObjectReference": "A reference to the object.
", "ListAttachedIndicesRequest$TargetReference": "A reference to the object that has indices attached.
", "ListIncomingTypedLinksRequest$ObjectReference": "Reference that identifies the object whose attributes will be listed.
", "ListIndexRequest$IndexReference": "The reference to the index to list.
", "ListObjectAttributesRequest$ObjectReference": "The reference that identifies the object whose attributes will be listed.
", "ListObjectChildrenRequest$ObjectReference": "The reference that identifies the object for which child objects are being listed.
", "ListObjectParentPathsRequest$ObjectReference": "The reference that identifies the object whose parent paths are listed.
", "ListObjectParentsRequest$ObjectReference": "The reference that identifies the object for which parent objects are being listed.
", "ListObjectPoliciesRequest$ObjectReference": "Reference that identifies the object for which policies will be listed.
", "ListOutgoingTypedLinksRequest$ObjectReference": "A reference that identifies the object whose attributes will be listed.
", "ListPolicyAttachmentsRequest$PolicyReference": "The reference that identifies the policy object.
", "LookupPolicyRequest$ObjectReference": "Reference that identifies the object whose policies will be looked up.
", "RemoveFacetFromObjectRequest$ObjectReference": "A reference to the object to remove the facet from.
", "TypedLinkSpecifier$SourceObjectReference": "Identifies the source object that the typed link will attach to.
", "TypedLinkSpecifier$TargetObjectReference": "Identifies the target object that the typed link will attach to.
", "UpdateObjectAttributesRequest$ObjectReference": "The reference that identifies the object.
" } }, "ObjectType": { "base": null, "refs": { "CreateFacetRequest$ObjectType": "Specifies whether a given object created from this facet is of type node, leaf node, policy or index.
Node: Can have multiple children but one parent.
Leaf node: Cannot have children but can have multiple parents.
Policy: Allows you to store a policy document and policy type. For more information, see Policies.
Index: Can be created with the Index API.
The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.
", "UpdateFacetRequest$ObjectType": "The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.
" } }, "PathString": { "base": null, "refs": { "PathToObjectIdentifiers$Path": "The path that is used to identify the object starting from directory root.
", "PolicyToPath$Path": "The path that is referenced from the root.
" } }, "PathToObjectIdentifiers": { "base": "Returns the path to the ObjectIdentifiers
that is associated with the directory.
Returns the path to the ObjectIdentifiers
that are associated with the directory.
Returns the path to the ObjectIdentifiers
that are associated with the directory.
Contains the PolicyType
, PolicyId
, and the ObjectIdentifier
to which it is attached. For more information, see Policies.
List of policy objects.
" } }, "PolicyToPath": { "base": "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.
", "refs": { "PolicyToPathList$member": null } }, "PolicyToPathList": { "base": null, "refs": { "BatchLookupPolicyResponse$PolicyToPathList": "Provides list of path to policies. Policies contain PolicyId
, ObjectIdentifier
, and PolicyType
. For more information, see Policies.
Provides list of path to policies. Policies contain PolicyId
, ObjectIdentifier
, and PolicyType
. For more information, see Policies.
The type of policy that can be associated with PolicyAttachment
.
The inclusive or exclusive range start.
", "TypedAttributeValueRange$EndMode": "The inclusive or exclusive range end.
" } }, "RemoveFacetFromObjectRequest": { "base": null, "refs": { } }, "RemoveFacetFromObjectResponse": { "base": null, "refs": { } }, "RequiredAttributeBehavior": { "base": null, "refs": { "FacetAttribute$RequiredBehavior": "The required behavior of the FacetAttribute
.
The required behavior of the TypedLinkAttributeDefinition
.
The specified resource could not be found.
", "refs": { } }, "RetryableConflictException": { "base": "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.
", "refs": { } }, "Rule": { "base": "Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.
", "refs": { "RuleMap$value": null } }, "RuleKey": { "base": null, "refs": { "RuleMap$key": null } }, "RuleMap": { "base": null, "refs": { "FacetAttributeDefinition$Rules": "Validation rules attached to the attribute definition.
", "TypedLinkAttributeDefinition$Rules": "Validation rules that are attached to the attribute definition.
" } }, "RuleParameterKey": { "base": null, "refs": { "RuleParameterMap$key": null } }, "RuleParameterMap": { "base": null, "refs": { "Rule$Parameters": "The minimum and maximum parameters that are associated with the rule.
" } }, "RuleParameterValue": { "base": null, "refs": { "RuleParameterMap$value": null } }, "RuleType": { "base": null, "refs": { "Rule$Type": "The type of attribute validation rule.
" } }, "SchemaAlreadyExistsException": { "base": "Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.
", "refs": { } }, "SchemaAlreadyPublishedException": { "base": "Indicates that a schema is already published.
", "refs": { } }, "SchemaFacet": { "base": "A facet.
", "refs": { "AddFacetToObjectRequest$SchemaFacet": "Identifiers for the facet that you are adding to the object.
", "BatchAddFacetToObject$SchemaFacet": "Represents the facet being added to the object.
", "BatchListObjectAttributes$FacetFilter": "Used to filter the list of object attributes that are associated with a certain facet.
", "BatchRemoveFacetFromObject$SchemaFacet": "The facet to remove from the object.
", "ListObjectAttributesRequest$FacetFilter": "Used to filter the list of object attributes that are associated with a certain facet.
", "RemoveFacetFromObjectRequest$SchemaFacet": "The facet to remove.
", "SchemaFacetList$member": null } }, "SchemaFacetList": { "base": null, "refs": { "BatchCreateObject$SchemaFacet": "A list of FacetArns
that will be associated with the object. For more information, see arns.
The facets attached to the specified object.
", "CreateObjectRequest$SchemaFacets": "A list of schema facets to be associated with the object that contains SchemaArn
and facet name. For more information, see arns.
The facets attached to the specified object.
" } }, "SchemaJsonDocument": { "base": null, "refs": { "GetSchemaAsJsonResponse$Document": "The JSON representation of the schema document.
", "PutSchemaFromJsonRequest$Document": "The replacement JSON schema.
" } }, "SchemaName": { "base": null, "refs": { "CreateSchemaRequest$Name": "The name that is associated with the schema. This is unique to each account and in each region.
", "GetSchemaAsJsonResponse$Name": "The name of the retrieved schema.
", "PublishSchemaRequest$Name": "The new name under which the schema will be published. If this is not provided, the development schema is considered.
", "UpdateSchemaRequest$Name": "The name of the schema.
" } }, "SelectorObjectReference": { "base": null, "refs": { "ObjectReference$Selector": "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:
$ObjectIdentifier - 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
/some/path - Identifies the object based on path
#SomeBatchReference - Identifies the object in a batch call
The object could not be deleted because links still exist. Remove the links and then try the operation again.
", "refs": { } }, "StringAttributeValue": { "base": null, "refs": { "TypedAttributeValue$StringValue": "A string data value.
" } }, "Tag": { "base": "The tag structure that contains a tag key and value.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The key that is associated with the tag.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "Keys of the tag that need to be removed from the resource.
" } }, "TagList": { "base": null, "refs": { "ListTagsForResourceResponse$Tags": "A list of tag key value pairs that are associated with the response.
", "TagResourceRequest$Tags": "A list of tag key-value pairs.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$Value": "The value that is associated with the tag.
" } }, "TagsNumberResults": { "base": null, "refs": { "ListTagsForResourceRequest$MaxResults": "The MaxResults
parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.
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.
", "refs": { "AttributeKeyAndValue$Value": "The value of the attribute.
", "AttributeNameAndValue$Value": "The value for the typed link.
", "FacetAttributeDefinition$DefaultValue": "The default value of the attribute (if configured).
", "ObjectAttributeAction$ObjectAttributeUpdateValue": "The value that you want to update to.
", "TypedAttributeValueRange$StartValue": "The value to start the range at.
", "TypedAttributeValueRange$EndValue": "The attribute value to terminate the range at.
", "TypedLinkAttributeDefinition$DefaultValue": "The default value of the attribute (if configured).
" } }, "TypedAttributeValueRange": { "base": "A range of attribute values.
", "refs": { "ObjectAttributeRange$Range": "The range of attribute values being selected.
", "TypedLinkAttributeRange$Range": "The range of attribute values that are being selected.
" } }, "TypedLinkAttributeDefinition": { "base": "A typed link attribute definition.
", "refs": { "TypedLinkAttributeDefinitionList$member": null, "TypedLinkFacetAttributeUpdate$Attribute": "The attribute to update.
" } }, "TypedLinkAttributeDefinitionList": { "base": null, "refs": { "ListTypedLinkFacetAttributesResponse$Attributes": "An ordered set of attributes associate with the typed link.
", "TypedLinkFacet$Attributes": "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.
" } }, "TypedLinkAttributeRange": { "base": "Identifies the range of attributes that are used by a specified filter.
", "refs": { "TypedLinkAttributeRangeList$member": null } }, "TypedLinkAttributeRangeList": { "base": null, "refs": { "BatchListIncomingTypedLinks$FilterAttributeRanges": "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.
", "BatchListOutgoingTypedLinks$FilterAttributeRanges": "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.
", "ListIncomingTypedLinksRequest$FilterAttributeRanges": "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.
", "ListOutgoingTypedLinksRequest$FilterAttributeRanges": "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.
" } }, "TypedLinkFacet": { "base": "Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.
", "refs": { "CreateTypedLinkFacetRequest$Facet": "Facet structure that is associated with the typed link facet.
" } }, "TypedLinkFacetAttributeUpdate": { "base": "A typed link facet attribute update.
", "refs": { "TypedLinkFacetAttributeUpdateList$member": null } }, "TypedLinkFacetAttributeUpdateList": { "base": null, "refs": { "UpdateTypedLinkFacetRequest$AttributeUpdates": "Attributes update structure.
" } }, "TypedLinkName": { "base": null, "refs": { "DeleteTypedLinkFacetRequest$Name": "The unique name of the typed link facet.
", "GetTypedLinkFacetInformationRequest$Name": "The unique name of the typed link facet.
", "ListTypedLinkFacetAttributesRequest$Name": "The unique name of the typed link facet.
", "TypedLinkFacet$Name": "The unique name of the typed link facet.
", "TypedLinkNameList$member": null, "TypedLinkSchemaAndFacetName$TypedLinkName": "The unique name of the typed link facet.
", "UpdateTypedLinkFacetRequest$Name": "The unique name of the typed link facet.
" } }, "TypedLinkNameList": { "base": null, "refs": { "ListTypedLinkFacetNamesResponse$FacetNames": "The names of typed link facets that exist within the schema.
" } }, "TypedLinkSchemaAndFacetName": { "base": "Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.
", "refs": { "AttachTypedLinkRequest$TypedLinkFacet": "Identifies the typed link facet that is associated with the typed link.
", "BatchAttachTypedLink$TypedLinkFacet": "Identifies the typed link facet that is associated with the typed link.
", "BatchListIncomingTypedLinks$FilterTypedLink": "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.
", "BatchListOutgoingTypedLinks$FilterTypedLink": "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.
", "ListIncomingTypedLinksRequest$FilterTypedLink": "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.
", "ListOutgoingTypedLinksRequest$FilterTypedLink": "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.
", "TypedLinkSpecifier$TypedLinkFacet": "Identifies the typed link facet that is associated with the typed link.
" } }, "TypedLinkSpecifier": { "base": "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.
", "refs": { "AttachTypedLinkResponse$TypedLinkSpecifier": "Returns a typed link specifier as output.
", "BatchAttachTypedLinkResponse$TypedLinkSpecifier": "Returns a typed link specifier as output.
", "BatchDetachTypedLink$TypedLinkSpecifier": "Used to accept a typed link specifier as input.
", "DetachTypedLinkRequest$TypedLinkSpecifier": "Used to accept a typed link specifier as input.
", "TypedLinkSpecifierList$member": null } }, "TypedLinkSpecifierList": { "base": null, "refs": { "BatchListIncomingTypedLinksResponse$LinkSpecifiers": "Returns one or more typed link specifiers as output.
", "BatchListOutgoingTypedLinksResponse$TypedLinkSpecifiers": "Returns a typed link specifier as output.
", "ListIncomingTypedLinksResponse$LinkSpecifiers": "Returns one or more typed link specifiers as output.
", "ListOutgoingTypedLinksResponse$TypedLinkSpecifiers": "Returns a typed link specifier as output.
" } }, "UnsupportedIndexTypeException": { "base": "Indicates that the requested index type is not supported.
", "refs": { } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateActionType": { "base": null, "refs": { "FacetAttributeUpdate$Action": "The action to perform when updating the attribute.
", "ObjectAttributeAction$ObjectAttributeActionType": "A type that can be either Update
or Delete
.
The action to perform when updating the attribute.
" } }, "UpdateFacetRequest": { "base": null, "refs": { } }, "UpdateFacetResponse": { "base": null, "refs": { } }, "UpdateObjectAttributesRequest": { "base": null, "refs": { } }, "UpdateObjectAttributesResponse": { "base": null, "refs": { } }, "UpdateSchemaRequest": { "base": null, "refs": { } }, "UpdateSchemaResponse": { "base": null, "refs": { } }, "UpdateTypedLinkFacetRequest": { "base": null, "refs": { } }, "UpdateTypedLinkFacetResponse": { "base": null, "refs": { } }, "ValidationException": { "base": "Indicates that your request is malformed in some manner. See the exception message.
", "refs": { } }, "Version": { "base": null, "refs": { "PublishSchemaRequest$Version": "The version under which the schema will be published.
" } } } }