Amazonka.CloudDirectory.Lens

Operations

AddFacetToObject

addFacetToObject_objectAttributeList :: Lens' AddFacetToObject (Maybe [AttributeKeyAndValue])

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

addFacetToObject_directoryArn :: Lens' AddFacetToObject Text

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

addFacetToObject_schemaFacet :: Lens' AddFacetToObject SchemaFacet

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

addFacetToObject_objectReference :: Lens' AddFacetToObject ObjectReference

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

addFacetToObjectResponse_httpStatus :: Lens' AddFacetToObjectResponse Int

The response's http status code.

ApplySchema

applySchema_publishedSchemaArn :: Lens' ApplySchema Text

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

applySchema_directoryArn :: Lens' ApplySchema Text

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

applySchemaResponse_appliedSchemaArn :: Lens' ApplySchemaResponse (Maybe Text)

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

applySchemaResponse_directoryArn :: Lens' ApplySchemaResponse (Maybe Text)

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

applySchemaResponse_httpStatus :: Lens' ApplySchemaResponse Int

The response's http status code.

AttachObject

attachObject_directoryArn :: Lens' AttachObject Text

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

attachObject_parentReference :: Lens' AttachObject ObjectReference

The parent object reference.

attachObject_childReference :: Lens' AttachObject ObjectReference

The child object reference to be attached to the object.

attachObject_linkName :: Lens' AttachObject Text

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

attachObjectResponse_attachedObjectIdentifier :: Lens' AttachObjectResponse (Maybe Text)

The attached ObjectIdentifier, which is the child ObjectIdentifier.

attachObjectResponse_httpStatus :: Lens' AttachObjectResponse Int

The response's http status code.

AttachPolicy

attachPolicy_directoryArn :: Lens' AttachPolicy Text

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

attachPolicy_policyReference :: Lens' AttachPolicy ObjectReference

The reference that is associated with the policy object.

attachPolicy_objectReference :: Lens' AttachPolicy ObjectReference

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

attachPolicyResponse_httpStatus :: Lens' AttachPolicyResponse Int

The response's http status code.

AttachToIndex

attachToIndex_directoryArn :: Lens' AttachToIndex Text

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

attachToIndex_indexReference :: Lens' AttachToIndex ObjectReference

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

attachToIndex_targetReference :: Lens' AttachToIndex ObjectReference

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

attachToIndexResponse_attachedObjectIdentifier :: Lens' AttachToIndexResponse (Maybe Text)

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

attachToIndexResponse_httpStatus :: Lens' AttachToIndexResponse Int

The response's http status code.

AttachTypedLink

attachTypedLink_directoryArn :: Lens' AttachTypedLink Text

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

attachTypedLink_sourceObjectReference :: Lens' AttachTypedLink ObjectReference

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

attachTypedLink_targetObjectReference :: Lens' AttachTypedLink ObjectReference

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

attachTypedLink_typedLinkFacet :: Lens' AttachTypedLink TypedLinkSchemaAndFacetName

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

attachTypedLink_attributes :: Lens' AttachTypedLink [AttributeNameAndValue]

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

attachTypedLinkResponse_typedLinkSpecifier :: Lens' AttachTypedLinkResponse (Maybe TypedLinkSpecifier)

Returns a typed link specifier as output.

attachTypedLinkResponse_httpStatus :: Lens' AttachTypedLinkResponse Int

The response's http status code.

BatchRead

batchRead_consistencyLevel :: Lens' BatchRead (Maybe ConsistencyLevel)

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

batchRead_directoryArn :: Lens' BatchRead Text

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

batchRead_operations :: Lens' BatchRead [BatchReadOperation]

A list of operations that are part of the batch.

batchReadResponse_responses :: Lens' BatchReadResponse (Maybe [BatchReadOperationResponse])

A list of all the responses for each batch read.

batchReadResponse_httpStatus :: Lens' BatchReadResponse Int

The response's http status code.

BatchWrite

batchWrite_directoryArn :: Lens' BatchWrite Text

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

batchWrite_operations :: Lens' BatchWrite [BatchWriteOperation]

A list of operations that are part of the batch.

batchWriteResponse_responses :: Lens' BatchWriteResponse (Maybe [BatchWriteOperationResponse])

A list of all the responses for each batch write.

batchWriteResponse_httpStatus :: Lens' BatchWriteResponse Int

The response's http status code.

CreateDirectory

createDirectory_name :: Lens' CreateDirectory Text

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

createDirectory_schemaArn :: Lens' CreateDirectory Text

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

createDirectoryResponse_httpStatus :: Lens' CreateDirectoryResponse Int

The response's http status code.

createDirectoryResponse_directoryArn :: Lens' CreateDirectoryResponse Text

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

createDirectoryResponse_name :: Lens' CreateDirectoryResponse Text

The name of the Directory.

createDirectoryResponse_objectIdentifier :: Lens' CreateDirectoryResponse Text

The root object node of the created directory.

createDirectoryResponse_appliedSchemaArn :: Lens' CreateDirectoryResponse Text

The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see arns.

CreateFacet

createFacet_attributes :: Lens' CreateFacet (Maybe [FacetAttribute])

The attributes that are associated with the Facet.

createFacet_facetStyle :: Lens' CreateFacet (Maybe FacetStyle)

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.

createFacet_objectType :: Lens' CreateFacet (Maybe ObjectType)

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

• Node: Can have multiple children but one parent.
• Leaf node: Cannot have children but can have multiple parents.
• Policy: Allows you to store a policy document and policy type. For more information, see Policies.
• Index: Can be created with the Index API.

createFacet_schemaArn :: Lens' CreateFacet Text

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

createFacet_name :: Lens' CreateFacet Text

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

createFacetResponse_httpStatus :: Lens' CreateFacetResponse Int

The response's http status code.

CreateIndex

createIndex_linkName :: Lens' CreateIndex (Maybe Text)

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

createIndex_parentReference :: Lens' CreateIndex (Maybe ObjectReference)

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

createIndex_directoryArn :: Lens' CreateIndex Text

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

createIndex_orderedIndexedAttributeList :: Lens' CreateIndex [AttributeKey]

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

createIndex_isUnique :: Lens' CreateIndex Bool

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

createIndexResponse_objectIdentifier :: Lens' CreateIndexResponse (Maybe Text)

The ObjectIdentifier of the index created by this operation.

createIndexResponse_httpStatus :: Lens' CreateIndexResponse Int

The response's http status code.

CreateObject

createObject_linkName :: Lens' CreateObject (Maybe Text)

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

createObject_objectAttributeList :: Lens' CreateObject (Maybe [AttributeKeyAndValue])

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

createObject_parentReference :: Lens' CreateObject (Maybe ObjectReference)

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

createObject_directoryArn :: Lens' CreateObject Text

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

createObject_schemaFacets :: Lens' CreateObject [SchemaFacet]

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

createObjectResponse_objectIdentifier :: Lens' CreateObjectResponse (Maybe Text)

The identifier that is associated with the object.

createObjectResponse_httpStatus :: Lens' CreateObjectResponse Int

The response's http status code.

CreateSchema

createSchema_name :: Lens' CreateSchema Text

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

createSchemaResponse_schemaArn :: Lens' CreateSchemaResponse (Maybe Text)

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

createSchemaResponse_httpStatus :: Lens' CreateSchemaResponse Int

The response's http status code.

CreateTypedLinkFacet

createTypedLinkFacet_schemaArn :: Lens' CreateTypedLinkFacet Text

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

createTypedLinkFacet_facet :: Lens' CreateTypedLinkFacet TypedLinkFacet

Facet structure that is associated with the typed link facet.

createTypedLinkFacetResponse_httpStatus :: Lens' CreateTypedLinkFacetResponse Int

The response's http status code.

DeleteDirectory

deleteDirectory_directoryArn :: Lens' DeleteDirectory Text

The ARN of the directory to delete.

deleteDirectoryResponse_httpStatus :: Lens' DeleteDirectoryResponse Int

The response's http status code.

deleteDirectoryResponse_directoryArn :: Lens' DeleteDirectoryResponse Text

The ARN of the deleted directory.

DeleteFacet

deleteFacet_schemaArn :: Lens' DeleteFacet Text

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

deleteFacet_name :: Lens' DeleteFacet Text

The name of the facet to delete.

deleteFacetResponse_httpStatus :: Lens' DeleteFacetResponse Int

The response's http status code.

DeleteObject

deleteObject_directoryArn :: Lens' DeleteObject Text

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

deleteObject_objectReference :: Lens' DeleteObject ObjectReference

A reference that identifies the object.

deleteObjectResponse_httpStatus :: Lens' DeleteObjectResponse Int

The response's http status code.

DeleteSchema

deleteSchema_schemaArn :: Lens' DeleteSchema Text

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

deleteSchemaResponse_schemaArn :: Lens' DeleteSchemaResponse (Maybe Text)

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

deleteSchemaResponse_httpStatus :: Lens' DeleteSchemaResponse Int

The response's http status code.

DeleteTypedLinkFacet

deleteTypedLinkFacet_schemaArn :: Lens' DeleteTypedLinkFacet Text

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

deleteTypedLinkFacet_name :: Lens' DeleteTypedLinkFacet Text

The unique name of the typed link facet.

deleteTypedLinkFacetResponse_httpStatus :: Lens' DeleteTypedLinkFacetResponse Int

The response's http status code.

DetachFromIndex

detachFromIndex_directoryArn :: Lens' DetachFromIndex Text

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

detachFromIndex_indexReference :: Lens' DetachFromIndex ObjectReference

A reference to the index object.

detachFromIndex_targetReference :: Lens' DetachFromIndex ObjectReference

A reference to the object being detached from the index.

detachFromIndexResponse_detachedObjectIdentifier :: Lens' DetachFromIndexResponse (Maybe Text)

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

detachFromIndexResponse_httpStatus :: Lens' DetachFromIndexResponse Int

The response's http status code.

DetachObject

detachObject_directoryArn :: Lens' DetachObject Text

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

detachObject_parentReference :: Lens' DetachObject ObjectReference

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

detachObject_linkName :: Lens' DetachObject Text

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

detachObjectResponse_detachedObjectIdentifier :: Lens' DetachObjectResponse (Maybe Text)

The ObjectIdentifier that was detached from the object.

detachObjectResponse_httpStatus :: Lens' DetachObjectResponse Int

The response's http status code.

DetachPolicy

detachPolicy_directoryArn :: Lens' DetachPolicy Text

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

detachPolicy_policyReference :: Lens' DetachPolicy ObjectReference

Reference that identifies the policy object.

detachPolicy_objectReference :: Lens' DetachPolicy ObjectReference

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

detachPolicyResponse_httpStatus :: Lens' DetachPolicyResponse Int

The response's http status code.

DetachTypedLink

detachTypedLink_directoryArn :: Lens' DetachTypedLink Text

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

detachTypedLink_typedLinkSpecifier :: Lens' DetachTypedLink TypedLinkSpecifier

Used to accept a typed link specifier as input.

DisableDirectory

disableDirectory_directoryArn :: Lens' DisableDirectory Text

The ARN of the directory to disable.

disableDirectoryResponse_httpStatus :: Lens' DisableDirectoryResponse Int

The response's http status code.

disableDirectoryResponse_directoryArn :: Lens' DisableDirectoryResponse Text

The ARN of the directory that has been disabled.

EnableDirectory

enableDirectory_directoryArn :: Lens' EnableDirectory Text

The ARN of the directory to enable.

enableDirectoryResponse_httpStatus :: Lens' EnableDirectoryResponse Int

The response's http status code.

enableDirectoryResponse_directoryArn :: Lens' EnableDirectoryResponse Text

The ARN of the enabled directory.

GetAppliedSchemaVersion

getAppliedSchemaVersion_schemaArn :: Lens' GetAppliedSchemaVersion Text

The ARN of the applied schema.

getAppliedSchemaVersionResponse_appliedSchemaArn :: Lens' GetAppliedSchemaVersionResponse (Maybe Text)

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

getAppliedSchemaVersionResponse_httpStatus :: Lens' GetAppliedSchemaVersionResponse Int

The response's http status code.

GetDirectory

getDirectory_directoryArn :: Lens' GetDirectory Text

The ARN of the directory.

getDirectoryResponse_httpStatus :: Lens' GetDirectoryResponse Int

The response's http status code.

getDirectoryResponse_directory :: Lens' GetDirectoryResponse Directory

Metadata about the directory.

GetFacet

getFacet_schemaArn :: Lens' GetFacet Text

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

getFacet_name :: Lens' GetFacet Text

The name of the facet to retrieve.

getFacetResponse_facet :: Lens' GetFacetResponse (Maybe Facet)

The Facet structure that is associated with the facet.

getFacetResponse_httpStatus :: Lens' GetFacetResponse Int

The response's http status code.

GetLinkAttributes

getLinkAttributes_consistencyLevel :: Lens' GetLinkAttributes (Maybe ConsistencyLevel)

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

getLinkAttributes_directoryArn :: Lens' GetLinkAttributes Text

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

getLinkAttributes_typedLinkSpecifier :: Lens' GetLinkAttributes TypedLinkSpecifier

Allows a typed link specifier to be accepted as input.

getLinkAttributes_attributeNames :: Lens' GetLinkAttributes [Text]

A list of attribute names whose values will be retrieved.

getLinkAttributesResponse_attributes :: Lens' GetLinkAttributesResponse (Maybe [AttributeKeyAndValue])

The attributes that are associated with the typed link.

getLinkAttributesResponse_httpStatus :: Lens' GetLinkAttributesResponse Int

The response's http status code.

GetObjectAttributes

getObjectAttributes_consistencyLevel :: Lens' GetObjectAttributes (Maybe ConsistencyLevel)

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

getObjectAttributes_directoryArn :: Lens' GetObjectAttributes Text

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

getObjectAttributes_objectReference :: Lens' GetObjectAttributes ObjectReference

Reference that identifies the object whose attributes will be retrieved.

getObjectAttributes_schemaFacet :: Lens' GetObjectAttributes SchemaFacet

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

getObjectAttributes_attributeNames :: Lens' GetObjectAttributes [Text]

List of attribute names whose values will be retrieved.

getObjectAttributesResponse_attributes :: Lens' GetObjectAttributesResponse (Maybe [AttributeKeyAndValue])

The attributes that are associated with the object.

getObjectAttributesResponse_httpStatus :: Lens' GetObjectAttributesResponse Int

The response's http status code.

GetObjectInformation

getObjectInformation_consistencyLevel :: Lens' GetObjectInformation (Maybe ConsistencyLevel)

The consistency level at which to retrieve the object information.

getObjectInformation_directoryArn :: Lens' GetObjectInformation Text

The ARN of the directory being retrieved.

getObjectInformation_objectReference :: Lens' GetObjectInformation ObjectReference

A reference to the object.

getObjectInformationResponse_objectIdentifier :: Lens' GetObjectInformationResponse (Maybe Text)

The ObjectIdentifier of the specified object.

getObjectInformationResponse_schemaFacets :: Lens' GetObjectInformationResponse (Maybe [SchemaFacet])

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

getObjectInformationResponse_httpStatus :: Lens' GetObjectInformationResponse Int

The response's http status code.

GetSchemaAsJson

getSchemaAsJson_schemaArn :: Lens' GetSchemaAsJson Text

The ARN of the schema to retrieve.

getSchemaAsJsonResponse_document :: Lens' GetSchemaAsJsonResponse (Maybe Text)

The JSON representation of the schema document.

getSchemaAsJsonResponse_name :: Lens' GetSchemaAsJsonResponse (Maybe Text)

The name of the retrieved schema.

getSchemaAsJsonResponse_httpStatus :: Lens' GetSchemaAsJsonResponse Int

The response's http status code.

GetTypedLinkFacetInformation

getTypedLinkFacetInformation_schemaArn :: Lens' GetTypedLinkFacetInformation Text

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

getTypedLinkFacetInformation_name :: Lens' GetTypedLinkFacetInformation Text

The unique name of the typed link facet.

getTypedLinkFacetInformationResponse_identityAttributeOrder :: Lens' GetTypedLinkFacetInformationResponse (Maybe [Text])

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

getTypedLinkFacetInformationResponse_httpStatus :: Lens' GetTypedLinkFacetInformationResponse Int

The response's http status code.

ListAppliedSchemaArns

listAppliedSchemaArns_maxResults :: Lens' ListAppliedSchemaArns (Maybe Natural)

The maximum number of results to retrieve.

listAppliedSchemaArns_nextToken :: Lens' ListAppliedSchemaArns (Maybe Text)

The pagination token.

listAppliedSchemaArns_schemaArn :: Lens' ListAppliedSchemaArns (Maybe Text)

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

listAppliedSchemaArns_directoryArn :: Lens' ListAppliedSchemaArns Text

The ARN of the directory you are listing.

listAppliedSchemaArnsResponse_nextToken :: Lens' ListAppliedSchemaArnsResponse (Maybe Text)

The pagination token.

listAppliedSchemaArnsResponse_schemaArns :: Lens' ListAppliedSchemaArnsResponse (Maybe [Text])

The ARNs of schemas that are applied to the directory.

listAppliedSchemaArnsResponse_httpStatus :: Lens' ListAppliedSchemaArnsResponse Int

The response's http status code.

ListAttachedIndices

listAttachedIndices_consistencyLevel :: Lens' ListAttachedIndices (Maybe ConsistencyLevel)

The consistency level to use for this operation.

listAttachedIndices_maxResults :: Lens' ListAttachedIndices (Maybe Natural)

The maximum number of results to retrieve.

listAttachedIndices_nextToken :: Lens' ListAttachedIndices (Maybe Text)

The pagination token.

listAttachedIndices_directoryArn :: Lens' ListAttachedIndices Text

The ARN of the directory.

listAttachedIndices_targetReference :: Lens' ListAttachedIndices ObjectReference

A reference to the object that has indices attached.

listAttachedIndicesResponse_indexAttachments :: Lens' ListAttachedIndicesResponse (Maybe [IndexAttachment])

The indices attached to the specified object.

listAttachedIndicesResponse_nextToken :: Lens' ListAttachedIndicesResponse (Maybe Text)

The pagination token.

listAttachedIndicesResponse_httpStatus :: Lens' ListAttachedIndicesResponse Int

The response's http status code.

ListDevelopmentSchemaArns

listDevelopmentSchemaArns_maxResults :: Lens' ListDevelopmentSchemaArns (Maybe Natural)

The maximum number of results to retrieve.

listDevelopmentSchemaArns_nextToken :: Lens' ListDevelopmentSchemaArns (Maybe Text)

The pagination token.

listDevelopmentSchemaArnsResponse_nextToken :: Lens' ListDevelopmentSchemaArnsResponse (Maybe Text)

The pagination token.

listDevelopmentSchemaArnsResponse_schemaArns :: Lens' ListDevelopmentSchemaArnsResponse (Maybe [Text])

The ARNs of retrieved development schemas.

listDevelopmentSchemaArnsResponse_httpStatus :: Lens' ListDevelopmentSchemaArnsResponse Int

The response's http status code.

ListDirectories

listDirectories_maxResults :: Lens' ListDirectories (Maybe Natural)

The maximum number of results to retrieve.

listDirectories_nextToken :: Lens' ListDirectories (Maybe Text)

The pagination token.

listDirectories_state :: Lens' ListDirectories (Maybe DirectoryState)

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

listDirectoriesResponse_nextToken :: Lens' ListDirectoriesResponse (Maybe Text)

The pagination token.

listDirectoriesResponse_httpStatus :: Lens' ListDirectoriesResponse Int

The response's http status code.

listDirectoriesResponse_directories :: Lens' ListDirectoriesResponse [Directory]

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

ListFacetAttributes

listFacetAttributes_maxResults :: Lens' ListFacetAttributes (Maybe Natural)

The maximum number of results to retrieve.

listFacetAttributes_nextToken :: Lens' ListFacetAttributes (Maybe Text)

The pagination token.

listFacetAttributes_schemaArn :: Lens' ListFacetAttributes Text

The ARN of the schema where the facet resides.

listFacetAttributes_name :: Lens' ListFacetAttributes Text

The name of the facet whose attributes will be retrieved.

listFacetAttributesResponse_attributes :: Lens' ListFacetAttributesResponse (Maybe [FacetAttribute])

The attributes attached to the facet.

listFacetAttributesResponse_nextToken :: Lens' ListFacetAttributesResponse (Maybe Text)

The pagination token.

listFacetAttributesResponse_httpStatus :: Lens' ListFacetAttributesResponse Int

The response's http status code.

ListFacetNames

listFacetNames_maxResults :: Lens' ListFacetNames (Maybe Natural)

The maximum number of results to retrieve.

listFacetNames_nextToken :: Lens' ListFacetNames (Maybe Text)

The pagination token.

listFacetNames_schemaArn :: Lens' ListFacetNames Text

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

listFacetNamesResponse_facetNames :: Lens' ListFacetNamesResponse (Maybe [Text])

The names of facets that exist within the schema.

listFacetNamesResponse_nextToken :: Lens' ListFacetNamesResponse (Maybe Text)

The pagination token.

listFacetNamesResponse_httpStatus :: Lens' ListFacetNamesResponse Int

The response's http status code.

ListIncomingTypedLinks

listIncomingTypedLinks_consistencyLevel :: Lens' ListIncomingTypedLinks (Maybe ConsistencyLevel)

The consistency level to execute the request at.

listIncomingTypedLinks_filterAttributeRanges :: Lens' ListIncomingTypedLinks (Maybe [TypedLinkAttributeRange])

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.

listIncomingTypedLinks_filterTypedLink :: Lens' ListIncomingTypedLinks (Maybe TypedLinkSchemaAndFacetName)

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.

listIncomingTypedLinks_maxResults :: Lens' ListIncomingTypedLinks (Maybe Natural)

The maximum number of results to retrieve.

listIncomingTypedLinks_nextToken :: Lens' ListIncomingTypedLinks (Maybe Text)

The pagination token.

listIncomingTypedLinks_directoryArn :: Lens' ListIncomingTypedLinks Text

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

listIncomingTypedLinks_objectReference :: Lens' ListIncomingTypedLinks ObjectReference

Reference that identifies the object whose attributes will be listed.

listIncomingTypedLinksResponse_linkSpecifiers :: Lens' ListIncomingTypedLinksResponse (Maybe [TypedLinkSpecifier])

Returns one or more typed link specifiers as output.

listIncomingTypedLinksResponse_nextToken :: Lens' ListIncomingTypedLinksResponse (Maybe Text)

The pagination token.

listIncomingTypedLinksResponse_httpStatus :: Lens' ListIncomingTypedLinksResponse Int

The response's http status code.

ListIndex

listIndex_consistencyLevel :: Lens' ListIndex (Maybe ConsistencyLevel)

The consistency level to execute the request at.

listIndex_maxResults :: Lens' ListIndex (Maybe Natural)

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

listIndex_nextToken :: Lens' ListIndex (Maybe Text)

The pagination token.

listIndex_rangesOnIndexedValues :: Lens' ListIndex (Maybe [ObjectAttributeRange])

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

listIndex_directoryArn :: Lens' ListIndex Text

The ARN of the directory that the index exists in.

listIndex_indexReference :: Lens' ListIndex ObjectReference

The reference to the index to list.

listIndexResponse_indexAttachments :: Lens' ListIndexResponse (Maybe [IndexAttachment])

The objects and indexed values attached to the index.

listIndexResponse_nextToken :: Lens' ListIndexResponse (Maybe Text)

The pagination token.

listIndexResponse_httpStatus :: Lens' ListIndexResponse Int

The response's http status code.

ListManagedSchemaArns

listManagedSchemaArns_maxResults :: Lens' ListManagedSchemaArns (Maybe Natural)

The maximum number of results to retrieve.

listManagedSchemaArns_nextToken :: Lens' ListManagedSchemaArns (Maybe Text)

The pagination token.

listManagedSchemaArns_schemaArn :: Lens' ListManagedSchemaArns (Maybe Text)

The response for ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version are listed.

listManagedSchemaArnsResponse_nextToken :: Lens' ListManagedSchemaArnsResponse (Maybe Text)

The pagination token.

listManagedSchemaArnsResponse_schemaArns :: Lens' ListManagedSchemaArnsResponse (Maybe [Text])

The ARNs for all AWS managed schemas.

listManagedSchemaArnsResponse_httpStatus :: Lens' ListManagedSchemaArnsResponse Int

The response's http status code.

ListObjectAttributes

listObjectAttributes_consistencyLevel :: Lens' ListObjectAttributes (Maybe ConsistencyLevel)

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

listObjectAttributes_facetFilter :: Lens' ListObjectAttributes (Maybe SchemaFacet)

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

listObjectAttributes_maxResults :: Lens' ListObjectAttributes (Maybe Natural)

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

listObjectAttributes_nextToken :: Lens' ListObjectAttributes (Maybe Text)

The pagination token.

listObjectAttributes_directoryArn :: Lens' ListObjectAttributes Text

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

listObjectAttributes_objectReference :: Lens' ListObjectAttributes ObjectReference

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

listObjectAttributesResponse_attributes :: Lens' ListObjectAttributesResponse (Maybe [AttributeKeyAndValue])

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

listObjectAttributesResponse_nextToken :: Lens' ListObjectAttributesResponse (Maybe Text)

The pagination token.

listObjectAttributesResponse_httpStatus :: Lens' ListObjectAttributesResponse Int

The response's http status code.

ListObjectChildren

listObjectChildren_consistencyLevel :: Lens' ListObjectChildren (Maybe ConsistencyLevel)

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

listObjectChildren_maxResults :: Lens' ListObjectChildren (Maybe Natural)

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

listObjectChildren_nextToken :: Lens' ListObjectChildren (Maybe Text)

The pagination token.

listObjectChildren_directoryArn :: Lens' ListObjectChildren Text

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

listObjectChildren_objectReference :: Lens' ListObjectChildren ObjectReference

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

listObjectChildrenResponse_children :: Lens' ListObjectChildrenResponse (Maybe (HashMap Text Text))

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

listObjectChildrenResponse_nextToken :: Lens' ListObjectChildrenResponse (Maybe Text)

The pagination token.

listObjectChildrenResponse_httpStatus :: Lens' ListObjectChildrenResponse Int

The response's http status code.

ListObjectParentPaths

listObjectParentPaths_maxResults :: Lens' ListObjectParentPaths (Maybe Natural)

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

listObjectParentPaths_nextToken :: Lens' ListObjectParentPaths (Maybe Text)

The pagination token.

listObjectParentPaths_directoryArn :: Lens' ListObjectParentPaths Text

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

listObjectParentPaths_objectReference :: Lens' ListObjectParentPaths ObjectReference

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

listObjectParentPathsResponse_nextToken :: Lens' ListObjectParentPathsResponse (Maybe Text)

The pagination token.

listObjectParentPathsResponse_pathToObjectIdentifiersList :: Lens' ListObjectParentPathsResponse (Maybe [PathToObjectIdentifiers])

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

listObjectParentPathsResponse_httpStatus :: Lens' ListObjectParentPathsResponse Int

The response's http status code.

ListObjectParents

listObjectParents_consistencyLevel :: Lens' ListObjectParents (Maybe ConsistencyLevel)

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

listObjectParents_includeAllLinksToEachParent :: Lens' ListObjectParents (Maybe Bool)

When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between a parent-child pair.

listObjectParents_maxResults :: Lens' ListObjectParents (Maybe Natural)

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

listObjectParents_nextToken :: Lens' ListObjectParents (Maybe Text)

The pagination token.

listObjectParents_directoryArn :: Lens' ListObjectParents Text

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

listObjectParents_objectReference :: Lens' ListObjectParents ObjectReference

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

listObjectParentsResponse_nextToken :: Lens' ListObjectParentsResponse (Maybe Text)

The pagination token.

listObjectParentsResponse_parentLinks :: Lens' ListObjectParentsResponse (Maybe [ObjectIdentifierAndLinkNameTuple])

Returns a list of parent reference and LinkName Tuples.

listObjectParentsResponse_parents :: Lens' ListObjectParentsResponse (Maybe (HashMap Text Text))

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

listObjectParentsResponse_httpStatus :: Lens' ListObjectParentsResponse Int

The response's http status code.

ListObjectPolicies

listObjectPolicies_consistencyLevel :: Lens' ListObjectPolicies (Maybe ConsistencyLevel)

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

listObjectPolicies_maxResults :: Lens' ListObjectPolicies (Maybe Natural)

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

listObjectPolicies_nextToken :: Lens' ListObjectPolicies (Maybe Text)

The pagination token.

listObjectPolicies_directoryArn :: Lens' ListObjectPolicies Text

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

listObjectPolicies_objectReference :: Lens' ListObjectPolicies ObjectReference

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

listObjectPoliciesResponse_attachedPolicyIds :: Lens' ListObjectPoliciesResponse (Maybe [Text])

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

listObjectPoliciesResponse_nextToken :: Lens' ListObjectPoliciesResponse (Maybe Text)

The pagination token.

listObjectPoliciesResponse_httpStatus :: Lens' ListObjectPoliciesResponse Int

The response's http status code.

ListOutgoingTypedLinks

listOutgoingTypedLinks_consistencyLevel :: Lens' ListOutgoingTypedLinks (Maybe ConsistencyLevel)

The consistency level to execute the request at.

listOutgoingTypedLinks_filterAttributeRanges :: Lens' ListOutgoingTypedLinks (Maybe [TypedLinkAttributeRange])

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.

listOutgoingTypedLinks_filterTypedLink :: Lens' ListOutgoingTypedLinks (Maybe TypedLinkSchemaAndFacetName)

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.

listOutgoingTypedLinks_maxResults :: Lens' ListOutgoingTypedLinks (Maybe Natural)

The maximum number of results to retrieve.

listOutgoingTypedLinks_nextToken :: Lens' ListOutgoingTypedLinks (Maybe Text)

The pagination token.

listOutgoingTypedLinks_directoryArn :: Lens' ListOutgoingTypedLinks Text

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

listOutgoingTypedLinks_objectReference :: Lens' ListOutgoingTypedLinks ObjectReference

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

listOutgoingTypedLinksResponse_nextToken :: Lens' ListOutgoingTypedLinksResponse (Maybe Text)

The pagination token.

listOutgoingTypedLinksResponse_typedLinkSpecifiers :: Lens' ListOutgoingTypedLinksResponse (Maybe [TypedLinkSpecifier])

Returns a typed link specifier as output.

listOutgoingTypedLinksResponse_httpStatus :: Lens' ListOutgoingTypedLinksResponse Int

The response's http status code.

ListPolicyAttachments

listPolicyAttachments_consistencyLevel :: Lens' ListPolicyAttachments (Maybe ConsistencyLevel)

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

listPolicyAttachments_maxResults :: Lens' ListPolicyAttachments (Maybe Natural)

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

listPolicyAttachments_nextToken :: Lens' ListPolicyAttachments (Maybe Text)

The pagination token.

listPolicyAttachments_directoryArn :: Lens' ListPolicyAttachments Text

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

listPolicyAttachments_policyReference :: Lens' ListPolicyAttachments ObjectReference

The reference that identifies the policy object.

listPolicyAttachmentsResponse_nextToken :: Lens' ListPolicyAttachmentsResponse (Maybe Text)

The pagination token.

listPolicyAttachmentsResponse_objectIdentifiers :: Lens' ListPolicyAttachmentsResponse (Maybe [Text])

A list of ObjectIdentifiers to which the policy is attached.

listPolicyAttachmentsResponse_httpStatus :: Lens' ListPolicyAttachmentsResponse Int

The response's http status code.

ListPublishedSchemaArns

listPublishedSchemaArns_maxResults :: Lens' ListPublishedSchemaArns (Maybe Natural)

The maximum number of results to retrieve.

listPublishedSchemaArns_nextToken :: Lens' ListPublishedSchemaArns (Maybe Text)

The pagination token.

listPublishedSchemaArns_schemaArn :: Lens' ListPublishedSchemaArns (Maybe Text)

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

listPublishedSchemaArnsResponse_nextToken :: Lens' ListPublishedSchemaArnsResponse (Maybe Text)

The pagination token.

listPublishedSchemaArnsResponse_schemaArns :: Lens' ListPublishedSchemaArnsResponse (Maybe [Text])

The ARNs of published schemas.

listPublishedSchemaArnsResponse_httpStatus :: Lens' ListPublishedSchemaArnsResponse Int

The response's http status code.

ListTagsForResource

listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural)

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

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text)

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

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text

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

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text)

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

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])

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

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int

The response's http status code.

ListTypedLinkFacetAttributes

listTypedLinkFacetAttributes_maxResults :: Lens' ListTypedLinkFacetAttributes (Maybe Natural)

The maximum number of results to retrieve.

listTypedLinkFacetAttributes_nextToken :: Lens' ListTypedLinkFacetAttributes (Maybe Text)

The pagination token.

listTypedLinkFacetAttributes_schemaArn :: Lens' ListTypedLinkFacetAttributes Text

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

listTypedLinkFacetAttributes_name :: Lens' ListTypedLinkFacetAttributes Text

The unique name of the typed link facet.

listTypedLinkFacetAttributesResponse_attributes :: Lens' ListTypedLinkFacetAttributesResponse (Maybe [TypedLinkAttributeDefinition])

An ordered set of attributes associate with the typed link.

listTypedLinkFacetAttributesResponse_nextToken :: Lens' ListTypedLinkFacetAttributesResponse (Maybe Text)

The pagination token.

listTypedLinkFacetAttributesResponse_httpStatus :: Lens' ListTypedLinkFacetAttributesResponse Int

The response's http status code.

ListTypedLinkFacetNames

listTypedLinkFacetNames_maxResults :: Lens' ListTypedLinkFacetNames (Maybe Natural)

The maximum number of results to retrieve.

listTypedLinkFacetNames_nextToken :: Lens' ListTypedLinkFacetNames (Maybe Text)

The pagination token.

listTypedLinkFacetNames_schemaArn :: Lens' ListTypedLinkFacetNames Text

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

listTypedLinkFacetNamesResponse_facetNames :: Lens' ListTypedLinkFacetNamesResponse (Maybe [Text])

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

listTypedLinkFacetNamesResponse_nextToken :: Lens' ListTypedLinkFacetNamesResponse (Maybe Text)

The pagination token.

listTypedLinkFacetNamesResponse_httpStatus :: Lens' ListTypedLinkFacetNamesResponse Int

The response's http status code.

LookupPolicy

lookupPolicy_maxResults :: Lens' LookupPolicy (Maybe Natural)

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

lookupPolicy_nextToken :: Lens' LookupPolicy (Maybe Text)

The token to request the next page of results.

lookupPolicy_directoryArn :: Lens' LookupPolicy Text

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

lookupPolicy_objectReference :: Lens' LookupPolicy ObjectReference

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

lookupPolicyResponse_nextToken :: Lens' LookupPolicyResponse (Maybe Text)

The pagination token.

lookupPolicyResponse_policyToPathList :: Lens' LookupPolicyResponse (Maybe [PolicyToPath])

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

lookupPolicyResponse_httpStatus :: Lens' LookupPolicyResponse Int

The response's http status code.

PublishSchema

publishSchema_minorVersion :: Lens' PublishSchema (Maybe Text)

The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.

publishSchema_name :: Lens' PublishSchema (Maybe Text)

The new name under which the schema will be published. If this is not provided, the development schema is considered.

publishSchema_developmentSchemaArn :: Lens' PublishSchema Text

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

publishSchema_version :: Lens' PublishSchema Text

The major version under which the schema will be published. Schemas have both a major and minor version associated with them.

publishSchemaResponse_publishedSchemaArn :: Lens' PublishSchemaResponse (Maybe Text)

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

publishSchemaResponse_httpStatus :: Lens' PublishSchemaResponse Int

The response's http status code.

PutSchemaFromJson

putSchemaFromJson_schemaArn :: Lens' PutSchemaFromJson Text

The ARN of the schema to update.

putSchemaFromJson_document :: Lens' PutSchemaFromJson Text

The replacement JSON schema.

putSchemaFromJsonResponse_arn :: Lens' PutSchemaFromJsonResponse (Maybe Text)

The ARN of the schema to update.

putSchemaFromJsonResponse_httpStatus :: Lens' PutSchemaFromJsonResponse Int

The response's http status code.

RemoveFacetFromObject

removeFacetFromObject_directoryArn :: Lens' RemoveFacetFromObject Text

The ARN of the directory in which the object resides.

removeFacetFromObject_schemaFacet :: Lens' RemoveFacetFromObject SchemaFacet

The facet to remove. See SchemaFacet for details.

removeFacetFromObject_objectReference :: Lens' RemoveFacetFromObject ObjectReference

A reference to the object to remove the facet from.

removeFacetFromObjectResponse_httpStatus :: Lens' RemoveFacetFromObjectResponse Int

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text

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

tagResource_tags :: Lens' TagResource [Tag]

A list of tag key-value pairs.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text

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

untagResource_tagKeys :: Lens' UntagResource [Text]

Keys of the tag that need to be removed from the resource.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int

The response's http status code.

UpdateFacet

updateFacet_attributeUpdates :: Lens' UpdateFacet (Maybe [FacetAttributeUpdate])

List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

updateFacet_objectType :: Lens' UpdateFacet (Maybe ObjectType)

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

updateFacet_schemaArn :: Lens' UpdateFacet Text

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

updateFacet_name :: Lens' UpdateFacet Text

The name of the facet.

updateFacetResponse_httpStatus :: Lens' UpdateFacetResponse Int

The response's http status code.

UpdateLinkAttributes

updateLinkAttributes_directoryArn :: Lens' UpdateLinkAttributes Text

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

updateLinkAttributes_typedLinkSpecifier :: Lens' UpdateLinkAttributes TypedLinkSpecifier

Allows a typed link specifier to be accepted as input.

updateLinkAttributes_attributeUpdates :: Lens' UpdateLinkAttributes [LinkAttributeUpdate]

The attributes update structure.

updateLinkAttributesResponse_httpStatus :: Lens' UpdateLinkAttributesResponse Int

The response's http status code.

UpdateObjectAttributes

updateObjectAttributes_directoryArn :: Lens' UpdateObjectAttributes Text

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

updateObjectAttributes_objectReference :: Lens' UpdateObjectAttributes ObjectReference

The reference that identifies the object.

updateObjectAttributes_attributeUpdates :: Lens' UpdateObjectAttributes [ObjectAttributeUpdate]

The attributes update structure.

updateObjectAttributesResponse_objectIdentifier :: Lens' UpdateObjectAttributesResponse (Maybe Text)

The ObjectIdentifier of the updated object.

updateObjectAttributesResponse_httpStatus :: Lens' UpdateObjectAttributesResponse Int

The response's http status code.

UpdateSchema

updateSchema_schemaArn :: Lens' UpdateSchema Text

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

updateSchema_name :: Lens' UpdateSchema Text

The name of the schema.

updateSchemaResponse_schemaArn :: Lens' UpdateSchemaResponse (Maybe Text)

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

updateSchemaResponse_httpStatus :: Lens' UpdateSchemaResponse Int

The response's http status code.

UpdateTypedLinkFacet

updateTypedLinkFacet_schemaArn :: Lens' UpdateTypedLinkFacet Text

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

updateTypedLinkFacet_name :: Lens' UpdateTypedLinkFacet Text

The unique name of the typed link facet.

updateTypedLinkFacet_attributeUpdates :: Lens' UpdateTypedLinkFacet [TypedLinkFacetAttributeUpdate]

Attributes update structure.

updateTypedLinkFacet_identityAttributeOrder :: Lens' UpdateTypedLinkFacet [Text]

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

updateTypedLinkFacetResponse_httpStatus :: Lens' UpdateTypedLinkFacetResponse Int

The response's http status code.

UpgradeAppliedSchema

upgradeAppliedSchema_dryRun :: Lens' UpgradeAppliedSchema (Maybe Bool)

Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

upgradeAppliedSchema_publishedSchemaArn :: Lens' UpgradeAppliedSchema Text

The revision of the published schema to upgrade the directory to.

upgradeAppliedSchema_directoryArn :: Lens' UpgradeAppliedSchema Text

The ARN for the directory to which the upgraded schema will be applied.

upgradeAppliedSchemaResponse_directoryArn :: Lens' UpgradeAppliedSchemaResponse (Maybe Text)

The ARN of the directory that is returned as part of the response.

upgradeAppliedSchemaResponse_upgradedSchemaArn :: Lens' UpgradeAppliedSchemaResponse (Maybe Text)

The ARN of the upgraded schema that is returned as part of the response.

upgradeAppliedSchemaResponse_httpStatus :: Lens' UpgradeAppliedSchemaResponse Int

The response's http status code.

UpgradePublishedSchema

upgradePublishedSchema_dryRun :: Lens' UpgradePublishedSchema (Maybe Bool)

Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.

upgradePublishedSchema_developmentSchemaArn :: Lens' UpgradePublishedSchema Text

The ARN of the development schema with the changes used for the upgrade.

upgradePublishedSchema_publishedSchemaArn :: Lens' UpgradePublishedSchema Text

The ARN of the published schema to be upgraded.

upgradePublishedSchema_minorVersion :: Lens' UpgradePublishedSchema Text

Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

upgradePublishedSchemaResponse_upgradedSchemaArn :: Lens' UpgradePublishedSchemaResponse (Maybe Text)

The ARN of the upgraded schema that is returned as part of the response.

upgradePublishedSchemaResponse_httpStatus :: Lens' UpgradePublishedSchemaResponse Int

The response's http status code.

Types

AttributeKey

attributeKey_schemaArn :: Lens' AttributeKey Text

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

attributeKey_facetName :: Lens' AttributeKey Text

The name of the facet that the attribute exists within.

attributeKey_name :: Lens' AttributeKey Text

The name of the attribute.

AttributeKeyAndValue

attributeKeyAndValue_key :: Lens' AttributeKeyAndValue AttributeKey

The key of the attribute.

attributeKeyAndValue_value :: Lens' AttributeKeyAndValue TypedAttributeValue

The value of the attribute.

AttributeNameAndValue

attributeNameAndValue_attributeName :: Lens' AttributeNameAndValue Text

The attribute name of the typed link.

attributeNameAndValue_value :: Lens' AttributeNameAndValue TypedAttributeValue

The value for the typed link.

BatchAddFacetToObject

batchAddFacetToObject_schemaFacet :: Lens' BatchAddFacetToObject SchemaFacet

Represents the facet being added to the object.

batchAddFacetToObject_objectAttributeList :: Lens' BatchAddFacetToObject [AttributeKeyAndValue]

The attributes to set on the object.

batchAddFacetToObject_objectReference :: Lens' BatchAddFacetToObject ObjectReference

A reference to the object being mutated.

BatchAddFacetToObjectResponse

BatchAttachObject

batchAttachObject_parentReference :: Lens' BatchAttachObject ObjectReference

The parent object reference.

batchAttachObject_childReference :: Lens' BatchAttachObject ObjectReference

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

batchAttachObject_linkName :: Lens' BatchAttachObject Text

The name of the link.

BatchAttachObjectResponse

batchAttachObjectResponse_attachedObjectIdentifier :: Lens' BatchAttachObjectResponse (Maybe Text)

The ObjectIdentifier of the object that has been attached.

BatchAttachPolicy

batchAttachPolicy_policyReference :: Lens' BatchAttachPolicy ObjectReference

The reference that is associated with the policy object.

batchAttachPolicy_objectReference :: Lens' BatchAttachPolicy ObjectReference

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

BatchAttachPolicyResponse

BatchAttachToIndex

batchAttachToIndex_indexReference :: Lens' BatchAttachToIndex ObjectReference

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

batchAttachToIndex_targetReference :: Lens' BatchAttachToIndex ObjectReference

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

BatchAttachToIndexResponse

batchAttachToIndexResponse_attachedObjectIdentifier :: Lens' BatchAttachToIndexResponse (Maybe Text)

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

BatchAttachTypedLink

batchAttachTypedLink_sourceObjectReference :: Lens' BatchAttachTypedLink ObjectReference

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

batchAttachTypedLink_targetObjectReference :: Lens' BatchAttachTypedLink ObjectReference

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

batchAttachTypedLink_typedLinkFacet :: Lens' BatchAttachTypedLink TypedLinkSchemaAndFacetName

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

batchAttachTypedLink_attributes :: Lens' BatchAttachTypedLink [AttributeNameAndValue]

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

BatchAttachTypedLinkResponse

batchAttachTypedLinkResponse_typedLinkSpecifier :: Lens' BatchAttachTypedLinkResponse (Maybe TypedLinkSpecifier)

Returns a typed link specifier as output.

BatchCreateIndex

batchCreateIndex_batchReferenceName :: Lens' BatchCreateIndex (Maybe Text)

The batch reference name. See Transaction Support for more information.

batchCreateIndex_linkName :: Lens' BatchCreateIndex (Maybe Text)

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

batchCreateIndex_parentReference :: Lens' BatchCreateIndex (Maybe ObjectReference)

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

batchCreateIndex_orderedIndexedAttributeList :: Lens' BatchCreateIndex [AttributeKey]

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

batchCreateIndex_isUnique :: Lens' BatchCreateIndex Bool

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

BatchCreateIndexResponse

batchCreateIndexResponse_objectIdentifier :: Lens' BatchCreateIndexResponse (Maybe Text)

The ObjectIdentifier of the index created by this operation.

BatchCreateObject

batchCreateObject_batchReferenceName :: Lens' BatchCreateObject (Maybe Text)

The batch reference name. See Transaction Support for more information.

batchCreateObject_linkName :: Lens' BatchCreateObject (Maybe Text)

The name of the link.

batchCreateObject_parentReference :: Lens' BatchCreateObject (Maybe ObjectReference)

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

batchCreateObject_schemaFacet :: Lens' BatchCreateObject [SchemaFacet]

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

batchCreateObject_objectAttributeList :: Lens' BatchCreateObject [AttributeKeyAndValue]

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

BatchCreateObjectResponse

batchCreateObjectResponse_objectIdentifier :: Lens' BatchCreateObjectResponse (Maybe Text)

The ID that is associated with the object.

BatchDeleteObject

batchDeleteObject_objectReference :: Lens' BatchDeleteObject ObjectReference

The reference that identifies the object.

BatchDeleteObjectResponse

BatchDetachFromIndex

batchDetachFromIndex_indexReference :: Lens' BatchDetachFromIndex ObjectReference

A reference to the index object.

batchDetachFromIndex_targetReference :: Lens' BatchDetachFromIndex ObjectReference

A reference to the object being detached from the index.

BatchDetachFromIndexResponse

batchDetachFromIndexResponse_detachedObjectIdentifier :: Lens' BatchDetachFromIndexResponse (Maybe Text)

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

BatchDetachObject

batchDetachObject_batchReferenceName :: Lens' BatchDetachObject (Maybe Text)

The batch reference name. See Transaction Support for more information.

batchDetachObject_parentReference :: Lens' BatchDetachObject ObjectReference

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

batchDetachObject_linkName :: Lens' BatchDetachObject Text

The name of the link.

BatchDetachObjectResponse

batchDetachObjectResponse_detachedObjectIdentifier :: Lens' BatchDetachObjectResponse (Maybe Text)

The ObjectIdentifier of the detached object.

BatchDetachPolicy

batchDetachPolicy_policyReference :: Lens' BatchDetachPolicy ObjectReference

Reference that identifies the policy object.

batchDetachPolicy_objectReference :: Lens' BatchDetachPolicy ObjectReference

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

BatchDetachPolicyResponse

BatchDetachTypedLink

batchDetachTypedLink_typedLinkSpecifier :: Lens' BatchDetachTypedLink TypedLinkSpecifier

Used to accept a typed link specifier as input.

BatchDetachTypedLinkResponse

BatchGetLinkAttributes

batchGetLinkAttributes_typedLinkSpecifier :: Lens' BatchGetLinkAttributes TypedLinkSpecifier

Allows a typed link specifier to be accepted as input.

batchGetLinkAttributes_attributeNames :: Lens' BatchGetLinkAttributes [Text]

A list of attribute names whose values will be retrieved.

BatchGetLinkAttributesResponse

batchGetLinkAttributesResponse_attributes :: Lens' BatchGetLinkAttributesResponse (Maybe [AttributeKeyAndValue])

The attributes that are associated with the typed link.

BatchGetObjectAttributes

batchGetObjectAttributes_objectReference :: Lens' BatchGetObjectAttributes ObjectReference

Reference that identifies the object whose attributes will be retrieved.

batchGetObjectAttributes_schemaFacet :: Lens' BatchGetObjectAttributes SchemaFacet

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

batchGetObjectAttributes_attributeNames :: Lens' BatchGetObjectAttributes [Text]

List of attribute names whose values will be retrieved.

BatchGetObjectAttributesResponse

batchGetObjectAttributesResponse_attributes :: Lens' BatchGetObjectAttributesResponse (Maybe [AttributeKeyAndValue])

The attribute values that are associated with an object.

BatchGetObjectInformation

batchGetObjectInformation_objectReference :: Lens' BatchGetObjectInformation ObjectReference

A reference to the object.

BatchGetObjectInformationResponse

batchGetObjectInformationResponse_objectIdentifier :: Lens' BatchGetObjectInformationResponse (Maybe Text)

The ObjectIdentifier of the specified object.

batchGetObjectInformationResponse_schemaFacets :: Lens' BatchGetObjectInformationResponse (Maybe [SchemaFacet])

The facets attached to the specified object.

BatchListAttachedIndices

batchListAttachedIndices_maxResults :: Lens' BatchListAttachedIndices (Maybe Natural)

The maximum number of results to retrieve.

batchListAttachedIndices_nextToken :: Lens' BatchListAttachedIndices (Maybe Text)

The pagination token.

batchListAttachedIndices_targetReference :: Lens' BatchListAttachedIndices ObjectReference

A reference to the object that has indices attached.

BatchListAttachedIndicesResponse

batchListAttachedIndicesResponse_indexAttachments :: Lens' BatchListAttachedIndicesResponse (Maybe [IndexAttachment])

The indices attached to the specified object.

batchListAttachedIndicesResponse_nextToken :: Lens' BatchListAttachedIndicesResponse (Maybe Text)

The pagination token.

BatchListIncomingTypedLinks

batchListIncomingTypedLinks_filterAttributeRanges :: Lens' BatchListIncomingTypedLinks (Maybe [TypedLinkAttributeRange])

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.

batchListIncomingTypedLinks_filterTypedLink :: Lens' BatchListIncomingTypedLinks (Maybe TypedLinkSchemaAndFacetName)

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.

batchListIncomingTypedLinks_maxResults :: Lens' BatchListIncomingTypedLinks (Maybe Natural)

The maximum number of results to retrieve.

batchListIncomingTypedLinks_nextToken :: Lens' BatchListIncomingTypedLinks (Maybe Text)

The pagination token.

batchListIncomingTypedLinks_objectReference :: Lens' BatchListIncomingTypedLinks ObjectReference

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

BatchListIncomingTypedLinksResponse

batchListIncomingTypedLinksResponse_linkSpecifiers :: Lens' BatchListIncomingTypedLinksResponse (Maybe [TypedLinkSpecifier])

Returns one or more typed link specifiers as output.

batchListIncomingTypedLinksResponse_nextToken :: Lens' BatchListIncomingTypedLinksResponse (Maybe Text)

The pagination token.

BatchListIndex

batchListIndex_maxResults :: Lens' BatchListIndex (Maybe Natural)

The maximum number of results to retrieve.

batchListIndex_nextToken :: Lens' BatchListIndex (Maybe Text)

The pagination token.

batchListIndex_rangesOnIndexedValues :: Lens' BatchListIndex (Maybe [ObjectAttributeRange])

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

batchListIndex_indexReference :: Lens' BatchListIndex ObjectReference

The reference to the index to list.

BatchListIndexResponse

batchListIndexResponse_indexAttachments :: Lens' BatchListIndexResponse (Maybe [IndexAttachment])

The objects and indexed values attached to the index.

batchListIndexResponse_nextToken :: Lens' BatchListIndexResponse (Maybe Text)

The pagination token.

BatchListObjectAttributes

batchListObjectAttributes_facetFilter :: Lens' BatchListObjectAttributes (Maybe SchemaFacet)

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

batchListObjectAttributes_maxResults :: Lens' BatchListObjectAttributes (Maybe Natural)

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

batchListObjectAttributes_nextToken :: Lens' BatchListObjectAttributes (Maybe Text)

The pagination token.

batchListObjectAttributes_objectReference :: Lens' BatchListObjectAttributes ObjectReference

Reference of the object whose attributes need to be listed.

BatchListObjectAttributesResponse

batchListObjectAttributesResponse_attributes :: Lens' BatchListObjectAttributesResponse (Maybe [AttributeKeyAndValue])

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

batchListObjectAttributesResponse_nextToken :: Lens' BatchListObjectAttributesResponse (Maybe Text)

The pagination token.

BatchListObjectChildren

batchListObjectChildren_maxResults :: Lens' BatchListObjectChildren (Maybe Natural)

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

batchListObjectChildren_nextToken :: Lens' BatchListObjectChildren (Maybe Text)

The pagination token.

batchListObjectChildren_objectReference :: Lens' BatchListObjectChildren ObjectReference

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

BatchListObjectChildrenResponse

batchListObjectChildrenResponse_children :: Lens' BatchListObjectChildrenResponse (Maybe (HashMap Text Text))

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

batchListObjectChildrenResponse_nextToken :: Lens' BatchListObjectChildrenResponse (Maybe Text)

The pagination token.

BatchListObjectParentPaths

batchListObjectParentPaths_maxResults :: Lens' BatchListObjectParentPaths (Maybe Natural)

The maximum number of results to retrieve.

batchListObjectParentPaths_nextToken :: Lens' BatchListObjectParentPaths (Maybe Text)

The pagination token.

batchListObjectParentPaths_objectReference :: Lens' BatchListObjectParentPaths ObjectReference

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

BatchListObjectParentPathsResponse

batchListObjectParentPathsResponse_nextToken :: Lens' BatchListObjectParentPathsResponse (Maybe Text)

The pagination token.

batchListObjectParentPathsResponse_pathToObjectIdentifiersList :: Lens' BatchListObjectParentPathsResponse (Maybe [PathToObjectIdentifiers])

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

BatchListObjectParents

batchListObjectParents_maxResults :: Lens' BatchListObjectParents (Maybe Natural)

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

batchListObjectParents_nextToken :: Lens' BatchListObjectParents (Maybe Text)

The pagination token.

batchListObjectParents_objectReference :: Lens' BatchListObjectParents ObjectReference

Undocumented member.

BatchListObjectParentsResponse

batchListObjectParentsResponse_nextToken :: Lens' BatchListObjectParentsResponse (Maybe Text)

The pagination token.

batchListObjectParentsResponse_parentLinks :: Lens' BatchListObjectParentsResponse (Maybe [ObjectIdentifierAndLinkNameTuple])

Returns a list of parent reference and LinkName Tuples.

BatchListObjectPolicies

batchListObjectPolicies_maxResults :: Lens' BatchListObjectPolicies (Maybe Natural)

The maximum number of results to retrieve.

batchListObjectPolicies_nextToken :: Lens' BatchListObjectPolicies (Maybe Text)

The pagination token.

batchListObjectPolicies_objectReference :: Lens' BatchListObjectPolicies ObjectReference

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

BatchListObjectPoliciesResponse

batchListObjectPoliciesResponse_attachedPolicyIds :: Lens' BatchListObjectPoliciesResponse (Maybe [Text])

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

batchListObjectPoliciesResponse_nextToken :: Lens' BatchListObjectPoliciesResponse (Maybe Text)

The pagination token.

BatchListOutgoingTypedLinks

batchListOutgoingTypedLinks_filterAttributeRanges :: Lens' BatchListOutgoingTypedLinks (Maybe [TypedLinkAttributeRange])

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

batchListOutgoingTypedLinks_filterTypedLink :: Lens' BatchListOutgoingTypedLinks (Maybe TypedLinkSchemaAndFacetName)

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.

batchListOutgoingTypedLinks_maxResults :: Lens' BatchListOutgoingTypedLinks (Maybe Natural)

The maximum number of results to retrieve.

batchListOutgoingTypedLinks_nextToken :: Lens' BatchListOutgoingTypedLinks (Maybe Text)

The pagination token.

batchListOutgoingTypedLinks_objectReference :: Lens' BatchListOutgoingTypedLinks ObjectReference

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

BatchListOutgoingTypedLinksResponse

batchListOutgoingTypedLinksResponse_nextToken :: Lens' BatchListOutgoingTypedLinksResponse (Maybe Text)

The pagination token.

batchListOutgoingTypedLinksResponse_typedLinkSpecifiers :: Lens' BatchListOutgoingTypedLinksResponse (Maybe [TypedLinkSpecifier])

Returns a typed link specifier as output.

BatchListPolicyAttachments

batchListPolicyAttachments_maxResults :: Lens' BatchListPolicyAttachments (Maybe Natural)

The maximum number of results to retrieve.

batchListPolicyAttachments_nextToken :: Lens' BatchListPolicyAttachments (Maybe Text)

The pagination token.

batchListPolicyAttachments_policyReference :: Lens' BatchListPolicyAttachments ObjectReference

The reference that identifies the policy object.

BatchListPolicyAttachmentsResponse

batchListPolicyAttachmentsResponse_nextToken :: Lens' BatchListPolicyAttachmentsResponse (Maybe Text)

The pagination token.

batchListPolicyAttachmentsResponse_objectIdentifiers :: Lens' BatchListPolicyAttachmentsResponse (Maybe [Text])

A list of ObjectIdentifiers to which the policy is attached.

BatchLookupPolicy

batchLookupPolicy_maxResults :: Lens' BatchLookupPolicy (Maybe Natural)

The maximum number of results to retrieve.

batchLookupPolicy_nextToken :: Lens' BatchLookupPolicy (Maybe Text)

The pagination token.

batchLookupPolicy_objectReference :: Lens' BatchLookupPolicy ObjectReference

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

BatchLookupPolicyResponse

batchLookupPolicyResponse_nextToken :: Lens' BatchLookupPolicyResponse (Maybe Text)

The pagination token.

batchLookupPolicyResponse_policyToPathList :: Lens' BatchLookupPolicyResponse (Maybe [PolicyToPath])

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

BatchReadException

batchReadException_message :: Lens' BatchReadException (Maybe Text)

An exception message that is associated with the failure.

batchReadException_type :: Lens' BatchReadException (Maybe BatchReadExceptionType)

A type of exception, such as InvalidArnException.

BatchReadOperation

batchReadOperation_getLinkAttributes :: Lens' BatchReadOperation (Maybe BatchGetLinkAttributes)

Retrieves attributes that are associated with a typed link.

batchReadOperation_getObjectAttributes :: Lens' BatchReadOperation (Maybe BatchGetObjectAttributes)

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

batchReadOperation_getObjectInformation :: Lens' BatchReadOperation (Maybe BatchGetObjectInformation)

Retrieves metadata about an object.

batchReadOperation_listAttachedIndices :: Lens' BatchReadOperation (Maybe BatchListAttachedIndices)

Lists indices attached to an object.

batchReadOperation_listIncomingTypedLinks :: Lens' BatchReadOperation (Maybe BatchListIncomingTypedLinks)

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

batchReadOperation_listIndex :: Lens' BatchReadOperation (Maybe BatchListIndex)

Lists objects attached to the specified index.

batchReadOperation_listObjectAttributes :: Lens' BatchReadOperation (Maybe BatchListObjectAttributes)

Lists all attributes that are associated with an object.

batchReadOperation_listObjectChildren :: Lens' BatchReadOperation (Maybe BatchListObjectChildren)

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

batchReadOperation_listObjectParentPaths :: Lens' BatchReadOperation (Maybe BatchListObjectParentPaths)

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.

batchReadOperation_listObjectParents :: Lens' BatchReadOperation (Maybe BatchListObjectParents)

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

batchReadOperation_listObjectPolicies :: Lens' BatchReadOperation (Maybe BatchListObjectPolicies)

Returns policies attached to an object in pagination fashion.

batchReadOperation_listOutgoingTypedLinks :: Lens' BatchReadOperation (Maybe BatchListOutgoingTypedLinks)

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

batchReadOperation_listPolicyAttachments :: Lens' BatchReadOperation (Maybe BatchListPolicyAttachments)

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

batchReadOperation_lookupPolicy :: Lens' BatchReadOperation (Maybe BatchLookupPolicy)

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

BatchReadOperationResponse

batchReadOperationResponse_exceptionResponse :: Lens' BatchReadOperationResponse (Maybe BatchReadException)

Identifies which operation in a batch has failed.

batchReadOperationResponse_successfulResponse :: Lens' BatchReadOperationResponse (Maybe BatchReadSuccessfulResponse)

Identifies which operation in a batch has succeeded.

BatchReadSuccessfulResponse

batchReadSuccessfulResponse_getLinkAttributes :: Lens' BatchReadSuccessfulResponse (Maybe BatchGetLinkAttributesResponse)

The list of attributes to retrieve from the typed link.

batchReadSuccessfulResponse_getObjectAttributes :: Lens' BatchReadSuccessfulResponse (Maybe BatchGetObjectAttributesResponse)

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

batchReadSuccessfulResponse_getObjectInformation :: Lens' BatchReadSuccessfulResponse (Maybe BatchGetObjectInformationResponse)

Retrieves metadata about an object.

batchReadSuccessfulResponse_listAttachedIndices :: Lens' BatchReadSuccessfulResponse (Maybe BatchListAttachedIndicesResponse)

Lists indices attached to an object.

batchReadSuccessfulResponse_listIncomingTypedLinks :: Lens' BatchReadSuccessfulResponse (Maybe BatchListIncomingTypedLinksResponse)

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

batchReadSuccessfulResponse_listIndex :: Lens' BatchReadSuccessfulResponse (Maybe BatchListIndexResponse)

Lists objects attached to the specified index.

batchReadSuccessfulResponse_listObjectAttributes :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectAttributesResponse)

Lists all attributes that are associated with an object.

batchReadSuccessfulResponse_listObjectChildren :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectChildrenResponse)

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

batchReadSuccessfulResponse_listObjectParentPaths :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectParentPathsResponse)

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.

batchReadSuccessfulResponse_listObjectParents :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectParentsResponse)

The list of parent objects to retrieve.

batchReadSuccessfulResponse_listObjectPolicies :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectPoliciesResponse)

Returns policies attached to an object in pagination fashion.

batchReadSuccessfulResponse_listOutgoingTypedLinks :: Lens' BatchReadSuccessfulResponse (Maybe BatchListOutgoingTypedLinksResponse)

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

batchReadSuccessfulResponse_listPolicyAttachments :: Lens' BatchReadSuccessfulResponse (Maybe BatchListPolicyAttachmentsResponse)

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

batchReadSuccessfulResponse_lookupPolicy :: Lens' BatchReadSuccessfulResponse (Maybe BatchLookupPolicyResponse)

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

BatchRemoveFacetFromObject

batchRemoveFacetFromObject_schemaFacet :: Lens' BatchRemoveFacetFromObject SchemaFacet

The facet to remove from the object.

batchRemoveFacetFromObject_objectReference :: Lens' BatchRemoveFacetFromObject ObjectReference

A reference to the object whose facet will be removed.

BatchRemoveFacetFromObjectResponse

BatchUpdateLinkAttributes

batchUpdateLinkAttributes_typedLinkSpecifier :: Lens' BatchUpdateLinkAttributes TypedLinkSpecifier

Allows a typed link specifier to be accepted as input.

batchUpdateLinkAttributes_attributeUpdates :: Lens' BatchUpdateLinkAttributes [LinkAttributeUpdate]

The attributes update structure.

BatchUpdateLinkAttributesResponse

BatchUpdateObjectAttributes

batchUpdateObjectAttributes_objectReference :: Lens' BatchUpdateObjectAttributes ObjectReference

Reference that identifies the object.

batchUpdateObjectAttributes_attributeUpdates :: Lens' BatchUpdateObjectAttributes [ObjectAttributeUpdate]

Attributes update structure.

BatchUpdateObjectAttributesResponse

batchUpdateObjectAttributesResponse_objectIdentifier :: Lens' BatchUpdateObjectAttributesResponse (Maybe Text)

ID that is associated with the object.

BatchWriteOperation

batchWriteOperation_addFacetToObject :: Lens' BatchWriteOperation (Maybe BatchAddFacetToObject)

A batch operation that adds a facet to an object.

batchWriteOperation_attachObject :: Lens' BatchWriteOperation (Maybe BatchAttachObject)

Attaches an object to a Directory.

batchWriteOperation_attachPolicy :: Lens' BatchWriteOperation (Maybe BatchAttachPolicy)

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

batchWriteOperation_attachToIndex :: Lens' BatchWriteOperation (Maybe BatchAttachToIndex)

Attaches the specified object to the specified index.

batchWriteOperation_attachTypedLink :: Lens' BatchWriteOperation (Maybe BatchAttachTypedLink)

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

batchWriteOperation_createIndex :: Lens' BatchWriteOperation (Maybe BatchCreateIndex)

Creates an index object. See Indexing and search for more information.

batchWriteOperation_createObject :: Lens' BatchWriteOperation (Maybe BatchCreateObject)

Creates an object.

batchWriteOperation_deleteObject :: Lens' BatchWriteOperation (Maybe BatchDeleteObject)

Deletes an object in a Directory.

batchWriteOperation_detachFromIndex :: Lens' BatchWriteOperation (Maybe BatchDetachFromIndex)

Detaches the specified object from the specified index.

batchWriteOperation_detachObject :: Lens' BatchWriteOperation (Maybe BatchDetachObject)

Detaches an object from a Directory.

batchWriteOperation_detachPolicy :: Lens' BatchWriteOperation (Maybe BatchDetachPolicy)

Detaches a policy from a Directory.

batchWriteOperation_detachTypedLink :: Lens' BatchWriteOperation (Maybe BatchDetachTypedLink)

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

batchWriteOperation_removeFacetFromObject :: Lens' BatchWriteOperation (Maybe BatchRemoveFacetFromObject)

A batch operation that removes a facet from an object.

batchWriteOperation_updateLinkAttributes :: Lens' BatchWriteOperation (Maybe BatchUpdateLinkAttributes)

Updates a given object's attributes.

batchWriteOperation_updateObjectAttributes :: Lens' BatchWriteOperation (Maybe BatchUpdateObjectAttributes)

Updates a given object's attributes.

BatchWriteOperationResponse

batchWriteOperationResponse_addFacetToObject :: Lens' BatchWriteOperationResponse (Maybe BatchAddFacetToObjectResponse)

The result of an add facet to object batch operation.

batchWriteOperationResponse_attachObject :: Lens' BatchWriteOperationResponse (Maybe BatchAttachObjectResponse)

Attaches an object to a Directory.

batchWriteOperationResponse_attachPolicy :: Lens' BatchWriteOperationResponse (Maybe BatchAttachPolicyResponse)

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

batchWriteOperationResponse_attachToIndex :: Lens' BatchWriteOperationResponse (Maybe BatchAttachToIndexResponse)

Attaches the specified object to the specified index.

batchWriteOperationResponse_attachTypedLink :: Lens' BatchWriteOperationResponse (Maybe BatchAttachTypedLinkResponse)

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

batchWriteOperationResponse_createIndex :: Lens' BatchWriteOperationResponse (Maybe BatchCreateIndexResponse)

Creates an index object. See Indexing and search for more information.

batchWriteOperationResponse_createObject :: Lens' BatchWriteOperationResponse (Maybe BatchCreateObjectResponse)

Creates an object in a Directory.

batchWriteOperationResponse_deleteObject :: Lens' BatchWriteOperationResponse (Maybe BatchDeleteObjectResponse)

Deletes an object in a Directory.

batchWriteOperationResponse_detachFromIndex :: Lens' BatchWriteOperationResponse (Maybe BatchDetachFromIndexResponse)

Detaches the specified object from the specified index.

batchWriteOperationResponse_detachObject :: Lens' BatchWriteOperationResponse (Maybe BatchDetachObjectResponse)

Detaches an object from a Directory.

batchWriteOperationResponse_detachPolicy :: Lens' BatchWriteOperationResponse (Maybe BatchDetachPolicyResponse)

Detaches a policy from a Directory.

batchWriteOperationResponse_detachTypedLink :: Lens' BatchWriteOperationResponse (Maybe BatchDetachTypedLinkResponse)

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

batchWriteOperationResponse_removeFacetFromObject :: Lens' BatchWriteOperationResponse (Maybe BatchRemoveFacetFromObjectResponse)

The result of a batch remove facet from object operation.

batchWriteOperationResponse_updateLinkAttributes :: Lens' BatchWriteOperationResponse (Maybe BatchUpdateLinkAttributesResponse)

Represents the output of a BatchWrite response operation.

batchWriteOperationResponse_updateObjectAttributes :: Lens' BatchWriteOperationResponse (Maybe BatchUpdateObjectAttributesResponse)

Updates a given object’s attributes.

Directory

directory_creationDateTime :: Lens' Directory (Maybe UTCTime)

The date and time when the directory was created.

directory_directoryArn :: Lens' Directory (Maybe Text)

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

directory_name :: Lens' Directory (Maybe Text)

The name of the directory.

directory_state :: Lens' Directory (Maybe DirectoryState)

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

Facet

facet_facetStyle :: Lens' Facet (Maybe FacetStyle)

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.

facet_name :: Lens' Facet (Maybe Text)

The name of the Facet.

facet_objectType :: Lens' Facet (Maybe ObjectType)

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

FacetAttribute

facetAttribute_attributeDefinition :: Lens' FacetAttribute (Maybe FacetAttributeDefinition)

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

facetAttribute_attributeReference :: Lens' FacetAttribute (Maybe FacetAttributeReference)

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

facetAttribute_requiredBehavior :: Lens' FacetAttribute (Maybe RequiredAttributeBehavior)

The required behavior of the FacetAttribute.

facetAttribute_name :: Lens' FacetAttribute Text

The name of the facet attribute.

FacetAttributeDefinition

facetAttributeDefinition_defaultValue :: Lens' FacetAttributeDefinition (Maybe TypedAttributeValue)

The default value of the attribute (if configured).

facetAttributeDefinition_isImmutable :: Lens' FacetAttributeDefinition (Maybe Bool)

Whether the attribute is mutable or not.

facetAttributeDefinition_rules :: Lens' FacetAttributeDefinition (Maybe (HashMap Text Rule))

Validation rules attached to the attribute definition.

facetAttributeDefinition_type :: Lens' FacetAttributeDefinition FacetAttributeType

The type of the attribute.

FacetAttributeReference

facetAttributeReference_targetFacetName :: Lens' FacetAttributeReference Text

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

facetAttributeReference_targetAttributeName :: Lens' FacetAttributeReference Text

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

FacetAttributeUpdate

facetAttributeUpdate_action :: Lens' FacetAttributeUpdate (Maybe UpdateActionType)

The action to perform when updating the attribute.

facetAttributeUpdate_attribute :: Lens' FacetAttributeUpdate (Maybe FacetAttribute)

The attribute to update.

IndexAttachment

indexAttachment_indexedAttributes :: Lens' IndexAttachment (Maybe [AttributeKeyAndValue])

The indexed attribute values.

indexAttachment_objectIdentifier :: Lens' IndexAttachment (Maybe Text)

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

LinkAttributeAction

linkAttributeAction_attributeActionType :: Lens' LinkAttributeAction (Maybe UpdateActionType)

A type that can be either UPDATE_OR_CREATE or DELETE.

linkAttributeAction_attributeUpdateValue :: Lens' LinkAttributeAction (Maybe TypedAttributeValue)

The value that you want to update to.

LinkAttributeUpdate

linkAttributeUpdate_attributeAction :: Lens' LinkAttributeUpdate (Maybe LinkAttributeAction)

The action to perform as part of the attribute update.

linkAttributeUpdate_attributeKey :: Lens' LinkAttributeUpdate (Maybe AttributeKey)

The key of the attribute being updated.

ObjectAttributeAction

objectAttributeAction_objectAttributeActionType :: Lens' ObjectAttributeAction (Maybe UpdateActionType)

A type that can be either Update or Delete.

objectAttributeAction_objectAttributeUpdateValue :: Lens' ObjectAttributeAction (Maybe TypedAttributeValue)

The value that you want to update to.

ObjectAttributeRange

objectAttributeRange_attributeKey :: Lens' ObjectAttributeRange (Maybe AttributeKey)

The key of the attribute that the attribute range covers.

objectAttributeRange_range :: Lens' ObjectAttributeRange (Maybe TypedAttributeValueRange)

The range of attribute values being selected.

ObjectAttributeUpdate

objectAttributeUpdate_objectAttributeAction :: Lens' ObjectAttributeUpdate (Maybe ObjectAttributeAction)

The action to perform as part of the attribute update.

objectAttributeUpdate_objectAttributeKey :: Lens' ObjectAttributeUpdate (Maybe AttributeKey)

The key of the attribute being updated.

ObjectIdentifierAndLinkNameTuple

objectIdentifierAndLinkNameTuple_linkName :: Lens' ObjectIdentifierAndLinkNameTuple (Maybe Text)

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

objectIdentifierAndLinkNameTuple_objectIdentifier :: Lens' ObjectIdentifierAndLinkNameTuple (Maybe Text)

The ID that is associated with the object.

ObjectReference

objectReference_selector :: Lens' ObjectReference (Maybe Text)

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. You can identify an object in one of the following ways:

• $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.
• /some/path - Identifies the object based on path
• #SomeBatchReference - Identifies the object in a batch call

PathToObjectIdentifiers

pathToObjectIdentifiers_objectIdentifiers :: Lens' PathToObjectIdentifiers (Maybe [Text])

Lists ObjectIdentifiers starting from directory root to the object in the request.

pathToObjectIdentifiers_path :: Lens' PathToObjectIdentifiers (Maybe Text)

The path that is used to identify the object starting from directory root.

PolicyAttachment

policyAttachment_objectIdentifier :: Lens' PolicyAttachment (Maybe Text)

The ObjectIdentifier that is associated with PolicyAttachment.

policyAttachment_policyId :: Lens' PolicyAttachment (Maybe Text)

The ID of PolicyAttachment.

policyAttachment_policyType :: Lens' PolicyAttachment (Maybe Text)

The type of policy that can be associated with PolicyAttachment.

PolicyToPath

policyToPath_path :: Lens' PolicyToPath (Maybe Text)

The path that is referenced from the root.

policyToPath_policies :: Lens' PolicyToPath (Maybe [PolicyAttachment])

List of policy objects.

Rule

rule_parameters :: Lens' Rule (Maybe (HashMap Text Text))

The minimum and maximum parameters that are associated with the rule.

rule_type :: Lens' Rule (Maybe RuleType)

The type of attribute validation rule.

SchemaFacet

schemaFacet_facetName :: Lens' SchemaFacet (Maybe Text)

The name of the facet. If this value is set, SchemaArn must also be set.

schemaFacet_schemaArn :: Lens' SchemaFacet (Maybe Text)

The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. If this value is set, FacetName must also be set.

Tag

tag_key :: Lens' Tag (Maybe Text)

The key that is associated with the tag.

tag_value :: Lens' Tag (Maybe Text)

The value that is associated with the tag.

TypedAttributeValue

typedAttributeValue_binaryValue :: Lens' TypedAttributeValue (Maybe ByteString)

A binary data value.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

typedAttributeValue_booleanValue :: Lens' TypedAttributeValue (Maybe Bool)

A Boolean data value.

typedAttributeValue_datetimeValue :: Lens' TypedAttributeValue (Maybe UTCTime)

A date and time value.

typedAttributeValue_numberValue :: Lens' TypedAttributeValue (Maybe Text)

A number data value.

typedAttributeValue_stringValue :: Lens' TypedAttributeValue (Maybe Text)

A string data value.

TypedAttributeValueRange

typedAttributeValueRange_endValue :: Lens' TypedAttributeValueRange (Maybe TypedAttributeValue)

The attribute value to terminate the range at.

typedAttributeValueRange_startValue :: Lens' TypedAttributeValueRange (Maybe TypedAttributeValue)

The value to start the range at.

typedAttributeValueRange_startMode :: Lens' TypedAttributeValueRange RangeMode

The inclusive or exclusive range start.

typedAttributeValueRange_endMode :: Lens' TypedAttributeValueRange RangeMode

The inclusive or exclusive range end.

TypedLinkAttributeDefinition

typedLinkAttributeDefinition_defaultValue :: Lens' TypedLinkAttributeDefinition (Maybe TypedAttributeValue)

The default value of the attribute (if configured).

typedLinkAttributeDefinition_isImmutable :: Lens' TypedLinkAttributeDefinition (Maybe Bool)

Whether the attribute is mutable or not.

typedLinkAttributeDefinition_rules :: Lens' TypedLinkAttributeDefinition (Maybe (HashMap Text Rule))

Validation rules that are attached to the attribute definition.

typedLinkAttributeDefinition_name :: Lens' TypedLinkAttributeDefinition Text

The unique name of the typed link attribute.

typedLinkAttributeDefinition_type :: Lens' TypedLinkAttributeDefinition FacetAttributeType

The type of the attribute.

typedLinkAttributeDefinition_requiredBehavior :: Lens' TypedLinkAttributeDefinition RequiredAttributeBehavior

The required behavior of the TypedLinkAttributeDefinition.

TypedLinkAttributeRange

typedLinkAttributeRange_attributeName :: Lens' TypedLinkAttributeRange (Maybe Text)

The unique name of the typed link attribute.

typedLinkAttributeRange_range :: Lens' TypedLinkAttributeRange TypedAttributeValueRange

The range of attribute values that are being selected.

TypedLinkFacet

typedLinkFacet_name :: Lens' TypedLinkFacet Text

The unique name of the typed link facet.

typedLinkFacet_attributes :: Lens' TypedLinkFacet [TypedLinkAttributeDefinition]

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.

typedLinkFacet_identityAttributeOrder :: Lens' TypedLinkFacet [Text]

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

TypedLinkFacetAttributeUpdate

typedLinkFacetAttributeUpdate_attribute :: Lens' TypedLinkFacetAttributeUpdate TypedLinkAttributeDefinition

The attribute to update.

typedLinkFacetAttributeUpdate_action :: Lens' TypedLinkFacetAttributeUpdate UpdateActionType

The action to perform when updating the attribute.

TypedLinkSchemaAndFacetName

typedLinkSchemaAndFacetName_schemaArn :: Lens' TypedLinkSchemaAndFacetName Text

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

typedLinkSchemaAndFacetName_typedLinkName :: Lens' TypedLinkSchemaAndFacetName Text

The unique name of the typed link facet.

TypedLinkSpecifier

typedLinkSpecifier_typedLinkFacet :: Lens' TypedLinkSpecifier TypedLinkSchemaAndFacetName

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

typedLinkSpecifier_sourceObjectReference :: Lens' TypedLinkSpecifier ObjectReference

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

typedLinkSpecifier_targetObjectReference :: Lens' TypedLinkSpecifier ObjectReference

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

typedLinkSpecifier_identityAttributeValues :: Lens' TypedLinkSpecifier [AttributeNameAndValue]

Identifies the attribute value to update.