amazonka-clouddirectory-2.0: Amazon CloudDirectory SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudDirectory.Lens

Contents

Description

 
Synopsis

Operations

AddFacetToObject

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

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

addFacetToObject_directoryArn :: Lens' AddFacetToObject Text Source #

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 Source #

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

addFacetToObject_objectReference :: Lens' AddFacetToObject ObjectReference Source #

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

ApplySchema

applySchema_publishedSchemaArn :: Lens' ApplySchema Text Source #

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

applySchema_directoryArn :: Lens' ApplySchema Text Source #

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) Source #

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) Source #

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

AttachObject

attachObject_directoryArn :: Lens' AttachObject Text Source #

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

attachObject_childReference :: Lens' AttachObject ObjectReference Source #

The child object reference to be attached to the object.

attachObject_linkName :: Lens' AttachObject Text Source #

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

attachObjectResponse_attachedObjectIdentifier :: Lens' AttachObjectResponse (Maybe Text) Source #

The attached ObjectIdentifier, which is the child ObjectIdentifier.

AttachPolicy

attachPolicy_directoryArn :: Lens' AttachPolicy Text Source #

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 Source #

The reference that is associated with the policy object.

attachPolicy_objectReference :: Lens' AttachPolicy ObjectReference Source #

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

AttachToIndex

attachToIndex_directoryArn :: Lens' AttachToIndex Text Source #

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

attachToIndex_indexReference :: Lens' AttachToIndex ObjectReference Source #

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

attachToIndex_targetReference :: Lens' AttachToIndex ObjectReference Source #

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

attachToIndexResponse_attachedObjectIdentifier :: Lens' AttachToIndexResponse (Maybe Text) Source #

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

AttachTypedLink

attachTypedLink_directoryArn :: Lens' AttachTypedLink Text Source #

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

attachTypedLink_sourceObjectReference :: Lens' AttachTypedLink ObjectReference Source #

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

attachTypedLink_targetObjectReference :: Lens' AttachTypedLink ObjectReference Source #

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

attachTypedLink_typedLinkFacet :: Lens' AttachTypedLink TypedLinkSchemaAndFacetName Source #

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

attachTypedLink_attributes :: Lens' AttachTypedLink [AttributeNameAndValue] Source #

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

BatchRead

batchRead_consistencyLevel :: Lens' BatchRead (Maybe ConsistencyLevel) Source #

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 Source #

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

batchRead_operations :: Lens' BatchRead [BatchReadOperation] Source #

A list of operations that are part of the batch.

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

A list of all the responses for each batch read.

batchReadResponse_httpStatus :: Lens' BatchReadResponse Int Source #

The response's http status code.

BatchWrite

batchWrite_directoryArn :: Lens' BatchWrite Text Source #

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

batchWrite_operations :: Lens' BatchWrite [BatchWriteOperation] Source #

A list of operations that are part of the batch.

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

A list of all the responses for each batch write.

CreateDirectory

createDirectory_name :: Lens' CreateDirectory Text Source #

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

createDirectory_schemaArn :: Lens' CreateDirectory Text Source #

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

createDirectoryResponse_directoryArn :: Lens' CreateDirectoryResponse Text Source #

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

createDirectoryResponse_objectIdentifier :: Lens' CreateDirectoryResponse Text Source #

The root object node of the created directory.

createDirectoryResponse_appliedSchemaArn :: Lens' CreateDirectoryResponse Text Source #

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]) Source #

The attributes that are associated with the Facet.

createFacet_facetStyle :: Lens' CreateFacet (Maybe FacetStyle) Source #

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) Source #

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 Source #

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

createFacet_name :: Lens' CreateFacet Text Source #

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

CreateIndex

createIndex_linkName :: Lens' CreateIndex (Maybe Text) Source #

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

createIndex_parentReference :: Lens' CreateIndex (Maybe ObjectReference) Source #

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

createIndex_directoryArn :: Lens' CreateIndex Text Source #

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

createIndex_orderedIndexedAttributeList :: Lens' CreateIndex [AttributeKey] Source #

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

createIndex_isUnique :: Lens' CreateIndex Bool Source #

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

createIndexResponse_objectIdentifier :: Lens' CreateIndexResponse (Maybe Text) Source #

The ObjectIdentifier of the index created by this operation.

CreateObject

createObject_linkName :: Lens' CreateObject (Maybe Text) Source #

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

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

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

createObject_parentReference :: Lens' CreateObject (Maybe ObjectReference) Source #

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

createObject_directoryArn :: Lens' CreateObject Text Source #

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] Source #

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) Source #

The identifier that is associated with the object.

CreateSchema

createSchema_name :: Lens' CreateSchema Text Source #

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

createSchemaResponse_schemaArn :: Lens' CreateSchemaResponse (Maybe Text) Source #

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

CreateTypedLinkFacet

createTypedLinkFacet_schemaArn :: Lens' CreateTypedLinkFacet Text Source #

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

createTypedLinkFacet_facet :: Lens' CreateTypedLinkFacet TypedLinkFacet Source #

Facet structure that is associated with the typed link facet.

DeleteDirectory

deleteDirectory_directoryArn :: Lens' DeleteDirectory Text Source #

The ARN of the directory to delete.

DeleteFacet

deleteFacet_schemaArn :: Lens' DeleteFacet Text Source #

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

deleteFacet_name :: Lens' DeleteFacet Text Source #

The name of the facet to delete.

DeleteObject

deleteObject_directoryArn :: Lens' DeleteObject Text Source #

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 Source #

A reference that identifies the object.

DeleteSchema

deleteSchema_schemaArn :: Lens' DeleteSchema Text Source #

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

deleteSchemaResponse_schemaArn :: Lens' DeleteSchemaResponse (Maybe Text) Source #

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

DeleteTypedLinkFacet

deleteTypedLinkFacet_schemaArn :: Lens' DeleteTypedLinkFacet Text Source #

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

deleteTypedLinkFacet_name :: Lens' DeleteTypedLinkFacet Text Source #

The unique name of the typed link facet.

DetachFromIndex

detachFromIndex_directoryArn :: Lens' DetachFromIndex Text Source #

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

detachFromIndex_targetReference :: Lens' DetachFromIndex ObjectReference Source #

A reference to the object being detached from the index.

detachFromIndexResponse_detachedObjectIdentifier :: Lens' DetachFromIndexResponse (Maybe Text) Source #

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

DetachObject

detachObject_directoryArn :: Lens' DetachObject Text Source #

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

detachObject_parentReference :: Lens' DetachObject ObjectReference Source #

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

detachObject_linkName :: Lens' DetachObject Text Source #

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

detachObjectResponse_detachedObjectIdentifier :: Lens' DetachObjectResponse (Maybe Text) Source #

The ObjectIdentifier that was detached from the object.

DetachPolicy

detachPolicy_directoryArn :: Lens' DetachPolicy Text Source #

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 Source #

Reference that identifies the policy object.

detachPolicy_objectReference :: Lens' DetachPolicy ObjectReference Source #

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

DetachTypedLink

detachTypedLink_directoryArn :: Lens' DetachTypedLink Text Source #

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

detachTypedLink_typedLinkSpecifier :: Lens' DetachTypedLink TypedLinkSpecifier Source #

Used to accept a typed link specifier as input.

DisableDirectory

disableDirectory_directoryArn :: Lens' DisableDirectory Text Source #

The ARN of the directory to disable.

disableDirectoryResponse_directoryArn :: Lens' DisableDirectoryResponse Text Source #

The ARN of the directory that has been disabled.

EnableDirectory

enableDirectory_directoryArn :: Lens' EnableDirectory Text Source #

The ARN of the directory to enable.

GetAppliedSchemaVersion

getAppliedSchemaVersionResponse_appliedSchemaArn :: Lens' GetAppliedSchemaVersionResponse (Maybe Text) Source #

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

GetDirectory

GetFacet

getFacet_schemaArn :: Lens' GetFacet Text Source #

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

getFacet_name :: Lens' GetFacet Text Source #

The name of the facet to retrieve.

getFacetResponse_facet :: Lens' GetFacetResponse (Maybe Facet) Source #

The Facet structure that is associated with the facet.

getFacetResponse_httpStatus :: Lens' GetFacetResponse Int Source #

The response's http status code.

GetLinkAttributes

getLinkAttributes_consistencyLevel :: Lens' GetLinkAttributes (Maybe ConsistencyLevel) Source #

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

getLinkAttributes_directoryArn :: Lens' GetLinkAttributes Text Source #

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 Source #

Allows a typed link specifier to be accepted as input.

getLinkAttributes_attributeNames :: Lens' GetLinkAttributes [Text] Source #

A list of attribute names whose values will be retrieved.

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

The attributes that are associated with the typed link.

GetObjectAttributes

getObjectAttributes_consistencyLevel :: Lens' GetObjectAttributes (Maybe ConsistencyLevel) Source #

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

getObjectAttributes_directoryArn :: Lens' GetObjectAttributes Text Source #

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

getObjectAttributes_objectReference :: Lens' GetObjectAttributes ObjectReference Source #

Reference that identifies the object whose attributes will be retrieved.

getObjectAttributes_schemaFacet :: Lens' GetObjectAttributes SchemaFacet Source #

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

getObjectAttributes_attributeNames :: Lens' GetObjectAttributes [Text] Source #

List of attribute names whose values will be retrieved.

GetObjectInformation

getObjectInformation_consistencyLevel :: Lens' GetObjectInformation (Maybe ConsistencyLevel) Source #

The consistency level at which to retrieve the object information.

getObjectInformation_directoryArn :: Lens' GetObjectInformation Text Source #

The ARN of the directory being retrieved.

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

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.

GetSchemaAsJson

getSchemaAsJson_schemaArn :: Lens' GetSchemaAsJson Text Source #

The ARN of the schema to retrieve.

getSchemaAsJsonResponse_document :: Lens' GetSchemaAsJsonResponse (Maybe Text) Source #

The JSON representation of the schema document.

GetTypedLinkFacetInformation

getTypedLinkFacetInformation_schemaArn :: Lens' GetTypedLinkFacetInformation Text Source #

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

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

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.

ListAppliedSchemaArns

listAppliedSchemaArns_maxResults :: Lens' ListAppliedSchemaArns (Maybe Natural) Source #

The maximum number of results to retrieve.

listAppliedSchemaArns_schemaArn :: Lens' ListAppliedSchemaArns (Maybe Text) Source #

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

listAppliedSchemaArns_directoryArn :: Lens' ListAppliedSchemaArns Text Source #

The ARN of the directory you are listing.

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

The ARNs of schemas that are applied to the directory.

ListAttachedIndices

listAttachedIndices_consistencyLevel :: Lens' ListAttachedIndices (Maybe ConsistencyLevel) Source #

The consistency level to use for this operation.

listAttachedIndices_maxResults :: Lens' ListAttachedIndices (Maybe Natural) Source #

The maximum number of results to retrieve.

listAttachedIndices_targetReference :: Lens' ListAttachedIndices ObjectReference Source #

A reference to the object that has indices attached.

ListDevelopmentSchemaArns

ListDirectories

listDirectories_maxResults :: Lens' ListDirectories (Maybe Natural) Source #

The maximum number of results to retrieve.

listDirectories_state :: Lens' ListDirectories (Maybe DirectoryState) Source #

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

listDirectoriesResponse_directories :: Lens' ListDirectoriesResponse [Directory] Source #

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

ListFacetAttributes

listFacetAttributes_maxResults :: Lens' ListFacetAttributes (Maybe Natural) Source #

The maximum number of results to retrieve.

listFacetAttributes_schemaArn :: Lens' ListFacetAttributes Text Source #

The ARN of the schema where the facet resides.

listFacetAttributes_name :: Lens' ListFacetAttributes Text Source #

The name of the facet whose attributes will be retrieved.

ListFacetNames

listFacetNames_maxResults :: Lens' ListFacetNames (Maybe Natural) Source #

The maximum number of results to retrieve.

listFacetNames_schemaArn :: Lens' ListFacetNames Text Source #

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

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

The names of facets that exist within the schema.

ListIncomingTypedLinks

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

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) Source #

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) Source #

The maximum number of results to retrieve.

listIncomingTypedLinks_directoryArn :: Lens' ListIncomingTypedLinks Text Source #

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

listIncomingTypedLinks_objectReference :: Lens' ListIncomingTypedLinks ObjectReference Source #

Reference that identifies the object whose attributes will be listed.

ListIndex

listIndex_consistencyLevel :: Lens' ListIndex (Maybe ConsistencyLevel) Source #

The consistency level to execute the request at.

listIndex_maxResults :: Lens' ListIndex (Maybe Natural) Source #

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_rangesOnIndexedValues :: Lens' ListIndex (Maybe [ObjectAttributeRange]) Source #

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

listIndex_directoryArn :: Lens' ListIndex Text Source #

The ARN of the directory that the index exists in.

listIndex_indexReference :: Lens' ListIndex ObjectReference Source #

The reference to the index to list.

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

The objects and indexed values attached to the index.

listIndexResponse_httpStatus :: Lens' ListIndexResponse Int Source #

The response's http status code.

ListManagedSchemaArns

listManagedSchemaArns_maxResults :: Lens' ListManagedSchemaArns (Maybe Natural) Source #

The maximum number of results to retrieve.

listManagedSchemaArns_schemaArn :: Lens' ListManagedSchemaArns (Maybe Text) Source #

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

ListObjectAttributes

listObjectAttributes_consistencyLevel :: Lens' ListObjectAttributes (Maybe ConsistencyLevel) Source #

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) Source #

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

listObjectAttributes_maxResults :: Lens' ListObjectAttributes (Maybe Natural) Source #

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

listObjectAttributes_directoryArn :: Lens' ListObjectAttributes Text Source #

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 Source #

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

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

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

ListObjectChildren

listObjectChildren_consistencyLevel :: Lens' ListObjectChildren (Maybe ConsistencyLevel) Source #

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) Source #

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

listObjectChildren_directoryArn :: Lens' ListObjectChildren Text Source #

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 Source #

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

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

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

ListObjectParentPaths

listObjectParentPaths_maxResults :: Lens' ListObjectParentPaths (Maybe Natural) Source #

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

listObjectParentPaths_directoryArn :: Lens' ListObjectParentPaths Text Source #

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

listObjectParentPaths_objectReference :: Lens' ListObjectParentPaths ObjectReference Source #

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

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

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

ListObjectParents

listObjectParents_consistencyLevel :: Lens' ListObjectParents (Maybe ConsistencyLevel) Source #

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) Source #

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

listObjectParents_maxResults :: Lens' ListObjectParents (Maybe Natural) Source #

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

listObjectParents_directoryArn :: Lens' ListObjectParents Text Source #

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 Source #

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

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

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

ListObjectPolicies

listObjectPolicies_consistencyLevel :: Lens' ListObjectPolicies (Maybe ConsistencyLevel) Source #

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) Source #

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

listObjectPolicies_directoryArn :: Lens' ListObjectPolicies Text Source #

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

listObjectPolicies_objectReference :: Lens' ListObjectPolicies ObjectReference Source #

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

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

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

ListOutgoingTypedLinks

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

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) Source #

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) Source #

The maximum number of results to retrieve.

listOutgoingTypedLinks_directoryArn :: Lens' ListOutgoingTypedLinks Text Source #

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

listOutgoingTypedLinks_objectReference :: Lens' ListOutgoingTypedLinks ObjectReference Source #

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

ListPolicyAttachments

listPolicyAttachments_consistencyLevel :: Lens' ListPolicyAttachments (Maybe ConsistencyLevel) Source #

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) Source #

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

listPolicyAttachments_directoryArn :: Lens' ListPolicyAttachments Text Source #

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

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

A list of ObjectIdentifiers to which the policy is attached.

ListPublishedSchemaArns

listPublishedSchemaArns_schemaArn :: Lens' ListPublishedSchemaArns (Maybe Text) Source #

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

ListTagsForResource

listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural) Source #

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) Source #

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

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

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

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

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]) Source #

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

ListTypedLinkFacetAttributes

listTypedLinkFacetAttributes_schemaArn :: Lens' ListTypedLinkFacetAttributes Text Source #

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

ListTypedLinkFacetNames

listTypedLinkFacetNames_schemaArn :: Lens' ListTypedLinkFacetNames Text Source #

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

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

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

LookupPolicy

lookupPolicy_maxResults :: Lens' LookupPolicy (Maybe Natural) Source #

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

lookupPolicy_nextToken :: Lens' LookupPolicy (Maybe Text) Source #

The token to request the next page of results.

lookupPolicy_directoryArn :: Lens' LookupPolicy Text Source #

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

lookupPolicy_objectReference :: Lens' LookupPolicy ObjectReference Source #

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

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

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

PublishSchema

publishSchema_minorVersion :: Lens' PublishSchema (Maybe Text) Source #

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) Source #

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 Source #

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

publishSchema_version :: Lens' PublishSchema Text Source #

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) Source #

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

PutSchemaFromJson

putSchemaFromJson_schemaArn :: Lens' PutSchemaFromJson Text Source #

The ARN of the schema to update.

RemoveFacetFromObject

removeFacetFromObject_directoryArn :: Lens' RemoveFacetFromObject Text Source #

The ARN of the directory in which the object resides.

removeFacetFromObject_schemaFacet :: Lens' RemoveFacetFromObject SchemaFacet Source #

The facet to remove. See SchemaFacet for details.

removeFacetFromObject_objectReference :: Lens' RemoveFacetFromObject ObjectReference Source #

A reference to the object to remove the facet from.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

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

tagResource_tags :: Lens' TagResource [Tag] Source #

A list of tag key-value pairs.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

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

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

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

UpdateFacet

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

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) Source #

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

updateFacet_schemaArn :: Lens' UpdateFacet Text Source #

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

updateFacet_name :: Lens' UpdateFacet Text Source #

The name of the facet.

UpdateLinkAttributes

updateLinkAttributes_directoryArn :: Lens' UpdateLinkAttributes Text Source #

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 Source #

Allows a typed link specifier to be accepted as input.

UpdateObjectAttributes

updateObjectAttributes_directoryArn :: Lens' UpdateObjectAttributes Text Source #

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

UpdateSchema

updateSchema_schemaArn :: Lens' UpdateSchema Text Source #

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

updateSchema_name :: Lens' UpdateSchema Text Source #

The name of the schema.

updateSchemaResponse_schemaArn :: Lens' UpdateSchemaResponse (Maybe Text) Source #

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

UpdateTypedLinkFacet

updateTypedLinkFacet_schemaArn :: Lens' UpdateTypedLinkFacet Text Source #

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

updateTypedLinkFacet_name :: Lens' UpdateTypedLinkFacet Text Source #

The unique name of the typed link facet.

updateTypedLinkFacet_identityAttributeOrder :: Lens' UpdateTypedLinkFacet [Text] Source #

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.

UpgradeAppliedSchema

upgradeAppliedSchema_dryRun :: Lens' UpgradeAppliedSchema (Maybe Bool) Source #

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 Source #

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

upgradeAppliedSchema_directoryArn :: Lens' UpgradeAppliedSchema Text Source #

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

upgradeAppliedSchemaResponse_directoryArn :: Lens' UpgradeAppliedSchemaResponse (Maybe Text) Source #

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

upgradeAppliedSchemaResponse_upgradedSchemaArn :: Lens' UpgradeAppliedSchemaResponse (Maybe Text) Source #

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

UpgradePublishedSchema

upgradePublishedSchema_dryRun :: Lens' UpgradePublishedSchema (Maybe Bool) Source #

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 Source #

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

upgradePublishedSchema_publishedSchemaArn :: Lens' UpgradePublishedSchema Text Source #

The ARN of the published schema to be upgraded.

upgradePublishedSchema_minorVersion :: Lens' UpgradePublishedSchema Text Source #

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

upgradePublishedSchemaResponse_upgradedSchemaArn :: Lens' UpgradePublishedSchemaResponse (Maybe Text) Source #

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

Types

AttributeKey

attributeKey_schemaArn :: Lens' AttributeKey Text Source #

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

attributeKey_facetName :: Lens' AttributeKey Text Source #

The name of the facet that the attribute exists within.

attributeKey_name :: Lens' AttributeKey Text Source #

The name of the attribute.

AttributeKeyAndValue

AttributeNameAndValue

BatchAddFacetToObject

batchAddFacetToObject_schemaFacet :: Lens' BatchAddFacetToObject SchemaFacet Source #

Represents the facet being added to the object.

BatchAddFacetToObjectResponse

BatchAttachObject

batchAttachObject_childReference :: Lens' BatchAttachObject ObjectReference Source #

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

BatchAttachObjectResponse

batchAttachObjectResponse_attachedObjectIdentifier :: Lens' BatchAttachObjectResponse (Maybe Text) Source #

The ObjectIdentifier of the object that has been attached.

BatchAttachPolicy

batchAttachPolicy_policyReference :: Lens' BatchAttachPolicy ObjectReference Source #

The reference that is associated with the policy object.

batchAttachPolicy_objectReference :: Lens' BatchAttachPolicy ObjectReference Source #

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

BatchAttachPolicyResponse

BatchAttachToIndex

batchAttachToIndex_indexReference :: Lens' BatchAttachToIndex ObjectReference Source #

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

batchAttachToIndex_targetReference :: Lens' BatchAttachToIndex ObjectReference Source #

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

BatchAttachToIndexResponse

batchAttachToIndexResponse_attachedObjectIdentifier :: Lens' BatchAttachToIndexResponse (Maybe Text) Source #

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

BatchAttachTypedLink

batchAttachTypedLink_sourceObjectReference :: Lens' BatchAttachTypedLink ObjectReference Source #

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

batchAttachTypedLink_targetObjectReference :: Lens' BatchAttachTypedLink ObjectReference Source #

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

batchAttachTypedLink_typedLinkFacet :: Lens' BatchAttachTypedLink TypedLinkSchemaAndFacetName Source #

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

batchAttachTypedLink_attributes :: Lens' BatchAttachTypedLink [AttributeNameAndValue] Source #

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

BatchAttachTypedLinkResponse

BatchCreateIndex

batchCreateIndex_batchReferenceName :: Lens' BatchCreateIndex (Maybe Text) Source #

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

batchCreateIndex_linkName :: Lens' BatchCreateIndex (Maybe Text) Source #

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

batchCreateIndex_parentReference :: Lens' BatchCreateIndex (Maybe ObjectReference) Source #

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

batchCreateIndex_orderedIndexedAttributeList :: Lens' BatchCreateIndex [AttributeKey] Source #

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

batchCreateIndex_isUnique :: Lens' BatchCreateIndex Bool Source #

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

BatchCreateIndexResponse

batchCreateIndexResponse_objectIdentifier :: Lens' BatchCreateIndexResponse (Maybe Text) Source #

The ObjectIdentifier of the index created by this operation.

BatchCreateObject

batchCreateObject_batchReferenceName :: Lens' BatchCreateObject (Maybe Text) Source #

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

batchCreateObject_parentReference :: Lens' BatchCreateObject (Maybe ObjectReference) Source #

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

batchCreateObject_schemaFacet :: Lens' BatchCreateObject [SchemaFacet] Source #

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

batchCreateObject_objectAttributeList :: Lens' BatchCreateObject [AttributeKeyAndValue] Source #

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

BatchCreateObjectResponse

BatchDeleteObject

BatchDeleteObjectResponse

BatchDetachFromIndex

batchDetachFromIndex_targetReference :: Lens' BatchDetachFromIndex ObjectReference Source #

A reference to the object being detached from the index.

BatchDetachFromIndexResponse

batchDetachFromIndexResponse_detachedObjectIdentifier :: Lens' BatchDetachFromIndexResponse (Maybe Text) Source #

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

BatchDetachObject

batchDetachObject_batchReferenceName :: Lens' BatchDetachObject (Maybe Text) Source #

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

batchDetachObject_parentReference :: Lens' BatchDetachObject ObjectReference Source #

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

BatchDetachObjectResponse

BatchDetachPolicy

batchDetachPolicy_policyReference :: Lens' BatchDetachPolicy ObjectReference Source #

Reference that identifies the policy object.

batchDetachPolicy_objectReference :: Lens' BatchDetachPolicy ObjectReference Source #

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

BatchDetachPolicyResponse

BatchDetachTypedLink

BatchDetachTypedLinkResponse

BatchGetLinkAttributes

batchGetLinkAttributes_typedLinkSpecifier :: Lens' BatchGetLinkAttributes TypedLinkSpecifier Source #

Allows a typed link specifier to be accepted as input.

batchGetLinkAttributes_attributeNames :: Lens' BatchGetLinkAttributes [Text] Source #

A list of attribute names whose values will be retrieved.

BatchGetLinkAttributesResponse

BatchGetObjectAttributes

batchGetObjectAttributes_objectReference :: Lens' BatchGetObjectAttributes ObjectReference Source #

Reference that identifies the object whose attributes will be retrieved.

batchGetObjectAttributes_schemaFacet :: Lens' BatchGetObjectAttributes SchemaFacet Source #

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

batchGetObjectAttributes_attributeNames :: Lens' BatchGetObjectAttributes [Text] Source #

List of attribute names whose values will be retrieved.

BatchGetObjectAttributesResponse

BatchGetObjectInformation

BatchGetObjectInformationResponse

BatchListAttachedIndices

BatchListAttachedIndicesResponse

BatchListIncomingTypedLinks

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

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) Source #

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_objectReference :: Lens' BatchListIncomingTypedLinks ObjectReference Source #

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

BatchListIncomingTypedLinksResponse

BatchListIndex

batchListIndex_maxResults :: Lens' BatchListIndex (Maybe Natural) Source #

The maximum number of results to retrieve.

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

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

BatchListIndexResponse

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

The objects and indexed values attached to the index.

BatchListObjectAttributes

batchListObjectAttributes_facetFilter :: Lens' BatchListObjectAttributes (Maybe SchemaFacet) Source #

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

batchListObjectAttributes_maxResults :: Lens' BatchListObjectAttributes (Maybe Natural) Source #

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

batchListObjectAttributes_objectReference :: Lens' BatchListObjectAttributes ObjectReference Source #

Reference of the object whose attributes need to be listed.

BatchListObjectAttributesResponse

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

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

BatchListObjectChildren

batchListObjectChildren_maxResults :: Lens' BatchListObjectChildren (Maybe Natural) Source #

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

batchListObjectChildren_objectReference :: Lens' BatchListObjectChildren ObjectReference Source #

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

BatchListObjectChildrenResponse

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

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

BatchListObjectParentPaths

batchListObjectParentPaths_objectReference :: Lens' BatchListObjectParentPaths ObjectReference Source #

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

BatchListObjectParentPathsResponse

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

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

BatchListObjectParents

batchListObjectParents_maxResults :: Lens' BatchListObjectParents (Maybe Natural) Source #

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

BatchListObjectParentsResponse

BatchListObjectPolicies

batchListObjectPolicies_objectReference :: Lens' BatchListObjectPolicies ObjectReference Source #

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

BatchListObjectPoliciesResponse

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

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

BatchListOutgoingTypedLinks

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

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) Source #

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_objectReference :: Lens' BatchListOutgoingTypedLinks ObjectReference Source #

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

BatchListOutgoingTypedLinksResponse

BatchListPolicyAttachments

BatchListPolicyAttachmentsResponse

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

A list of ObjectIdentifiers to which the policy is attached.

BatchLookupPolicy

batchLookupPolicy_maxResults :: Lens' BatchLookupPolicy (Maybe Natural) Source #

The maximum number of results to retrieve.

batchLookupPolicy_objectReference :: Lens' BatchLookupPolicy ObjectReference Source #

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

BatchLookupPolicyResponse

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

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

BatchReadException

batchReadException_message :: Lens' BatchReadException (Maybe Text) Source #

An exception message that is associated with the failure.

batchReadException_type :: Lens' BatchReadException (Maybe BatchReadExceptionType) Source #

A type of exception, such as InvalidArnException.

BatchReadOperation

batchReadOperation_getLinkAttributes :: Lens' BatchReadOperation (Maybe BatchGetLinkAttributes) Source #

Retrieves attributes that are associated with a typed link.

batchReadOperation_getObjectAttributes :: Lens' BatchReadOperation (Maybe BatchGetObjectAttributes) Source #

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

batchReadOperation_listIncomingTypedLinks :: Lens' BatchReadOperation (Maybe BatchListIncomingTypedLinks) Source #

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) Source #

Lists objects attached to the specified index.

batchReadOperation_listObjectAttributes :: Lens' BatchReadOperation (Maybe BatchListObjectAttributes) Source #

Lists all attributes that are associated with an object.

batchReadOperation_listObjectChildren :: Lens' BatchReadOperation (Maybe BatchListObjectChildren) Source #

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

batchReadOperation_listObjectParentPaths :: Lens' BatchReadOperation (Maybe BatchListObjectParentPaths) Source #

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) Source #

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

batchReadOperation_listObjectPolicies :: Lens' BatchReadOperation (Maybe BatchListObjectPolicies) Source #

Returns policies attached to an object in pagination fashion.

batchReadOperation_listOutgoingTypedLinks :: Lens' BatchReadOperation (Maybe BatchListOutgoingTypedLinks) Source #

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) Source #

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

batchReadOperation_lookupPolicy :: Lens' BatchReadOperation (Maybe BatchLookupPolicy) Source #

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

BatchReadSuccessfulResponse

batchReadSuccessfulResponse_getObjectAttributes :: Lens' BatchReadSuccessfulResponse (Maybe BatchGetObjectAttributesResponse) Source #

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

batchReadSuccessfulResponse_listIncomingTypedLinks :: Lens' BatchReadSuccessfulResponse (Maybe BatchListIncomingTypedLinksResponse) Source #

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_listObjectChildren :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectChildrenResponse) Source #

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

batchReadSuccessfulResponse_listObjectParentPaths :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectParentPathsResponse) Source #

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_listOutgoingTypedLinks :: Lens' BatchReadSuccessfulResponse (Maybe BatchListOutgoingTypedLinksResponse) Source #

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_lookupPolicy :: Lens' BatchReadSuccessfulResponse (Maybe BatchLookupPolicyResponse) Source #

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

BatchRemoveFacetFromObjectResponse

BatchUpdateLinkAttributes

BatchUpdateLinkAttributesResponse

BatchUpdateObjectAttributes

BatchUpdateObjectAttributesResponse

BatchWriteOperation

batchWriteOperation_attachPolicy :: Lens' BatchWriteOperation (Maybe BatchAttachPolicy) Source #

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

batchWriteOperation_attachToIndex :: Lens' BatchWriteOperation (Maybe BatchAttachToIndex) Source #

Attaches the specified object to the specified index.

batchWriteOperation_attachTypedLink :: Lens' BatchWriteOperation (Maybe BatchAttachTypedLink) Source #

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

batchWriteOperation_detachFromIndex :: Lens' BatchWriteOperation (Maybe BatchDetachFromIndex) Source #

Detaches the specified object from the specified index.

batchWriteOperation_detachTypedLink :: Lens' BatchWriteOperation (Maybe BatchDetachTypedLink) Source #

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

BatchWriteOperationResponse

batchWriteOperationResponse_attachPolicy :: Lens' BatchWriteOperationResponse (Maybe BatchAttachPolicyResponse) Source #

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

batchWriteOperationResponse_attachTypedLink :: Lens' BatchWriteOperationResponse (Maybe BatchAttachTypedLinkResponse) Source #

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

batchWriteOperationResponse_detachTypedLink :: Lens' BatchWriteOperationResponse (Maybe BatchDetachTypedLinkResponse) Source #

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

Directory

directory_creationDateTime :: Lens' Directory (Maybe UTCTime) Source #

The date and time when the directory was created.

directory_directoryArn :: Lens' Directory (Maybe Text) Source #

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

directory_name :: Lens' Directory (Maybe Text) Source #

The name of the directory.

directory_state :: Lens' Directory (Maybe DirectoryState) Source #

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

Facet

facet_facetStyle :: Lens' Facet (Maybe FacetStyle) Source #

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) Source #

The name of the Facet.

facet_objectType :: Lens' Facet (Maybe ObjectType) Source #

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

FacetAttribute

facetAttribute_attributeDefinition :: Lens' FacetAttribute (Maybe FacetAttributeDefinition) Source #

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) Source #

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

facetAttribute_name :: Lens' FacetAttribute Text Source #

The name of the facet attribute.

FacetAttributeDefinition

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

Validation rules attached to the attribute definition.

FacetAttributeReference

facetAttributeReference_targetFacetName :: Lens' FacetAttributeReference Text Source #

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

facetAttributeReference_targetAttributeName :: Lens' FacetAttributeReference Text Source #

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

FacetAttributeUpdate

facetAttributeUpdate_action :: Lens' FacetAttributeUpdate (Maybe UpdateActionType) Source #

The action to perform when updating the attribute.

IndexAttachment

indexAttachment_objectIdentifier :: Lens' IndexAttachment (Maybe Text) Source #

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) Source #

A type that can be either UPDATE_OR_CREATE or DELETE.

LinkAttributeUpdate

linkAttributeUpdate_attributeAction :: Lens' LinkAttributeUpdate (Maybe LinkAttributeAction) Source #

The action to perform as part of the attribute update.

ObjectAttributeAction

ObjectAttributeRange

objectAttributeRange_attributeKey :: Lens' ObjectAttributeRange (Maybe AttributeKey) Source #

The key of the attribute that the attribute range covers.

ObjectAttributeUpdate

ObjectIdentifierAndLinkNameTuple

objectIdentifierAndLinkNameTuple_linkName :: Lens' ObjectIdentifierAndLinkNameTuple (Maybe Text) Source #

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

ObjectReference

objectReference_selector :: Lens' ObjectReference (Maybe Text) Source #

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]) Source #

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

pathToObjectIdentifiers_path :: Lens' PathToObjectIdentifiers (Maybe Text) Source #

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

PolicyAttachment

policyAttachment_objectIdentifier :: Lens' PolicyAttachment (Maybe Text) Source #

The ObjectIdentifier that is associated with PolicyAttachment.

policyAttachment_policyType :: Lens' PolicyAttachment (Maybe Text) Source #

The type of policy that can be associated with PolicyAttachment.

PolicyToPath

policyToPath_path :: Lens' PolicyToPath (Maybe Text) Source #

The path that is referenced from the root.

Rule

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

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

rule_type :: Lens' Rule (Maybe RuleType) Source #

The type of attribute validation rule.

SchemaFacet

schemaFacet_facetName :: Lens' SchemaFacet (Maybe Text) Source #

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

schemaFacet_schemaArn :: Lens' SchemaFacet (Maybe Text) Source #

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) Source #

The key that is associated with the tag.

tag_value :: Lens' Tag (Maybe Text) Source #

The value that is associated with the tag.

TypedAttributeValue

typedAttributeValue_binaryValue :: Lens' TypedAttributeValue (Maybe ByteString) Source #

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.

TypedAttributeValueRange

TypedLinkAttributeDefinition

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

Validation rules that are attached to the attribute definition.

typedLinkAttributeDefinition_name :: Lens' TypedLinkAttributeDefinition Text Source #

The unique name of the typed link attribute.

TypedLinkAttributeRange

typedLinkAttributeRange_attributeName :: Lens' TypedLinkAttributeRange (Maybe Text) Source #

The unique name of the typed link attribute.

typedLinkAttributeRange_range :: Lens' TypedLinkAttributeRange TypedAttributeValueRange Source #

The range of attribute values that are being selected.

TypedLinkFacet

typedLinkFacet_name :: Lens' TypedLinkFacet Text Source #

The unique name of the typed link facet.

typedLinkFacet_attributes :: Lens' TypedLinkFacet [TypedLinkAttributeDefinition] Source #

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] Source #

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

TypedLinkSchemaAndFacetName

typedLinkSchemaAndFacetName_schemaArn :: Lens' TypedLinkSchemaAndFacetName Text Source #

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

TypedLinkSpecifier

typedLinkSpecifier_typedLinkFacet :: Lens' TypedLinkSpecifier TypedLinkSchemaAndFacetName Source #

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

typedLinkSpecifier_sourceObjectReference :: Lens' TypedLinkSpecifier ObjectReference Source #

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

typedLinkSpecifier_targetObjectReference :: Lens' TypedLinkSpecifier ObjectReference Source #

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