Amazon Cloud Directory will no longer be open to new customers starting on November 7, 2025. For alternatives to Cloud Directory, explore [Amazon DynamoDB](https://aws.amazon.com/dynamodb/) and [Amazon Neptune](https://aws.amazon.com/neptune/). If you need help choosing the right alternative for your use case, or for any other questions, contact [AWS Support](https://aws.amazon.com/support/).

# Data Types


The Amazon CloudDirectory API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [AttributeKey](API_AttributeKey.md) 
+  [AttributeKeyAndValue](API_AttributeKeyAndValue.md) 
+  [AttributeNameAndValue](API_AttributeNameAndValue.md) 
+  [BatchAddFacetToObject](API_BatchAddFacetToObject.md) 
+  [BatchAddFacetToObjectResponse](API_BatchAddFacetToObjectResponse.md) 
+  [BatchAttachObject](API_BatchAttachObject.md) 
+  [BatchAttachObjectResponse](API_BatchAttachObjectResponse.md) 
+  [BatchAttachPolicy](API_BatchAttachPolicy.md) 
+  [BatchAttachPolicyResponse](API_BatchAttachPolicyResponse.md) 
+  [BatchAttachToIndex](API_BatchAttachToIndex.md) 
+  [BatchAttachToIndexResponse](API_BatchAttachToIndexResponse.md) 
+  [BatchAttachTypedLink](API_BatchAttachTypedLink.md) 
+  [BatchAttachTypedLinkResponse](API_BatchAttachTypedLinkResponse.md) 
+  [BatchCreateIndex](API_BatchCreateIndex.md) 
+  [BatchCreateIndexResponse](API_BatchCreateIndexResponse.md) 
+  [BatchCreateObject](API_BatchCreateObject.md) 
+  [BatchCreateObjectResponse](API_BatchCreateObjectResponse.md) 
+  [BatchDeleteObject](API_BatchDeleteObject.md) 
+  [BatchDeleteObjectResponse](API_BatchDeleteObjectResponse.md) 
+  [BatchDetachFromIndex](API_BatchDetachFromIndex.md) 
+  [BatchDetachFromIndexResponse](API_BatchDetachFromIndexResponse.md) 
+  [BatchDetachObject](API_BatchDetachObject.md) 
+  [BatchDetachObjectResponse](API_BatchDetachObjectResponse.md) 
+  [BatchDetachPolicy](API_BatchDetachPolicy.md) 
+  [BatchDetachPolicyResponse](API_BatchDetachPolicyResponse.md) 
+  [BatchDetachTypedLink](API_BatchDetachTypedLink.md) 
+  [BatchDetachTypedLinkResponse](API_BatchDetachTypedLinkResponse.md) 
+  [BatchGetLinkAttributes](API_BatchGetLinkAttributes.md) 
+  [BatchGetLinkAttributesResponse](API_BatchGetLinkAttributesResponse.md) 
+  [BatchGetObjectAttributes](API_BatchGetObjectAttributes.md) 
+  [BatchGetObjectAttributesResponse](API_BatchGetObjectAttributesResponse.md) 
+  [BatchGetObjectInformation](API_BatchGetObjectInformation.md) 
+  [BatchGetObjectInformationResponse](API_BatchGetObjectInformationResponse.md) 
+  [BatchListAttachedIndices](API_BatchListAttachedIndices.md) 
+  [BatchListAttachedIndicesResponse](API_BatchListAttachedIndicesResponse.md) 
+  [BatchListIncomingTypedLinks](API_BatchListIncomingTypedLinks.md) 
+  [BatchListIncomingTypedLinksResponse](API_BatchListIncomingTypedLinksResponse.md) 
+  [BatchListIndex](API_BatchListIndex.md) 
+  [BatchListIndexResponse](API_BatchListIndexResponse.md) 
+  [BatchListObjectAttributes](API_BatchListObjectAttributes.md) 
+  [BatchListObjectAttributesResponse](API_BatchListObjectAttributesResponse.md) 
+  [BatchListObjectChildren](API_BatchListObjectChildren.md) 
+  [BatchListObjectChildrenResponse](API_BatchListObjectChildrenResponse.md) 
+  [BatchListObjectParentPaths](API_BatchListObjectParentPaths.md) 
+  [BatchListObjectParentPathsResponse](API_BatchListObjectParentPathsResponse.md) 
+  [BatchListObjectParents](API_BatchListObjectParents.md) 
+  [BatchListObjectParentsResponse](API_BatchListObjectParentsResponse.md) 
+  [BatchListObjectPolicies](API_BatchListObjectPolicies.md) 
+  [BatchListObjectPoliciesResponse](API_BatchListObjectPoliciesResponse.md) 
+  [BatchListOutgoingTypedLinks](API_BatchListOutgoingTypedLinks.md) 
+  [BatchListOutgoingTypedLinksResponse](API_BatchListOutgoingTypedLinksResponse.md) 
+  [BatchListPolicyAttachments](API_BatchListPolicyAttachments.md) 
+  [BatchListPolicyAttachmentsResponse](API_BatchListPolicyAttachmentsResponse.md) 
+  [BatchLookupPolicy](API_BatchLookupPolicy.md) 
+  [BatchLookupPolicyResponse](API_BatchLookupPolicyResponse.md) 
+  [BatchReadException](API_BatchReadException.md) 
+  [BatchReadOperation](API_BatchReadOperation.md) 
+  [BatchReadOperationResponse](API_BatchReadOperationResponse.md) 
+  [BatchReadSuccessfulResponse](API_BatchReadSuccessfulResponse.md) 
+  [BatchRemoveFacetFromObject](API_BatchRemoveFacetFromObject.md) 
+  [BatchRemoveFacetFromObjectResponse](API_BatchRemoveFacetFromObjectResponse.md) 
+  [BatchUpdateLinkAttributes](API_BatchUpdateLinkAttributes.md) 
+  [BatchUpdateLinkAttributesResponse](API_BatchUpdateLinkAttributesResponse.md) 
+  [BatchUpdateObjectAttributes](API_BatchUpdateObjectAttributes.md) 
+  [BatchUpdateObjectAttributesResponse](API_BatchUpdateObjectAttributesResponse.md) 
+  [BatchWriteOperation](API_BatchWriteOperation.md) 
+  [BatchWriteOperationResponse](API_BatchWriteOperationResponse.md) 
+  [Directory](API_Directory.md) 
+  [Facet](API_Facet.md) 
+  [FacetAttribute](API_FacetAttribute.md) 
+  [FacetAttributeDefinition](API_FacetAttributeDefinition.md) 
+  [FacetAttributeReference](API_FacetAttributeReference.md) 
+  [FacetAttributeUpdate](API_FacetAttributeUpdate.md) 
+  [IndexAttachment](API_IndexAttachment.md) 
+  [LinkAttributeAction](API_LinkAttributeAction.md) 
+  [LinkAttributeUpdate](API_LinkAttributeUpdate.md) 
+  [ObjectAttributeAction](API_ObjectAttributeAction.md) 
+  [ObjectAttributeRange](API_ObjectAttributeRange.md) 
+  [ObjectAttributeUpdate](API_ObjectAttributeUpdate.md) 
+  [ObjectIdentifierAndLinkNameTuple](API_ObjectIdentifierAndLinkNameTuple.md) 
+  [ObjectReference](API_ObjectReference.md) 
+  [PathToObjectIdentifiers](API_PathToObjectIdentifiers.md) 
+  [PolicyAttachment](API_PolicyAttachment.md) 
+  [PolicyToPath](API_PolicyToPath.md) 
+  [Rule](API_Rule.md) 
+  [SchemaFacet](API_SchemaFacet.md) 
+  [Tag](API_Tag.md) 
+  [TypedAttributeValue](API_TypedAttributeValue.md) 
+  [TypedAttributeValueRange](API_TypedAttributeValueRange.md) 
+  [TypedLinkAttributeDefinition](API_TypedLinkAttributeDefinition.md) 
+  [TypedLinkAttributeRange](API_TypedLinkAttributeRange.md) 
+  [TypedLinkFacet](API_TypedLinkFacet.md) 
+  [TypedLinkFacetAttributeUpdate](API_TypedLinkFacetAttributeUpdate.md) 
+  [TypedLinkSchemaAndFacetName](API_TypedLinkSchemaAndFacetName.md) 
+  [TypedLinkSpecifier](API_TypedLinkSpecifier.md) 

# AttributeKey


A unique identifier for an attribute.

## Contents


 ** FacetName **   <a name="amazoncds-Type-AttributeKey-FacetName"></a>
The name of the facet that the attribute exists within.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: Yes

 ** Name **   <a name="amazoncds-Type-AttributeKey-Name"></a>
The name of the attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 230.  
Pattern: `^[a-zA-Z0-9._:-]*$`   
Required: Yes

 ** SchemaArn **   <a name="amazoncds-Type-AttributeKey-SchemaArn"></a>
The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.  
Type: String  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/AttributeKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/AttributeKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/AttributeKey) 

# AttributeKeyAndValue


The combination of an attribute key and an attribute value.

## Contents


 ** Key **   <a name="amazoncds-Type-AttributeKeyAndValue-Key"></a>
The key of the attribute.  
Type: [AttributeKey](API_AttributeKey.md) object  
Required: Yes

 ** Value **   <a name="amazoncds-Type-AttributeKeyAndValue-Value"></a>
The value of the attribute.  
Type: [TypedAttributeValue](API_TypedAttributeValue.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/AttributeKeyAndValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/AttributeKeyAndValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/AttributeKeyAndValue) 

# AttributeNameAndValue


Identifies the attribute name and value for a typed link.

## Contents


 ** AttributeName **   <a name="amazoncds-Type-AttributeNameAndValue-AttributeName"></a>
The attribute name of the typed link.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 230.  
Pattern: `^[a-zA-Z0-9._:-]*$`   
Required: Yes

 ** Value **   <a name="amazoncds-Type-AttributeNameAndValue-Value"></a>
The value for the typed link.  
Type: [TypedAttributeValue](API_TypedAttributeValue.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/AttributeNameAndValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/AttributeNameAndValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/AttributeNameAndValue) 

# BatchAddFacetToObject


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

## Contents


 ** ObjectAttributeList **   <a name="amazoncds-Type-BatchAddFacetToObject-ObjectAttributeList"></a>
The attributes to set on the object.  
Type: Array of [AttributeKeyAndValue](API_AttributeKeyAndValue.md) objects  
Required: Yes

 ** ObjectReference **   <a name="amazoncds-Type-BatchAddFacetToObject-ObjectReference"></a>
A reference to the object being mutated.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** SchemaFacet **   <a name="amazoncds-Type-BatchAddFacetToObject-SchemaFacet"></a>
Represents the facet being added to the object.  
Type: [SchemaFacet](API_SchemaFacet.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchAddFacetToObject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchAddFacetToObject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchAddFacetToObject) 

# BatchAddFacetToObjectResponse


The result of a batch add facet to object operation.

## Contents


The members of this exception structure are context-dependent.

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchAddFacetToObjectResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchAddFacetToObjectResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchAddFacetToObjectResponse) 

# BatchAttachObject


Represents the output of an [AttachObject](API_AttachObject.md) operation.

## Contents


 ** ChildReference **   <a name="amazoncds-Type-BatchAttachObject-ChildReference"></a>
The child object reference that is to be attached to the object.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** LinkName **   <a name="amazoncds-Type-BatchAttachObject-LinkName"></a>
The name of the link.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[^\/\[\]\(\):\{\}#@!?\s\\;]+`   
Required: Yes

 ** ParentReference **   <a name="amazoncds-Type-BatchAttachObject-ParentReference"></a>
The parent object reference.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchAttachObject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchAttachObject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchAttachObject) 

# BatchAttachObjectResponse


Represents the output batch [AttachObject](API_AttachObject.md) response operation.

## Contents


 ** attachedObjectIdentifier **   <a name="amazoncds-Type-BatchAttachObjectResponse-attachedObjectIdentifier"></a>
The `ObjectIdentifier` of the object that has been attached.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchAttachObjectResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchAttachObjectResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchAttachObjectResponse) 

# BatchAttachPolicy


Attaches a policy object to a regular object inside a [BatchRead](API_BatchRead.md) operation. For more information, see [AttachPolicy](API_AttachPolicy.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchAttachPolicy-ObjectReference"></a>
The reference that identifies the object to which the policy will be attached.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** PolicyReference **   <a name="amazoncds-Type-BatchAttachPolicy-PolicyReference"></a>
The reference that is associated with the policy object.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchAttachPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchAttachPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchAttachPolicy) 

# BatchAttachPolicyResponse


Represents the output of an [AttachPolicy](API_AttachPolicy.md) response operation.

## Contents


The members of this exception structure are context-dependent.

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchAttachPolicyResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchAttachPolicyResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchAttachPolicyResponse) 

# BatchAttachToIndex


Attaches the specified object to the specified index inside a [BatchRead](API_BatchRead.md) operation. For more information, see [AttachToIndex](API_AttachToIndex.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** IndexReference **   <a name="amazoncds-Type-BatchAttachToIndex-IndexReference"></a>
A reference to the index that you are attaching the object to.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** TargetReference **   <a name="amazoncds-Type-BatchAttachToIndex-TargetReference"></a>
A reference to the object that you are attaching to the index.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchAttachToIndex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchAttachToIndex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchAttachToIndex) 

# BatchAttachToIndexResponse


Represents the output of a [AttachToIndex](API_AttachToIndex.md) response operation.

## Contents


 ** AttachedObjectIdentifier **   <a name="amazoncds-Type-BatchAttachToIndexResponse-AttachedObjectIdentifier"></a>
The `ObjectIdentifier` of the object that was attached to the index.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchAttachToIndexResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchAttachToIndexResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchAttachToIndexResponse) 

# BatchAttachTypedLink


Attaches a typed link to a specified source and target object inside a [BatchRead](API_BatchRead.md) operation. For more information, see [AttachTypedLink](API_AttachTypedLink.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** Attributes **   <a name="amazoncds-Type-BatchAttachTypedLink-Attributes"></a>
A set of attributes that are associated with the typed link.  
Type: Array of [AttributeNameAndValue](API_AttributeNameAndValue.md) objects  
Required: Yes

 ** SourceObjectReference **   <a name="amazoncds-Type-BatchAttachTypedLink-SourceObjectReference"></a>
Identifies the source object that the typed link will attach to.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** TargetObjectReference **   <a name="amazoncds-Type-BatchAttachTypedLink-TargetObjectReference"></a>
Identifies the target object that the typed link will attach to.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** TypedLinkFacet **   <a name="amazoncds-Type-BatchAttachTypedLink-TypedLinkFacet"></a>
Identifies the typed link facet that is associated with the typed link.  
Type: [TypedLinkSchemaAndFacetName](API_TypedLinkSchemaAndFacetName.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchAttachTypedLink) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchAttachTypedLink) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchAttachTypedLink) 

# BatchAttachTypedLinkResponse


Represents the output of a [AttachTypedLink](API_AttachTypedLink.md) response operation.

## Contents


 ** TypedLinkSpecifier **   <a name="amazoncds-Type-BatchAttachTypedLinkResponse-TypedLinkSpecifier"></a>
Returns a typed link specifier as output.  
Type: [TypedLinkSpecifier](API_TypedLinkSpecifier.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchAttachTypedLinkResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchAttachTypedLinkResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchAttachTypedLinkResponse) 

# BatchCreateIndex


Creates an index object inside of a [BatchRead](API_BatchRead.md) operation. For more information, see [CreateIndex](API_CreateIndex.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** IsUnique **   <a name="amazoncds-Type-BatchCreateIndex-IsUnique"></a>
Indicates whether the attribute that is being indexed has unique values or not.  
Type: Boolean  
Required: Yes

 ** OrderedIndexedAttributeList **   <a name="amazoncds-Type-BatchCreateIndex-OrderedIndexedAttributeList"></a>
Specifies the attributes that should be indexed on. Currently only a single attribute is supported.  
Type: Array of [AttributeKey](API_AttributeKey.md) objects  
Required: Yes

 ** BatchReferenceName **   <a name="amazoncds-Type-BatchCreateIndex-BatchReferenceName"></a>
The batch reference name. See [Transaction Support](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) for more information.  
Type: String  
Required: No

 ** LinkName **   <a name="amazoncds-Type-BatchCreateIndex-LinkName"></a>
The name of the link between the parent object and the index object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[^\/\[\]\(\):\{\}#@!?\s\\;]+`   
Required: No

 ** ParentReference **   <a name="amazoncds-Type-BatchCreateIndex-ParentReference"></a>
A reference to the parent object that contains the index object.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchCreateIndex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchCreateIndex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchCreateIndex) 

# BatchCreateIndexResponse


Represents the output of a [CreateIndex](API_CreateIndex.md) response operation.

## Contents


 ** ObjectIdentifier **   <a name="amazoncds-Type-BatchCreateIndexResponse-ObjectIdentifier"></a>
The `ObjectIdentifier` of the index created by this operation.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchCreateIndexResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchCreateIndexResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchCreateIndexResponse) 

# BatchCreateObject


Represents the output of a [CreateObject](API_CreateObject.md) operation.

## Contents


 ** ObjectAttributeList **   <a name="amazoncds-Type-BatchCreateObject-ObjectAttributeList"></a>
An attribute map, which contains an attribute ARN as the key and attribute value as the map value.  
Type: Array of [AttributeKeyAndValue](API_AttributeKeyAndValue.md) objects  
Required: Yes

 ** SchemaFacet **   <a name="amazoncds-Type-BatchCreateObject-SchemaFacet"></a>
A list of `FacetArns` that will be associated with the object. For more information, see [Arn Examples](arns.md).  
Type: Array of [SchemaFacet](API_SchemaFacet.md) objects  
Required: Yes

 ** BatchReferenceName **   <a name="amazoncds-Type-BatchCreateObject-BatchReferenceName"></a>
The batch reference name. See [Transaction Support](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) for more information.  
Type: String  
Required: No

 ** LinkName **   <a name="amazoncds-Type-BatchCreateObject-LinkName"></a>
The name of the link.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[^\/\[\]\(\):\{\}#@!?\s\\;]+`   
Required: No

 ** ParentReference **   <a name="amazoncds-Type-BatchCreateObject-ParentReference"></a>
If specified, the parent reference to which this object will be attached.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchCreateObject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchCreateObject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchCreateObject) 

# BatchCreateObjectResponse


Represents the output of a [CreateObject](API_CreateObject.md) response operation.

## Contents


 ** ObjectIdentifier **   <a name="amazoncds-Type-BatchCreateObjectResponse-ObjectIdentifier"></a>
The ID that is associated with the object.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchCreateObjectResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchCreateObjectResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchCreateObjectResponse) 

# BatchDeleteObject


Represents the output of a [DeleteObject](API_DeleteObject.md) operation.

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchDeleteObject-ObjectReference"></a>
The reference that identifies the object.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchDeleteObject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchDeleteObject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchDeleteObject) 

# BatchDeleteObjectResponse


Represents the output of a [DeleteObject](API_DeleteObject.md) response operation.

## Contents


The members of this exception structure are context-dependent.

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchDeleteObjectResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchDeleteObjectResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchDeleteObjectResponse) 

# BatchDetachFromIndex


Detaches the specified object from the specified index inside a [BatchRead](API_BatchRead.md) operation. For more information, see [DetachFromIndex](API_DetachFromIndex.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** IndexReference **   <a name="amazoncds-Type-BatchDetachFromIndex-IndexReference"></a>
A reference to the index object.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** TargetReference **   <a name="amazoncds-Type-BatchDetachFromIndex-TargetReference"></a>
A reference to the object being detached from the index.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchDetachFromIndex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchDetachFromIndex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchDetachFromIndex) 

# BatchDetachFromIndexResponse


Represents the output of a [DetachFromIndex](API_DetachFromIndex.md) response operation.

## Contents


 ** DetachedObjectIdentifier **   <a name="amazoncds-Type-BatchDetachFromIndexResponse-DetachedObjectIdentifier"></a>
The `ObjectIdentifier` of the object that was detached from the index.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchDetachFromIndexResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchDetachFromIndexResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchDetachFromIndexResponse) 

# BatchDetachObject


Represents the output of a [DetachObject](API_DetachObject.md) operation.

## Contents


 ** LinkName **   <a name="amazoncds-Type-BatchDetachObject-LinkName"></a>
The name of the link.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[^\/\[\]\(\):\{\}#@!?\s\\;]+`   
Required: Yes

 ** ParentReference **   <a name="amazoncds-Type-BatchDetachObject-ParentReference"></a>
Parent reference from which the object with the specified link name is detached.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** BatchReferenceName **   <a name="amazoncds-Type-BatchDetachObject-BatchReferenceName"></a>
The batch reference name. See [Transaction Support](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) for more information.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchDetachObject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchDetachObject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchDetachObject) 

# BatchDetachObjectResponse


Represents the output of a [DetachObject](API_DetachObject.md) response operation.

## Contents


 ** detachedObjectIdentifier **   <a name="amazoncds-Type-BatchDetachObjectResponse-detachedObjectIdentifier"></a>
The `ObjectIdentifier` of the detached object.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchDetachObjectResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchDetachObjectResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchDetachObjectResponse) 

# BatchDetachPolicy


Detaches the specified policy from the specified directory inside a [BatchWrite](API_BatchWrite.md) operation. For more information, see [DetachPolicy](API_DetachPolicy.md) and [BatchWrite:Operations](API_BatchWrite.md#amazoncds-BatchWrite-request-Operations).

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchDetachPolicy-ObjectReference"></a>
Reference that identifies the object whose policy object will be detached.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** PolicyReference **   <a name="amazoncds-Type-BatchDetachPolicy-PolicyReference"></a>
Reference that identifies the policy object.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchDetachPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchDetachPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchDetachPolicy) 

# BatchDetachPolicyResponse


Represents the output of a [DetachPolicy](API_DetachPolicy.md) response operation.

## Contents


The members of this exception structure are context-dependent.

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchDetachPolicyResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchDetachPolicyResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchDetachPolicyResponse) 

# BatchDetachTypedLink


Detaches a typed link from a specified source and target object inside a [BatchRead](API_BatchRead.md) operation. For more information, see [DetachTypedLink](API_DetachTypedLink.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** TypedLinkSpecifier **   <a name="amazoncds-Type-BatchDetachTypedLink-TypedLinkSpecifier"></a>
Used to accept a typed link specifier as input.  
Type: [TypedLinkSpecifier](API_TypedLinkSpecifier.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchDetachTypedLink) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchDetachTypedLink) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchDetachTypedLink) 

# BatchDetachTypedLinkResponse


Represents the output of a [DetachTypedLink](API_DetachTypedLink.md) response operation.

## Contents


The members of this exception structure are context-dependent.

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchDetachTypedLinkResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchDetachTypedLinkResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchDetachTypedLinkResponse) 

# BatchGetLinkAttributes


Retrieves attributes that are associated with a typed link inside a [BatchRead](API_BatchRead.md) operation. For more information, see [GetLinkAttributes](API_GetLinkAttributes.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** AttributeNames **   <a name="amazoncds-Type-BatchGetLinkAttributes-AttributeNames"></a>
A list of attribute names whose values will be retrieved.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 230.  
Pattern: `^[a-zA-Z0-9._:-]*$`   
Required: Yes

 ** TypedLinkSpecifier **   <a name="amazoncds-Type-BatchGetLinkAttributes-TypedLinkSpecifier"></a>
Allows a typed link specifier to be accepted as input.  
Type: [TypedLinkSpecifier](API_TypedLinkSpecifier.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchGetLinkAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchGetLinkAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchGetLinkAttributes) 

# BatchGetLinkAttributesResponse


Represents the output of a [GetLinkAttributes](API_GetLinkAttributes.md) response operation.

## Contents


 ** Attributes **   <a name="amazoncds-Type-BatchGetLinkAttributesResponse-Attributes"></a>
The attributes that are associated with the typed link.  
Type: Array of [AttributeKeyAndValue](API_AttributeKeyAndValue.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchGetLinkAttributesResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchGetLinkAttributesResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchGetLinkAttributesResponse) 

# BatchGetObjectAttributes


Retrieves attributes within a facet that are associated with an object inside an [BatchRead](API_BatchRead.md) operation. For more information, see [GetObjectAttributes](API_GetObjectAttributes.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** AttributeNames **   <a name="amazoncds-Type-BatchGetObjectAttributes-AttributeNames"></a>
List of attribute names whose values will be retrieved.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 230.  
Pattern: `^[a-zA-Z0-9._:-]*$`   
Required: Yes

 ** ObjectReference **   <a name="amazoncds-Type-BatchGetObjectAttributes-ObjectReference"></a>
Reference that identifies the object whose attributes will be retrieved.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** SchemaFacet **   <a name="amazoncds-Type-BatchGetObjectAttributes-SchemaFacet"></a>
Identifier for the facet whose attributes will be retrieved. See [SchemaFacet](API_SchemaFacet.md) for details.  
Type: [SchemaFacet](API_SchemaFacet.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchGetObjectAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchGetObjectAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchGetObjectAttributes) 

# BatchGetObjectAttributesResponse


Represents the output of a [GetObjectAttributes](API_GetObjectAttributes.md) response operation.

## Contents


 ** Attributes **   <a name="amazoncds-Type-BatchGetObjectAttributesResponse-Attributes"></a>
The attribute values that are associated with an object.  
Type: Array of [AttributeKeyAndValue](API_AttributeKeyAndValue.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchGetObjectAttributesResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchGetObjectAttributesResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchGetObjectAttributesResponse) 

# BatchGetObjectInformation


Retrieves metadata about an object inside a [BatchRead](API_BatchRead.md) operation. For more information, see [GetObjectInformation](API_GetObjectInformation.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchGetObjectInformation-ObjectReference"></a>
A reference to the object.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchGetObjectInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchGetObjectInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchGetObjectInformation) 

# BatchGetObjectInformationResponse


Represents the output of a [GetObjectInformation](API_GetObjectInformation.md) response operation.

## Contents


 ** ObjectIdentifier **   <a name="amazoncds-Type-BatchGetObjectInformationResponse-ObjectIdentifier"></a>
The `ObjectIdentifier` of the specified object.  
Type: String  
Required: No

 ** SchemaFacets **   <a name="amazoncds-Type-BatchGetObjectInformationResponse-SchemaFacets"></a>
The facets attached to the specified object.  
Type: Array of [SchemaFacet](API_SchemaFacet.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchGetObjectInformationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchGetObjectInformationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchGetObjectInformationResponse) 

# BatchListAttachedIndices


Lists indices attached to an object inside a [BatchRead](API_BatchRead.md) operation. For more information, see [ListAttachedIndices](API_ListAttachedIndices.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** TargetReference **   <a name="amazoncds-Type-BatchListAttachedIndices-TargetReference"></a>
A reference to the object that has indices attached.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** MaxResults **   <a name="amazoncds-Type-BatchListAttachedIndices-MaxResults"></a>
The maximum number of results to retrieve.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListAttachedIndices-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListAttachedIndices) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListAttachedIndices) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListAttachedIndices) 

# BatchListAttachedIndicesResponse


Represents the output of a [ListAttachedIndices](API_ListAttachedIndices.md) response operation.

## Contents


 ** IndexAttachments **   <a name="amazoncds-Type-BatchListAttachedIndicesResponse-IndexAttachments"></a>
The indices attached to the specified object.  
Type: Array of [IndexAttachment](API_IndexAttachment.md) objects  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListAttachedIndicesResponse-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListAttachedIndicesResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListAttachedIndicesResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListAttachedIndicesResponse) 

# BatchListIncomingTypedLinks


Returns a paginated list of all the incoming [TypedLinkSpecifier](API_TypedLinkSpecifier.md) information for an object inside a [BatchRead](API_BatchRead.md) operation. For more information, see [ListIncomingTypedLinks](API_ListIncomingTypedLinks.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchListIncomingTypedLinks-ObjectReference"></a>
The reference that identifies the object whose attributes will be listed.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** FilterAttributeRanges **   <a name="amazoncds-Type-BatchListIncomingTypedLinks-FilterAttributeRanges"></a>
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.  
Type: Array of [TypedLinkAttributeRange](API_TypedLinkAttributeRange.md) objects  
Required: No

 ** FilterTypedLink **   <a name="amazoncds-Type-BatchListIncomingTypedLinks-FilterTypedLink"></a>
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.  
Type: [TypedLinkSchemaAndFacetName](API_TypedLinkSchemaAndFacetName.md) object  
Required: No

 ** MaxResults **   <a name="amazoncds-Type-BatchListIncomingTypedLinks-MaxResults"></a>
The maximum number of results to retrieve.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListIncomingTypedLinks-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListIncomingTypedLinks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListIncomingTypedLinks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListIncomingTypedLinks) 

# BatchListIncomingTypedLinksResponse


Represents the output of a [ListIncomingTypedLinks](API_ListIncomingTypedLinks.md) response operation.

## Contents


 ** LinkSpecifiers **   <a name="amazoncds-Type-BatchListIncomingTypedLinksResponse-LinkSpecifiers"></a>
Returns one or more typed link specifiers as output.  
Type: Array of [TypedLinkSpecifier](API_TypedLinkSpecifier.md) objects  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListIncomingTypedLinksResponse-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListIncomingTypedLinksResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListIncomingTypedLinksResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListIncomingTypedLinksResponse) 

# BatchListIndex


Lists objects attached to the specified index inside a [BatchRead](API_BatchRead.md) operation. For more information, see [ListIndex](API_ListIndex.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** IndexReference **   <a name="amazoncds-Type-BatchListIndex-IndexReference"></a>
The reference to the index to list.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** MaxResults **   <a name="amazoncds-Type-BatchListIndex-MaxResults"></a>
The maximum number of results to retrieve.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListIndex-NextToken"></a>
The pagination token.  
Type: String  
Required: No

 ** RangesOnIndexedValues **   <a name="amazoncds-Type-BatchListIndex-RangesOnIndexedValues"></a>
Specifies the ranges of indexed values that you want to query.  
Type: Array of [ObjectAttributeRange](API_ObjectAttributeRange.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListIndex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListIndex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListIndex) 

# BatchListIndexResponse


Represents the output of a [ListIndex](API_ListIndex.md) response operation.

## Contents


 ** IndexAttachments **   <a name="amazoncds-Type-BatchListIndexResponse-IndexAttachments"></a>
The objects and indexed values attached to the index.  
Type: Array of [IndexAttachment](API_IndexAttachment.md) objects  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListIndexResponse-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListIndexResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListIndexResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListIndexResponse) 

# BatchListObjectAttributes


Represents the output of a [ListObjectAttributes](API_ListObjectAttributes.md) operation.

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchListObjectAttributes-ObjectReference"></a>
Reference of the object whose attributes need to be listed.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** FacetFilter **   <a name="amazoncds-Type-BatchListObjectAttributes-FacetFilter"></a>
Used to filter the list of object attributes that are associated with a certain facet.  
Type: [SchemaFacet](API_SchemaFacet.md) object  
Required: No

 ** MaxResults **   <a name="amazoncds-Type-BatchListObjectAttributes-MaxResults"></a>
The maximum number of items to be retrieved in a single call. This is an approximate number.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListObjectAttributes-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListObjectAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListObjectAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListObjectAttributes) 

# BatchListObjectAttributesResponse


Represents the output of a [ListObjectAttributes](API_ListObjectAttributes.md) response operation.

## Contents


 ** Attributes **   <a name="amazoncds-Type-BatchListObjectAttributesResponse-Attributes"></a>
The attributes map that is associated with the object. `AttributeArn` is the key; attribute value is the value.  
Type: Array of [AttributeKeyAndValue](API_AttributeKeyAndValue.md) objects  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListObjectAttributesResponse-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListObjectAttributesResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListObjectAttributesResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListObjectAttributesResponse) 

# BatchListObjectChildren


Represents the output of a [ListObjectChildren](API_ListObjectChildren.md) operation.

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchListObjectChildren-ObjectReference"></a>
Reference of the object for which child objects are being listed.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** MaxResults **   <a name="amazoncds-Type-BatchListObjectChildren-MaxResults"></a>
Maximum number of items to be retrieved in a single call. This is an approximate number.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListObjectChildren-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListObjectChildren) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListObjectChildren) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListObjectChildren) 

# BatchListObjectChildrenResponse


Represents the output of a [ListObjectChildren](API_ListObjectChildren.md) response operation.

## Contents


 ** Children **   <a name="amazoncds-Type-BatchListObjectChildrenResponse-Children"></a>
The children structure, which is a map with the key as the `LinkName` and `ObjectIdentifier` as the value.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `[^\/\[\]\(\):\{\}#@!?\s\\;]+`   
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListObjectChildrenResponse-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListObjectChildrenResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListObjectChildrenResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListObjectChildrenResponse) 

# BatchListObjectParentPaths


Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a [BatchRead](API_BatchRead.md) operation. For more information, see [ListObjectParentPaths](API_ListObjectParentPaths.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchListObjectParentPaths-ObjectReference"></a>
The reference that identifies the object whose attributes will be listed.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** MaxResults **   <a name="amazoncds-Type-BatchListObjectParentPaths-MaxResults"></a>
The maximum number of results to retrieve.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListObjectParentPaths-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListObjectParentPaths) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListObjectParentPaths) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListObjectParentPaths) 

# BatchListObjectParentPathsResponse


Represents the output of a [ListObjectParentPaths](API_ListObjectParentPaths.md) response operation.

## Contents


 ** NextToken **   <a name="amazoncds-Type-BatchListObjectParentPathsResponse-NextToken"></a>
The pagination token.  
Type: String  
Required: No

 ** PathToObjectIdentifiersList **   <a name="amazoncds-Type-BatchListObjectParentPathsResponse-PathToObjectIdentifiersList"></a>
Returns the path to the `ObjectIdentifiers` that are associated with the directory.  
Type: Array of [PathToObjectIdentifiers](API_PathToObjectIdentifiers.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListObjectParentPathsResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListObjectParentPathsResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListObjectParentPathsResponse) 

# BatchListObjectParents


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

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchListObjectParents-ObjectReference"></a>
The reference that identifies an object.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** MaxResults **   <a name="amazoncds-Type-BatchListObjectParents-MaxResults"></a>
The maximum number of items to be retrieved in a single call. This is an approximate number.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListObjectParents-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListObjectParents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListObjectParents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListObjectParents) 

# BatchListObjectParentsResponse


Represents the output of a [ListObjectParents](API_ListObjectParents.md) response operation.

## Contents


 ** NextToken **   <a name="amazoncds-Type-BatchListObjectParentsResponse-NextToken"></a>
The pagination token.  
Type: String  
Required: No

 ** ParentLinks **   <a name="amazoncds-Type-BatchListObjectParentsResponse-ParentLinks"></a>
Returns a list of parent reference and LinkName Tuples.  
Type: Array of [ObjectIdentifierAndLinkNameTuple](API_ObjectIdentifierAndLinkNameTuple.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListObjectParentsResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListObjectParentsResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListObjectParentsResponse) 

# BatchListObjectPolicies


Returns policies attached to an object in pagination fashion inside a [BatchRead](API_BatchRead.md) operation. For more information, see [ListObjectPolicies](API_ListObjectPolicies.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchListObjectPolicies-ObjectReference"></a>
The reference that identifies the object whose attributes will be listed.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** MaxResults **   <a name="amazoncds-Type-BatchListObjectPolicies-MaxResults"></a>
The maximum number of results to retrieve.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListObjectPolicies-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListObjectPolicies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListObjectPolicies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListObjectPolicies) 

# BatchListObjectPoliciesResponse


Represents the output of a [ListObjectPolicies](API_ListObjectPolicies.md) response operation.

## Contents


 ** AttachedPolicyIds **   <a name="amazoncds-Type-BatchListObjectPoliciesResponse-AttachedPolicyIds"></a>
A list of policy `ObjectIdentifiers`, that are attached to the object.  
Type: Array of strings  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListObjectPoliciesResponse-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListObjectPoliciesResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListObjectPoliciesResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListObjectPoliciesResponse) 

# BatchListOutgoingTypedLinks


Returns a paginated list of all the outgoing [TypedLinkSpecifier](API_TypedLinkSpecifier.md) information for an object inside a [BatchRead](API_BatchRead.md) operation. For more information, see [ListOutgoingTypedLinks](API_ListOutgoingTypedLinks.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchListOutgoingTypedLinks-ObjectReference"></a>
The reference that identifies the object whose attributes will be listed.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** FilterAttributeRanges **   <a name="amazoncds-Type-BatchListOutgoingTypedLinks-FilterAttributeRanges"></a>
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.  
Type: Array of [TypedLinkAttributeRange](API_TypedLinkAttributeRange.md) objects  
Required: No

 ** FilterTypedLink **   <a name="amazoncds-Type-BatchListOutgoingTypedLinks-FilterTypedLink"></a>
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.  
Type: [TypedLinkSchemaAndFacetName](API_TypedLinkSchemaAndFacetName.md) object  
Required: No

 ** MaxResults **   <a name="amazoncds-Type-BatchListOutgoingTypedLinks-MaxResults"></a>
The maximum number of results to retrieve.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListOutgoingTypedLinks-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListOutgoingTypedLinks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListOutgoingTypedLinks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListOutgoingTypedLinks) 

# BatchListOutgoingTypedLinksResponse


Represents the output of a [ListOutgoingTypedLinks](API_ListOutgoingTypedLinks.md) response operation.

## Contents


 ** NextToken **   <a name="amazoncds-Type-BatchListOutgoingTypedLinksResponse-NextToken"></a>
The pagination token.  
Type: String  
Required: No

 ** TypedLinkSpecifiers **   <a name="amazoncds-Type-BatchListOutgoingTypedLinksResponse-TypedLinkSpecifiers"></a>
Returns a typed link specifier as output.  
Type: Array of [TypedLinkSpecifier](API_TypedLinkSpecifier.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListOutgoingTypedLinksResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListOutgoingTypedLinksResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListOutgoingTypedLinksResponse) 

# BatchListPolicyAttachments


Returns all of the `ObjectIdentifiers` to which a given policy is attached inside a [BatchRead](API_BatchRead.md) operation. For more information, see [ListPolicyAttachments](API_ListPolicyAttachments.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** PolicyReference **   <a name="amazoncds-Type-BatchListPolicyAttachments-PolicyReference"></a>
The reference that identifies the policy object.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** MaxResults **   <a name="amazoncds-Type-BatchListPolicyAttachments-MaxResults"></a>
The maximum number of results to retrieve.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchListPolicyAttachments-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListPolicyAttachments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListPolicyAttachments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListPolicyAttachments) 

# BatchListPolicyAttachmentsResponse


Represents the output of a [ListPolicyAttachments](API_ListPolicyAttachments.md) response operation.

## Contents


 ** NextToken **   <a name="amazoncds-Type-BatchListPolicyAttachmentsResponse-NextToken"></a>
The pagination token.  
Type: String  
Required: No

 ** ObjectIdentifiers **   <a name="amazoncds-Type-BatchListPolicyAttachmentsResponse-ObjectIdentifiers"></a>
A list of `ObjectIdentifiers` to which the policy is attached.  
Type: Array of strings  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchListPolicyAttachmentsResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchListPolicyAttachmentsResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchListPolicyAttachmentsResponse) 

# BatchLookupPolicy


Lists all policies from the root of the Directory to the object specified inside a [BatchRead](API_BatchRead.md) operation. For more information, see [LookupPolicy](API_LookupPolicy.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchLookupPolicy-ObjectReference"></a>
Reference that identifies the object whose policies will be looked up.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** MaxResults **   <a name="amazoncds-Type-BatchLookupPolicy-MaxResults"></a>
The maximum number of results to retrieve.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   <a name="amazoncds-Type-BatchLookupPolicy-NextToken"></a>
The pagination token.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchLookupPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchLookupPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchLookupPolicy) 

# BatchLookupPolicyResponse


Represents the output of a [LookupPolicy](API_LookupPolicy.md) response operation.

## Contents


 ** NextToken **   <a name="amazoncds-Type-BatchLookupPolicyResponse-NextToken"></a>
The pagination token.  
Type: String  
Required: No

 ** PolicyToPathList **   <a name="amazoncds-Type-BatchLookupPolicyResponse-PolicyToPathList"></a>
Provides list of path to policies. Policies contain `PolicyId`, `ObjectIdentifier`, and `PolicyType`. For more information, see [Policies](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies).  
Type: Array of [PolicyToPath](API_PolicyToPath.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchLookupPolicyResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchLookupPolicyResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchLookupPolicyResponse) 

# BatchReadException


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

## Contents


 ** Message **   <a name="amazoncds-Type-BatchReadException-Message"></a>
An exception message that is associated with the failure.  
Type: String  
Required: No

 ** Type **   <a name="amazoncds-Type-BatchReadException-Type"></a>
A type of exception, such as `InvalidArnException`.  
Type: String  
Valid Values: `ValidationException | InvalidArnException | ResourceNotFoundException | InvalidNextTokenException | AccessDeniedException | NotNodeException | FacetValidationException | CannotListParentOfRootException | NotIndexException | NotPolicyException | DirectoryNotEnabledException | LimitExceededException | InternalServiceException`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchReadException) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchReadException) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchReadException) 

# BatchReadOperation


Represents the output of a `BatchRead` operation.

## Contents


 ** GetLinkAttributes **   <a name="amazoncds-Type-BatchReadOperation-GetLinkAttributes"></a>
Retrieves attributes that are associated with a typed link.  
Type: [BatchGetLinkAttributes](API_BatchGetLinkAttributes.md) object  
Required: No

 ** GetObjectAttributes **   <a name="amazoncds-Type-BatchReadOperation-GetObjectAttributes"></a>
Retrieves attributes within a facet that are associated with an object.  
Type: [BatchGetObjectAttributes](API_BatchGetObjectAttributes.md) object  
Required: No

 ** GetObjectInformation **   <a name="amazoncds-Type-BatchReadOperation-GetObjectInformation"></a>
Retrieves metadata about an object.  
Type: [BatchGetObjectInformation](API_BatchGetObjectInformation.md) object  
Required: No

 ** ListAttachedIndices **   <a name="amazoncds-Type-BatchReadOperation-ListAttachedIndices"></a>
Lists indices attached to an object.  
Type: [BatchListAttachedIndices](API_BatchListAttachedIndices.md) object  
Required: No

 ** ListIncomingTypedLinks **   <a name="amazoncds-Type-BatchReadOperation-ListIncomingTypedLinks"></a>
Returns a paginated list of all the incoming [TypedLinkSpecifier](API_TypedLinkSpecifier.md) information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see [Typed Links](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).  
Type: [BatchListIncomingTypedLinks](API_BatchListIncomingTypedLinks.md) object  
Required: No

 ** ListIndex **   <a name="amazoncds-Type-BatchReadOperation-ListIndex"></a>
Lists objects attached to the specified index.  
Type: [BatchListIndex](API_BatchListIndex.md) object  
Required: No

 ** ListObjectAttributes **   <a name="amazoncds-Type-BatchReadOperation-ListObjectAttributes"></a>
Lists all attributes that are associated with an object.  
Type: [BatchListObjectAttributes](API_BatchListObjectAttributes.md) object  
Required: No

 ** ListObjectChildren **   <a name="amazoncds-Type-BatchReadOperation-ListObjectChildren"></a>
Returns a paginated list of child objects that are associated with a given object.  
Type: [BatchListObjectChildren](API_BatchListObjectChildren.md) object  
Required: No

 ** ListObjectParentPaths **   <a name="amazoncds-Type-BatchReadOperation-ListObjectParentPaths"></a>
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](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html).  
Type: [BatchListObjectParentPaths](API_BatchListObjectParentPaths.md) object  
Required: No

 ** ListObjectParents **   <a name="amazoncds-Type-BatchReadOperation-ListObjectParents"></a>
Lists parent objects that are associated with a given object in pagination fashion.  
Type: [BatchListObjectParents](API_BatchListObjectParents.md) object  
Required: No

 ** ListObjectPolicies **   <a name="amazoncds-Type-BatchReadOperation-ListObjectPolicies"></a>
Returns policies attached to an object in pagination fashion.  
Type: [BatchListObjectPolicies](API_BatchListObjectPolicies.md) object  
Required: No

 ** ListOutgoingTypedLinks **   <a name="amazoncds-Type-BatchReadOperation-ListOutgoingTypedLinks"></a>
Returns a paginated list of all the outgoing [TypedLinkSpecifier](API_TypedLinkSpecifier.md) information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see [Typed Links](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).  
Type: [BatchListOutgoingTypedLinks](API_BatchListOutgoingTypedLinks.md) object  
Required: No

 ** ListPolicyAttachments **   <a name="amazoncds-Type-BatchReadOperation-ListPolicyAttachments"></a>
Returns all of the `ObjectIdentifiers` to which a given policy is attached.  
Type: [BatchListPolicyAttachments](API_BatchListPolicyAttachments.md) object  
Required: No

 ** LookupPolicy **   <a name="amazoncds-Type-BatchReadOperation-LookupPolicy"></a>
Lists all policies from the root of the [Directory](API_Directory.md) 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](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies).  
Type: [BatchLookupPolicy](API_BatchLookupPolicy.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchReadOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchReadOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchReadOperation) 

# BatchReadOperationResponse


Represents the output of a `BatchRead` response operation.

## Contents


 ** ExceptionResponse **   <a name="amazoncds-Type-BatchReadOperationResponse-ExceptionResponse"></a>
Identifies which operation in a batch has failed.  
Type: [BatchReadException](API_BatchReadException.md) object  
Required: No

 ** SuccessfulResponse **   <a name="amazoncds-Type-BatchReadOperationResponse-SuccessfulResponse"></a>
Identifies which operation in a batch has succeeded.  
Type: [BatchReadSuccessfulResponse](API_BatchReadSuccessfulResponse.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchReadOperationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchReadOperationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchReadOperationResponse) 

# BatchReadSuccessfulResponse


Represents the output of a `BatchRead` success response operation.

## Contents


 ** GetLinkAttributes **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-GetLinkAttributes"></a>
The list of attributes to retrieve from the typed link.  
Type: [BatchGetLinkAttributesResponse](API_BatchGetLinkAttributesResponse.md) object  
Required: No

 ** GetObjectAttributes **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-GetObjectAttributes"></a>
Retrieves attributes within a facet that are associated with an object.  
Type: [BatchGetObjectAttributesResponse](API_BatchGetObjectAttributesResponse.md) object  
Required: No

 ** GetObjectInformation **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-GetObjectInformation"></a>
Retrieves metadata about an object.  
Type: [BatchGetObjectInformationResponse](API_BatchGetObjectInformationResponse.md) object  
Required: No

 ** ListAttachedIndices **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-ListAttachedIndices"></a>
Lists indices attached to an object.  
Type: [BatchListAttachedIndicesResponse](API_BatchListAttachedIndicesResponse.md) object  
Required: No

 ** ListIncomingTypedLinks **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-ListIncomingTypedLinks"></a>
Returns a paginated list of all the incoming [TypedLinkSpecifier](API_TypedLinkSpecifier.md) information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see [Typed Links](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).  
Type: [BatchListIncomingTypedLinksResponse](API_BatchListIncomingTypedLinksResponse.md) object  
Required: No

 ** ListIndex **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-ListIndex"></a>
Lists objects attached to the specified index.  
Type: [BatchListIndexResponse](API_BatchListIndexResponse.md) object  
Required: No

 ** ListObjectAttributes **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-ListObjectAttributes"></a>
Lists all attributes that are associated with an object.  
Type: [BatchListObjectAttributesResponse](API_BatchListObjectAttributesResponse.md) object  
Required: No

 ** ListObjectChildren **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-ListObjectChildren"></a>
Returns a paginated list of child objects that are associated with a given object.  
Type: [BatchListObjectChildrenResponse](API_BatchListObjectChildrenResponse.md) object  
Required: No

 ** ListObjectParentPaths **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-ListObjectParentPaths"></a>
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](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html).  
Type: [BatchListObjectParentPathsResponse](API_BatchListObjectParentPathsResponse.md) object  
Required: No

 ** ListObjectParents **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-ListObjectParents"></a>
The list of parent objects to retrieve.  
Type: [BatchListObjectParentsResponse](API_BatchListObjectParentsResponse.md) object  
Required: No

 ** ListObjectPolicies **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-ListObjectPolicies"></a>
Returns policies attached to an object in pagination fashion.  
Type: [BatchListObjectPoliciesResponse](API_BatchListObjectPoliciesResponse.md) object  
Required: No

 ** ListOutgoingTypedLinks **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-ListOutgoingTypedLinks"></a>
Returns a paginated list of all the outgoing [TypedLinkSpecifier](API_TypedLinkSpecifier.md) information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see [Typed Links](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).  
Type: [BatchListOutgoingTypedLinksResponse](API_BatchListOutgoingTypedLinksResponse.md) object  
Required: No

 ** ListPolicyAttachments **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-ListPolicyAttachments"></a>
Returns all of the `ObjectIdentifiers` to which a given policy is attached.  
Type: [BatchListPolicyAttachmentsResponse](API_BatchListPolicyAttachmentsResponse.md) object  
Required: No

 ** LookupPolicy **   <a name="amazoncds-Type-BatchReadSuccessfulResponse-LookupPolicy"></a>
Lists all policies from the root of the [Directory](API_Directory.md) 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](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies).  
Type: [BatchLookupPolicyResponse](API_BatchLookupPolicyResponse.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchReadSuccessfulResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchReadSuccessfulResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchReadSuccessfulResponse) 

# BatchRemoveFacetFromObject


A batch operation to remove a facet from an object.

## Contents


 ** ObjectReference **   <a name="amazoncds-Type-BatchRemoveFacetFromObject-ObjectReference"></a>
A reference to the object whose facet will be removed.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** SchemaFacet **   <a name="amazoncds-Type-BatchRemoveFacetFromObject-SchemaFacet"></a>
The facet to remove from the object.  
Type: [SchemaFacet](API_SchemaFacet.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchRemoveFacetFromObject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchRemoveFacetFromObject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchRemoveFacetFromObject) 

# BatchRemoveFacetFromObjectResponse


An empty result that represents success.

## Contents


The members of this exception structure are context-dependent.

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchRemoveFacetFromObjectResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchRemoveFacetFromObjectResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchRemoveFacetFromObjectResponse) 

# BatchUpdateLinkAttributes


Updates a given typed link’s attributes inside a [BatchRead](API_BatchRead.md) operation. Attributes to be updated must not contribute to the typed link’s identity, as defined by its `IdentityAttributeOrder`. For more information, see [UpdateLinkAttributes](API_UpdateLinkAttributes.md) and [BatchRead:Operations](API_BatchRead.md#amazoncds-BatchRead-request-Operations).

## Contents


 ** AttributeUpdates **   <a name="amazoncds-Type-BatchUpdateLinkAttributes-AttributeUpdates"></a>
The attributes update structure.  
Type: Array of [LinkAttributeUpdate](API_LinkAttributeUpdate.md) objects  
Required: Yes

 ** TypedLinkSpecifier **   <a name="amazoncds-Type-BatchUpdateLinkAttributes-TypedLinkSpecifier"></a>
Allows a typed link specifier to be accepted as input.  
Type: [TypedLinkSpecifier](API_TypedLinkSpecifier.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchUpdateLinkAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchUpdateLinkAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchUpdateLinkAttributes) 

# BatchUpdateLinkAttributesResponse


Represents the output of a [UpdateLinkAttributes](API_UpdateLinkAttributes.md) response operation.

## Contents


The members of this exception structure are context-dependent.

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchUpdateLinkAttributesResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchUpdateLinkAttributesResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchUpdateLinkAttributesResponse) 

# BatchUpdateObjectAttributes


Represents the output of a `BatchUpdate` operation. 

## Contents


 ** AttributeUpdates **   <a name="amazoncds-Type-BatchUpdateObjectAttributes-AttributeUpdates"></a>
Attributes update structure.  
Type: Array of [ObjectAttributeUpdate](API_ObjectAttributeUpdate.md) objects  
Required: Yes

 ** ObjectReference **   <a name="amazoncds-Type-BatchUpdateObjectAttributes-ObjectReference"></a>
Reference that identifies the object.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchUpdateObjectAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchUpdateObjectAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchUpdateObjectAttributes) 

# BatchUpdateObjectAttributesResponse


Represents the output of a `BatchUpdate` response operation.

## Contents


 ** ObjectIdentifier **   <a name="amazoncds-Type-BatchUpdateObjectAttributesResponse-ObjectIdentifier"></a>
ID that is associated with the object.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchUpdateObjectAttributesResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchUpdateObjectAttributesResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchUpdateObjectAttributesResponse) 

# BatchWriteOperation


Represents the output of a `BatchWrite` operation. 

## Contents


 ** AddFacetToObject **   <a name="amazoncds-Type-BatchWriteOperation-AddFacetToObject"></a>
A batch operation that adds a facet to an object.  
Type: [BatchAddFacetToObject](API_BatchAddFacetToObject.md) object  
Required: No

 ** AttachObject **   <a name="amazoncds-Type-BatchWriteOperation-AttachObject"></a>
Attaches an object to a [Directory](API_Directory.md).  
Type: [BatchAttachObject](API_BatchAttachObject.md) object  
Required: No

 ** AttachPolicy **   <a name="amazoncds-Type-BatchWriteOperation-AttachPolicy"></a>
Attaches a policy object to a regular object. An object can have a limited number of attached policies.  
Type: [BatchAttachPolicy](API_BatchAttachPolicy.md) object  
Required: No

 ** AttachToIndex **   <a name="amazoncds-Type-BatchWriteOperation-AttachToIndex"></a>
Attaches the specified object to the specified index.  
Type: [BatchAttachToIndex](API_BatchAttachToIndex.md) object  
Required: No

 ** AttachTypedLink **   <a name="amazoncds-Type-BatchWriteOperation-AttachTypedLink"></a>
Attaches a typed link to a specified source and target object. For more information, see [Typed Links](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).  
Type: [BatchAttachTypedLink](API_BatchAttachTypedLink.md) object  
Required: No

 ** CreateIndex **   <a name="amazoncds-Type-BatchWriteOperation-CreateIndex"></a>
Creates an index object. See [Indexing and search](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm) for more information.  
Type: [BatchCreateIndex](API_BatchCreateIndex.md) object  
Required: No

 ** CreateObject **   <a name="amazoncds-Type-BatchWriteOperation-CreateObject"></a>
Creates an object.  
Type: [BatchCreateObject](API_BatchCreateObject.md) object  
Required: No

 ** DeleteObject **   <a name="amazoncds-Type-BatchWriteOperation-DeleteObject"></a>
Deletes an object in a [Directory](API_Directory.md).  
Type: [BatchDeleteObject](API_BatchDeleteObject.md) object  
Required: No

 ** DetachFromIndex **   <a name="amazoncds-Type-BatchWriteOperation-DetachFromIndex"></a>
Detaches the specified object from the specified index.  
Type: [BatchDetachFromIndex](API_BatchDetachFromIndex.md) object  
Required: No

 ** DetachObject **   <a name="amazoncds-Type-BatchWriteOperation-DetachObject"></a>
Detaches an object from a [Directory](API_Directory.md).  
Type: [BatchDetachObject](API_BatchDetachObject.md) object  
Required: No

 ** DetachPolicy **   <a name="amazoncds-Type-BatchWriteOperation-DetachPolicy"></a>
Detaches a policy from a [Directory](API_Directory.md).  
Type: [BatchDetachPolicy](API_BatchDetachPolicy.md) object  
Required: No

 ** DetachTypedLink **   <a name="amazoncds-Type-BatchWriteOperation-DetachTypedLink"></a>
Detaches a typed link from a specified source and target object. For more information, see [Typed Links](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).  
Type: [BatchDetachTypedLink](API_BatchDetachTypedLink.md) object  
Required: No

 ** RemoveFacetFromObject **   <a name="amazoncds-Type-BatchWriteOperation-RemoveFacetFromObject"></a>
A batch operation that removes a facet from an object.  
Type: [BatchRemoveFacetFromObject](API_BatchRemoveFacetFromObject.md) object  
Required: No

 ** UpdateLinkAttributes **   <a name="amazoncds-Type-BatchWriteOperation-UpdateLinkAttributes"></a>
Updates a given object's attributes.  
Type: [BatchUpdateLinkAttributes](API_BatchUpdateLinkAttributes.md) object  
Required: No

 ** UpdateObjectAttributes **   <a name="amazoncds-Type-BatchWriteOperation-UpdateObjectAttributes"></a>
Updates a given object's attributes.  
Type: [BatchUpdateObjectAttributes](API_BatchUpdateObjectAttributes.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchWriteOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchWriteOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchWriteOperation) 

# BatchWriteOperationResponse


Represents the output of a `BatchWrite` response operation.

## Contents


 ** AddFacetToObject **   <a name="amazoncds-Type-BatchWriteOperationResponse-AddFacetToObject"></a>
The result of an add facet to object batch operation.  
Type: [BatchAddFacetToObjectResponse](API_BatchAddFacetToObjectResponse.md) object  
Required: No

 ** AttachObject **   <a name="amazoncds-Type-BatchWriteOperationResponse-AttachObject"></a>
Attaches an object to a [Directory](API_Directory.md).  
Type: [BatchAttachObjectResponse](API_BatchAttachObjectResponse.md) object  
Required: No

 ** AttachPolicy **   <a name="amazoncds-Type-BatchWriteOperationResponse-AttachPolicy"></a>
Attaches a policy object to a regular object. An object can have a limited number of attached policies.  
Type: [BatchAttachPolicyResponse](API_BatchAttachPolicyResponse.md) object  
Required: No

 ** AttachToIndex **   <a name="amazoncds-Type-BatchWriteOperationResponse-AttachToIndex"></a>
Attaches the specified object to the specified index.  
Type: [BatchAttachToIndexResponse](API_BatchAttachToIndexResponse.md) object  
Required: No

 ** AttachTypedLink **   <a name="amazoncds-Type-BatchWriteOperationResponse-AttachTypedLink"></a>
Attaches a typed link to a specified source and target object. For more information, see [Typed Links](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).  
Type: [BatchAttachTypedLinkResponse](API_BatchAttachTypedLinkResponse.md) object  
Required: No

 ** CreateIndex **   <a name="amazoncds-Type-BatchWriteOperationResponse-CreateIndex"></a>
Creates an index object. See [Indexing and search](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm) for more information.  
Type: [BatchCreateIndexResponse](API_BatchCreateIndexResponse.md) object  
Required: No

 ** CreateObject **   <a name="amazoncds-Type-BatchWriteOperationResponse-CreateObject"></a>
Creates an object in a [Directory](API_Directory.md).  
Type: [BatchCreateObjectResponse](API_BatchCreateObjectResponse.md) object  
Required: No

 ** DeleteObject **   <a name="amazoncds-Type-BatchWriteOperationResponse-DeleteObject"></a>
Deletes an object in a [Directory](API_Directory.md).  
Type: [BatchDeleteObjectResponse](API_BatchDeleteObjectResponse.md) object  
Required: No

 ** DetachFromIndex **   <a name="amazoncds-Type-BatchWriteOperationResponse-DetachFromIndex"></a>
Detaches the specified object from the specified index.  
Type: [BatchDetachFromIndexResponse](API_BatchDetachFromIndexResponse.md) object  
Required: No

 ** DetachObject **   <a name="amazoncds-Type-BatchWriteOperationResponse-DetachObject"></a>
Detaches an object from a [Directory](API_Directory.md).  
Type: [BatchDetachObjectResponse](API_BatchDetachObjectResponse.md) object  
Required: No

 ** DetachPolicy **   <a name="amazoncds-Type-BatchWriteOperationResponse-DetachPolicy"></a>
Detaches a policy from a [Directory](API_Directory.md).  
Type: [BatchDetachPolicyResponse](API_BatchDetachPolicyResponse.md) object  
Required: No

 ** DetachTypedLink **   <a name="amazoncds-Type-BatchWriteOperationResponse-DetachTypedLink"></a>
Detaches a typed link from a specified source and target object. For more information, see [Typed Links](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).  
Type: [BatchDetachTypedLinkResponse](API_BatchDetachTypedLinkResponse.md) object  
Required: No

 ** RemoveFacetFromObject **   <a name="amazoncds-Type-BatchWriteOperationResponse-RemoveFacetFromObject"></a>
The result of a batch remove facet from object operation.  
Type: [BatchRemoveFacetFromObjectResponse](API_BatchRemoveFacetFromObjectResponse.md) object  
Required: No

 ** UpdateLinkAttributes **   <a name="amazoncds-Type-BatchWriteOperationResponse-UpdateLinkAttributes"></a>
Represents the output of a `BatchWrite` response operation.  
Type: [BatchUpdateLinkAttributesResponse](API_BatchUpdateLinkAttributesResponse.md) object  
Required: No

 ** UpdateObjectAttributes **   <a name="amazoncds-Type-BatchWriteOperationResponse-UpdateObjectAttributes"></a>
Updates a given object’s attributes.  
Type: [BatchUpdateObjectAttributesResponse](API_BatchUpdateObjectAttributesResponse.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/BatchWriteOperationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/BatchWriteOperationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/BatchWriteOperationResponse) 

# Directory


Directory structure that includes the directory name and directory ARN.

## Contents


 ** CreationDateTime **   <a name="amazoncds-Type-Directory-CreationDateTime"></a>
The date and time when the directory was created.  
Type: Timestamp  
Required: No

 ** DirectoryArn **   <a name="amazoncds-Type-Directory-DirectoryArn"></a>
The Amazon Resource Name (ARN) that is associated with the directory. For more information, see [Arn Examples](arns.md).  
Type: String  
Required: No

 ** Name **   <a name="amazoncds-Type-Directory-Name"></a>
The name of the directory.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: No

 ** State **   <a name="amazoncds-Type-Directory-State"></a>
The state of the directory. Can be either `Enabled`, `Disabled`, or `Deleted`.  
Type: String  
Valid Values: `ENABLED | DISABLED | DELETED`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/Directory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/Directory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/Directory) 

# Facet


A structure that contains `Name`, `ARN`, `Attributes`, ` Rules`, and `ObjectTypes`. See [Facets](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_whatarefacets.html) for more information.

## Contents


 ** FacetStyle **   <a name="amazoncds-Type-Facet-FacetStyle"></a>
There are two different styles that you can define on any given facet, `Static` and `Dynamic`. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.  
Type: String  
Valid Values: `STATIC | DYNAMIC`   
Required: No

 ** Name **   <a name="amazoncds-Type-Facet-Name"></a>
The name of the [Facet](#API_Facet).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: No

 ** ObjectType **   <a name="amazoncds-Type-Facet-ObjectType"></a>
The object type that is associated with the facet. See [CreateFacet:ObjectType](API_CreateFacet.md#amazoncds-CreateFacet-request-ObjectType) for more details.  
Type: String  
Valid Values: `NODE | LEAF_NODE | POLICY | INDEX`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/Facet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/Facet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/Facet) 

# FacetAttribute


An attribute that is associated with the [Facet](API_Facet.md).

## Contents


 ** Name **   <a name="amazoncds-Type-FacetAttribute-Name"></a>
The name of the facet attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 230.  
Pattern: `^[a-zA-Z0-9._:-]*$`   
Required: Yes

 ** AttributeDefinition **   <a name="amazoncds-Type-FacetAttribute-AttributeDefinition"></a>
A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See [Attribute References](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) for more information.  
Type: [FacetAttributeDefinition](API_FacetAttributeDefinition.md) object  
Required: No

 ** AttributeReference **   <a name="amazoncds-Type-FacetAttribute-AttributeReference"></a>
An attribute reference that is associated with the attribute. See [Attribute References](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) for more information.  
Type: [FacetAttributeReference](API_FacetAttributeReference.md) object  
Required: No

 ** RequiredBehavior **   <a name="amazoncds-Type-FacetAttribute-RequiredBehavior"></a>
The required behavior of the `FacetAttribute`.  
Type: String  
Valid Values: `REQUIRED_ALWAYS | NOT_REQUIRED`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/FacetAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/FacetAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/FacetAttribute) 

# FacetAttributeDefinition


A facet attribute definition. See [Attribute References](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) for more information.

## Contents


 ** Type **   <a name="amazoncds-Type-FacetAttributeDefinition-Type"></a>
The type of the attribute.  
Type: String  
Valid Values: `STRING | BINARY | BOOLEAN | NUMBER | DATETIME | VARIANT`   
Required: Yes

 ** DefaultValue **   <a name="amazoncds-Type-FacetAttributeDefinition-DefaultValue"></a>
The default value of the attribute (if configured).  
Type: [TypedAttributeValue](API_TypedAttributeValue.md) object  
Required: No

 ** IsImmutable **   <a name="amazoncds-Type-FacetAttributeDefinition-IsImmutable"></a>
Whether the attribute is mutable or not.  
Type: Boolean  
Required: No

 ** Rules **   <a name="amazoncds-Type-FacetAttributeDefinition-Rules"></a>
Validation rules attached to the attribute definition.  
Type: String to [Rule](API_Rule.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9._-]*$`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/FacetAttributeDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/FacetAttributeDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/FacetAttributeDefinition) 

# FacetAttributeReference


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

## Contents


 ** TargetAttributeName **   <a name="amazoncds-Type-FacetAttributeReference-TargetAttributeName"></a>
The target attribute name that is associated with the facet reference. See [Attribute References](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) for more information.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 230.  
Pattern: `^[a-zA-Z0-9._:-]*$`   
Required: Yes

 ** TargetFacetName **   <a name="amazoncds-Type-FacetAttributeReference-TargetFacetName"></a>
The target facet name that is associated with the facet reference. See [Attribute References](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) for more information.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/FacetAttributeReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/FacetAttributeReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/FacetAttributeReference) 

# FacetAttributeUpdate


A structure that contains information used to update an attribute.

## Contents


 ** Action **   <a name="amazoncds-Type-FacetAttributeUpdate-Action"></a>
The action to perform when updating the attribute.  
Type: String  
Valid Values: `CREATE_OR_UPDATE | DELETE`   
Required: No

 ** Attribute **   <a name="amazoncds-Type-FacetAttributeUpdate-Attribute"></a>
The attribute to update.  
Type: [FacetAttribute](API_FacetAttribute.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/FacetAttributeUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/FacetAttributeUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/FacetAttributeUpdate) 

# IndexAttachment


Represents an index and an attached object.

## Contents


 ** IndexedAttributes **   <a name="amazoncds-Type-IndexAttachment-IndexedAttributes"></a>
The indexed attribute values.  
Type: Array of [AttributeKeyAndValue](API_AttributeKeyAndValue.md) objects  
Required: No

 ** ObjectIdentifier **   <a name="amazoncds-Type-IndexAttachment-ObjectIdentifier"></a>
In response to [ListIndex](API_ListIndex.md), the `ObjectIdentifier` of the object attached to the index. In response to [ListAttachedIndices](API_ListAttachedIndices.md), the `ObjectIdentifier` of the index attached to the object. This field will always contain the `ObjectIdentifier` of the object on the opposite side of the attachment specified in the query.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/IndexAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/IndexAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/IndexAttachment) 

# LinkAttributeAction


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

## Contents


 ** AttributeActionType **   <a name="amazoncds-Type-LinkAttributeAction-AttributeActionType"></a>
A type that can be either `UPDATE_OR_CREATE` or `DELETE`.  
Type: String  
Valid Values: `CREATE_OR_UPDATE | DELETE`   
Required: No

 ** AttributeUpdateValue **   <a name="amazoncds-Type-LinkAttributeAction-AttributeUpdateValue"></a>
The value that you want to update to.  
Type: [TypedAttributeValue](API_TypedAttributeValue.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/LinkAttributeAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/LinkAttributeAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/LinkAttributeAction) 

# LinkAttributeUpdate


Structure that contains attribute update information.

## Contents


 ** AttributeAction **   <a name="amazoncds-Type-LinkAttributeUpdate-AttributeAction"></a>
The action to perform as part of the attribute update.  
Type: [LinkAttributeAction](API_LinkAttributeAction.md) object  
Required: No

 ** AttributeKey **   <a name="amazoncds-Type-LinkAttributeUpdate-AttributeKey"></a>
The key of the attribute being updated.  
Type: [AttributeKey](API_AttributeKey.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/LinkAttributeUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/LinkAttributeUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/LinkAttributeUpdate) 

# ObjectAttributeAction


The action to take on the object attribute.

## Contents


 ** ObjectAttributeActionType **   <a name="amazoncds-Type-ObjectAttributeAction-ObjectAttributeActionType"></a>
A type that can be either `Update` or `Delete`.  
Type: String  
Valid Values: `CREATE_OR_UPDATE | DELETE`   
Required: No

 ** ObjectAttributeUpdateValue **   <a name="amazoncds-Type-ObjectAttributeAction-ObjectAttributeUpdateValue"></a>
The value that you want to update to.  
Type: [TypedAttributeValue](API_TypedAttributeValue.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/ObjectAttributeAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/ObjectAttributeAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/ObjectAttributeAction) 

# ObjectAttributeRange


A range of attributes.

## Contents


 ** AttributeKey **   <a name="amazoncds-Type-ObjectAttributeRange-AttributeKey"></a>
The key of the attribute that the attribute range covers.  
Type: [AttributeKey](API_AttributeKey.md) object  
Required: No

 ** Range **   <a name="amazoncds-Type-ObjectAttributeRange-Range"></a>
The range of attribute values being selected.  
Type: [TypedAttributeValueRange](API_TypedAttributeValueRange.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/ObjectAttributeRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/ObjectAttributeRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/ObjectAttributeRange) 

# ObjectAttributeUpdate


Structure that contains attribute update information.

## Contents


 ** ObjectAttributeAction **   <a name="amazoncds-Type-ObjectAttributeUpdate-ObjectAttributeAction"></a>
The action to perform as part of the attribute update.  
Type: [ObjectAttributeAction](API_ObjectAttributeAction.md) object  
Required: No

 ** ObjectAttributeKey **   <a name="amazoncds-Type-ObjectAttributeUpdate-ObjectAttributeKey"></a>
The key of the attribute being updated.  
Type: [AttributeKey](API_AttributeKey.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/ObjectAttributeUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/ObjectAttributeUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/ObjectAttributeUpdate) 

# ObjectIdentifierAndLinkNameTuple


A pair of ObjectIdentifier and LinkName.

## Contents


 ** LinkName **   <a name="amazoncds-Type-ObjectIdentifierAndLinkNameTuple-LinkName"></a>
The name of the link between the parent and the child object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[^\/\[\]\(\):\{\}#@!?\s\\;]+`   
Required: No

 ** ObjectIdentifier **   <a name="amazoncds-Type-ObjectIdentifierAndLinkNameTuple-ObjectIdentifier"></a>
The ID that is associated with the object.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/ObjectIdentifierAndLinkNameTuple) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/ObjectIdentifierAndLinkNameTuple) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/ObjectIdentifierAndLinkNameTuple) 

# ObjectReference


The reference that identifies an object.

## Contents


 ** Selector **   <a name="amazoncds-Type-ObjectReference-Selector"></a>
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 [Access Objects](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html). You can identify an object in one of the following ways:  
+  *\$1ObjectIdentifier* - 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. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. 
+  */some/path* - Identifies the object based on path
+  *\$1SomeBatchReference* - Identifies the object in a batch call
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/ObjectReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/ObjectReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/ObjectReference) 

# PathToObjectIdentifiers


Returns the path to the `ObjectIdentifiers` that is associated with the directory.

## Contents


 ** ObjectIdentifiers **   <a name="amazoncds-Type-PathToObjectIdentifiers-ObjectIdentifiers"></a>
Lists `ObjectIdentifiers` starting from directory root to the object in the request.  
Type: Array of strings  
Required: No

 ** Path **   <a name="amazoncds-Type-PathToObjectIdentifiers-Path"></a>
The path that is used to identify the object starting from directory root.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/PathToObjectIdentifiers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/PathToObjectIdentifiers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/PathToObjectIdentifiers) 

# PolicyAttachment


Contains the `PolicyType`, `PolicyId`, and the `ObjectIdentifier` to which it is attached. For more information, see [Policies](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies).

## Contents


 ** ObjectIdentifier **   <a name="amazoncds-Type-PolicyAttachment-ObjectIdentifier"></a>
The `ObjectIdentifier` that is associated with `PolicyAttachment`.  
Type: String  
Required: No

 ** PolicyId **   <a name="amazoncds-Type-PolicyAttachment-PolicyId"></a>
The ID of `PolicyAttachment`.  
Type: String  
Required: No

 ** PolicyType **   <a name="amazoncds-Type-PolicyAttachment-PolicyType"></a>
The type of policy that can be associated with `PolicyAttachment`.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/PolicyAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/PolicyAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/PolicyAttachment) 

# PolicyToPath


Used when a regular object exists in a [Directory](API_Directory.md) and you want to find all of the policies that are associated with that object and the parent to that object.

## Contents


 ** Path **   <a name="amazoncds-Type-PolicyToPath-Path"></a>
The path that is referenced from the root.  
Type: String  
Required: No

 ** Policies **   <a name="amazoncds-Type-PolicyToPath-Policies"></a>
List of policy objects.  
Type: Array of [PolicyAttachment](API_PolicyAttachment.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/PolicyToPath) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/PolicyToPath) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/PolicyToPath) 

# Rule


Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.

## Contents


 ** Parameters **   <a name="amazoncds-Type-Rule-Parameters"></a>
The minimum and maximum parameters that are associated with the rule.  
Type: String to string map  
Required: No

 ** Type **   <a name="amazoncds-Type-Rule-Type"></a>
The type of attribute validation rule.  
Type: String  
Valid Values: `BINARY_LENGTH | NUMBER_COMPARISON | STRING_FROM_SET | STRING_LENGTH`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/Rule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/Rule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/Rule) 

# SchemaFacet


A facet.

## Contents


 ** FacetName **   <a name="amazoncds-Type-SchemaFacet-FacetName"></a>
The name of the facet. If this value is set, SchemaArn must also be set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: No

 ** SchemaArn **   <a name="amazoncds-Type-SchemaFacet-SchemaArn"></a>
The ARN of the schema that contains the facet with no minor component. See [Arn Examples](arns.md) and [In-Place Schema Upgrade](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html) for a description of when to provide minor versions. If this value is set, FacetName must also be set.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/SchemaFacet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/SchemaFacet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/SchemaFacet) 

# Tag


The tag structure that contains a tag key and value.

## Contents


 ** Key **   <a name="amazoncds-Type-Tag-Key"></a>
The key that is associated with the tag.  
Type: String  
Required: Yes

 ** Value **   <a name="amazoncds-Type-Tag-Value"></a>
The value that is associated with the tag.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/Tag) 

# TypedAttributeValue


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.

## Contents


 ** BinaryValue **   <a name="amazoncds-Type-TypedAttributeValue-BinaryValue"></a>
A binary data value.  
Type: Base64-encoded binary data object  
Required: No

 ** BooleanValue **   <a name="amazoncds-Type-TypedAttributeValue-BooleanValue"></a>
A Boolean data value.  
Type: Boolean  
Required: No

 ** DatetimeValue **   <a name="amazoncds-Type-TypedAttributeValue-DatetimeValue"></a>
A date and time value.  
Type: Timestamp  
Required: No

 ** NumberValue **   <a name="amazoncds-Type-TypedAttributeValue-NumberValue"></a>
A number data value.  
Type: String  
Required: No

 ** StringValue **   <a name="amazoncds-Type-TypedAttributeValue-StringValue"></a>
A string data value.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/TypedAttributeValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/TypedAttributeValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/TypedAttributeValue) 

# TypedAttributeValueRange


A range of attribute values. For more information, see [Range Filters](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_range_filters.html).

## Contents


 ** EndMode **   <a name="amazoncds-Type-TypedAttributeValueRange-EndMode"></a>
The inclusive or exclusive range end.  
Type: String  
Valid Values: `FIRST | LAST | LAST_BEFORE_MISSING_VALUES | INCLUSIVE | EXCLUSIVE`   
Required: Yes

 ** StartMode **   <a name="amazoncds-Type-TypedAttributeValueRange-StartMode"></a>
The inclusive or exclusive range start.  
Type: String  
Valid Values: `FIRST | LAST | LAST_BEFORE_MISSING_VALUES | INCLUSIVE | EXCLUSIVE`   
Required: Yes

 ** EndValue **   <a name="amazoncds-Type-TypedAttributeValueRange-EndValue"></a>
The attribute value to terminate the range at.  
Type: [TypedAttributeValue](API_TypedAttributeValue.md) object  
Required: No

 ** StartValue **   <a name="amazoncds-Type-TypedAttributeValueRange-StartValue"></a>
The value to start the range at.  
Type: [TypedAttributeValue](API_TypedAttributeValue.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/TypedAttributeValueRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/TypedAttributeValueRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/TypedAttributeValueRange) 

# TypedLinkAttributeDefinition


A typed link attribute definition.

## Contents


 ** Name **   <a name="amazoncds-Type-TypedLinkAttributeDefinition-Name"></a>
The unique name of the typed link attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 230.  
Pattern: `^[a-zA-Z0-9._:-]*$`   
Required: Yes

 ** RequiredBehavior **   <a name="amazoncds-Type-TypedLinkAttributeDefinition-RequiredBehavior"></a>
The required behavior of the `TypedLinkAttributeDefinition`.  
Type: String  
Valid Values: `REQUIRED_ALWAYS | NOT_REQUIRED`   
Required: Yes

 ** Type **   <a name="amazoncds-Type-TypedLinkAttributeDefinition-Type"></a>
The type of the attribute.  
Type: String  
Valid Values: `STRING | BINARY | BOOLEAN | NUMBER | DATETIME | VARIANT`   
Required: Yes

 ** DefaultValue **   <a name="amazoncds-Type-TypedLinkAttributeDefinition-DefaultValue"></a>
The default value of the attribute (if configured).  
Type: [TypedAttributeValue](API_TypedAttributeValue.md) object  
Required: No

 ** IsImmutable **   <a name="amazoncds-Type-TypedLinkAttributeDefinition-IsImmutable"></a>
Whether the attribute is mutable or not.  
Type: Boolean  
Required: No

 ** Rules **   <a name="amazoncds-Type-TypedLinkAttributeDefinition-Rules"></a>
Validation rules that are attached to the attribute definition.  
Type: String to [Rule](API_Rule.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9._-]*$`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/TypedLinkAttributeDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/TypedLinkAttributeDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/TypedLinkAttributeDefinition) 

# TypedLinkAttributeRange


Identifies the range of attributes that are used by a specified filter.

## Contents


 ** Range **   <a name="amazoncds-Type-TypedLinkAttributeRange-Range"></a>
The range of attribute values that are being selected.  
Type: [TypedAttributeValueRange](API_TypedAttributeValueRange.md) object  
Required: Yes

 ** AttributeName **   <a name="amazoncds-Type-TypedLinkAttributeRange-AttributeName"></a>
The unique name of the typed link attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 230.  
Pattern: `^[a-zA-Z0-9._:-]*$`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/TypedLinkAttributeRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/TypedLinkAttributeRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/TypedLinkAttributeRange) 

# TypedLinkFacet


Defines the typed links structure and its attributes. To create a typed link facet, use the [CreateTypedLinkFacet](API_CreateTypedLinkFacet.md) API.

## Contents


 ** Attributes **   <a name="amazoncds-Type-TypedLinkFacet-Attributes"></a>
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.  
Type: Array of [TypedLinkAttributeDefinition](API_TypedLinkAttributeDefinition.md) objects  
Required: Yes

 ** IdentityAttributeOrder **   <a name="amazoncds-Type-TypedLinkFacet-IdentityAttributeOrder"></a>
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](API_ListOutgoingTypedLinks.md) and [ListIncomingTypedLinks](API_ListIncomingTypedLinks.md) for details.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 230.  
Pattern: `^[a-zA-Z0-9._:-]*$`   
Required: Yes

 ** Name **   <a name="amazoncds-Type-TypedLinkFacet-Name"></a>
The unique name of the typed link facet.  
Type: String  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/TypedLinkFacet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/TypedLinkFacet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/TypedLinkFacet) 

# TypedLinkFacetAttributeUpdate


A typed link facet attribute update.

## Contents


 ** Action **   <a name="amazoncds-Type-TypedLinkFacetAttributeUpdate-Action"></a>
The action to perform when updating the attribute.  
Type: String  
Valid Values: `CREATE_OR_UPDATE | DELETE`   
Required: Yes

 ** Attribute **   <a name="amazoncds-Type-TypedLinkFacetAttributeUpdate-Attribute"></a>
The attribute to update.  
Type: [TypedLinkAttributeDefinition](API_TypedLinkAttributeDefinition.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/TypedLinkFacetAttributeUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/TypedLinkFacetAttributeUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/TypedLinkFacetAttributeUpdate) 

# TypedLinkSchemaAndFacetName


Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.

## Contents


 ** SchemaArn **   <a name="amazoncds-Type-TypedLinkSchemaAndFacetName-SchemaArn"></a>
The Amazon Resource Name (ARN) that is associated with the schema. For more information, see [Arn Examples](arns.md).  
Type: String  
Required: Yes

 ** TypedLinkName **   <a name="amazoncds-Type-TypedLinkSchemaAndFacetName-TypedLinkName"></a>
The unique name of the typed link facet.  
Type: String  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/TypedLinkSchemaAndFacetName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/TypedLinkSchemaAndFacetName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/TypedLinkSchemaAndFacetName) 

# TypedLinkSpecifier


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_AttachTypedLink.md) API returns a typed link specifier while the [DetachTypedLink](API_DetachTypedLink.md) API accepts one as input. Similarly, the [ListIncomingTypedLinks](API_ListIncomingTypedLinks.md) and [ListOutgoingTypedLinks](API_ListOutgoingTypedLinks.md) API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.

## Contents


 ** IdentityAttributeValues **   <a name="amazoncds-Type-TypedLinkSpecifier-IdentityAttributeValues"></a>
Identifies the attribute value to update.  
Type: Array of [AttributeNameAndValue](API_AttributeNameAndValue.md) objects  
Required: Yes

 ** SourceObjectReference **   <a name="amazoncds-Type-TypedLinkSpecifier-SourceObjectReference"></a>
Identifies the source object that the typed link will attach to.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** TargetObjectReference **   <a name="amazoncds-Type-TypedLinkSpecifier-TargetObjectReference"></a>
Identifies the target object that the typed link will attach to.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

 ** TypedLinkFacet **   <a name="amazoncds-Type-TypedLinkSpecifier-TypedLinkFacet"></a>
Identifies the typed link facet that is associated with the typed link.  
Type: [TypedLinkSchemaAndFacetName](API_TypedLinkSchemaAndFacetName.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/TypedLinkSpecifier) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/TypedLinkSpecifier) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/TypedLinkSpecifier)