| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CloudDirectory.Types
Contents
- Service Configuration
- Errors
- BatchReadExceptionType
- ConsistencyLevel
- DirectoryState
- FacetAttributeType
- ObjectType
- RangeMode
- RequiredAttributeBehavior
- RuleType
- UpdateActionType
- AttributeKey
- AttributeKeyAndValue
- AttributeNameAndValue
- BatchAddFacetToObject
- BatchAddFacetToObjectResponse
- BatchAttachObject
- BatchAttachObjectResponse
- BatchAttachPolicy
- BatchAttachPolicyResponse
- BatchAttachToIndex
- BatchAttachToIndexResponse
- BatchAttachTypedLink
- BatchAttachTypedLinkResponse
- BatchCreateIndex
- BatchCreateIndexResponse
- BatchCreateObject
- BatchCreateObjectResponse
- BatchDeleteObject
- BatchDeleteObjectResponse
- BatchDetachFromIndex
- BatchDetachFromIndexResponse
- BatchDetachObject
- BatchDetachObjectResponse
- BatchDetachPolicy
- BatchDetachPolicyResponse
- BatchDetachTypedLink
- BatchDetachTypedLinkResponse
- BatchGetObjectAttributes
- BatchGetObjectAttributesResponse
- BatchGetObjectInformation
- BatchGetObjectInformationResponse
- BatchListAttachedIndices
- BatchListAttachedIndicesResponse
- BatchListIncomingTypedLinks
- BatchListIncomingTypedLinksResponse
- BatchListIndex
- BatchListIndexResponse
- BatchListObjectAttributes
- BatchListObjectAttributesResponse
- BatchListObjectChildren
- BatchListObjectChildrenResponse
- BatchListObjectParentPaths
- BatchListObjectParentPathsResponse
- BatchListObjectPolicies
- BatchListObjectPoliciesResponse
- BatchListOutgoingTypedLinks
- BatchListOutgoingTypedLinksResponse
- BatchListPolicyAttachments
- BatchListPolicyAttachmentsResponse
- BatchLookupPolicy
- BatchLookupPolicyResponse
- BatchReadException
- BatchReadOperation
- BatchReadOperationResponse
- BatchReadSuccessfulResponse
- BatchRemoveFacetFromObject
- BatchRemoveFacetFromObjectResponse
- BatchUpdateObjectAttributes
- BatchUpdateObjectAttributesResponse
- BatchWriteOperation
- BatchWriteOperationResponse
- Directory
- Facet
- FacetAttribute
- FacetAttributeDefinition
- FacetAttributeReference
- FacetAttributeUpdate
- IndexAttachment
- ObjectAttributeAction
- ObjectAttributeRange
- ObjectAttributeUpdate
- ObjectReference
- PathToObjectIdentifiers
- PolicyAttachment
- PolicyToPath
- Rule
- SchemaFacet
- Tag
- TypedAttributeValue
- TypedAttributeValueRange
- TypedLinkAttributeDefinition
- TypedLinkAttributeRange
- TypedLinkFacet
- TypedLinkFacetAttributeUpdate
- TypedLinkSchemaAndFacetName
- TypedLinkSpecifier
Description
- cloudDirectory :: Service
- _UnsupportedIndexTypeException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotIndexException :: AsError a => Getting (First ServiceError) a ServiceError
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _FacetAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSchemaDocException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidAttachmentException :: AsError a => Getting (First ServiceError) a ServiceError
- _CannotListParentOfRootException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTaggingRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidFacetUpdateException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRuleException :: AsError a => Getting (First ServiceError) a ServiceError
- _SchemaAlreadyPublishedException :: AsError a => Getting (First ServiceError) a ServiceError
- _DirectoryAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _DirectoryNotDisabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _BatchWriteException :: AsError a => Getting (First ServiceError) a ServiceError
- _DirectoryNotEnabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _FacetInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _FacetValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _StillContainsLinksException :: AsError a => Getting (First ServiceError) a ServiceError
- _IncompatibleSchemaException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotNodeException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _ObjectAlreadyDetachedException :: AsError a => Getting (First ServiceError) a ServiceError
- _LinkNameAlreadyInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _SchemaAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _IndexedAttributeMissingException :: AsError a => Getting (First ServiceError) a ServiceError
- _DirectoryDeletedException :: AsError a => Getting (First ServiceError) a ServiceError
- _RetryableConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidARNException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _FacetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ObjectNotDetachedException :: AsError a => Getting (First ServiceError) a ServiceError
- data BatchReadExceptionType
- = AccessDeniedException
- | CannotListParentOfRootException
- | DirectoryNotEnabledException
- | FacetValidationException
- | InternalServiceException
- | InvalidARNException
- | InvalidNextTokenException
- | LimitExceededException
- | NotIndexException
- | NotNodeException
- | NotPolicyException
- | ResourceNotFoundException
- | ValidationException
- data ConsistencyLevel
- data DirectoryState
- data FacetAttributeType
- data ObjectType
- data RangeMode
- data RequiredAttributeBehavior
- data RuleType
- data UpdateActionType
- data AttributeKey
- attributeKey :: Text -> Text -> Text -> AttributeKey
- akSchemaARN :: Lens' AttributeKey Text
- akFacetName :: Lens' AttributeKey Text
- akName :: Lens' AttributeKey Text
- data AttributeKeyAndValue
- attributeKeyAndValue :: AttributeKey -> TypedAttributeValue -> AttributeKeyAndValue
- akavKey :: Lens' AttributeKeyAndValue AttributeKey
- akavValue :: Lens' AttributeKeyAndValue TypedAttributeValue
- data AttributeNameAndValue
- attributeNameAndValue :: Text -> TypedAttributeValue -> AttributeNameAndValue
- anavAttributeName :: Lens' AttributeNameAndValue Text
- anavValue :: Lens' AttributeNameAndValue TypedAttributeValue
- data BatchAddFacetToObject
- batchAddFacetToObject :: SchemaFacet -> ObjectReference -> BatchAddFacetToObject
- baftoSchemaFacet :: Lens' BatchAddFacetToObject SchemaFacet
- baftoObjectAttributeList :: Lens' BatchAddFacetToObject [AttributeKeyAndValue]
- baftoObjectReference :: Lens' BatchAddFacetToObject ObjectReference
- data BatchAddFacetToObjectResponse
- batchAddFacetToObjectResponse :: BatchAddFacetToObjectResponse
- data BatchAttachObject
- batchAttachObject :: ObjectReference -> ObjectReference -> Text -> BatchAttachObject
- baoParentReference :: Lens' BatchAttachObject ObjectReference
- baoChildReference :: Lens' BatchAttachObject ObjectReference
- baoLinkName :: Lens' BatchAttachObject Text
- data BatchAttachObjectResponse
- batchAttachObjectResponse :: BatchAttachObjectResponse
- baoAttachedObjectIdentifier :: Lens' BatchAttachObjectResponse (Maybe Text)
- data BatchAttachPolicy
- batchAttachPolicy :: ObjectReference -> ObjectReference -> BatchAttachPolicy
- bapPolicyReference :: Lens' BatchAttachPolicy ObjectReference
- bapObjectReference :: Lens' BatchAttachPolicy ObjectReference
- data BatchAttachPolicyResponse
- batchAttachPolicyResponse :: BatchAttachPolicyResponse
- data BatchAttachToIndex
- batchAttachToIndex :: ObjectReference -> ObjectReference -> BatchAttachToIndex
- batiIndexReference :: Lens' BatchAttachToIndex ObjectReference
- batiTargetReference :: Lens' BatchAttachToIndex ObjectReference
- data BatchAttachToIndexResponse
- batchAttachToIndexResponse :: BatchAttachToIndexResponse
- batiAttachedObjectIdentifier :: Lens' BatchAttachToIndexResponse (Maybe Text)
- data BatchAttachTypedLink
- batchAttachTypedLink :: ObjectReference -> ObjectReference -> TypedLinkSchemaAndFacetName -> BatchAttachTypedLink
- batlSourceObjectReference :: Lens' BatchAttachTypedLink ObjectReference
- batlTargetObjectReference :: Lens' BatchAttachTypedLink ObjectReference
- batlTypedLinkFacet :: Lens' BatchAttachTypedLink TypedLinkSchemaAndFacetName
- batlAttributes :: Lens' BatchAttachTypedLink [AttributeNameAndValue]
- data BatchAttachTypedLinkResponse
- batchAttachTypedLinkResponse :: BatchAttachTypedLinkResponse
- batlTypedLinkSpecifier :: Lens' BatchAttachTypedLinkResponse (Maybe TypedLinkSpecifier)
- data BatchCreateIndex
- batchCreateIndex :: Bool -> BatchCreateIndex
- bciParentReference :: Lens' BatchCreateIndex (Maybe ObjectReference)
- bciLinkName :: Lens' BatchCreateIndex (Maybe Text)
- bciBatchReferenceName :: Lens' BatchCreateIndex (Maybe Text)
- bciOrderedIndexedAttributeList :: Lens' BatchCreateIndex [AttributeKey]
- bciIsUnique :: Lens' BatchCreateIndex Bool
- data BatchCreateIndexResponse
- batchCreateIndexResponse :: BatchCreateIndexResponse
- bciObjectIdentifier :: Lens' BatchCreateIndexResponse (Maybe Text)
- data BatchCreateObject
- batchCreateObject :: BatchCreateObject
- bcoParentReference :: Lens' BatchCreateObject (Maybe ObjectReference)
- bcoLinkName :: Lens' BatchCreateObject (Maybe Text)
- bcoBatchReferenceName :: Lens' BatchCreateObject (Maybe Text)
- bcoSchemaFacet :: Lens' BatchCreateObject [SchemaFacet]
- bcoObjectAttributeList :: Lens' BatchCreateObject [AttributeKeyAndValue]
- data BatchCreateObjectResponse
- batchCreateObjectResponse :: BatchCreateObjectResponse
- bcoObjectIdentifier :: Lens' BatchCreateObjectResponse (Maybe Text)
- data BatchDeleteObject
- batchDeleteObject :: ObjectReference -> BatchDeleteObject
- bdoObjectReference :: Lens' BatchDeleteObject ObjectReference
- data BatchDeleteObjectResponse
- batchDeleteObjectResponse :: BatchDeleteObjectResponse
- data BatchDetachFromIndex
- batchDetachFromIndex :: ObjectReference -> ObjectReference -> BatchDetachFromIndex
- bdfiIndexReference :: Lens' BatchDetachFromIndex ObjectReference
- bdfiTargetReference :: Lens' BatchDetachFromIndex ObjectReference
- data BatchDetachFromIndexResponse
- batchDetachFromIndexResponse :: BatchDetachFromIndexResponse
- bdfiDetachedObjectIdentifier :: Lens' BatchDetachFromIndexResponse (Maybe Text)
- data BatchDetachObject
- batchDetachObject :: ObjectReference -> Text -> BatchDetachObject
- bdoBatchReferenceName :: Lens' BatchDetachObject (Maybe Text)
- bdoParentReference :: Lens' BatchDetachObject ObjectReference
- bdoLinkName :: Lens' BatchDetachObject Text
- data BatchDetachObjectResponse
- batchDetachObjectResponse :: BatchDetachObjectResponse
- bdoDetachedObjectIdentifier :: Lens' BatchDetachObjectResponse (Maybe Text)
- data BatchDetachPolicy
- batchDetachPolicy :: ObjectReference -> ObjectReference -> BatchDetachPolicy
- bdpPolicyReference :: Lens' BatchDetachPolicy ObjectReference
- bdpObjectReference :: Lens' BatchDetachPolicy ObjectReference
- data BatchDetachPolicyResponse
- batchDetachPolicyResponse :: BatchDetachPolicyResponse
- data BatchDetachTypedLink
- batchDetachTypedLink :: TypedLinkSpecifier -> BatchDetachTypedLink
- bdtlTypedLinkSpecifier :: Lens' BatchDetachTypedLink TypedLinkSpecifier
- data BatchDetachTypedLinkResponse
- batchDetachTypedLinkResponse :: BatchDetachTypedLinkResponse
- data BatchGetObjectAttributes
- batchGetObjectAttributes :: ObjectReference -> SchemaFacet -> BatchGetObjectAttributes
- bgoaObjectReference :: Lens' BatchGetObjectAttributes ObjectReference
- bgoaSchemaFacet :: Lens' BatchGetObjectAttributes SchemaFacet
- bgoaAttributeNames :: Lens' BatchGetObjectAttributes [Text]
- data BatchGetObjectAttributesResponse
- batchGetObjectAttributesResponse :: BatchGetObjectAttributesResponse
- bgoaAttributes :: Lens' BatchGetObjectAttributesResponse [AttributeKeyAndValue]
- data BatchGetObjectInformation
- batchGetObjectInformation :: ObjectReference -> BatchGetObjectInformation
- bgoiObjectReference :: Lens' BatchGetObjectInformation ObjectReference
- data BatchGetObjectInformationResponse
- batchGetObjectInformationResponse :: BatchGetObjectInformationResponse
- bgoiObjectIdentifier :: Lens' BatchGetObjectInformationResponse (Maybe Text)
- bgoiSchemaFacets :: Lens' BatchGetObjectInformationResponse [SchemaFacet]
- data BatchListAttachedIndices
- batchListAttachedIndices :: ObjectReference -> BatchListAttachedIndices
- blaisNextToken :: Lens' BatchListAttachedIndices (Maybe Text)
- blaisMaxResults :: Lens' BatchListAttachedIndices (Maybe Natural)
- blaisTargetReference :: Lens' BatchListAttachedIndices ObjectReference
- data BatchListAttachedIndicesResponse
- batchListAttachedIndicesResponse :: BatchListAttachedIndicesResponse
- blaiIndexAttachments :: Lens' BatchListAttachedIndicesResponse [IndexAttachment]
- blaiNextToken :: Lens' BatchListAttachedIndicesResponse (Maybe Text)
- data BatchListIncomingTypedLinks
- batchListIncomingTypedLinks :: ObjectReference -> BatchListIncomingTypedLinks
- blitlsFilterAttributeRanges :: Lens' BatchListIncomingTypedLinks [TypedLinkAttributeRange]
- blitlsNextToken :: Lens' BatchListIncomingTypedLinks (Maybe Text)
- blitlsFilterTypedLink :: Lens' BatchListIncomingTypedLinks (Maybe TypedLinkSchemaAndFacetName)
- blitlsMaxResults :: Lens' BatchListIncomingTypedLinks (Maybe Natural)
- blitlsObjectReference :: Lens' BatchListIncomingTypedLinks ObjectReference
- data BatchListIncomingTypedLinksResponse
- batchListIncomingTypedLinksResponse :: BatchListIncomingTypedLinksResponse
- blitlLinkSpecifiers :: Lens' BatchListIncomingTypedLinksResponse [TypedLinkSpecifier]
- blitlNextToken :: Lens' BatchListIncomingTypedLinksResponse (Maybe Text)
- data BatchListIndex
- batchListIndex :: ObjectReference -> BatchListIndex
- batRangesOnIndexedValues :: Lens' BatchListIndex [ObjectAttributeRange]
- batNextToken :: Lens' BatchListIndex (Maybe Text)
- batMaxResults :: Lens' BatchListIndex (Maybe Natural)
- batIndexReference :: Lens' BatchListIndex ObjectReference
- data BatchListIndexResponse
- batchListIndexResponse :: BatchListIndexResponse
- bliIndexAttachments :: Lens' BatchListIndexResponse [IndexAttachment]
- bliNextToken :: Lens' BatchListIndexResponse (Maybe Text)
- data BatchListObjectAttributes
- batchListObjectAttributes :: ObjectReference -> BatchListObjectAttributes
- bloaFacetFilter :: Lens' BatchListObjectAttributes (Maybe SchemaFacet)
- bloaNextToken :: Lens' BatchListObjectAttributes (Maybe Text)
- bloaMaxResults :: Lens' BatchListObjectAttributes (Maybe Natural)
- bloaObjectReference :: Lens' BatchListObjectAttributes ObjectReference
- data BatchListObjectAttributesResponse
- batchListObjectAttributesResponse :: BatchListObjectAttributesResponse
- bNextToken :: Lens' BatchListObjectAttributesResponse (Maybe Text)
- bAttributes :: Lens' BatchListObjectAttributesResponse [AttributeKeyAndValue]
- data BatchListObjectChildren
- batchListObjectChildren :: ObjectReference -> BatchListObjectChildren
- bloclNextToken :: Lens' BatchListObjectChildren (Maybe Text)
- bloclMaxResults :: Lens' BatchListObjectChildren (Maybe Natural)
- bloclObjectReference :: Lens' BatchListObjectChildren ObjectReference
- data BatchListObjectChildrenResponse
- batchListObjectChildrenResponse :: BatchListObjectChildrenResponse
- blocChildren :: Lens' BatchListObjectChildrenResponse (HashMap Text Text)
- blocNextToken :: Lens' BatchListObjectChildrenResponse (Maybe Text)
- data BatchListObjectParentPaths
- batchListObjectParentPaths :: ObjectReference -> BatchListObjectParentPaths
- bloppsNextToken :: Lens' BatchListObjectParentPaths (Maybe Text)
- bloppsMaxResults :: Lens' BatchListObjectParentPaths (Maybe Natural)
- bloppsObjectReference :: Lens' BatchListObjectParentPaths ObjectReference
- data BatchListObjectParentPathsResponse
- batchListObjectParentPathsResponse :: BatchListObjectParentPathsResponse
- bloppPathToObjectIdentifiersList :: Lens' BatchListObjectParentPathsResponse [PathToObjectIdentifiers]
- bloppNextToken :: Lens' BatchListObjectParentPathsResponse (Maybe Text)
- data BatchListObjectPolicies
- batchListObjectPolicies :: ObjectReference -> BatchListObjectPolicies
- blopsNextToken :: Lens' BatchListObjectPolicies (Maybe Text)
- blopsMaxResults :: Lens' BatchListObjectPolicies (Maybe Natural)
- blopsObjectReference :: Lens' BatchListObjectPolicies ObjectReference
- data BatchListObjectPoliciesResponse
- batchListObjectPoliciesResponse :: BatchListObjectPoliciesResponse
- blopNextToken :: Lens' BatchListObjectPoliciesResponse (Maybe Text)
- blopAttachedPolicyIds :: Lens' BatchListObjectPoliciesResponse [Text]
- data BatchListOutgoingTypedLinks
- batchListOutgoingTypedLinks :: ObjectReference -> BatchListOutgoingTypedLinks
- blotlsFilterAttributeRanges :: Lens' BatchListOutgoingTypedLinks [TypedLinkAttributeRange]
- blotlsNextToken :: Lens' BatchListOutgoingTypedLinks (Maybe Text)
- blotlsFilterTypedLink :: Lens' BatchListOutgoingTypedLinks (Maybe TypedLinkSchemaAndFacetName)
- blotlsMaxResults :: Lens' BatchListOutgoingTypedLinks (Maybe Natural)
- blotlsObjectReference :: Lens' BatchListOutgoingTypedLinks ObjectReference
- data BatchListOutgoingTypedLinksResponse
- batchListOutgoingTypedLinksResponse :: BatchListOutgoingTypedLinksResponse
- blotlTypedLinkSpecifiers :: Lens' BatchListOutgoingTypedLinksResponse [TypedLinkSpecifier]
- blotlNextToken :: Lens' BatchListOutgoingTypedLinksResponse (Maybe Text)
- data BatchListPolicyAttachments
- batchListPolicyAttachments :: ObjectReference -> BatchListPolicyAttachments
- blpasNextToken :: Lens' BatchListPolicyAttachments (Maybe Text)
- blpasMaxResults :: Lens' BatchListPolicyAttachments (Maybe Natural)
- blpasPolicyReference :: Lens' BatchListPolicyAttachments ObjectReference
- data BatchListPolicyAttachmentsResponse
- batchListPolicyAttachmentsResponse :: BatchListPolicyAttachmentsResponse
- blpaObjectIdentifiers :: Lens' BatchListPolicyAttachmentsResponse [Text]
- blpaNextToken :: Lens' BatchListPolicyAttachmentsResponse (Maybe Text)
- data BatchLookupPolicy
- batchLookupPolicy :: ObjectReference -> BatchLookupPolicy
- blplNextToken :: Lens' BatchLookupPolicy (Maybe Text)
- blplMaxResults :: Lens' BatchLookupPolicy (Maybe Natural)
- blplObjectReference :: Lens' BatchLookupPolicy ObjectReference
- data BatchLookupPolicyResponse
- batchLookupPolicyResponse :: BatchLookupPolicyResponse
- blpNextToken :: Lens' BatchLookupPolicyResponse (Maybe Text)
- blpPolicyToPathList :: Lens' BatchLookupPolicyResponse [PolicyToPath]
- data BatchReadException
- batchReadException :: BatchReadException
- breType :: Lens' BatchReadException (Maybe BatchReadExceptionType)
- breMessage :: Lens' BatchReadException (Maybe Text)
- data BatchReadOperation
- batchReadOperation :: BatchReadOperation
- broListIndex :: Lens' BatchReadOperation (Maybe BatchListIndex)
- broGetObjectInformation :: Lens' BatchReadOperation (Maybe BatchGetObjectInformation)
- broListAttachedIndices :: Lens' BatchReadOperation (Maybe BatchListAttachedIndices)
- broLookupPolicy :: Lens' BatchReadOperation (Maybe BatchLookupPolicy)
- broListObjectParentPaths :: Lens' BatchReadOperation (Maybe BatchListObjectParentPaths)
- broListObjectAttributes :: Lens' BatchReadOperation (Maybe BatchListObjectAttributes)
- broListIncomingTypedLinks :: Lens' BatchReadOperation (Maybe BatchListIncomingTypedLinks)
- broGetObjectAttributes :: Lens' BatchReadOperation (Maybe BatchGetObjectAttributes)
- broListObjectChildren :: Lens' BatchReadOperation (Maybe BatchListObjectChildren)
- broListPolicyAttachments :: Lens' BatchReadOperation (Maybe BatchListPolicyAttachments)
- broListOutgoingTypedLinks :: Lens' BatchReadOperation (Maybe BatchListOutgoingTypedLinks)
- broListObjectPolicies :: Lens' BatchReadOperation (Maybe BatchListObjectPolicies)
- data BatchReadOperationResponse
- batchReadOperationResponse :: BatchReadOperationResponse
- broExceptionResponse :: Lens' BatchReadOperationResponse (Maybe BatchReadException)
- broSuccessfulResponse :: Lens' BatchReadOperationResponse (Maybe BatchReadSuccessfulResponse)
- data BatchReadSuccessfulResponse
- batchReadSuccessfulResponse :: BatchReadSuccessfulResponse
- brsListIndex :: Lens' BatchReadSuccessfulResponse (Maybe BatchListIndexResponse)
- brsGetObjectInformation :: Lens' BatchReadSuccessfulResponse (Maybe BatchGetObjectInformationResponse)
- brsListAttachedIndices :: Lens' BatchReadSuccessfulResponse (Maybe BatchListAttachedIndicesResponse)
- brsLookupPolicy :: Lens' BatchReadSuccessfulResponse (Maybe BatchLookupPolicyResponse)
- brsListObjectParentPaths :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectParentPathsResponse)
- brsListObjectAttributes :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectAttributesResponse)
- brsListIncomingTypedLinks :: Lens' BatchReadSuccessfulResponse (Maybe BatchListIncomingTypedLinksResponse)
- brsGetObjectAttributes :: Lens' BatchReadSuccessfulResponse (Maybe BatchGetObjectAttributesResponse)
- brsListObjectChildren :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectChildrenResponse)
- brsListPolicyAttachments :: Lens' BatchReadSuccessfulResponse (Maybe BatchListPolicyAttachmentsResponse)
- brsListOutgoingTypedLinks :: Lens' BatchReadSuccessfulResponse (Maybe BatchListOutgoingTypedLinksResponse)
- brsListObjectPolicies :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectPoliciesResponse)
- data BatchRemoveFacetFromObject
- batchRemoveFacetFromObject :: SchemaFacet -> ObjectReference -> BatchRemoveFacetFromObject
- brffoSchemaFacet :: Lens' BatchRemoveFacetFromObject SchemaFacet
- brffoObjectReference :: Lens' BatchRemoveFacetFromObject ObjectReference
- data BatchRemoveFacetFromObjectResponse
- batchRemoveFacetFromObjectResponse :: BatchRemoveFacetFromObjectResponse
- data BatchUpdateObjectAttributes
- batchUpdateObjectAttributes :: ObjectReference -> BatchUpdateObjectAttributes
- buoaObjectReference :: Lens' BatchUpdateObjectAttributes ObjectReference
- buoaAttributeUpdates :: Lens' BatchUpdateObjectAttributes [ObjectAttributeUpdate]
- data BatchUpdateObjectAttributesResponse
- batchUpdateObjectAttributesResponse :: BatchUpdateObjectAttributesResponse
- buoaObjectIdentifier :: Lens' BatchUpdateObjectAttributesResponse (Maybe Text)
- data BatchWriteOperation
- batchWriteOperation :: BatchWriteOperation
- bDeleteObject :: Lens' BatchWriteOperation (Maybe BatchDeleteObject)
- bDetachFromIndex :: Lens' BatchWriteOperation (Maybe BatchDetachFromIndex)
- bRemoveFacetFromObject :: Lens' BatchWriteOperation (Maybe BatchRemoveFacetFromObject)
- bAttachObject :: Lens' BatchWriteOperation (Maybe BatchAttachObject)
- bCreateObject :: Lens' BatchWriteOperation (Maybe BatchCreateObject)
- bAttachTypedLink :: Lens' BatchWriteOperation (Maybe BatchAttachTypedLink)
- bDetachPolicy :: Lens' BatchWriteOperation (Maybe BatchDetachPolicy)
- bCreateIndex :: Lens' BatchWriteOperation (Maybe BatchCreateIndex)
- bDetachObject :: Lens' BatchWriteOperation (Maybe BatchDetachObject)
- bAddFacetToObject :: Lens' BatchWriteOperation (Maybe BatchAddFacetToObject)
- bDetachTypedLink :: Lens' BatchWriteOperation (Maybe BatchDetachTypedLink)
- bUpdateObjectAttributes :: Lens' BatchWriteOperation (Maybe BatchUpdateObjectAttributes)
- bAttachPolicy :: Lens' BatchWriteOperation (Maybe BatchAttachPolicy)
- bAttachToIndex :: Lens' BatchWriteOperation (Maybe BatchAttachToIndex)
- data BatchWriteOperationResponse
- batchWriteOperationResponse :: BatchWriteOperationResponse
- bwoDeleteObject :: Lens' BatchWriteOperationResponse (Maybe BatchDeleteObjectResponse)
- bwoDetachFromIndex :: Lens' BatchWriteOperationResponse (Maybe BatchDetachFromIndexResponse)
- bwoRemoveFacetFromObject :: Lens' BatchWriteOperationResponse (Maybe BatchRemoveFacetFromObjectResponse)
- bwoAttachObject :: Lens' BatchWriteOperationResponse (Maybe BatchAttachObjectResponse)
- bwoCreateObject :: Lens' BatchWriteOperationResponse (Maybe BatchCreateObjectResponse)
- bwoAttachTypedLink :: Lens' BatchWriteOperationResponse (Maybe BatchAttachTypedLinkResponse)
- bwoDetachPolicy :: Lens' BatchWriteOperationResponse (Maybe BatchDetachPolicyResponse)
- bwoCreateIndex :: Lens' BatchWriteOperationResponse (Maybe BatchCreateIndexResponse)
- bwoDetachObject :: Lens' BatchWriteOperationResponse (Maybe BatchDetachObjectResponse)
- bwoAddFacetToObject :: Lens' BatchWriteOperationResponse (Maybe BatchAddFacetToObjectResponse)
- bwoDetachTypedLink :: Lens' BatchWriteOperationResponse (Maybe BatchDetachTypedLinkResponse)
- bwoUpdateObjectAttributes :: Lens' BatchWriteOperationResponse (Maybe BatchUpdateObjectAttributesResponse)
- bwoAttachPolicy :: Lens' BatchWriteOperationResponse (Maybe BatchAttachPolicyResponse)
- bwoAttachToIndex :: Lens' BatchWriteOperationResponse (Maybe BatchAttachToIndexResponse)
- data Directory
- directory :: Directory
- dDirectoryARN :: Lens' Directory (Maybe Text)
- dState :: Lens' Directory (Maybe DirectoryState)
- dName :: Lens' Directory (Maybe Text)
- dCreationDateTime :: Lens' Directory (Maybe UTCTime)
- data Facet
- facet :: Facet
- fObjectType :: Lens' Facet (Maybe ObjectType)
- fName :: Lens' Facet (Maybe Text)
- data FacetAttribute
- facetAttribute :: Text -> FacetAttribute
- faAttributeReference :: Lens' FacetAttribute (Maybe FacetAttributeReference)
- faAttributeDefinition :: Lens' FacetAttribute (Maybe FacetAttributeDefinition)
- faRequiredBehavior :: Lens' FacetAttribute (Maybe RequiredAttributeBehavior)
- faName :: Lens' FacetAttribute Text
- data FacetAttributeDefinition
- facetAttributeDefinition :: FacetAttributeType -> FacetAttributeDefinition
- fadRules :: Lens' FacetAttributeDefinition (HashMap Text Rule)
- fadDefaultValue :: Lens' FacetAttributeDefinition (Maybe TypedAttributeValue)
- fadIsImmutable :: Lens' FacetAttributeDefinition (Maybe Bool)
- fadType :: Lens' FacetAttributeDefinition FacetAttributeType
- data FacetAttributeReference
- facetAttributeReference :: Text -> Text -> FacetAttributeReference
- farTargetFacetName :: Lens' FacetAttributeReference Text
- farTargetAttributeName :: Lens' FacetAttributeReference Text
- data FacetAttributeUpdate
- facetAttributeUpdate :: FacetAttributeUpdate
- fauAttribute :: Lens' FacetAttributeUpdate (Maybe FacetAttribute)
- fauAction :: Lens' FacetAttributeUpdate (Maybe UpdateActionType)
- data IndexAttachment
- indexAttachment :: IndexAttachment
- iaIndexedAttributes :: Lens' IndexAttachment [AttributeKeyAndValue]
- iaObjectIdentifier :: Lens' IndexAttachment (Maybe Text)
- data ObjectAttributeAction
- objectAttributeAction :: ObjectAttributeAction
- oaaObjectAttributeActionType :: Lens' ObjectAttributeAction (Maybe UpdateActionType)
- oaaObjectAttributeUpdateValue :: Lens' ObjectAttributeAction (Maybe TypedAttributeValue)
- data ObjectAttributeRange
- objectAttributeRange :: ObjectAttributeRange
- oarRange :: Lens' ObjectAttributeRange (Maybe TypedAttributeValueRange)
- oarAttributeKey :: Lens' ObjectAttributeRange (Maybe AttributeKey)
- data ObjectAttributeUpdate
- objectAttributeUpdate :: ObjectAttributeUpdate
- oauObjectAttributeAction :: Lens' ObjectAttributeUpdate (Maybe ObjectAttributeAction)
- oauObjectAttributeKey :: Lens' ObjectAttributeUpdate (Maybe AttributeKey)
- data ObjectReference
- objectReference :: ObjectReference
- orSelector :: Lens' ObjectReference (Maybe Text)
- data PathToObjectIdentifiers
- pathToObjectIdentifiers :: PathToObjectIdentifiers
- ptoiObjectIdentifiers :: Lens' PathToObjectIdentifiers [Text]
- ptoiPath :: Lens' PathToObjectIdentifiers (Maybe Text)
- data PolicyAttachment
- policyAttachment :: PolicyAttachment
- paPolicyId :: Lens' PolicyAttachment (Maybe Text)
- paPolicyType :: Lens' PolicyAttachment (Maybe Text)
- paObjectIdentifier :: Lens' PolicyAttachment (Maybe Text)
- data PolicyToPath
- policyToPath :: PolicyToPath
- ptpPath :: Lens' PolicyToPath (Maybe Text)
- ptpPolicies :: Lens' PolicyToPath [PolicyAttachment]
- data Rule
- rule :: Rule
- rParameters :: Lens' Rule (HashMap Text Text)
- rType :: Lens' Rule (Maybe RuleType)
- data SchemaFacet
- schemaFacet :: SchemaFacet
- sfFacetName :: Lens' SchemaFacet (Maybe Text)
- sfSchemaARN :: Lens' SchemaFacet (Maybe Text)
- data Tag
- tag :: Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag (Maybe Text)
- data TypedAttributeValue
- typedAttributeValue :: TypedAttributeValue
- tavBinaryValue :: Lens' TypedAttributeValue (Maybe ByteString)
- tavDatetimeValue :: Lens' TypedAttributeValue (Maybe UTCTime)
- tavNumberValue :: Lens' TypedAttributeValue (Maybe Text)
- tavStringValue :: Lens' TypedAttributeValue (Maybe Text)
- tavBooleanValue :: Lens' TypedAttributeValue (Maybe Bool)
- data TypedAttributeValueRange
- typedAttributeValueRange :: RangeMode -> RangeMode -> TypedAttributeValueRange
- tavrEndValue :: Lens' TypedAttributeValueRange (Maybe TypedAttributeValue)
- tavrStartValue :: Lens' TypedAttributeValueRange (Maybe TypedAttributeValue)
- tavrStartMode :: Lens' TypedAttributeValueRange RangeMode
- tavrEndMode :: Lens' TypedAttributeValueRange RangeMode
- data TypedLinkAttributeDefinition
- typedLinkAttributeDefinition :: Text -> FacetAttributeType -> RequiredAttributeBehavior -> TypedLinkAttributeDefinition
- tladRules :: Lens' TypedLinkAttributeDefinition (HashMap Text Rule)
- tladDefaultValue :: Lens' TypedLinkAttributeDefinition (Maybe TypedAttributeValue)
- tladIsImmutable :: Lens' TypedLinkAttributeDefinition (Maybe Bool)
- tladName :: Lens' TypedLinkAttributeDefinition Text
- tladType :: Lens' TypedLinkAttributeDefinition FacetAttributeType
- tladRequiredBehavior :: Lens' TypedLinkAttributeDefinition RequiredAttributeBehavior
- data TypedLinkAttributeRange
- typedLinkAttributeRange :: TypedAttributeValueRange -> TypedLinkAttributeRange
- tlarAttributeName :: Lens' TypedLinkAttributeRange (Maybe Text)
- tlarRange :: Lens' TypedLinkAttributeRange TypedAttributeValueRange
- data TypedLinkFacet
- typedLinkFacet :: Text -> TypedLinkFacet
- tlfName :: Lens' TypedLinkFacet Text
- tlfAttributes :: Lens' TypedLinkFacet [TypedLinkAttributeDefinition]
- tlfIdentityAttributeOrder :: Lens' TypedLinkFacet [Text]
- data TypedLinkFacetAttributeUpdate
- typedLinkFacetAttributeUpdate :: TypedLinkAttributeDefinition -> UpdateActionType -> TypedLinkFacetAttributeUpdate
- tlfauAttribute :: Lens' TypedLinkFacetAttributeUpdate TypedLinkAttributeDefinition
- tlfauAction :: Lens' TypedLinkFacetAttributeUpdate UpdateActionType
- data TypedLinkSchemaAndFacetName
- typedLinkSchemaAndFacetName :: Text -> Text -> TypedLinkSchemaAndFacetName
- tlsafnSchemaARN :: Lens' TypedLinkSchemaAndFacetName Text
- tlsafnTypedLinkName :: Lens' TypedLinkSchemaAndFacetName Text
- data TypedLinkSpecifier
- typedLinkSpecifier :: TypedLinkSchemaAndFacetName -> ObjectReference -> ObjectReference -> TypedLinkSpecifier
- tlsTypedLinkFacet :: Lens' TypedLinkSpecifier TypedLinkSchemaAndFacetName
- tlsSourceObjectReference :: Lens' TypedLinkSpecifier ObjectReference
- tlsTargetObjectReference :: Lens' TypedLinkSpecifier ObjectReference
- tlsIdentityAttributeValues :: Lens' TypedLinkSpecifier [AttributeNameAndValue]
Service Configuration
cloudDirectory :: Service Source #
API version 2016-05-10 of the Amazon CloudDirectory SDK configuration.
Errors
_UnsupportedIndexTypeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the requested index type is not supported.
_NotIndexException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the requested operation can only operate on index objects.
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that your request is malformed in some manner. See the exception message.
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Access denied. Check your permissions.
_FacetAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A facet with the same name already exists.
_InvalidSchemaDocException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the provided SchemaDoc value is not valid.
_InvalidAttachmentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that an attempt to attach an object with the same link name or to apply a schema with the same name has occurred. Rename the link or the schema and then try again.
_CannotListParentOfRootException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Cannot list the parents of a Directory root.
_NotPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the requested operation can only operate on policy objects.
_InvalidTaggingRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
_InvalidFacetUpdateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An attempt to modify a Facet resulted in an invalid schema exception.
_InvalidRuleException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Occurs when any of the rule parameter keys or values are invalid.
_SchemaAlreadyPublishedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that a schema is already published.
_DirectoryAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.
_DirectoryNotDisabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An operation can only operate on a disabled directory.
_BatchWriteException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A BatchWrite exception has occurred.
_DirectoryNotEnabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Operations are only permitted on enabled directories.
_FacetInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.
_FacetValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Facet that you provided was not well formed or could not be validated with the schema.
_StillContainsLinksException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The object could not be deleted because links still exist. Remove the links and then try the operation again.
_IncompatibleSchemaException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.
_NotNodeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the NextToken value is not valid.
_ObjectAlreadyDetachedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the object is not attached to the index.
_LinkNameAlreadyInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
_InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
_SchemaAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.
_IndexedAttributeMissingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An object has been attempted to be attached to an object that does not have the appropriate attribute value.
_DirectoryDeletedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.
_RetryableConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
_InvalidARNException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the provided ARN value is not valid.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource could not be found.
_FacetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified Facet could not be found.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that limits are exceeded. See Limits for more information.
_ObjectNotDetachedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the requested operation cannot be completed because the object has not been detached from the tree.
BatchReadExceptionType
data BatchReadExceptionType Source #
Constructors
Instances
ConsistencyLevel
data ConsistencyLevel Source #
Constructors
| Eventual | |
| Serializable |
Instances
DirectoryState
data DirectoryState Source #
Instances
FacetAttributeType
data FacetAttributeType Source #
Instances
ObjectType
data ObjectType Source #
Instances
RangeMode
Constructors
| Exclusive | |
| First | |
| Inclusive | |
| Last | |
| LastBeforeMissingValues |
Instances
RequiredAttributeBehavior
data RequiredAttributeBehavior Source #
Constructors
| NotRequired | |
| RequiredAlways |
Instances
RuleType
Constructors
| BinaryLength | |
| NumberComparison | |
| StringFromSet | |
| StringLength |
Instances
UpdateActionType
data UpdateActionType Source #
Constructors
| CreateOrUpdate | |
| Delete |
Instances
AttributeKey
data AttributeKey Source #
A unique identifier for an attribute.
See: attributeKey smart constructor.
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AttributeKey |
Creates a value of AttributeKey with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
akSchemaARN- The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.akFacetName- The name of the facet that the attribute exists within.akName- The name of the attribute.
akSchemaARN :: Lens' AttributeKey Text Source #
The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.
akFacetName :: Lens' AttributeKey Text Source #
The name of the facet that the attribute exists within.
AttributeKeyAndValue
data AttributeKeyAndValue Source #
The combination of an attribute key and an attribute value.
See: attributeKeyAndValue smart constructor.
Instances
Arguments
| :: AttributeKey | |
| -> TypedAttributeValue | |
| -> AttributeKeyAndValue |
Creates a value of AttributeKeyAndValue with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
akavKey :: Lens' AttributeKeyAndValue AttributeKey Source #
The key of the attribute.
akavValue :: Lens' AttributeKeyAndValue TypedAttributeValue Source #
The value of the attribute.
AttributeNameAndValue
data AttributeNameAndValue Source #
Identifies the attribute name and value for a typed link.
See: attributeNameAndValue smart constructor.
Instances
attributeNameAndValue Source #
Arguments
| :: Text | |
| -> TypedAttributeValue | |
| -> AttributeNameAndValue |
Creates a value of AttributeNameAndValue with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
anavAttributeName- The attribute name of the typed link.anavValue- The value for the typed link.
anavAttributeName :: Lens' AttributeNameAndValue Text Source #
The attribute name of the typed link.
anavValue :: Lens' AttributeNameAndValue TypedAttributeValue Source #
The value for the typed link.
BatchAddFacetToObject
data BatchAddFacetToObject Source #
Represents the output of a batch add facet to object operation.
See: batchAddFacetToObject smart constructor.
Instances
batchAddFacetToObject Source #
Arguments
| :: SchemaFacet | |
| -> ObjectReference | |
| -> BatchAddFacetToObject |
Creates a value of BatchAddFacetToObject with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
baftoSchemaFacet- Represents the facet being added to the object.baftoObjectAttributeList- The attributes to set on the object.baftoObjectReference- A reference to the object being mutated.
baftoSchemaFacet :: Lens' BatchAddFacetToObject SchemaFacet Source #
Represents the facet being added to the object.
baftoObjectAttributeList :: Lens' BatchAddFacetToObject [AttributeKeyAndValue] Source #
The attributes to set on the object.
baftoObjectReference :: Lens' BatchAddFacetToObject ObjectReference Source #
A reference to the object being mutated.
BatchAddFacetToObjectResponse
data BatchAddFacetToObjectResponse Source #
The result of a batch add facet to object operation.
See: batchAddFacetToObjectResponse smart constructor.
Instances
batchAddFacetToObjectResponse :: BatchAddFacetToObjectResponse Source #
Creates a value of BatchAddFacetToObjectResponse with the minimum fields required to make a request.
BatchAttachObject
data BatchAttachObject Source #
Represents the output of an AttachObject operation.
See: batchAttachObject smart constructor.
Instances
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> Text | |
| -> BatchAttachObject |
Creates a value of BatchAttachObject with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
baoParentReference- The parent object reference.baoChildReference- The child object reference that is to be attached to the object.baoLinkName- The name of the link.
baoParentReference :: Lens' BatchAttachObject ObjectReference Source #
The parent object reference.
baoChildReference :: Lens' BatchAttachObject ObjectReference Source #
The child object reference that is to be attached to the object.
baoLinkName :: Lens' BatchAttachObject Text Source #
The name of the link.
BatchAttachObjectResponse
data BatchAttachObjectResponse Source #
Represents the output batch AttachObject response operation.
See: batchAttachObjectResponse smart constructor.
Instances
batchAttachObjectResponse :: BatchAttachObjectResponse Source #
Creates a value of BatchAttachObjectResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
baoAttachedObjectIdentifier- TheObjectIdentifierof the object that has been attached.
baoAttachedObjectIdentifier :: Lens' BatchAttachObjectResponse (Maybe Text) Source #
The ObjectIdentifier of the object that has been attached.
BatchAttachPolicy
data BatchAttachPolicy Source #
Attaches a policy object to a regular object inside a BatchRead operation. For more information, see AttachPolicy and 'BatchReadRequest$Operations' .
See: batchAttachPolicy smart constructor.
Instances
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> BatchAttachPolicy |
Creates a value of BatchAttachPolicy with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bapPolicyReference- The reference that is associated with the policy object.bapObjectReference- The reference that identifies the object to which the policy will be attached.
bapPolicyReference :: Lens' BatchAttachPolicy ObjectReference Source #
The reference that is associated with the policy object.
bapObjectReference :: Lens' BatchAttachPolicy ObjectReference Source #
The reference that identifies the object to which the policy will be attached.
BatchAttachPolicyResponse
data BatchAttachPolicyResponse Source #
Represents the output of an AttachPolicy response operation.
See: batchAttachPolicyResponse smart constructor.
Instances
batchAttachPolicyResponse :: BatchAttachPolicyResponse Source #
Creates a value of BatchAttachPolicyResponse with the minimum fields required to make a request.
BatchAttachToIndex
data BatchAttachToIndex Source #
Attaches the specified object to the specified index inside a BatchRead operation. For more information, see AttachToIndex and 'BatchReadRequest$Operations' .
See: batchAttachToIndex smart constructor.
Instances
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> BatchAttachToIndex |
Creates a value of BatchAttachToIndex with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
batiIndexReference- A reference to the index that you are attaching the object to.batiTargetReference- A reference to the object that you are attaching to the index.
batiIndexReference :: Lens' BatchAttachToIndex ObjectReference Source #
A reference to the index that you are attaching the object to.
batiTargetReference :: Lens' BatchAttachToIndex ObjectReference Source #
A reference to the object that you are attaching to the index.
BatchAttachToIndexResponse
data BatchAttachToIndexResponse Source #
Represents the output of a AttachToIndex response operation.
See: batchAttachToIndexResponse smart constructor.
Instances
batchAttachToIndexResponse :: BatchAttachToIndexResponse Source #
Creates a value of BatchAttachToIndexResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
batiAttachedObjectIdentifier- TheObjectIdentifierof the object that was attached to the index.
batiAttachedObjectIdentifier :: Lens' BatchAttachToIndexResponse (Maybe Text) Source #
The ObjectIdentifier of the object that was attached to the index.
BatchAttachTypedLink
data BatchAttachTypedLink Source #
Attaches a typed link to a specified source and target object inside a BatchRead operation. For more information, see AttachTypedLink and 'BatchReadRequest$Operations' .
See: batchAttachTypedLink smart constructor.
Instances
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> TypedLinkSchemaAndFacetName | |
| -> BatchAttachTypedLink |
Creates a value of BatchAttachTypedLink with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
batlSourceObjectReference- Identifies the source object that the typed link will attach to.batlTargetObjectReference- Identifies the target object that the typed link will attach to.batlTypedLinkFacet- Identifies the typed link facet that is associated with the typed link.batlAttributes- A set of attributes that are associated with the typed link.
batlSourceObjectReference :: Lens' BatchAttachTypedLink ObjectReference Source #
Identifies the source object that the typed link will attach to.
batlTargetObjectReference :: Lens' BatchAttachTypedLink ObjectReference Source #
Identifies the target object that the typed link will attach to.
batlTypedLinkFacet :: Lens' BatchAttachTypedLink TypedLinkSchemaAndFacetName Source #
Identifies the typed link facet that is associated with the typed link.
batlAttributes :: Lens' BatchAttachTypedLink [AttributeNameAndValue] Source #
A set of attributes that are associated with the typed link.
BatchAttachTypedLinkResponse
data BatchAttachTypedLinkResponse Source #
Represents the output of a AttachTypedLink response operation.
See: batchAttachTypedLinkResponse smart constructor.
Instances
batchAttachTypedLinkResponse :: BatchAttachTypedLinkResponse Source #
Creates a value of BatchAttachTypedLinkResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
batlTypedLinkSpecifier- Returns a typed link specifier as output.
batlTypedLinkSpecifier :: Lens' BatchAttachTypedLinkResponse (Maybe TypedLinkSpecifier) Source #
Returns a typed link specifier as output.
BatchCreateIndex
data BatchCreateIndex Source #
Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and 'BatchReadRequest$Operations' .
See: batchCreateIndex smart constructor.
Instances
Arguments
| :: Bool | |
| -> BatchCreateIndex |
Creates a value of BatchCreateIndex with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bciParentReference- A reference to the parent object that contains the index object.bciLinkName- The name of the link between the parent object and the index object.bciBatchReferenceName- The batch reference name. See Batches for more information.bciOrderedIndexedAttributeList- Specifies the attributes that should be indexed on. Currently only a single attribute is supported.bciIsUnique- Indicates whether the attribute that is being indexed has unique values or not.
bciParentReference :: Lens' BatchCreateIndex (Maybe ObjectReference) Source #
A reference to the parent object that contains the index object.
bciLinkName :: Lens' BatchCreateIndex (Maybe Text) Source #
The name of the link between the parent object and the index object.
bciBatchReferenceName :: Lens' BatchCreateIndex (Maybe Text) Source #
The batch reference name. See Batches for more information.
bciOrderedIndexedAttributeList :: Lens' BatchCreateIndex [AttributeKey] Source #
Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
bciIsUnique :: Lens' BatchCreateIndex Bool Source #
Indicates whether the attribute that is being indexed has unique values or not.
BatchCreateIndexResponse
data BatchCreateIndexResponse Source #
Represents the output of a CreateIndex response operation.
See: batchCreateIndexResponse smart constructor.
Instances
batchCreateIndexResponse :: BatchCreateIndexResponse Source #
Creates a value of BatchCreateIndexResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bciObjectIdentifier- TheObjectIdentifierof the index created by this operation.
bciObjectIdentifier :: Lens' BatchCreateIndexResponse (Maybe Text) Source #
The ObjectIdentifier of the index created by this operation.
BatchCreateObject
data BatchCreateObject Source #
Represents the output of a CreateObject operation.
See: batchCreateObject smart constructor.
Instances
batchCreateObject :: BatchCreateObject Source #
Creates a value of BatchCreateObject with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bcoParentReference- If specified, the parent reference to which this object will be attached.bcoLinkName- The name of the link.bcoBatchReferenceName- The batch reference name. See Batches for more information.bcoSchemaFacet- A list ofFacetArnsthat will be associated with the object. For more information, seearns.bcoObjectAttributeList- An attribute map, which contains an attribute ARN as the key and attribute value as the map value.
bcoParentReference :: Lens' BatchCreateObject (Maybe ObjectReference) Source #
If specified, the parent reference to which this object will be attached.
bcoLinkName :: Lens' BatchCreateObject (Maybe Text) Source #
The name of the link.
bcoBatchReferenceName :: Lens' BatchCreateObject (Maybe Text) Source #
The batch reference name. See Batches for more information.
bcoSchemaFacet :: Lens' BatchCreateObject [SchemaFacet] Source #
A list of FacetArns that will be associated with the object. For more information, see arns .
bcoObjectAttributeList :: Lens' BatchCreateObject [AttributeKeyAndValue] Source #
An attribute map, which contains an attribute ARN as the key and attribute value as the map value.
BatchCreateObjectResponse
data BatchCreateObjectResponse Source #
Represents the output of a CreateObject response operation.
See: batchCreateObjectResponse smart constructor.
Instances
batchCreateObjectResponse :: BatchCreateObjectResponse Source #
Creates a value of BatchCreateObjectResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bcoObjectIdentifier- The ID that is associated with the object.
bcoObjectIdentifier :: Lens' BatchCreateObjectResponse (Maybe Text) Source #
The ID that is associated with the object.
BatchDeleteObject
data BatchDeleteObject Source #
Represents the output of a DeleteObject operation.
See: batchDeleteObject smart constructor.
Instances
Arguments
| :: ObjectReference | |
| -> BatchDeleteObject |
Creates a value of BatchDeleteObject with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdoObjectReference- The reference that identifies the object.
bdoObjectReference :: Lens' BatchDeleteObject ObjectReference Source #
The reference that identifies the object.
BatchDeleteObjectResponse
data BatchDeleteObjectResponse Source #
Represents the output of a DeleteObject response operation.
See: batchDeleteObjectResponse smart constructor.
Instances
batchDeleteObjectResponse :: BatchDeleteObjectResponse Source #
Creates a value of BatchDeleteObjectResponse with the minimum fields required to make a request.
BatchDetachFromIndex
data BatchDetachFromIndex Source #
Detaches the specified object from the specified index inside a BatchRead operation. For more information, see DetachFromIndex and 'BatchReadRequest$Operations' .
See: batchDetachFromIndex smart constructor.
Instances
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> BatchDetachFromIndex |
Creates a value of BatchDetachFromIndex with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdfiIndexReference- A reference to the index object.bdfiTargetReference- A reference to the object being detached from the index.
bdfiIndexReference :: Lens' BatchDetachFromIndex ObjectReference Source #
A reference to the index object.
bdfiTargetReference :: Lens' BatchDetachFromIndex ObjectReference Source #
A reference to the object being detached from the index.
BatchDetachFromIndexResponse
data BatchDetachFromIndexResponse Source #
Represents the output of a DetachFromIndex response operation.
See: batchDetachFromIndexResponse smart constructor.
Instances
batchDetachFromIndexResponse :: BatchDetachFromIndexResponse Source #
Creates a value of BatchDetachFromIndexResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdfiDetachedObjectIdentifier- TheObjectIdentifierof the object that was detached from the index.
bdfiDetachedObjectIdentifier :: Lens' BatchDetachFromIndexResponse (Maybe Text) Source #
The ObjectIdentifier of the object that was detached from the index.
BatchDetachObject
data BatchDetachObject Source #
Represents the output of a DetachObject operation.
See: batchDetachObject smart constructor.
Instances
Arguments
| :: ObjectReference | |
| -> Text | |
| -> BatchDetachObject |
Creates a value of BatchDetachObject with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdoBatchReferenceName- The batch reference name. See Batches for more information.bdoParentReference- Parent reference from which the object with the specified link name is detached.bdoLinkName- The name of the link.
bdoBatchReferenceName :: Lens' BatchDetachObject (Maybe Text) Source #
The batch reference name. See Batches for more information.
bdoParentReference :: Lens' BatchDetachObject ObjectReference Source #
Parent reference from which the object with the specified link name is detached.
bdoLinkName :: Lens' BatchDetachObject Text Source #
The name of the link.
BatchDetachObjectResponse
data BatchDetachObjectResponse Source #
Represents the output of a DetachObject response operation.
See: batchDetachObjectResponse smart constructor.
Instances
batchDetachObjectResponse :: BatchDetachObjectResponse Source #
Creates a value of BatchDetachObjectResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdoDetachedObjectIdentifier- TheObjectIdentifierof the detached object.
bdoDetachedObjectIdentifier :: Lens' BatchDetachObjectResponse (Maybe Text) Source #
The ObjectIdentifier of the detached object.
BatchDetachPolicy
data BatchDetachPolicy Source #
Detaches the specified policy from the specified directory inside a BatchWrite operation. For more information, see DetachPolicy and 'BatchWriteRequest$Operations' .
See: batchDetachPolicy smart constructor.
Instances
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> BatchDetachPolicy |
Creates a value of BatchDetachPolicy with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdpPolicyReference- Reference that identifies the policy object.bdpObjectReference- Reference that identifies the object whose policy object will be detached.
bdpPolicyReference :: Lens' BatchDetachPolicy ObjectReference Source #
Reference that identifies the policy object.
bdpObjectReference :: Lens' BatchDetachPolicy ObjectReference Source #
Reference that identifies the object whose policy object will be detached.
BatchDetachPolicyResponse
data BatchDetachPolicyResponse Source #
Represents the output of a DetachPolicy response operation.
See: batchDetachPolicyResponse smart constructor.
Instances
batchDetachPolicyResponse :: BatchDetachPolicyResponse Source #
Creates a value of BatchDetachPolicyResponse with the minimum fields required to make a request.
BatchDetachTypedLink
data BatchDetachTypedLink Source #
Detaches a typed link from a specified source and target object inside a BatchRead operation. For more information, see DetachTypedLink and 'BatchReadRequest$Operations' .
See: batchDetachTypedLink smart constructor.
Instances
Arguments
| :: TypedLinkSpecifier | |
| -> BatchDetachTypedLink |
Creates a value of BatchDetachTypedLink with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdtlTypedLinkSpecifier- Used to accept a typed link specifier as input.
bdtlTypedLinkSpecifier :: Lens' BatchDetachTypedLink TypedLinkSpecifier Source #
Used to accept a typed link specifier as input.
BatchDetachTypedLinkResponse
data BatchDetachTypedLinkResponse Source #
Represents the output of a DetachTypedLink response operation.
See: batchDetachTypedLinkResponse smart constructor.
Instances
batchDetachTypedLinkResponse :: BatchDetachTypedLinkResponse Source #
Creates a value of BatchDetachTypedLinkResponse with the minimum fields required to make a request.
BatchGetObjectAttributes
data BatchGetObjectAttributes Source #
Retrieves attributes within a facet that are associated with an object inside an BatchRead operation. For more information, see GetObjectAttributes and 'BatchReadRequest$Operations' .
See: batchGetObjectAttributes smart constructor.
Instances
batchGetObjectAttributes Source #
Arguments
| :: ObjectReference | |
| -> SchemaFacet | |
| -> BatchGetObjectAttributes |
Creates a value of BatchGetObjectAttributes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bgoaObjectReference- Reference that identifies the object whose attributes will be retrieved.bgoaSchemaFacet- Identifier for the facet whose attributes will be retrieved. SeeSchemaFacetfor details.bgoaAttributeNames- List of attribute names whose values will be retrieved.
bgoaObjectReference :: Lens' BatchGetObjectAttributes ObjectReference Source #
Reference that identifies the object whose attributes will be retrieved.
bgoaSchemaFacet :: Lens' BatchGetObjectAttributes SchemaFacet Source #
Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.
bgoaAttributeNames :: Lens' BatchGetObjectAttributes [Text] Source #
List of attribute names whose values will be retrieved.
BatchGetObjectAttributesResponse
data BatchGetObjectAttributesResponse Source #
Represents the output of a GetObjectAttributes response operation.
See: batchGetObjectAttributesResponse smart constructor.
Instances
batchGetObjectAttributesResponse :: BatchGetObjectAttributesResponse Source #
Creates a value of BatchGetObjectAttributesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bgoaAttributes- The attribute values that are associated with an object.
bgoaAttributes :: Lens' BatchGetObjectAttributesResponse [AttributeKeyAndValue] Source #
The attribute values that are associated with an object.
BatchGetObjectInformation
data BatchGetObjectInformation Source #
Retrieves metadata about an object inside a BatchRead operation. For more information, see GetObjectInformation and 'BatchReadRequest$Operations' .
See: batchGetObjectInformation smart constructor.
Instances
batchGetObjectInformation Source #
Arguments
| :: ObjectReference | |
| -> BatchGetObjectInformation |
Creates a value of BatchGetObjectInformation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bgoiObjectReference- A reference to the object.
bgoiObjectReference :: Lens' BatchGetObjectInformation ObjectReference Source #
A reference to the object.
BatchGetObjectInformationResponse
data BatchGetObjectInformationResponse Source #
Represents the output of a GetObjectInformation response operation.
See: batchGetObjectInformationResponse smart constructor.
Instances
batchGetObjectInformationResponse :: BatchGetObjectInformationResponse Source #
Creates a value of BatchGetObjectInformationResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bgoiObjectIdentifier- TheObjectIdentifierof the specified object.bgoiSchemaFacets- The facets attached to the specified object.
bgoiObjectIdentifier :: Lens' BatchGetObjectInformationResponse (Maybe Text) Source #
The ObjectIdentifier of the specified object.
bgoiSchemaFacets :: Lens' BatchGetObjectInformationResponse [SchemaFacet] Source #
The facets attached to the specified object.
BatchListAttachedIndices
data BatchListAttachedIndices Source #
Lists indices attached to an object inside a BatchRead operation. For more information, see ListAttachedIndices and 'BatchReadRequest$Operations' .
See: batchListAttachedIndices smart constructor.
Instances
batchListAttachedIndices Source #
Arguments
| :: ObjectReference | |
| -> BatchListAttachedIndices |
Creates a value of BatchListAttachedIndices with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blaisNextToken- The pagination token.blaisMaxResults- The maximum number of results to retrieve.blaisTargetReference- A reference to the object that has indices attached.
blaisNextToken :: Lens' BatchListAttachedIndices (Maybe Text) Source #
The pagination token.
blaisMaxResults :: Lens' BatchListAttachedIndices (Maybe Natural) Source #
The maximum number of results to retrieve.
blaisTargetReference :: Lens' BatchListAttachedIndices ObjectReference Source #
A reference to the object that has indices attached.
BatchListAttachedIndicesResponse
data BatchListAttachedIndicesResponse Source #
Represents the output of a ListAttachedIndices response operation.
See: batchListAttachedIndicesResponse smart constructor.
Instances
batchListAttachedIndicesResponse :: BatchListAttachedIndicesResponse Source #
Creates a value of BatchListAttachedIndicesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blaiIndexAttachments- The indices attached to the specified object.blaiNextToken- The pagination token.
blaiIndexAttachments :: Lens' BatchListAttachedIndicesResponse [IndexAttachment] Source #
The indices attached to the specified object.
blaiNextToken :: Lens' BatchListAttachedIndicesResponse (Maybe Text) Source #
The pagination token.
BatchListIncomingTypedLinks
data BatchListIncomingTypedLinks Source #
Returns a paginated list of all the incoming TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListIncomingTypedLinks and 'BatchReadRequest$Operations' .
See: batchListIncomingTypedLinks smart constructor.
Instances
batchListIncomingTypedLinks Source #
Creates a value of BatchListIncomingTypedLinks with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blitlsFilterAttributeRanges- 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.blitlsNextToken- The pagination token.blitlsFilterTypedLink- 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.blitlsMaxResults- The maximum number of results to retrieve.blitlsObjectReference- The reference that identifies the object whose attributes will be listed.
blitlsFilterAttributeRanges :: Lens' BatchListIncomingTypedLinks [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.
blitlsNextToken :: Lens' BatchListIncomingTypedLinks (Maybe Text) Source #
The pagination token.
blitlsFilterTypedLink :: 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.
blitlsMaxResults :: Lens' BatchListIncomingTypedLinks (Maybe Natural) Source #
The maximum number of results to retrieve.
blitlsObjectReference :: Lens' BatchListIncomingTypedLinks ObjectReference Source #
The reference that identifies the object whose attributes will be listed.
BatchListIncomingTypedLinksResponse
data BatchListIncomingTypedLinksResponse Source #
Represents the output of a ListIncomingTypedLinks response operation.
See: batchListIncomingTypedLinksResponse smart constructor.
Instances
batchListIncomingTypedLinksResponse :: BatchListIncomingTypedLinksResponse Source #
Creates a value of BatchListIncomingTypedLinksResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blitlLinkSpecifiers- Returns one or more typed link specifiers as output.blitlNextToken- The pagination token.
blitlLinkSpecifiers :: Lens' BatchListIncomingTypedLinksResponse [TypedLinkSpecifier] Source #
Returns one or more typed link specifiers as output.
blitlNextToken :: Lens' BatchListIncomingTypedLinksResponse (Maybe Text) Source #
The pagination token.
BatchListIndex
data BatchListIndex Source #
Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and 'BatchReadRequest$Operations' .
See: batchListIndex smart constructor.
Arguments
| :: ObjectReference | |
| -> BatchListIndex |
Creates a value of BatchListIndex with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
batRangesOnIndexedValues- Specifies the ranges of indexed values that you want to query.batNextToken- The pagination token.batMaxResults- The maximum number of results to retrieve.batIndexReference- The reference to the index to list.
batRangesOnIndexedValues :: Lens' BatchListIndex [ObjectAttributeRange] Source #
Specifies the ranges of indexed values that you want to query.
batNextToken :: Lens' BatchListIndex (Maybe Text) Source #
The pagination token.
batMaxResults :: Lens' BatchListIndex (Maybe Natural) Source #
The maximum number of results to retrieve.
batIndexReference :: Lens' BatchListIndex ObjectReference Source #
The reference to the index to list.
BatchListIndexResponse
data BatchListIndexResponse Source #
Represents the output of a ListIndex response operation.
See: batchListIndexResponse smart constructor.
Instances
batchListIndexResponse :: BatchListIndexResponse Source #
Creates a value of BatchListIndexResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bliIndexAttachments- The objects and indexed values attached to the index.bliNextToken- The pagination token.
bliIndexAttachments :: Lens' BatchListIndexResponse [IndexAttachment] Source #
The objects and indexed values attached to the index.
bliNextToken :: Lens' BatchListIndexResponse (Maybe Text) Source #
The pagination token.
BatchListObjectAttributes
data BatchListObjectAttributes Source #
Represents the output of a ListObjectAttributes operation.
See: batchListObjectAttributes smart constructor.
Instances
batchListObjectAttributes Source #
Arguments
| :: ObjectReference | |
| -> BatchListObjectAttributes |
Creates a value of BatchListObjectAttributes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bloaFacetFilter- Used to filter the list of object attributes that are associated with a certain facet.bloaNextToken- The pagination token.bloaMaxResults- The maximum number of items to be retrieved in a single call. This is an approximate number.bloaObjectReference- Reference of the object whose attributes need to be listed.
bloaFacetFilter :: Lens' BatchListObjectAttributes (Maybe SchemaFacet) Source #
Used to filter the list of object attributes that are associated with a certain facet.
bloaNextToken :: Lens' BatchListObjectAttributes (Maybe Text) Source #
The pagination token.
bloaMaxResults :: Lens' BatchListObjectAttributes (Maybe Natural) Source #
The maximum number of items to be retrieved in a single call. This is an approximate number.
bloaObjectReference :: Lens' BatchListObjectAttributes ObjectReference Source #
Reference of the object whose attributes need to be listed.
BatchListObjectAttributesResponse
data BatchListObjectAttributesResponse Source #
Represents the output of a ListObjectAttributes response operation.
See: batchListObjectAttributesResponse smart constructor.
Instances
batchListObjectAttributesResponse :: BatchListObjectAttributesResponse Source #
Creates a value of BatchListObjectAttributesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bNextToken- The pagination token.bAttributes- The attributes map that is associated with the object.AttributeArnis the key; attribute value is the value.
bNextToken :: Lens' BatchListObjectAttributesResponse (Maybe Text) Source #
The pagination token.
bAttributes :: Lens' BatchListObjectAttributesResponse [AttributeKeyAndValue] Source #
The attributes map that is associated with the object. AttributeArn is the key; attribute value is the value.
BatchListObjectChildren
data BatchListObjectChildren Source #
Represents the output of a ListObjectChildren operation.
See: batchListObjectChildren smart constructor.
Instances
batchListObjectChildren Source #
Arguments
| :: ObjectReference | |
| -> BatchListObjectChildren |
Creates a value of BatchListObjectChildren with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bloclNextToken- The pagination token.bloclMaxResults- Maximum number of items to be retrieved in a single call. This is an approximate number.bloclObjectReference- Reference of the object for which child objects are being listed.
bloclNextToken :: Lens' BatchListObjectChildren (Maybe Text) Source #
The pagination token.
bloclMaxResults :: Lens' BatchListObjectChildren (Maybe Natural) Source #
Maximum number of items to be retrieved in a single call. This is an approximate number.
bloclObjectReference :: Lens' BatchListObjectChildren ObjectReference Source #
Reference of the object for which child objects are being listed.
BatchListObjectChildrenResponse
data BatchListObjectChildrenResponse Source #
Represents the output of a ListObjectChildren response operation.
See: batchListObjectChildrenResponse smart constructor.
Instances
batchListObjectChildrenResponse :: BatchListObjectChildrenResponse Source #
Creates a value of BatchListObjectChildrenResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blocChildren- The children structure, which is a map with the key as theLinkNameandObjectIdentifieras the value.blocNextToken- The pagination token.
blocChildren :: Lens' BatchListObjectChildrenResponse (HashMap Text Text) Source #
The children structure, which is a map with the key as the LinkName and ObjectIdentifier as the value.
blocNextToken :: Lens' BatchListObjectChildrenResponse (Maybe Text) Source #
The pagination token.
BatchListObjectParentPaths
data BatchListObjectParentPaths Source #
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a BatchRead operation. For more information, see ListObjectParentPaths and 'BatchReadRequest$Operations' .
See: batchListObjectParentPaths smart constructor.
Instances
batchListObjectParentPaths Source #
Creates a value of BatchListObjectParentPaths with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bloppsNextToken- The pagination token.bloppsMaxResults- The maximum number of results to retrieve.bloppsObjectReference- The reference that identifies the object whose attributes will be listed.
bloppsNextToken :: Lens' BatchListObjectParentPaths (Maybe Text) Source #
The pagination token.
bloppsMaxResults :: Lens' BatchListObjectParentPaths (Maybe Natural) Source #
The maximum number of results to retrieve.
bloppsObjectReference :: Lens' BatchListObjectParentPaths ObjectReference Source #
The reference that identifies the object whose attributes will be listed.
BatchListObjectParentPathsResponse
data BatchListObjectParentPathsResponse Source #
Represents the output of a ListObjectParentPaths response operation.
See: batchListObjectParentPathsResponse smart constructor.
Instances
batchListObjectParentPathsResponse :: BatchListObjectParentPathsResponse Source #
Creates a value of BatchListObjectParentPathsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bloppPathToObjectIdentifiersList- Returns the path to theObjectIdentifiersthat are associated with the directory.bloppNextToken- The pagination token.
bloppPathToObjectIdentifiersList :: Lens' BatchListObjectParentPathsResponse [PathToObjectIdentifiers] Source #
Returns the path to the ObjectIdentifiers that are associated with the directory.
bloppNextToken :: Lens' BatchListObjectParentPathsResponse (Maybe Text) Source #
The pagination token.
BatchListObjectPolicies
data BatchListObjectPolicies Source #
Returns policies attached to an object in pagination fashion inside a BatchRead operation. For more information, see ListObjectPolicies and 'BatchReadRequest$Operations' .
See: batchListObjectPolicies smart constructor.
Instances
batchListObjectPolicies Source #
Arguments
| :: ObjectReference | |
| -> BatchListObjectPolicies |
Creates a value of BatchListObjectPolicies with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blopsNextToken- The pagination token.blopsMaxResults- The maximum number of results to retrieve.blopsObjectReference- The reference that identifies the object whose attributes will be listed.
blopsNextToken :: Lens' BatchListObjectPolicies (Maybe Text) Source #
The pagination token.
blopsMaxResults :: Lens' BatchListObjectPolicies (Maybe Natural) Source #
The maximum number of results to retrieve.
blopsObjectReference :: Lens' BatchListObjectPolicies ObjectReference Source #
The reference that identifies the object whose attributes will be listed.
BatchListObjectPoliciesResponse
data BatchListObjectPoliciesResponse Source #
Represents the output of a ListObjectPolicies response operation.
See: batchListObjectPoliciesResponse smart constructor.
Instances
batchListObjectPoliciesResponse :: BatchListObjectPoliciesResponse Source #
Creates a value of BatchListObjectPoliciesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blopNextToken- The pagination token.blopAttachedPolicyIds- A list of policyObjectIdentifiers, that are attached to the object.
blopNextToken :: Lens' BatchListObjectPoliciesResponse (Maybe Text) Source #
The pagination token.
blopAttachedPolicyIds :: Lens' BatchListObjectPoliciesResponse [Text] Source #
A list of policy ObjectIdentifiers , that are attached to the object.
BatchListOutgoingTypedLinks
data BatchListOutgoingTypedLinks Source #
Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListOutgoingTypedLinks and 'BatchReadRequest$Operations' .
See: batchListOutgoingTypedLinks smart constructor.
Instances
batchListOutgoingTypedLinks Source #
Creates a value of BatchListOutgoingTypedLinks with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blotlsFilterAttributeRanges- 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.blotlsNextToken- The pagination token.blotlsFilterTypedLink- 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.blotlsMaxResults- The maximum number of results to retrieve.blotlsObjectReference- The reference that identifies the object whose attributes will be listed.
blotlsFilterAttributeRanges :: Lens' BatchListOutgoingTypedLinks [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.
blotlsNextToken :: Lens' BatchListOutgoingTypedLinks (Maybe Text) Source #
The pagination token.
blotlsFilterTypedLink :: 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.
blotlsMaxResults :: Lens' BatchListOutgoingTypedLinks (Maybe Natural) Source #
The maximum number of results to retrieve.
blotlsObjectReference :: Lens' BatchListOutgoingTypedLinks ObjectReference Source #
The reference that identifies the object whose attributes will be listed.
BatchListOutgoingTypedLinksResponse
data BatchListOutgoingTypedLinksResponse Source #
Represents the output of a ListOutgoingTypedLinks response operation.
See: batchListOutgoingTypedLinksResponse smart constructor.
Instances
batchListOutgoingTypedLinksResponse :: BatchListOutgoingTypedLinksResponse Source #
Creates a value of BatchListOutgoingTypedLinksResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blotlTypedLinkSpecifiers- Returns a typed link specifier as output.blotlNextToken- The pagination token.
blotlTypedLinkSpecifiers :: Lens' BatchListOutgoingTypedLinksResponse [TypedLinkSpecifier] Source #
Returns a typed link specifier as output.
blotlNextToken :: Lens' BatchListOutgoingTypedLinksResponse (Maybe Text) Source #
The pagination token.
BatchListPolicyAttachments
data BatchListPolicyAttachments Source #
Returns all of the ObjectIdentifiers to which a given policy is attached inside a BatchRead operation. For more information, see ListPolicyAttachments and 'BatchReadRequest$Operations' .
See: batchListPolicyAttachments smart constructor.
Instances
batchListPolicyAttachments Source #
Creates a value of BatchListPolicyAttachments with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blpasNextToken- The pagination token.blpasMaxResults- The maximum number of results to retrieve.blpasPolicyReference- The reference that identifies the policy object.
blpasNextToken :: Lens' BatchListPolicyAttachments (Maybe Text) Source #
The pagination token.
blpasMaxResults :: Lens' BatchListPolicyAttachments (Maybe Natural) Source #
The maximum number of results to retrieve.
blpasPolicyReference :: Lens' BatchListPolicyAttachments ObjectReference Source #
The reference that identifies the policy object.
BatchListPolicyAttachmentsResponse
data BatchListPolicyAttachmentsResponse Source #
Represents the output of a ListPolicyAttachments response operation.
See: batchListPolicyAttachmentsResponse smart constructor.
Instances
batchListPolicyAttachmentsResponse :: BatchListPolicyAttachmentsResponse Source #
Creates a value of BatchListPolicyAttachmentsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blpaObjectIdentifiers- A list ofObjectIdentifiersto which the policy is attached.blpaNextToken- The pagination token.
blpaObjectIdentifiers :: Lens' BatchListPolicyAttachmentsResponse [Text] Source #
A list of ObjectIdentifiers to which the policy is attached.
blpaNextToken :: Lens' BatchListPolicyAttachmentsResponse (Maybe Text) Source #
The pagination token.
BatchLookupPolicy
data BatchLookupPolicy Source #
Lists all policies from the root of the Directory to the object specified inside a BatchRead operation. For more information, see LookupPolicy and 'BatchReadRequest$Operations' .
See: batchLookupPolicy smart constructor.
Instances
Arguments
| :: ObjectReference | |
| -> BatchLookupPolicy |
Creates a value of BatchLookupPolicy with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blplNextToken- The pagination token.blplMaxResults- The maximum number of results to retrieve.blplObjectReference- Reference that identifies the object whose policies will be looked up.
blplNextToken :: Lens' BatchLookupPolicy (Maybe Text) Source #
The pagination token.
blplMaxResults :: Lens' BatchLookupPolicy (Maybe Natural) Source #
The maximum number of results to retrieve.
blplObjectReference :: Lens' BatchLookupPolicy ObjectReference Source #
Reference that identifies the object whose policies will be looked up.
BatchLookupPolicyResponse
data BatchLookupPolicyResponse Source #
Represents the output of a LookupPolicy response operation.
See: batchLookupPolicyResponse smart constructor.
Instances
batchLookupPolicyResponse :: BatchLookupPolicyResponse Source #
Creates a value of BatchLookupPolicyResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
blpNextToken- The pagination token.blpPolicyToPathList- Provides list of path to policies. Policies containPolicyId,ObjectIdentifier, andPolicyType. For more information, see Policies .
blpNextToken :: Lens' BatchLookupPolicyResponse (Maybe Text) Source #
The pagination token.
blpPolicyToPathList :: Lens' BatchLookupPolicyResponse [PolicyToPath] Source #
Provides list of path to policies. Policies contain PolicyId , ObjectIdentifier , and PolicyType . For more information, see Policies .
BatchReadException
data BatchReadException Source #
The batch read exception structure, which contains the exception type and message.
See: batchReadException smart constructor.
Instances
batchReadException :: BatchReadException Source #
Creates a value of BatchReadException with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
breType- A type of exception, such asInvalidArnException.breMessage- An exception message that is associated with the failure.
breType :: Lens' BatchReadException (Maybe BatchReadExceptionType) Source #
A type of exception, such as InvalidArnException .
breMessage :: Lens' BatchReadException (Maybe Text) Source #
An exception message that is associated with the failure.
BatchReadOperation
data BatchReadOperation Source #
Represents the output of a BatchRead operation.
See: batchReadOperation smart constructor.
Instances
batchReadOperation :: BatchReadOperation Source #
Creates a value of BatchReadOperation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
broListIndex- Lists objects attached to the specified index.broGetObjectInformation- Retrieves metadata about an object.broListAttachedIndices- Lists indices attached to an object.broLookupPolicy- Lists all policies from the root of theDirectoryto 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 theObjectIdentifierfor such objects. If policies are present, it returnsObjectIdentifier,policyId, andpolicyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies .broListObjectParentPaths- 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 .broListObjectAttributes- Lists all attributes that are associated with an object.broListIncomingTypedLinks- Returns a paginated list of all the incomingTypedLinkSpecifierinformation for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link .broGetObjectAttributes- Retrieves attributes within a facet that are associated with an object.broListObjectChildren- Returns a paginated list of child objects that are associated with a given object.broListPolicyAttachments- Returns all of theObjectIdentifiersto which a given policy is attached.broListOutgoingTypedLinks- Returns a paginated list of all the outgoingTypedLinkSpecifierinformation for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link .broListObjectPolicies- Returns policies attached to an object in pagination fashion.
broListIndex :: Lens' BatchReadOperation (Maybe BatchListIndex) Source #
Lists objects attached to the specified index.
broGetObjectInformation :: Lens' BatchReadOperation (Maybe BatchGetObjectInformation) Source #
Retrieves metadata about an object.
broListAttachedIndices :: Lens' BatchReadOperation (Maybe BatchListAttachedIndices) Source #
Lists indices attached to an object.
broLookupPolicy :: 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 .
broListObjectParentPaths :: 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 .
broListObjectAttributes :: Lens' BatchReadOperation (Maybe BatchListObjectAttributes) Source #
Lists all attributes that are associated with an object.
broListIncomingTypedLinks :: 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 link .
broGetObjectAttributes :: Lens' BatchReadOperation (Maybe BatchGetObjectAttributes) Source #
Retrieves attributes within a facet that are associated with an object.
broListObjectChildren :: Lens' BatchReadOperation (Maybe BatchListObjectChildren) Source #
Returns a paginated list of child objects that are associated with a given object.
broListPolicyAttachments :: Lens' BatchReadOperation (Maybe BatchListPolicyAttachments) Source #
Returns all of the ObjectIdentifiers to which a given policy is attached.
broListOutgoingTypedLinks :: 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 link .
broListObjectPolicies :: Lens' BatchReadOperation (Maybe BatchListObjectPolicies) Source #
Returns policies attached to an object in pagination fashion.
BatchReadOperationResponse
data BatchReadOperationResponse Source #
Represents the output of a BatchRead response operation.
See: batchReadOperationResponse smart constructor.
Instances
batchReadOperationResponse :: BatchReadOperationResponse Source #
Creates a value of BatchReadOperationResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
broExceptionResponse- Identifies which operation in a batch has failed.broSuccessfulResponse- Identifies which operation in a batch has succeeded.
broExceptionResponse :: Lens' BatchReadOperationResponse (Maybe BatchReadException) Source #
Identifies which operation in a batch has failed.
broSuccessfulResponse :: Lens' BatchReadOperationResponse (Maybe BatchReadSuccessfulResponse) Source #
Identifies which operation in a batch has succeeded.
BatchReadSuccessfulResponse
data BatchReadSuccessfulResponse Source #
Represents the output of a BatchRead success response operation.
See: batchReadSuccessfulResponse smart constructor.
Instances
batchReadSuccessfulResponse :: BatchReadSuccessfulResponse Source #
Creates a value of BatchReadSuccessfulResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
brsListIndex- Lists objects attached to the specified index.brsGetObjectInformation- Retrieves metadata about an object.brsListAttachedIndices- Lists indices attached to an object.brsLookupPolicy- Lists all policies from the root of theDirectoryto 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 theObjectIdentifierfor such objects. If policies are present, it returnsObjectIdentifier,policyId, andpolicyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies .brsListObjectParentPaths- 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 .brsListObjectAttributes- Lists all attributes that are associated with an object.brsListIncomingTypedLinks- Returns a paginated list of all the incomingTypedLinkSpecifierinformation for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link .brsGetObjectAttributes- Retrieves attributes within a facet that are associated with an object.brsListObjectChildren- Returns a paginated list of child objects that are associated with a given object.brsListPolicyAttachments- Returns all of theObjectIdentifiersto which a given policy is attached.brsListOutgoingTypedLinks- Returns a paginated list of all the outgoingTypedLinkSpecifierinformation for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link .brsListObjectPolicies- Returns policies attached to an object in pagination fashion.
brsListIndex :: Lens' BatchReadSuccessfulResponse (Maybe BatchListIndexResponse) Source #
Lists objects attached to the specified index.
brsGetObjectInformation :: Lens' BatchReadSuccessfulResponse (Maybe BatchGetObjectInformationResponse) Source #
Retrieves metadata about an object.
brsListAttachedIndices :: Lens' BatchReadSuccessfulResponse (Maybe BatchListAttachedIndicesResponse) Source #
Lists indices attached to an object.
brsLookupPolicy :: 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 .
brsListObjectParentPaths :: 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 .
brsListObjectAttributes :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectAttributesResponse) Source #
Lists all attributes that are associated with an object.
brsListIncomingTypedLinks :: 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 link .
brsGetObjectAttributes :: Lens' BatchReadSuccessfulResponse (Maybe BatchGetObjectAttributesResponse) Source #
Retrieves attributes within a facet that are associated with an object.
brsListObjectChildren :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectChildrenResponse) Source #
Returns a paginated list of child objects that are associated with a given object.
brsListPolicyAttachments :: Lens' BatchReadSuccessfulResponse (Maybe BatchListPolicyAttachmentsResponse) Source #
Returns all of the ObjectIdentifiers to which a given policy is attached.
brsListOutgoingTypedLinks :: 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 link .
brsListObjectPolicies :: Lens' BatchReadSuccessfulResponse (Maybe BatchListObjectPoliciesResponse) Source #
Returns policies attached to an object in pagination fashion.
BatchRemoveFacetFromObject
data BatchRemoveFacetFromObject Source #
A batch operation to remove a facet from an object.
See: batchRemoveFacetFromObject smart constructor.
Instances
batchRemoveFacetFromObject Source #
Arguments
| :: SchemaFacet | |
| -> ObjectReference | |
| -> BatchRemoveFacetFromObject |
Creates a value of BatchRemoveFacetFromObject with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
brffoSchemaFacet- The facet to remove from the object.brffoObjectReference- A reference to the object whose facet will be removed.
brffoSchemaFacet :: Lens' BatchRemoveFacetFromObject SchemaFacet Source #
The facet to remove from the object.
brffoObjectReference :: Lens' BatchRemoveFacetFromObject ObjectReference Source #
A reference to the object whose facet will be removed.
BatchRemoveFacetFromObjectResponse
data BatchRemoveFacetFromObjectResponse Source #
An empty result that represents success.
See: batchRemoveFacetFromObjectResponse smart constructor.
Instances
batchRemoveFacetFromObjectResponse :: BatchRemoveFacetFromObjectResponse Source #
Creates a value of BatchRemoveFacetFromObjectResponse with the minimum fields required to make a request.
BatchUpdateObjectAttributes
data BatchUpdateObjectAttributes Source #
Represents the output of a BatchUpdate operation.
See: batchUpdateObjectAttributes smart constructor.
Instances
batchUpdateObjectAttributes Source #
Creates a value of BatchUpdateObjectAttributes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
buoaObjectReference- Reference that identifies the object.buoaAttributeUpdates- Attributes update structure.
buoaObjectReference :: Lens' BatchUpdateObjectAttributes ObjectReference Source #
Reference that identifies the object.
buoaAttributeUpdates :: Lens' BatchUpdateObjectAttributes [ObjectAttributeUpdate] Source #
Attributes update structure.
BatchUpdateObjectAttributesResponse
data BatchUpdateObjectAttributesResponse Source #
Represents the output of a BatchUpdate response operation.
See: batchUpdateObjectAttributesResponse smart constructor.
Instances
batchUpdateObjectAttributesResponse :: BatchUpdateObjectAttributesResponse Source #
Creates a value of BatchUpdateObjectAttributesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
buoaObjectIdentifier- ID that is associated with the object.
buoaObjectIdentifier :: Lens' BatchUpdateObjectAttributesResponse (Maybe Text) Source #
ID that is associated with the object.
BatchWriteOperation
data BatchWriteOperation Source #
Represents the output of a BatchWrite operation.
See: batchWriteOperation smart constructor.
Instances
batchWriteOperation :: BatchWriteOperation Source #
Creates a value of BatchWriteOperation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bDeleteObject- Deletes an object in aDirectory.bDetachFromIndex- Detaches the specified object from the specified index.bRemoveFacetFromObject- A batch operation that removes a facet from an object.bAttachObject- Attaches an object to aDirectory.bCreateObject- Creates an object.bAttachTypedLink- Attaches a typed link to a specified source and target object. For more information, see Typed link .bDetachPolicy- Detaches a policy from aDirectory.bCreateIndex- Creates an index object. See Indexing for more information.bDetachObject- Detaches an object from aDirectory.bAddFacetToObject- A batch operation that adds a facet to an object.bDetachTypedLink- Detaches a typed link from a specified source and target object. For more information, see Typed link .bUpdateObjectAttributes- Updates a given object's attributes.bAttachPolicy- Attaches a policy object to a regular object. An object can have a limited number of attached policies.bAttachToIndex- Attaches the specified object to the specified index.
bDeleteObject :: Lens' BatchWriteOperation (Maybe BatchDeleteObject) Source #
Deletes an object in a Directory .
bDetachFromIndex :: Lens' BatchWriteOperation (Maybe BatchDetachFromIndex) Source #
Detaches the specified object from the specified index.
bRemoveFacetFromObject :: Lens' BatchWriteOperation (Maybe BatchRemoveFacetFromObject) Source #
A batch operation that removes a facet from an object.
bAttachObject :: Lens' BatchWriteOperation (Maybe BatchAttachObject) Source #
Attaches an object to a Directory .
bCreateObject :: Lens' BatchWriteOperation (Maybe BatchCreateObject) Source #
Creates an object.
bAttachTypedLink :: Lens' BatchWriteOperation (Maybe BatchAttachTypedLink) Source #
Attaches a typed link to a specified source and target object. For more information, see Typed link .
bDetachPolicy :: Lens' BatchWriteOperation (Maybe BatchDetachPolicy) Source #
Detaches a policy from a Directory .
bCreateIndex :: Lens' BatchWriteOperation (Maybe BatchCreateIndex) Source #
Creates an index object. See Indexing for more information.
bDetachObject :: Lens' BatchWriteOperation (Maybe BatchDetachObject) Source #
Detaches an object from a Directory .
bAddFacetToObject :: Lens' BatchWriteOperation (Maybe BatchAddFacetToObject) Source #
A batch operation that adds a facet to an object.
bDetachTypedLink :: Lens' BatchWriteOperation (Maybe BatchDetachTypedLink) Source #
Detaches a typed link from a specified source and target object. For more information, see Typed link .
bUpdateObjectAttributes :: Lens' BatchWriteOperation (Maybe BatchUpdateObjectAttributes) Source #
Updates a given object's attributes.
bAttachPolicy :: Lens' BatchWriteOperation (Maybe BatchAttachPolicy) Source #
Attaches a policy object to a regular object. An object can have a limited number of attached policies.
bAttachToIndex :: Lens' BatchWriteOperation (Maybe BatchAttachToIndex) Source #
Attaches the specified object to the specified index.
BatchWriteOperationResponse
data BatchWriteOperationResponse Source #
Represents the output of a BatchWrite response operation.
See: batchWriteOperationResponse smart constructor.
Instances
batchWriteOperationResponse :: BatchWriteOperationResponse Source #
Creates a value of BatchWriteOperationResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bwoDeleteObject- Deletes an object in aDirectory.bwoDetachFromIndex- Detaches the specified object from the specified index.bwoRemoveFacetFromObject- The result of a batch remove facet from object operation.bwoAttachObject- Attaches an object to aDirectory.bwoCreateObject- Creates an object in aDirectory.bwoAttachTypedLink- Attaches a typed link to a specified source and target object. For more information, see Typed link .bwoDetachPolicy- Detaches a policy from aDirectory.bwoCreateIndex- Creates an index object. See Indexing for more information.bwoDetachObject- Detaches an object from aDirectory.bwoAddFacetToObject- The result of an add facet to object batch operation.bwoDetachTypedLink- Detaches a typed link from a specified source and target object. For more information, see Typed link .bwoUpdateObjectAttributes- Updates a given object’s attributes.bwoAttachPolicy- Attaches a policy object to a regular object. An object can have a limited number of attached policies.bwoAttachToIndex- Attaches the specified object to the specified index.
bwoDeleteObject :: Lens' BatchWriteOperationResponse (Maybe BatchDeleteObjectResponse) Source #
Deletes an object in a Directory .
bwoDetachFromIndex :: Lens' BatchWriteOperationResponse (Maybe BatchDetachFromIndexResponse) Source #
Detaches the specified object from the specified index.
bwoRemoveFacetFromObject :: Lens' BatchWriteOperationResponse (Maybe BatchRemoveFacetFromObjectResponse) Source #
The result of a batch remove facet from object operation.
bwoAttachObject :: Lens' BatchWriteOperationResponse (Maybe BatchAttachObjectResponse) Source #
Attaches an object to a Directory .
bwoCreateObject :: Lens' BatchWriteOperationResponse (Maybe BatchCreateObjectResponse) Source #
Creates an object in a Directory .
bwoAttachTypedLink :: Lens' BatchWriteOperationResponse (Maybe BatchAttachTypedLinkResponse) Source #
Attaches a typed link to a specified source and target object. For more information, see Typed link .
bwoDetachPolicy :: Lens' BatchWriteOperationResponse (Maybe BatchDetachPolicyResponse) Source #
Detaches a policy from a Directory .
bwoCreateIndex :: Lens' BatchWriteOperationResponse (Maybe BatchCreateIndexResponse) Source #
Creates an index object. See Indexing for more information.
bwoDetachObject :: Lens' BatchWriteOperationResponse (Maybe BatchDetachObjectResponse) Source #
Detaches an object from a Directory .
bwoAddFacetToObject :: Lens' BatchWriteOperationResponse (Maybe BatchAddFacetToObjectResponse) Source #
The result of an add facet to object batch operation.
bwoDetachTypedLink :: Lens' BatchWriteOperationResponse (Maybe BatchDetachTypedLinkResponse) Source #
Detaches a typed link from a specified source and target object. For more information, see Typed link .
bwoUpdateObjectAttributes :: Lens' BatchWriteOperationResponse (Maybe BatchUpdateObjectAttributesResponse) Source #
Updates a given object’s attributes.
bwoAttachPolicy :: Lens' BatchWriteOperationResponse (Maybe BatchAttachPolicyResponse) Source #
Attaches a policy object to a regular object. An object can have a limited number of attached policies.
bwoAttachToIndex :: Lens' BatchWriteOperationResponse (Maybe BatchAttachToIndexResponse) Source #
Attaches the specified object to the specified index.
Directory
Directory structure that includes the directory name and directory ARN.
See: directory smart constructor.
directory :: Directory Source #
Creates a value of Directory with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dDirectoryARN- The Amazon Resource Name (ARN) that is associated with the directory. For more information, seearns.dState- The state of the directory. Can be eitherEnabled,Disabled, orDeleted.dName- The name of the directory.dCreationDateTime- The date and time when the directory was created.
dDirectoryARN :: Lens' Directory (Maybe Text) Source #
The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns .
dState :: Lens' Directory (Maybe DirectoryState) Source #
The state of the directory. Can be either Enabled , Disabled , or Deleted .
dCreationDateTime :: Lens' Directory (Maybe UTCTime) Source #
The date and time when the directory was created.
Facet
Creates a value of Facet with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fObjectType- The object type that is associated with the facet. See 'CreateFacetRequest$ObjectType' for more details.fName- The name of theFacet.
fObjectType :: Lens' Facet (Maybe ObjectType) Source #
The object type that is associated with the facet. See 'CreateFacetRequest$ObjectType' for more details.
FacetAttribute
data FacetAttribute Source #
An attribute that is associated with the Facet .
See: facetAttribute smart constructor.
Instances
Arguments
| :: Text | |
| -> FacetAttribute |
Creates a value of FacetAttribute with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
faAttributeReference- An attribute reference that is associated with the attribute. See Attribute References for more information.faAttributeDefinition- A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.faRequiredBehavior- The required behavior of theFacetAttribute.faName- The name of the facet attribute.
faAttributeReference :: Lens' FacetAttribute (Maybe FacetAttributeReference) Source #
An attribute reference that is associated with the attribute. See Attribute References for more information.
faAttributeDefinition :: 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.
faRequiredBehavior :: Lens' FacetAttribute (Maybe RequiredAttributeBehavior) Source #
The required behavior of the FacetAttribute .
FacetAttributeDefinition
data FacetAttributeDefinition Source #
A facet attribute definition. See Attribute References for more information.
See: facetAttributeDefinition smart constructor.
Instances
facetAttributeDefinition Source #
Arguments
| :: FacetAttributeType | |
| -> FacetAttributeDefinition |
Creates a value of FacetAttributeDefinition with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fadRules- Validation rules attached to the attribute definition.fadDefaultValue- The default value of the attribute (if configured).fadIsImmutable- Whether the attribute is mutable or not.fadType- The type of the attribute.
fadRules :: Lens' FacetAttributeDefinition (HashMap Text Rule) Source #
Validation rules attached to the attribute definition.
fadDefaultValue :: Lens' FacetAttributeDefinition (Maybe TypedAttributeValue) Source #
The default value of the attribute (if configured).
fadIsImmutable :: Lens' FacetAttributeDefinition (Maybe Bool) Source #
Whether the attribute is mutable or not.
fadType :: Lens' FacetAttributeDefinition FacetAttributeType Source #
The type of the attribute.
FacetAttributeReference
data FacetAttributeReference Source #
The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.
See: facetAttributeReference smart constructor.
Instances
facetAttributeReference Source #
Arguments
| :: Text | |
| -> Text | |
| -> FacetAttributeReference |
Creates a value of FacetAttributeReference with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
farTargetFacetName- The target facet name that is associated with the facet reference. See Attribute References for more information.farTargetAttributeName- The target attribute name that is associated with the facet reference. See Attribute References for more information.
farTargetFacetName :: Lens' FacetAttributeReference Text Source #
The target facet name that is associated with the facet reference. See Attribute References for more information.
farTargetAttributeName :: Lens' FacetAttributeReference Text Source #
The target attribute name that is associated with the facet reference. See Attribute References for more information.
FacetAttributeUpdate
data FacetAttributeUpdate Source #
A structure that contains information used to update an attribute.
See: facetAttributeUpdate smart constructor.
Instances
facetAttributeUpdate :: FacetAttributeUpdate Source #
Creates a value of FacetAttributeUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fauAttribute- The attribute to update.fauAction- The action to perform when updating the attribute.
fauAttribute :: Lens' FacetAttributeUpdate (Maybe FacetAttribute) Source #
The attribute to update.
fauAction :: Lens' FacetAttributeUpdate (Maybe UpdateActionType) Source #
The action to perform when updating the attribute.
IndexAttachment
data IndexAttachment Source #
Represents an index and an attached object.
See: indexAttachment smart constructor.
indexAttachment :: IndexAttachment Source #
Creates a value of IndexAttachment with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iaIndexedAttributes- The indexed attribute values.iaObjectIdentifier- In response toListIndex, theObjectIdentifierof the object attached to the index. In response toListAttachedIndices, theObjectIdentifierof the index attached to the object. This field will always contain theObjectIdentifierof the object on the opposite side of the attachment specified in the query.
iaIndexedAttributes :: Lens' IndexAttachment [AttributeKeyAndValue] Source #
The indexed attribute values.
iaObjectIdentifier :: 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.
ObjectAttributeAction
data ObjectAttributeAction Source #
The action to take on the object attribute.
See: objectAttributeAction smart constructor.
Instances
objectAttributeAction :: ObjectAttributeAction Source #
Creates a value of ObjectAttributeAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oaaObjectAttributeActionType- A type that can be eitherUpdateorDelete.oaaObjectAttributeUpdateValue- The value that you want to update to.
oaaObjectAttributeActionType :: Lens' ObjectAttributeAction (Maybe UpdateActionType) Source #
A type that can be either Update or Delete .
oaaObjectAttributeUpdateValue :: Lens' ObjectAttributeAction (Maybe TypedAttributeValue) Source #
The value that you want to update to.
ObjectAttributeRange
data ObjectAttributeRange Source #
A range of attributes.
See: objectAttributeRange smart constructor.
Instances
objectAttributeRange :: ObjectAttributeRange Source #
Creates a value of ObjectAttributeRange with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oarRange- The range of attribute values being selected.oarAttributeKey- The key of the attribute that the attribute range covers.
oarRange :: Lens' ObjectAttributeRange (Maybe TypedAttributeValueRange) Source #
The range of attribute values being selected.
oarAttributeKey :: Lens' ObjectAttributeRange (Maybe AttributeKey) Source #
The key of the attribute that the attribute range covers.
ObjectAttributeUpdate
data ObjectAttributeUpdate Source #
Structure that contains attribute update information.
See: objectAttributeUpdate smart constructor.
Instances
objectAttributeUpdate :: ObjectAttributeUpdate Source #
Creates a value of ObjectAttributeUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oauObjectAttributeAction- The action to perform as part of the attribute update.oauObjectAttributeKey- The key of the attribute being updated.
oauObjectAttributeAction :: Lens' ObjectAttributeUpdate (Maybe ObjectAttributeAction) Source #
The action to perform as part of the attribute update.
oauObjectAttributeKey :: Lens' ObjectAttributeUpdate (Maybe AttributeKey) Source #
The key of the attribute being updated.
ObjectReference
data ObjectReference Source #
The reference that identifies an object.
See: objectReference smart constructor.
Instances
objectReference :: ObjectReference Source #
Creates a value of ObjectReference with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
orSelector- A path selector supports easy selection of an object by the parentchild links leading to it from the directory root. Use the link names from each parentchild link to construct the path. Path selectors start with a slash () and link names are separated by slashes. For more information about paths, see <http:docs.aws.amazon.comdirectoryservicelatestadmin-guideobjectsandlinks.html#accessingobjects Accessing Objects> . You can identify an object in one of the following ways: * > ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier * /some/path - Identifies the object based on path * #SomeBatchReference/ - Identifies the object in a batch call
orSelector :: Lens' ObjectReference (Maybe Text) Source #
A path selector supports easy selection of an object by the parentchild links leading to it from the directory root. Use the link names from each parentchild link to construct the path. Path selectors start with a slash () and link names are separated by slashes. For more information about paths, see <http:docs.aws.amazon.comdirectoryservicelatestadmin-guideobjectsandlinks.html#accessingobjects Accessing Objects> . You can identify an object in one of the following ways: * > ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier * /some/path - Identifies the object based on path * #SomeBatchReference/ - Identifies the object in a batch call
PathToObjectIdentifiers
data PathToObjectIdentifiers Source #
Returns the path to the ObjectIdentifiers that is associated with the directory.
See: pathToObjectIdentifiers smart constructor.
Instances
pathToObjectIdentifiers :: PathToObjectIdentifiers Source #
Creates a value of PathToObjectIdentifiers with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ptoiObjectIdentifiers- ListsObjectIdentifiersstarting from directory root to the object in the request.ptoiPath- The path that is used to identify the object starting from directory root.
ptoiObjectIdentifiers :: Lens' PathToObjectIdentifiers [Text] Source #
Lists ObjectIdentifiers starting from directory root to the object in the request.
ptoiPath :: Lens' PathToObjectIdentifiers (Maybe Text) Source #
The path that is used to identify the object starting from directory root.
PolicyAttachment
data PolicyAttachment Source #
Contains the PolicyType , PolicyId , and the ObjectIdentifier to which it is attached. For more information, see Policies .
See: policyAttachment smart constructor.
Instances
policyAttachment :: PolicyAttachment Source #
Creates a value of PolicyAttachment with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
paPolicyId- The ID ofPolicyAttachment.paPolicyType- The type of policy that can be associated withPolicyAttachment.paObjectIdentifier- TheObjectIdentifierthat is associated withPolicyAttachment.
paPolicyId :: Lens' PolicyAttachment (Maybe Text) Source #
The ID of PolicyAttachment .
paPolicyType :: Lens' PolicyAttachment (Maybe Text) Source #
The type of policy that can be associated with PolicyAttachment .
paObjectIdentifier :: Lens' PolicyAttachment (Maybe Text) Source #
The ObjectIdentifier that is associated with PolicyAttachment .
PolicyToPath
data PolicyToPath Source #
Used when a regular object exists in a Directory and you want to find all of the policies that are associated with that object and the parent to that object.
See: policyToPath smart constructor.
policyToPath :: PolicyToPath Source #
Creates a value of PolicyToPath with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ptpPath- The path that is referenced from the root.ptpPolicies- List of policy objects.
ptpPolicies :: Lens' PolicyToPath [PolicyAttachment] Source #
List of policy objects.
Rule
Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.
See: rule smart constructor.
Creates a value of Rule with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rParameters- The minimum and maximum parameters that are associated with the rule.rType- The type of attribute validation rule.
rParameters :: Lens' Rule (HashMap Text Text) Source #
The minimum and maximum parameters that are associated with the rule.
SchemaFacet
data SchemaFacet Source #
A facet.
See: schemaFacet smart constructor.
schemaFacet :: SchemaFacet Source #
Creates a value of SchemaFacet with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sfFacetName- The name of the facet.sfSchemaARN- The ARN of the schema that contains the facet with no minor component. Seearnsand In-Place Schema Upgrade for a description of when to provide minor versions.
sfFacetName :: Lens' SchemaFacet (Maybe Text) Source #
The name of the facet.
sfSchemaARN :: 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.
Tag
The tag structure that contains a tag key and value.
See: tag smart constructor.
TypedAttributeValue
data TypedAttributeValue Source #
Represents the data for a typed attribute. You can set one, and only one, of the elements. Each attribute in an item is a name-value pair. Attributes have a single value.
See: typedAttributeValue smart constructor.
Instances
typedAttributeValue :: TypedAttributeValue Source #
Creates a value of TypedAttributeValue with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tavBinaryValue- A binary data value.-- Note: ThisLensautomatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLensaccepts and returns only raw unencoded data.tavDatetimeValue- A date and time value.tavNumberValue- A number data value.tavStringValue- A string data value.tavBooleanValue- A Boolean data value.
tavBinaryValue :: 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.
tavDatetimeValue :: Lens' TypedAttributeValue (Maybe UTCTime) Source #
A date and time value.
tavNumberValue :: Lens' TypedAttributeValue (Maybe Text) Source #
A number data value.
tavStringValue :: Lens' TypedAttributeValue (Maybe Text) Source #
A string data value.
tavBooleanValue :: Lens' TypedAttributeValue (Maybe Bool) Source #
A Boolean data value.
TypedAttributeValueRange
data TypedAttributeValueRange Source #
A range of attribute values. For more information, see Range Filters .
See: typedAttributeValueRange smart constructor.
Instances
typedAttributeValueRange Source #
Arguments
| :: RangeMode | |
| -> RangeMode | |
| -> TypedAttributeValueRange |
Creates a value of TypedAttributeValueRange with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tavrEndValue- The attribute value to terminate the range at.tavrStartValue- The value to start the range at.tavrStartMode- The inclusive or exclusive range start.tavrEndMode- The inclusive or exclusive range end.
tavrEndValue :: Lens' TypedAttributeValueRange (Maybe TypedAttributeValue) Source #
The attribute value to terminate the range at.
tavrStartValue :: Lens' TypedAttributeValueRange (Maybe TypedAttributeValue) Source #
The value to start the range at.
tavrStartMode :: Lens' TypedAttributeValueRange RangeMode Source #
The inclusive or exclusive range start.
tavrEndMode :: Lens' TypedAttributeValueRange RangeMode Source #
The inclusive or exclusive range end.
TypedLinkAttributeDefinition
data TypedLinkAttributeDefinition Source #
A typed link attribute definition.
See: typedLinkAttributeDefinition smart constructor.
Instances
typedLinkAttributeDefinition Source #
Arguments
| :: Text | |
| -> FacetAttributeType | |
| -> RequiredAttributeBehavior | |
| -> TypedLinkAttributeDefinition |
Creates a value of TypedLinkAttributeDefinition with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tladRules- Validation rules that are attached to the attribute definition.tladDefaultValue- The default value of the attribute (if configured).tladIsImmutable- Whether the attribute is mutable or not.tladName- The unique name of the typed link attribute.tladType- The type of the attribute.tladRequiredBehavior- The required behavior of theTypedLinkAttributeDefinition.
tladRules :: Lens' TypedLinkAttributeDefinition (HashMap Text Rule) Source #
Validation rules that are attached to the attribute definition.
tladDefaultValue :: Lens' TypedLinkAttributeDefinition (Maybe TypedAttributeValue) Source #
The default value of the attribute (if configured).
tladIsImmutable :: Lens' TypedLinkAttributeDefinition (Maybe Bool) Source #
Whether the attribute is mutable or not.
tladName :: Lens' TypedLinkAttributeDefinition Text Source #
The unique name of the typed link attribute.
tladType :: Lens' TypedLinkAttributeDefinition FacetAttributeType Source #
The type of the attribute.
tladRequiredBehavior :: Lens' TypedLinkAttributeDefinition RequiredAttributeBehavior Source #
The required behavior of the TypedLinkAttributeDefinition .
TypedLinkAttributeRange
data TypedLinkAttributeRange Source #
Identifies the range of attributes that are used by a specified filter.
See: typedLinkAttributeRange smart constructor.
Instances
typedLinkAttributeRange Source #
Arguments
| :: TypedAttributeValueRange | |
| -> TypedLinkAttributeRange |
Creates a value of TypedLinkAttributeRange with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tlarAttributeName- The unique name of the typed link attribute.tlarRange- The range of attribute values that are being selected.
tlarAttributeName :: Lens' TypedLinkAttributeRange (Maybe Text) Source #
The unique name of the typed link attribute.
tlarRange :: Lens' TypedLinkAttributeRange TypedAttributeValueRange Source #
The range of attribute values that are being selected.
TypedLinkFacet
data TypedLinkFacet Source #
Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.
See: typedLinkFacet smart constructor.
Arguments
| :: Text | |
| -> TypedLinkFacet |
Creates a value of TypedLinkFacet with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tlfName- The unique name of the typed link facet.tlfAttributes- 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.tlfIdentityAttributeOrder- 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. SeeListOutgoingTypedLinksandListIncomingTypedLinksfor details.
tlfAttributes :: 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.
tlfIdentityAttributeOrder :: 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
data TypedLinkFacetAttributeUpdate Source #
A typed link facet attribute update.
See: typedLinkFacetAttributeUpdate smart constructor.
Instances
typedLinkFacetAttributeUpdate Source #
Creates a value of TypedLinkFacetAttributeUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tlfauAttribute- The attribute to update.tlfauAction- The action to perform when updating the attribute.
tlfauAttribute :: Lens' TypedLinkFacetAttributeUpdate TypedLinkAttributeDefinition Source #
The attribute to update.
tlfauAction :: Lens' TypedLinkFacetAttributeUpdate UpdateActionType Source #
The action to perform when updating the attribute.
TypedLinkSchemaAndFacetName
data TypedLinkSchemaAndFacetName Source #
Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.
See: typedLinkSchemaAndFacetName smart constructor.
Instances
typedLinkSchemaAndFacetName Source #
Arguments
| :: Text | |
| -> Text | |
| -> TypedLinkSchemaAndFacetName |
Creates a value of TypedLinkSchemaAndFacetName with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tlsafnSchemaARN- The Amazon Resource Name (ARN) that is associated with the schema. For more information, seearns.tlsafnTypedLinkName- The unique name of the typed link facet.
tlsafnSchemaARN :: Lens' TypedLinkSchemaAndFacetName Text Source #
The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .
tlsafnTypedLinkName :: Lens' TypedLinkSchemaAndFacetName Text Source #
The unique name of the typed link facet.
TypedLinkSpecifier
data TypedLinkSpecifier Source #
Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The AttachTypedLink API returns a typed link specifier while the DetachTypedLink API accepts one as input. Similarly, the ListIncomingTypedLinks and ListOutgoingTypedLinks API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.
See: typedLinkSpecifier smart constructor.
Instances
Arguments
| :: TypedLinkSchemaAndFacetName | |
| -> ObjectReference | |
| -> ObjectReference | |
| -> TypedLinkSpecifier |
Creates a value of TypedLinkSpecifier with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tlsTypedLinkFacet- Identifies the typed link facet that is associated with the typed link.tlsSourceObjectReference- Identifies the source object that the typed link will attach to.tlsTargetObjectReference- Identifies the target object that the typed link will attach to.tlsIdentityAttributeValues- Identifies the attribute value to update.
tlsTypedLinkFacet :: Lens' TypedLinkSpecifier TypedLinkSchemaAndFacetName Source #
Identifies the typed link facet that is associated with the typed link.
tlsSourceObjectReference :: Lens' TypedLinkSpecifier ObjectReference Source #
Identifies the source object that the typed link will attach to.
tlsTargetObjectReference :: Lens' TypedLinkSpecifier ObjectReference Source #
Identifies the target object that the typed link will attach to.
tlsIdentityAttributeValues :: Lens' TypedLinkSpecifier [AttributeNameAndValue] Source #
Identifies the attribute value to update.