| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudDirectory
Contents
- Service Configuration
- Errors
- AccessDeniedException
- BatchWriteException
- CannotListParentOfRootException
- DirectoryAlreadyExistsException
- DirectoryDeletedException
- DirectoryNotDisabledException
- DirectoryNotEnabledException
- FacetAlreadyExistsException
- FacetInUseException
- FacetNotFoundException
- FacetValidationException
- IncompatibleSchemaException
- IndexedAttributeMissingException
- InternalServiceException
- InvalidArnException
- InvalidAttachmentException
- InvalidFacetUpdateException
- InvalidNextTokenException
- InvalidRuleException
- InvalidSchemaDocException
- InvalidTaggingRequestException
- LimitExceededException
- LinkNameAlreadyInUseException
- NotIndexException
- NotNodeException
- NotPolicyException
- ObjectAlreadyDetachedException
- ObjectNotDetachedException
- ResourceNotFoundException
- RetryableConflictException
- SchemaAlreadyExistsException
- SchemaAlreadyPublishedException
- StillContainsLinksException
- UnsupportedIndexTypeException
- ValidationException
- Waiters
- Operations
- AddFacetToObject
- ApplySchema
- AttachObject
- AttachPolicy
- AttachToIndex
- AttachTypedLink
- BatchRead
- BatchWrite
- CreateDirectory
- CreateFacet
- CreateIndex
- CreateObject
- CreateSchema
- CreateTypedLinkFacet
- DeleteDirectory
- DeleteFacet
- DeleteObject
- DeleteSchema
- DeleteTypedLinkFacet
- DetachFromIndex
- DetachObject
- DetachPolicy
- DetachTypedLink
- DisableDirectory
- EnableDirectory
- GetAppliedSchemaVersion
- GetDirectory
- GetFacet
- GetLinkAttributes
- GetObjectAttributes
- GetObjectInformation
- GetSchemaAsJson
- GetTypedLinkFacetInformation
- ListAppliedSchemaArns (Paginated)
- ListAttachedIndices (Paginated)
- ListDevelopmentSchemaArns (Paginated)
- ListDirectories (Paginated)
- ListFacetAttributes (Paginated)
- ListFacetNames (Paginated)
- ListIncomingTypedLinks (Paginated)
- ListIndex (Paginated)
- ListManagedSchemaArns (Paginated)
- ListObjectAttributes (Paginated)
- ListObjectChildren
- ListObjectParentPaths (Paginated)
- ListObjectParents
- ListObjectPolicies (Paginated)
- ListOutgoingTypedLinks (Paginated)
- ListPolicyAttachments (Paginated)
- ListPublishedSchemaArns (Paginated)
- ListTagsForResource (Paginated)
- ListTypedLinkFacetAttributes (Paginated)
- ListTypedLinkFacetNames (Paginated)
- LookupPolicy (Paginated)
- PublishSchema
- PutSchemaFromJson
- RemoveFacetFromObject
- TagResource
- UntagResource
- UpdateFacet
- UpdateLinkAttributes
- UpdateObjectAttributes
- UpdateSchema
- UpdateTypedLinkFacet
- UpgradeAppliedSchema
- UpgradePublishedSchema
- Types
- BatchReadExceptionType
- ConsistencyLevel
- DirectoryState
- FacetAttributeType
- FacetStyle
- 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
- BatchGetLinkAttributes
- BatchGetLinkAttributesResponse
- BatchGetObjectAttributes
- BatchGetObjectAttributesResponse
- BatchGetObjectInformation
- BatchGetObjectInformationResponse
- BatchListAttachedIndices
- BatchListAttachedIndicesResponse
- BatchListIncomingTypedLinks
- BatchListIncomingTypedLinksResponse
- BatchListIndex
- BatchListIndexResponse
- BatchListObjectAttributes
- BatchListObjectAttributesResponse
- BatchListObjectChildren
- BatchListObjectChildrenResponse
- BatchListObjectParentPaths
- BatchListObjectParentPathsResponse
- BatchListObjectParents
- BatchListObjectParentsResponse
- BatchListObjectPolicies
- BatchListObjectPoliciesResponse
- BatchListOutgoingTypedLinks
- BatchListOutgoingTypedLinksResponse
- BatchListPolicyAttachments
- BatchListPolicyAttachmentsResponse
- BatchLookupPolicy
- BatchLookupPolicyResponse
- BatchReadException
- BatchReadOperation
- BatchReadOperationResponse
- BatchReadSuccessfulResponse
- BatchRemoveFacetFromObject
- BatchRemoveFacetFromObjectResponse
- BatchUpdateLinkAttributes
- BatchUpdateLinkAttributesResponse
- BatchUpdateObjectAttributes
- BatchUpdateObjectAttributesResponse
- BatchWriteOperation
- BatchWriteOperationResponse
- Directory
- Facet
- FacetAttribute
- FacetAttributeDefinition
- FacetAttributeReference
- FacetAttributeUpdate
- IndexAttachment
- LinkAttributeAction
- LinkAttributeUpdate
- ObjectAttributeAction
- ObjectAttributeRange
- ObjectAttributeUpdate
- ObjectIdentifierAndLinkNameTuple
- ObjectReference
- PathToObjectIdentifiers
- PolicyAttachment
- PolicyToPath
- Rule
- SchemaFacet
- Tag
- TypedAttributeValue
- TypedAttributeValueRange
- TypedLinkAttributeDefinition
- TypedLinkAttributeRange
- TypedLinkFacet
- TypedLinkFacetAttributeUpdate
- TypedLinkSchemaAndFacetName
- TypedLinkSpecifier
Description
Derived from API version 2017-01-11 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Cloud Directory
Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about Cloud Directory features, see AWS Directory Service and the Amazon Cloud Directory Developer Guide.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _BatchWriteException :: AsError a => Fold a ServiceError
- _CannotListParentOfRootException :: AsError a => Fold a ServiceError
- _DirectoryAlreadyExistsException :: AsError a => Fold a ServiceError
- _DirectoryDeletedException :: AsError a => Fold a ServiceError
- _DirectoryNotDisabledException :: AsError a => Fold a ServiceError
- _DirectoryNotEnabledException :: AsError a => Fold a ServiceError
- _FacetAlreadyExistsException :: AsError a => Fold a ServiceError
- _FacetInUseException :: AsError a => Fold a ServiceError
- _FacetNotFoundException :: AsError a => Fold a ServiceError
- _FacetValidationException :: AsError a => Fold a ServiceError
- _IncompatibleSchemaException :: AsError a => Fold a ServiceError
- _IndexedAttributeMissingException :: AsError a => Fold a ServiceError
- _InternalServiceException :: AsError a => Fold a ServiceError
- _InvalidArnException :: AsError a => Fold a ServiceError
- _InvalidAttachmentException :: AsError a => Fold a ServiceError
- _InvalidFacetUpdateException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidRuleException :: AsError a => Fold a ServiceError
- _InvalidSchemaDocException :: AsError a => Fold a ServiceError
- _InvalidTaggingRequestException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _LinkNameAlreadyInUseException :: AsError a => Fold a ServiceError
- _NotIndexException :: AsError a => Fold a ServiceError
- _NotNodeException :: AsError a => Fold a ServiceError
- _NotPolicyException :: AsError a => Fold a ServiceError
- _ObjectAlreadyDetachedException :: AsError a => Fold a ServiceError
- _ObjectNotDetachedException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _RetryableConflictException :: AsError a => Fold a ServiceError
- _SchemaAlreadyExistsException :: AsError a => Fold a ServiceError
- _SchemaAlreadyPublishedException :: AsError a => Fold a ServiceError
- _StillContainsLinksException :: AsError a => Fold a ServiceError
- _UnsupportedIndexTypeException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data AddFacetToObject = AddFacetToObject' (Maybe [AttributeKeyAndValue]) Text SchemaFacet ObjectReference
- newAddFacetToObject :: Text -> SchemaFacet -> ObjectReference -> AddFacetToObject
- data AddFacetToObjectResponse = AddFacetToObjectResponse' Int
- newAddFacetToObjectResponse :: Int -> AddFacetToObjectResponse
- data ApplySchema = ApplySchema' Text Text
- newApplySchema :: Text -> Text -> ApplySchema
- data ApplySchemaResponse = ApplySchemaResponse' (Maybe Text) (Maybe Text) Int
- newApplySchemaResponse :: Int -> ApplySchemaResponse
- data AttachObject = AttachObject' Text ObjectReference ObjectReference Text
- newAttachObject :: Text -> ObjectReference -> ObjectReference -> Text -> AttachObject
- data AttachObjectResponse = AttachObjectResponse' (Maybe Text) Int
- newAttachObjectResponse :: Int -> AttachObjectResponse
- data AttachPolicy = AttachPolicy' Text ObjectReference ObjectReference
- newAttachPolicy :: Text -> ObjectReference -> ObjectReference -> AttachPolicy
- data AttachPolicyResponse = AttachPolicyResponse' Int
- newAttachPolicyResponse :: Int -> AttachPolicyResponse
- data AttachToIndex = AttachToIndex' Text ObjectReference ObjectReference
- newAttachToIndex :: Text -> ObjectReference -> ObjectReference -> AttachToIndex
- data AttachToIndexResponse = AttachToIndexResponse' (Maybe Text) Int
- newAttachToIndexResponse :: Int -> AttachToIndexResponse
- data AttachTypedLink = AttachTypedLink' Text ObjectReference ObjectReference TypedLinkSchemaAndFacetName [AttributeNameAndValue]
- newAttachTypedLink :: Text -> ObjectReference -> ObjectReference -> TypedLinkSchemaAndFacetName -> AttachTypedLink
- data AttachTypedLinkResponse = AttachTypedLinkResponse' (Maybe TypedLinkSpecifier) Int
- newAttachTypedLinkResponse :: Int -> AttachTypedLinkResponse
- data BatchRead = BatchRead' (Maybe ConsistencyLevel) Text [BatchReadOperation]
- newBatchRead :: Text -> BatchRead
- data BatchReadResponse = BatchReadResponse' (Maybe [BatchReadOperationResponse]) Int
- newBatchReadResponse :: Int -> BatchReadResponse
- data BatchWrite = BatchWrite' Text [BatchWriteOperation]
- newBatchWrite :: Text -> BatchWrite
- data BatchWriteResponse = BatchWriteResponse' (Maybe [BatchWriteOperationResponse]) Int
- newBatchWriteResponse :: Int -> BatchWriteResponse
- data CreateDirectory = CreateDirectory' Text Text
- newCreateDirectory :: Text -> Text -> CreateDirectory
- data CreateDirectoryResponse = CreateDirectoryResponse' Int Text Text Text Text
- newCreateDirectoryResponse :: Int -> Text -> Text -> Text -> Text -> CreateDirectoryResponse
- data CreateFacet = CreateFacet' (Maybe [FacetAttribute]) (Maybe FacetStyle) (Maybe ObjectType) Text Text
- newCreateFacet :: Text -> Text -> CreateFacet
- data CreateFacetResponse = CreateFacetResponse' Int
- newCreateFacetResponse :: Int -> CreateFacetResponse
- data CreateIndex = CreateIndex' (Maybe Text) (Maybe ObjectReference) Text [AttributeKey] Bool
- newCreateIndex :: Text -> Bool -> CreateIndex
- data CreateIndexResponse = CreateIndexResponse' (Maybe Text) Int
- newCreateIndexResponse :: Int -> CreateIndexResponse
- data CreateObject = CreateObject' (Maybe Text) (Maybe [AttributeKeyAndValue]) (Maybe ObjectReference) Text [SchemaFacet]
- newCreateObject :: Text -> CreateObject
- data CreateObjectResponse = CreateObjectResponse' (Maybe Text) Int
- newCreateObjectResponse :: Int -> CreateObjectResponse
- data CreateSchema = CreateSchema' Text
- newCreateSchema :: Text -> CreateSchema
- data CreateSchemaResponse = CreateSchemaResponse' (Maybe Text) Int
- newCreateSchemaResponse :: Int -> CreateSchemaResponse
- data CreateTypedLinkFacet = CreateTypedLinkFacet' Text TypedLinkFacet
- newCreateTypedLinkFacet :: Text -> TypedLinkFacet -> CreateTypedLinkFacet
- data CreateTypedLinkFacetResponse = CreateTypedLinkFacetResponse' Int
- newCreateTypedLinkFacetResponse :: Int -> CreateTypedLinkFacetResponse
- data DeleteDirectory = DeleteDirectory' Text
- newDeleteDirectory :: Text -> DeleteDirectory
- data DeleteDirectoryResponse = DeleteDirectoryResponse' Int Text
- newDeleteDirectoryResponse :: Int -> Text -> DeleteDirectoryResponse
- data DeleteFacet = DeleteFacet' Text Text
- newDeleteFacet :: Text -> Text -> DeleteFacet
- data DeleteFacetResponse = DeleteFacetResponse' Int
- newDeleteFacetResponse :: Int -> DeleteFacetResponse
- data DeleteObject = DeleteObject' Text ObjectReference
- newDeleteObject :: Text -> ObjectReference -> DeleteObject
- data DeleteObjectResponse = DeleteObjectResponse' Int
- newDeleteObjectResponse :: Int -> DeleteObjectResponse
- data DeleteSchema = DeleteSchema' Text
- newDeleteSchema :: Text -> DeleteSchema
- data DeleteSchemaResponse = DeleteSchemaResponse' (Maybe Text) Int
- newDeleteSchemaResponse :: Int -> DeleteSchemaResponse
- data DeleteTypedLinkFacet = DeleteTypedLinkFacet' Text Text
- newDeleteTypedLinkFacet :: Text -> Text -> DeleteTypedLinkFacet
- data DeleteTypedLinkFacetResponse = DeleteTypedLinkFacetResponse' Int
- newDeleteTypedLinkFacetResponse :: Int -> DeleteTypedLinkFacetResponse
- data DetachFromIndex = DetachFromIndex' Text ObjectReference ObjectReference
- newDetachFromIndex :: Text -> ObjectReference -> ObjectReference -> DetachFromIndex
- data DetachFromIndexResponse = DetachFromIndexResponse' (Maybe Text) Int
- newDetachFromIndexResponse :: Int -> DetachFromIndexResponse
- data DetachObject = DetachObject' Text ObjectReference Text
- newDetachObject :: Text -> ObjectReference -> Text -> DetachObject
- data DetachObjectResponse = DetachObjectResponse' (Maybe Text) Int
- newDetachObjectResponse :: Int -> DetachObjectResponse
- data DetachPolicy = DetachPolicy' Text ObjectReference ObjectReference
- newDetachPolicy :: Text -> ObjectReference -> ObjectReference -> DetachPolicy
- data DetachPolicyResponse = DetachPolicyResponse' Int
- newDetachPolicyResponse :: Int -> DetachPolicyResponse
- data DetachTypedLink = DetachTypedLink' Text TypedLinkSpecifier
- newDetachTypedLink :: Text -> TypedLinkSpecifier -> DetachTypedLink
- data DetachTypedLinkResponse = DetachTypedLinkResponse' {
- newDetachTypedLinkResponse :: DetachTypedLinkResponse
- data DisableDirectory = DisableDirectory' Text
- newDisableDirectory :: Text -> DisableDirectory
- data DisableDirectoryResponse = DisableDirectoryResponse' Int Text
- newDisableDirectoryResponse :: Int -> Text -> DisableDirectoryResponse
- data EnableDirectory = EnableDirectory' Text
- newEnableDirectory :: Text -> EnableDirectory
- data EnableDirectoryResponse = EnableDirectoryResponse' Int Text
- newEnableDirectoryResponse :: Int -> Text -> EnableDirectoryResponse
- data GetAppliedSchemaVersion = GetAppliedSchemaVersion' Text
- newGetAppliedSchemaVersion :: Text -> GetAppliedSchemaVersion
- data GetAppliedSchemaVersionResponse = GetAppliedSchemaVersionResponse' (Maybe Text) Int
- newGetAppliedSchemaVersionResponse :: Int -> GetAppliedSchemaVersionResponse
- data GetDirectory = GetDirectory' Text
- newGetDirectory :: Text -> GetDirectory
- data GetDirectoryResponse = GetDirectoryResponse' Int Directory
- newGetDirectoryResponse :: Int -> Directory -> GetDirectoryResponse
- data GetFacet = GetFacet' Text Text
- newGetFacet :: Text -> Text -> GetFacet
- data GetFacetResponse = GetFacetResponse' (Maybe Facet) Int
- newGetFacetResponse :: Int -> GetFacetResponse
- data GetLinkAttributes = GetLinkAttributes' (Maybe ConsistencyLevel) Text TypedLinkSpecifier [Text]
- newGetLinkAttributes :: Text -> TypedLinkSpecifier -> GetLinkAttributes
- data GetLinkAttributesResponse = GetLinkAttributesResponse' (Maybe [AttributeKeyAndValue]) Int
- newGetLinkAttributesResponse :: Int -> GetLinkAttributesResponse
- data GetObjectAttributes = GetObjectAttributes' (Maybe ConsistencyLevel) Text ObjectReference SchemaFacet [Text]
- newGetObjectAttributes :: Text -> ObjectReference -> SchemaFacet -> GetObjectAttributes
- data GetObjectAttributesResponse = GetObjectAttributesResponse' (Maybe [AttributeKeyAndValue]) Int
- newGetObjectAttributesResponse :: Int -> GetObjectAttributesResponse
- data GetObjectInformation = GetObjectInformation' (Maybe ConsistencyLevel) Text ObjectReference
- newGetObjectInformation :: Text -> ObjectReference -> GetObjectInformation
- data GetObjectInformationResponse = GetObjectInformationResponse' (Maybe Text) (Maybe [SchemaFacet]) Int
- newGetObjectInformationResponse :: Int -> GetObjectInformationResponse
- data GetSchemaAsJson = GetSchemaAsJson' Text
- newGetSchemaAsJson :: Text -> GetSchemaAsJson
- data GetSchemaAsJsonResponse = GetSchemaAsJsonResponse' (Maybe Text) (Maybe Text) Int
- newGetSchemaAsJsonResponse :: Int -> GetSchemaAsJsonResponse
- data GetTypedLinkFacetInformation = GetTypedLinkFacetInformation' Text Text
- newGetTypedLinkFacetInformation :: Text -> Text -> GetTypedLinkFacetInformation
- data GetTypedLinkFacetInformationResponse = GetTypedLinkFacetInformationResponse' (Maybe [Text]) Int
- newGetTypedLinkFacetInformationResponse :: Int -> GetTypedLinkFacetInformationResponse
- data ListAppliedSchemaArns = ListAppliedSchemaArns' (Maybe Natural) (Maybe Text) (Maybe Text) Text
- newListAppliedSchemaArns :: Text -> ListAppliedSchemaArns
- data ListAppliedSchemaArnsResponse = ListAppliedSchemaArnsResponse' (Maybe Text) (Maybe [Text]) Int
- newListAppliedSchemaArnsResponse :: Int -> ListAppliedSchemaArnsResponse
- data ListAttachedIndices = ListAttachedIndices' (Maybe ConsistencyLevel) (Maybe Natural) (Maybe Text) Text ObjectReference
- newListAttachedIndices :: Text -> ObjectReference -> ListAttachedIndices
- data ListAttachedIndicesResponse = ListAttachedIndicesResponse' (Maybe [IndexAttachment]) (Maybe Text) Int
- newListAttachedIndicesResponse :: Int -> ListAttachedIndicesResponse
- data ListDevelopmentSchemaArns = ListDevelopmentSchemaArns' (Maybe Natural) (Maybe Text)
- newListDevelopmentSchemaArns :: ListDevelopmentSchemaArns
- data ListDevelopmentSchemaArnsResponse = ListDevelopmentSchemaArnsResponse' (Maybe Text) (Maybe [Text]) Int
- newListDevelopmentSchemaArnsResponse :: Int -> ListDevelopmentSchemaArnsResponse
- data ListDirectories = ListDirectories' (Maybe Natural) (Maybe Text) (Maybe DirectoryState)
- newListDirectories :: ListDirectories
- data ListDirectoriesResponse = ListDirectoriesResponse' (Maybe Text) Int [Directory]
- newListDirectoriesResponse :: Int -> ListDirectoriesResponse
- data ListFacetAttributes = ListFacetAttributes' (Maybe Natural) (Maybe Text) Text Text
- newListFacetAttributes :: Text -> Text -> ListFacetAttributes
- data ListFacetAttributesResponse = ListFacetAttributesResponse' (Maybe [FacetAttribute]) (Maybe Text) Int
- newListFacetAttributesResponse :: Int -> ListFacetAttributesResponse
- data ListFacetNames = ListFacetNames' (Maybe Natural) (Maybe Text) Text
- newListFacetNames :: Text -> ListFacetNames
- data ListFacetNamesResponse = ListFacetNamesResponse' (Maybe [Text]) (Maybe Text) Int
- newListFacetNamesResponse :: Int -> ListFacetNamesResponse
- data ListIncomingTypedLinks = ListIncomingTypedLinks' (Maybe ConsistencyLevel) (Maybe [TypedLinkAttributeRange]) (Maybe TypedLinkSchemaAndFacetName) (Maybe Natural) (Maybe Text) Text ObjectReference
- newListIncomingTypedLinks :: Text -> ObjectReference -> ListIncomingTypedLinks
- data ListIncomingTypedLinksResponse = ListIncomingTypedLinksResponse' (Maybe [TypedLinkSpecifier]) (Maybe Text) Int
- newListIncomingTypedLinksResponse :: Int -> ListIncomingTypedLinksResponse
- data ListIndex = ListIndex' (Maybe ConsistencyLevel) (Maybe Natural) (Maybe Text) (Maybe [ObjectAttributeRange]) Text ObjectReference
- newListIndex :: Text -> ObjectReference -> ListIndex
- data ListIndexResponse = ListIndexResponse' (Maybe [IndexAttachment]) (Maybe Text) Int
- newListIndexResponse :: Int -> ListIndexResponse
- data ListManagedSchemaArns = ListManagedSchemaArns' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListManagedSchemaArns :: ListManagedSchemaArns
- data ListManagedSchemaArnsResponse = ListManagedSchemaArnsResponse' (Maybe Text) (Maybe [Text]) Int
- newListManagedSchemaArnsResponse :: Int -> ListManagedSchemaArnsResponse
- data ListObjectAttributes = ListObjectAttributes' (Maybe ConsistencyLevel) (Maybe SchemaFacet) (Maybe Natural) (Maybe Text) Text ObjectReference
- newListObjectAttributes :: Text -> ObjectReference -> ListObjectAttributes
- data ListObjectAttributesResponse = ListObjectAttributesResponse' (Maybe [AttributeKeyAndValue]) (Maybe Text) Int
- newListObjectAttributesResponse :: Int -> ListObjectAttributesResponse
- data ListObjectChildren = ListObjectChildren' (Maybe ConsistencyLevel) (Maybe Natural) (Maybe Text) Text ObjectReference
- newListObjectChildren :: Text -> ObjectReference -> ListObjectChildren
- data ListObjectChildrenResponse = ListObjectChildrenResponse' (Maybe (HashMap Text Text)) (Maybe Text) Int
- newListObjectChildrenResponse :: Int -> ListObjectChildrenResponse
- data ListObjectParentPaths = ListObjectParentPaths' (Maybe Natural) (Maybe Text) Text ObjectReference
- newListObjectParentPaths :: Text -> ObjectReference -> ListObjectParentPaths
- data ListObjectParentPathsResponse = ListObjectParentPathsResponse' (Maybe Text) (Maybe [PathToObjectIdentifiers]) Int
- newListObjectParentPathsResponse :: Int -> ListObjectParentPathsResponse
- data ListObjectParents = ListObjectParents' (Maybe ConsistencyLevel) (Maybe Bool) (Maybe Natural) (Maybe Text) Text ObjectReference
- newListObjectParents :: Text -> ObjectReference -> ListObjectParents
- data ListObjectParentsResponse = ListObjectParentsResponse' (Maybe Text) (Maybe [ObjectIdentifierAndLinkNameTuple]) (Maybe (HashMap Text Text)) Int
- newListObjectParentsResponse :: Int -> ListObjectParentsResponse
- data ListObjectPolicies = ListObjectPolicies' (Maybe ConsistencyLevel) (Maybe Natural) (Maybe Text) Text ObjectReference
- newListObjectPolicies :: Text -> ObjectReference -> ListObjectPolicies
- data ListObjectPoliciesResponse = ListObjectPoliciesResponse' (Maybe [Text]) (Maybe Text) Int
- newListObjectPoliciesResponse :: Int -> ListObjectPoliciesResponse
- data ListOutgoingTypedLinks = ListOutgoingTypedLinks' (Maybe ConsistencyLevel) (Maybe [TypedLinkAttributeRange]) (Maybe TypedLinkSchemaAndFacetName) (Maybe Natural) (Maybe Text) Text ObjectReference
- newListOutgoingTypedLinks :: Text -> ObjectReference -> ListOutgoingTypedLinks
- data ListOutgoingTypedLinksResponse = ListOutgoingTypedLinksResponse' (Maybe Text) (Maybe [TypedLinkSpecifier]) Int
- newListOutgoingTypedLinksResponse :: Int -> ListOutgoingTypedLinksResponse
- data ListPolicyAttachments = ListPolicyAttachments' (Maybe ConsistencyLevel) (Maybe Natural) (Maybe Text) Text ObjectReference
- newListPolicyAttachments :: Text -> ObjectReference -> ListPolicyAttachments
- data ListPolicyAttachmentsResponse = ListPolicyAttachmentsResponse' (Maybe Text) (Maybe [Text]) Int
- newListPolicyAttachmentsResponse :: Int -> ListPolicyAttachmentsResponse
- data ListPublishedSchemaArns = ListPublishedSchemaArns' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListPublishedSchemaArns :: ListPublishedSchemaArns
- data ListPublishedSchemaArnsResponse = ListPublishedSchemaArnsResponse' (Maybe Text) (Maybe [Text]) Int
- newListPublishedSchemaArnsResponse :: Int -> ListPublishedSchemaArnsResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListTypedLinkFacetAttributes = ListTypedLinkFacetAttributes' (Maybe Natural) (Maybe Text) Text Text
- newListTypedLinkFacetAttributes :: Text -> Text -> ListTypedLinkFacetAttributes
- data ListTypedLinkFacetAttributesResponse = ListTypedLinkFacetAttributesResponse' (Maybe [TypedLinkAttributeDefinition]) (Maybe Text) Int
- newListTypedLinkFacetAttributesResponse :: Int -> ListTypedLinkFacetAttributesResponse
- data ListTypedLinkFacetNames = ListTypedLinkFacetNames' (Maybe Natural) (Maybe Text) Text
- newListTypedLinkFacetNames :: Text -> ListTypedLinkFacetNames
- data ListTypedLinkFacetNamesResponse = ListTypedLinkFacetNamesResponse' (Maybe [Text]) (Maybe Text) Int
- newListTypedLinkFacetNamesResponse :: Int -> ListTypedLinkFacetNamesResponse
- data LookupPolicy = LookupPolicy' (Maybe Natural) (Maybe Text) Text ObjectReference
- newLookupPolicy :: Text -> ObjectReference -> LookupPolicy
- data LookupPolicyResponse = LookupPolicyResponse' (Maybe Text) (Maybe [PolicyToPath]) Int
- newLookupPolicyResponse :: Int -> LookupPolicyResponse
- data PublishSchema = PublishSchema' (Maybe Text) (Maybe Text) Text Text
- newPublishSchema :: Text -> Text -> PublishSchema
- data PublishSchemaResponse = PublishSchemaResponse' (Maybe Text) Int
- newPublishSchemaResponse :: Int -> PublishSchemaResponse
- data PutSchemaFromJson = PutSchemaFromJson' Text Text
- newPutSchemaFromJson :: Text -> Text -> PutSchemaFromJson
- data PutSchemaFromJsonResponse = PutSchemaFromJsonResponse' (Maybe Text) Int
- newPutSchemaFromJsonResponse :: Int -> PutSchemaFromJsonResponse
- data RemoveFacetFromObject = RemoveFacetFromObject' Text SchemaFacet ObjectReference
- newRemoveFacetFromObject :: Text -> SchemaFacet -> ObjectReference -> RemoveFacetFromObject
- data RemoveFacetFromObjectResponse = RemoveFacetFromObjectResponse' Int
- newRemoveFacetFromObjectResponse :: Int -> RemoveFacetFromObjectResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateFacet = UpdateFacet' (Maybe [FacetAttributeUpdate]) (Maybe ObjectType) Text Text
- newUpdateFacet :: Text -> Text -> UpdateFacet
- data UpdateFacetResponse = UpdateFacetResponse' Int
- newUpdateFacetResponse :: Int -> UpdateFacetResponse
- data UpdateLinkAttributes = UpdateLinkAttributes' Text TypedLinkSpecifier [LinkAttributeUpdate]
- newUpdateLinkAttributes :: Text -> TypedLinkSpecifier -> UpdateLinkAttributes
- data UpdateLinkAttributesResponse = UpdateLinkAttributesResponse' Int
- newUpdateLinkAttributesResponse :: Int -> UpdateLinkAttributesResponse
- data UpdateObjectAttributes = UpdateObjectAttributes' Text ObjectReference [ObjectAttributeUpdate]
- newUpdateObjectAttributes :: Text -> ObjectReference -> UpdateObjectAttributes
- data UpdateObjectAttributesResponse = UpdateObjectAttributesResponse' (Maybe Text) Int
- newUpdateObjectAttributesResponse :: Int -> UpdateObjectAttributesResponse
- data UpdateSchema = UpdateSchema' Text Text
- newUpdateSchema :: Text -> Text -> UpdateSchema
- data UpdateSchemaResponse = UpdateSchemaResponse' (Maybe Text) Int
- newUpdateSchemaResponse :: Int -> UpdateSchemaResponse
- data UpdateTypedLinkFacet = UpdateTypedLinkFacet' Text Text [TypedLinkFacetAttributeUpdate] [Text]
- newUpdateTypedLinkFacet :: Text -> Text -> UpdateTypedLinkFacet
- data UpdateTypedLinkFacetResponse = UpdateTypedLinkFacetResponse' Int
- newUpdateTypedLinkFacetResponse :: Int -> UpdateTypedLinkFacetResponse
- data UpgradeAppliedSchema = UpgradeAppliedSchema' (Maybe Bool) Text Text
- newUpgradeAppliedSchema :: Text -> Text -> UpgradeAppliedSchema
- data UpgradeAppliedSchemaResponse = UpgradeAppliedSchemaResponse' (Maybe Text) (Maybe Text) Int
- newUpgradeAppliedSchemaResponse :: Int -> UpgradeAppliedSchemaResponse
- data UpgradePublishedSchema = UpgradePublishedSchema' (Maybe Bool) Text Text Text
- newUpgradePublishedSchema :: Text -> Text -> Text -> UpgradePublishedSchema
- data UpgradePublishedSchemaResponse = UpgradePublishedSchemaResponse' (Maybe Text) Int
- newUpgradePublishedSchemaResponse :: Int -> UpgradePublishedSchemaResponse
- newtype BatchReadExceptionType where
- BatchReadExceptionType' { }
- pattern BatchReadExceptionType_AccessDeniedException :: BatchReadExceptionType
- pattern BatchReadExceptionType_CannotListParentOfRootException :: BatchReadExceptionType
- pattern BatchReadExceptionType_DirectoryNotEnabledException :: BatchReadExceptionType
- pattern BatchReadExceptionType_FacetValidationException :: BatchReadExceptionType
- pattern BatchReadExceptionType_InternalServiceException :: BatchReadExceptionType
- pattern BatchReadExceptionType_InvalidArnException :: BatchReadExceptionType
- pattern BatchReadExceptionType_InvalidNextTokenException :: BatchReadExceptionType
- pattern BatchReadExceptionType_LimitExceededException :: BatchReadExceptionType
- pattern BatchReadExceptionType_NotIndexException :: BatchReadExceptionType
- pattern BatchReadExceptionType_NotNodeException :: BatchReadExceptionType
- pattern BatchReadExceptionType_NotPolicyException :: BatchReadExceptionType
- pattern BatchReadExceptionType_ResourceNotFoundException :: BatchReadExceptionType
- pattern BatchReadExceptionType_ValidationException :: BatchReadExceptionType
- newtype ConsistencyLevel where
- ConsistencyLevel' { }
- pattern ConsistencyLevel_EVENTUAL :: ConsistencyLevel
- pattern ConsistencyLevel_SERIALIZABLE :: ConsistencyLevel
- newtype DirectoryState where
- DirectoryState' { }
- pattern DirectoryState_DELETED :: DirectoryState
- pattern DirectoryState_DISABLED :: DirectoryState
- pattern DirectoryState_ENABLED :: DirectoryState
- newtype FacetAttributeType where
- FacetAttributeType' { }
- pattern FacetAttributeType_BINARY :: FacetAttributeType
- pattern FacetAttributeType_BOOLEAN :: FacetAttributeType
- pattern FacetAttributeType_DATETIME :: FacetAttributeType
- pattern FacetAttributeType_NUMBER :: FacetAttributeType
- pattern FacetAttributeType_STRING :: FacetAttributeType
- pattern FacetAttributeType_VARIANT :: FacetAttributeType
- newtype FacetStyle where
- FacetStyle' { }
- pattern FacetStyle_DYNAMIC :: FacetStyle
- pattern FacetStyle_STATIC :: FacetStyle
- newtype ObjectType where
- ObjectType' { }
- pattern ObjectType_INDEX :: ObjectType
- pattern ObjectType_LEAF_NODE :: ObjectType
- pattern ObjectType_NODE :: ObjectType
- pattern ObjectType_POLICY :: ObjectType
- newtype RangeMode where
- RangeMode' { }
- pattern RangeMode_EXCLUSIVE :: RangeMode
- pattern RangeMode_FIRST :: RangeMode
- pattern RangeMode_INCLUSIVE :: RangeMode
- pattern RangeMode_LAST :: RangeMode
- pattern RangeMode_LAST_BEFORE_MISSING_VALUES :: RangeMode
- newtype RequiredAttributeBehavior where
- newtype RuleType where
- RuleType' {
- fromRuleType :: Text
- pattern RuleType_BINARY_LENGTH :: RuleType
- pattern RuleType_NUMBER_COMPARISON :: RuleType
- pattern RuleType_STRING_FROM_SET :: RuleType
- pattern RuleType_STRING_LENGTH :: RuleType
- RuleType' {
- newtype UpdateActionType where
- UpdateActionType' { }
- pattern UpdateActionType_CREATE_OR_UPDATE :: UpdateActionType
- pattern UpdateActionType_DELETE :: UpdateActionType
- data AttributeKey = AttributeKey' Text Text Text
- newAttributeKey :: Text -> Text -> Text -> AttributeKey
- data AttributeKeyAndValue = AttributeKeyAndValue' AttributeKey TypedAttributeValue
- newAttributeKeyAndValue :: AttributeKey -> TypedAttributeValue -> AttributeKeyAndValue
- data AttributeNameAndValue = AttributeNameAndValue' Text TypedAttributeValue
- newAttributeNameAndValue :: Text -> TypedAttributeValue -> AttributeNameAndValue
- data BatchAddFacetToObject = BatchAddFacetToObject' SchemaFacet [AttributeKeyAndValue] ObjectReference
- newBatchAddFacetToObject :: SchemaFacet -> ObjectReference -> BatchAddFacetToObject
- data BatchAddFacetToObjectResponse = BatchAddFacetToObjectResponse' {
- newBatchAddFacetToObjectResponse :: BatchAddFacetToObjectResponse
- data BatchAttachObject = BatchAttachObject' ObjectReference ObjectReference Text
- newBatchAttachObject :: ObjectReference -> ObjectReference -> Text -> BatchAttachObject
- data BatchAttachObjectResponse = BatchAttachObjectResponse' (Maybe Text)
- newBatchAttachObjectResponse :: BatchAttachObjectResponse
- data BatchAttachPolicy = BatchAttachPolicy' ObjectReference ObjectReference
- newBatchAttachPolicy :: ObjectReference -> ObjectReference -> BatchAttachPolicy
- data BatchAttachPolicyResponse = BatchAttachPolicyResponse' {
- newBatchAttachPolicyResponse :: BatchAttachPolicyResponse
- data BatchAttachToIndex = BatchAttachToIndex' ObjectReference ObjectReference
- newBatchAttachToIndex :: ObjectReference -> ObjectReference -> BatchAttachToIndex
- data BatchAttachToIndexResponse = BatchAttachToIndexResponse' (Maybe Text)
- newBatchAttachToIndexResponse :: BatchAttachToIndexResponse
- data BatchAttachTypedLink = BatchAttachTypedLink' ObjectReference ObjectReference TypedLinkSchemaAndFacetName [AttributeNameAndValue]
- newBatchAttachTypedLink :: ObjectReference -> ObjectReference -> TypedLinkSchemaAndFacetName -> BatchAttachTypedLink
- data BatchAttachTypedLinkResponse = BatchAttachTypedLinkResponse' (Maybe TypedLinkSpecifier)
- newBatchAttachTypedLinkResponse :: BatchAttachTypedLinkResponse
- data BatchCreateIndex = BatchCreateIndex' (Maybe Text) (Maybe Text) (Maybe ObjectReference) [AttributeKey] Bool
- newBatchCreateIndex :: Bool -> BatchCreateIndex
- data BatchCreateIndexResponse = BatchCreateIndexResponse' (Maybe Text)
- newBatchCreateIndexResponse :: BatchCreateIndexResponse
- data BatchCreateObject = BatchCreateObject' (Maybe Text) (Maybe Text) (Maybe ObjectReference) [SchemaFacet] [AttributeKeyAndValue]
- newBatchCreateObject :: BatchCreateObject
- data BatchCreateObjectResponse = BatchCreateObjectResponse' (Maybe Text)
- newBatchCreateObjectResponse :: BatchCreateObjectResponse
- data BatchDeleteObject = BatchDeleteObject' ObjectReference
- newBatchDeleteObject :: ObjectReference -> BatchDeleteObject
- data BatchDeleteObjectResponse = BatchDeleteObjectResponse' {
- newBatchDeleteObjectResponse :: BatchDeleteObjectResponse
- data BatchDetachFromIndex = BatchDetachFromIndex' ObjectReference ObjectReference
- newBatchDetachFromIndex :: ObjectReference -> ObjectReference -> BatchDetachFromIndex
- data BatchDetachFromIndexResponse = BatchDetachFromIndexResponse' (Maybe Text)
- newBatchDetachFromIndexResponse :: BatchDetachFromIndexResponse
- data BatchDetachObject = BatchDetachObject' (Maybe Text) ObjectReference Text
- newBatchDetachObject :: ObjectReference -> Text -> BatchDetachObject
- data BatchDetachObjectResponse = BatchDetachObjectResponse' (Maybe Text)
- newBatchDetachObjectResponse :: BatchDetachObjectResponse
- data BatchDetachPolicy = BatchDetachPolicy' ObjectReference ObjectReference
- newBatchDetachPolicy :: ObjectReference -> ObjectReference -> BatchDetachPolicy
- data BatchDetachPolicyResponse = BatchDetachPolicyResponse' {
- newBatchDetachPolicyResponse :: BatchDetachPolicyResponse
- data BatchDetachTypedLink = BatchDetachTypedLink' TypedLinkSpecifier
- newBatchDetachTypedLink :: TypedLinkSpecifier -> BatchDetachTypedLink
- data BatchDetachTypedLinkResponse = BatchDetachTypedLinkResponse' {
- newBatchDetachTypedLinkResponse :: BatchDetachTypedLinkResponse
- data BatchGetLinkAttributes = BatchGetLinkAttributes' TypedLinkSpecifier [Text]
- newBatchGetLinkAttributes :: TypedLinkSpecifier -> BatchGetLinkAttributes
- data BatchGetLinkAttributesResponse = BatchGetLinkAttributesResponse' (Maybe [AttributeKeyAndValue])
- newBatchGetLinkAttributesResponse :: BatchGetLinkAttributesResponse
- data BatchGetObjectAttributes = BatchGetObjectAttributes' ObjectReference SchemaFacet [Text]
- newBatchGetObjectAttributes :: ObjectReference -> SchemaFacet -> BatchGetObjectAttributes
- data BatchGetObjectAttributesResponse = BatchGetObjectAttributesResponse' (Maybe [AttributeKeyAndValue])
- newBatchGetObjectAttributesResponse :: BatchGetObjectAttributesResponse
- data BatchGetObjectInformation = BatchGetObjectInformation' ObjectReference
- newBatchGetObjectInformation :: ObjectReference -> BatchGetObjectInformation
- data BatchGetObjectInformationResponse = BatchGetObjectInformationResponse' (Maybe Text) (Maybe [SchemaFacet])
- newBatchGetObjectInformationResponse :: BatchGetObjectInformationResponse
- data BatchListAttachedIndices = BatchListAttachedIndices' (Maybe Natural) (Maybe Text) ObjectReference
- newBatchListAttachedIndices :: ObjectReference -> BatchListAttachedIndices
- data BatchListAttachedIndicesResponse = BatchListAttachedIndicesResponse' (Maybe [IndexAttachment]) (Maybe Text)
- newBatchListAttachedIndicesResponse :: BatchListAttachedIndicesResponse
- data BatchListIncomingTypedLinks = BatchListIncomingTypedLinks' (Maybe [TypedLinkAttributeRange]) (Maybe TypedLinkSchemaAndFacetName) (Maybe Natural) (Maybe Text) ObjectReference
- newBatchListIncomingTypedLinks :: ObjectReference -> BatchListIncomingTypedLinks
- data BatchListIncomingTypedLinksResponse = BatchListIncomingTypedLinksResponse' (Maybe [TypedLinkSpecifier]) (Maybe Text)
- newBatchListIncomingTypedLinksResponse :: BatchListIncomingTypedLinksResponse
- data BatchListIndex = BatchListIndex' (Maybe Natural) (Maybe Text) (Maybe [ObjectAttributeRange]) ObjectReference
- newBatchListIndex :: ObjectReference -> BatchListIndex
- data BatchListIndexResponse = BatchListIndexResponse' (Maybe [IndexAttachment]) (Maybe Text)
- newBatchListIndexResponse :: BatchListIndexResponse
- data BatchListObjectAttributes = BatchListObjectAttributes' (Maybe SchemaFacet) (Maybe Natural) (Maybe Text) ObjectReference
- newBatchListObjectAttributes :: ObjectReference -> BatchListObjectAttributes
- data BatchListObjectAttributesResponse = BatchListObjectAttributesResponse' (Maybe [AttributeKeyAndValue]) (Maybe Text)
- newBatchListObjectAttributesResponse :: BatchListObjectAttributesResponse
- data BatchListObjectChildren = BatchListObjectChildren' (Maybe Natural) (Maybe Text) ObjectReference
- newBatchListObjectChildren :: ObjectReference -> BatchListObjectChildren
- data BatchListObjectChildrenResponse = BatchListObjectChildrenResponse' (Maybe (HashMap Text Text)) (Maybe Text)
- newBatchListObjectChildrenResponse :: BatchListObjectChildrenResponse
- data BatchListObjectParentPaths = BatchListObjectParentPaths' (Maybe Natural) (Maybe Text) ObjectReference
- newBatchListObjectParentPaths :: ObjectReference -> BatchListObjectParentPaths
- data BatchListObjectParentPathsResponse = BatchListObjectParentPathsResponse' (Maybe Text) (Maybe [PathToObjectIdentifiers])
- newBatchListObjectParentPathsResponse :: BatchListObjectParentPathsResponse
- data BatchListObjectParents = BatchListObjectParents' (Maybe Natural) (Maybe Text) ObjectReference
- newBatchListObjectParents :: ObjectReference -> BatchListObjectParents
- data BatchListObjectParentsResponse = BatchListObjectParentsResponse' (Maybe Text) (Maybe [ObjectIdentifierAndLinkNameTuple])
- newBatchListObjectParentsResponse :: BatchListObjectParentsResponse
- data BatchListObjectPolicies = BatchListObjectPolicies' (Maybe Natural) (Maybe Text) ObjectReference
- newBatchListObjectPolicies :: ObjectReference -> BatchListObjectPolicies
- data BatchListObjectPoliciesResponse = BatchListObjectPoliciesResponse' (Maybe [Text]) (Maybe Text)
- newBatchListObjectPoliciesResponse :: BatchListObjectPoliciesResponse
- data BatchListOutgoingTypedLinks = BatchListOutgoingTypedLinks' (Maybe [TypedLinkAttributeRange]) (Maybe TypedLinkSchemaAndFacetName) (Maybe Natural) (Maybe Text) ObjectReference
- newBatchListOutgoingTypedLinks :: ObjectReference -> BatchListOutgoingTypedLinks
- data BatchListOutgoingTypedLinksResponse = BatchListOutgoingTypedLinksResponse' (Maybe Text) (Maybe [TypedLinkSpecifier])
- newBatchListOutgoingTypedLinksResponse :: BatchListOutgoingTypedLinksResponse
- data BatchListPolicyAttachments = BatchListPolicyAttachments' (Maybe Natural) (Maybe Text) ObjectReference
- newBatchListPolicyAttachments :: ObjectReference -> BatchListPolicyAttachments
- data BatchListPolicyAttachmentsResponse = BatchListPolicyAttachmentsResponse' (Maybe Text) (Maybe [Text])
- newBatchListPolicyAttachmentsResponse :: BatchListPolicyAttachmentsResponse
- data BatchLookupPolicy = BatchLookupPolicy' (Maybe Natural) (Maybe Text) ObjectReference
- newBatchLookupPolicy :: ObjectReference -> BatchLookupPolicy
- data BatchLookupPolicyResponse = BatchLookupPolicyResponse' (Maybe Text) (Maybe [PolicyToPath])
- newBatchLookupPolicyResponse :: BatchLookupPolicyResponse
- data BatchReadException = BatchReadException' (Maybe Text) (Maybe BatchReadExceptionType)
- newBatchReadException :: BatchReadException
- data BatchReadOperation = BatchReadOperation' (Maybe BatchGetLinkAttributes) (Maybe BatchGetObjectAttributes) (Maybe BatchGetObjectInformation) (Maybe BatchListAttachedIndices) (Maybe BatchListIncomingTypedLinks) (Maybe BatchListIndex) (Maybe BatchListObjectAttributes) (Maybe BatchListObjectChildren) (Maybe BatchListObjectParentPaths) (Maybe BatchListObjectParents) (Maybe BatchListObjectPolicies) (Maybe BatchListOutgoingTypedLinks) (Maybe BatchListPolicyAttachments) (Maybe BatchLookupPolicy)
- newBatchReadOperation :: BatchReadOperation
- data BatchReadOperationResponse = BatchReadOperationResponse' (Maybe BatchReadException) (Maybe BatchReadSuccessfulResponse)
- newBatchReadOperationResponse :: BatchReadOperationResponse
- data BatchReadSuccessfulResponse = BatchReadSuccessfulResponse' (Maybe BatchGetLinkAttributesResponse) (Maybe BatchGetObjectAttributesResponse) (Maybe BatchGetObjectInformationResponse) (Maybe BatchListAttachedIndicesResponse) (Maybe BatchListIncomingTypedLinksResponse) (Maybe BatchListIndexResponse) (Maybe BatchListObjectAttributesResponse) (Maybe BatchListObjectChildrenResponse) (Maybe BatchListObjectParentPathsResponse) (Maybe BatchListObjectParentsResponse) (Maybe BatchListObjectPoliciesResponse) (Maybe BatchListOutgoingTypedLinksResponse) (Maybe BatchListPolicyAttachmentsResponse) (Maybe BatchLookupPolicyResponse)
- newBatchReadSuccessfulResponse :: BatchReadSuccessfulResponse
- data BatchRemoveFacetFromObject = BatchRemoveFacetFromObject' SchemaFacet ObjectReference
- newBatchRemoveFacetFromObject :: SchemaFacet -> ObjectReference -> BatchRemoveFacetFromObject
- data BatchRemoveFacetFromObjectResponse = BatchRemoveFacetFromObjectResponse' {
- newBatchRemoveFacetFromObjectResponse :: BatchRemoveFacetFromObjectResponse
- data BatchUpdateLinkAttributes = BatchUpdateLinkAttributes' TypedLinkSpecifier [LinkAttributeUpdate]
- newBatchUpdateLinkAttributes :: TypedLinkSpecifier -> BatchUpdateLinkAttributes
- data BatchUpdateLinkAttributesResponse = BatchUpdateLinkAttributesResponse' {
- newBatchUpdateLinkAttributesResponse :: BatchUpdateLinkAttributesResponse
- data BatchUpdateObjectAttributes = BatchUpdateObjectAttributes' ObjectReference [ObjectAttributeUpdate]
- newBatchUpdateObjectAttributes :: ObjectReference -> BatchUpdateObjectAttributes
- data BatchUpdateObjectAttributesResponse = BatchUpdateObjectAttributesResponse' (Maybe Text)
- newBatchUpdateObjectAttributesResponse :: BatchUpdateObjectAttributesResponse
- data BatchWriteOperation = BatchWriteOperation' (Maybe BatchAddFacetToObject) (Maybe BatchAttachObject) (Maybe BatchAttachPolicy) (Maybe BatchAttachToIndex) (Maybe BatchAttachTypedLink) (Maybe BatchCreateIndex) (Maybe BatchCreateObject) (Maybe BatchDeleteObject) (Maybe BatchDetachFromIndex) (Maybe BatchDetachObject) (Maybe BatchDetachPolicy) (Maybe BatchDetachTypedLink) (Maybe BatchRemoveFacetFromObject) (Maybe BatchUpdateLinkAttributes) (Maybe BatchUpdateObjectAttributes)
- newBatchWriteOperation :: BatchWriteOperation
- data BatchWriteOperationResponse = BatchWriteOperationResponse' (Maybe BatchAddFacetToObjectResponse) (Maybe BatchAttachObjectResponse) (Maybe BatchAttachPolicyResponse) (Maybe BatchAttachToIndexResponse) (Maybe BatchAttachTypedLinkResponse) (Maybe BatchCreateIndexResponse) (Maybe BatchCreateObjectResponse) (Maybe BatchDeleteObjectResponse) (Maybe BatchDetachFromIndexResponse) (Maybe BatchDetachObjectResponse) (Maybe BatchDetachPolicyResponse) (Maybe BatchDetachTypedLinkResponse) (Maybe BatchRemoveFacetFromObjectResponse) (Maybe BatchUpdateLinkAttributesResponse) (Maybe BatchUpdateObjectAttributesResponse)
- newBatchWriteOperationResponse :: BatchWriteOperationResponse
- data Directory = Directory' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DirectoryState)
- newDirectory :: Directory
- data Facet = Facet' (Maybe FacetStyle) (Maybe Text) (Maybe ObjectType)
- newFacet :: Facet
- data FacetAttribute = FacetAttribute' (Maybe FacetAttributeDefinition) (Maybe FacetAttributeReference) (Maybe RequiredAttributeBehavior) Text
- newFacetAttribute :: Text -> FacetAttribute
- data FacetAttributeDefinition = FacetAttributeDefinition' (Maybe TypedAttributeValue) (Maybe Bool) (Maybe (HashMap Text Rule)) FacetAttributeType
- newFacetAttributeDefinition :: FacetAttributeType -> FacetAttributeDefinition
- data FacetAttributeReference = FacetAttributeReference' Text Text
- newFacetAttributeReference :: Text -> Text -> FacetAttributeReference
- data FacetAttributeUpdate = FacetAttributeUpdate' (Maybe UpdateActionType) (Maybe FacetAttribute)
- newFacetAttributeUpdate :: FacetAttributeUpdate
- data IndexAttachment = IndexAttachment' (Maybe [AttributeKeyAndValue]) (Maybe Text)
- newIndexAttachment :: IndexAttachment
- data LinkAttributeAction = LinkAttributeAction' (Maybe UpdateActionType) (Maybe TypedAttributeValue)
- newLinkAttributeAction :: LinkAttributeAction
- data LinkAttributeUpdate = LinkAttributeUpdate' (Maybe LinkAttributeAction) (Maybe AttributeKey)
- newLinkAttributeUpdate :: LinkAttributeUpdate
- data ObjectAttributeAction = ObjectAttributeAction' (Maybe UpdateActionType) (Maybe TypedAttributeValue)
- newObjectAttributeAction :: ObjectAttributeAction
- data ObjectAttributeRange = ObjectAttributeRange' (Maybe AttributeKey) (Maybe TypedAttributeValueRange)
- newObjectAttributeRange :: ObjectAttributeRange
- data ObjectAttributeUpdate = ObjectAttributeUpdate' (Maybe ObjectAttributeAction) (Maybe AttributeKey)
- newObjectAttributeUpdate :: ObjectAttributeUpdate
- data ObjectIdentifierAndLinkNameTuple = ObjectIdentifierAndLinkNameTuple' (Maybe Text) (Maybe Text)
- newObjectIdentifierAndLinkNameTuple :: ObjectIdentifierAndLinkNameTuple
- data ObjectReference = ObjectReference' (Maybe Text)
- newObjectReference :: ObjectReference
- data PathToObjectIdentifiers = PathToObjectIdentifiers' (Maybe [Text]) (Maybe Text)
- newPathToObjectIdentifiers :: PathToObjectIdentifiers
- data PolicyAttachment = PolicyAttachment' (Maybe Text) (Maybe Text) (Maybe Text)
- newPolicyAttachment :: PolicyAttachment
- data PolicyToPath = PolicyToPath' (Maybe Text) (Maybe [PolicyAttachment])
- newPolicyToPath :: PolicyToPath
- data Rule = Rule' (Maybe (HashMap Text Text)) (Maybe RuleType)
- newRule :: Rule
- data SchemaFacet = SchemaFacet' (Maybe Text) (Maybe Text)
- newSchemaFacet :: SchemaFacet
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data TypedAttributeValue = TypedAttributeValue' (Maybe Base64) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newTypedAttributeValue :: TypedAttributeValue
- data TypedAttributeValueRange = TypedAttributeValueRange' (Maybe TypedAttributeValue) (Maybe TypedAttributeValue) RangeMode RangeMode
- newTypedAttributeValueRange :: RangeMode -> RangeMode -> TypedAttributeValueRange
- data TypedLinkAttributeDefinition = TypedLinkAttributeDefinition' (Maybe TypedAttributeValue) (Maybe Bool) (Maybe (HashMap Text Rule)) Text FacetAttributeType RequiredAttributeBehavior
- newTypedLinkAttributeDefinition :: Text -> FacetAttributeType -> RequiredAttributeBehavior -> TypedLinkAttributeDefinition
- data TypedLinkAttributeRange = TypedLinkAttributeRange' (Maybe Text) TypedAttributeValueRange
- newTypedLinkAttributeRange :: TypedAttributeValueRange -> TypedLinkAttributeRange
- data TypedLinkFacet = TypedLinkFacet' Text [TypedLinkAttributeDefinition] [Text]
- newTypedLinkFacet :: Text -> TypedLinkFacet
- data TypedLinkFacetAttributeUpdate = TypedLinkFacetAttributeUpdate' TypedLinkAttributeDefinition UpdateActionType
- newTypedLinkFacetAttributeUpdate :: TypedLinkAttributeDefinition -> UpdateActionType -> TypedLinkFacetAttributeUpdate
- data TypedLinkSchemaAndFacetName = TypedLinkSchemaAndFacetName' Text Text
- newTypedLinkSchemaAndFacetName :: Text -> Text -> TypedLinkSchemaAndFacetName
- data TypedLinkSpecifier = TypedLinkSpecifier' TypedLinkSchemaAndFacetName ObjectReference ObjectReference [AttributeNameAndValue]
- newTypedLinkSpecifier :: TypedLinkSchemaAndFacetName -> ObjectReference -> ObjectReference -> TypedLinkSpecifier
Service Configuration
defaultService :: Service Source #
API version 2017-01-11 of the Amazon CloudDirectory SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CloudDirectory.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
BatchWriteException
_BatchWriteException :: AsError a => Fold a ServiceError Source #
A BatchWrite exception has occurred.
CannotListParentOfRootException
_CannotListParentOfRootException :: AsError a => Fold a ServiceError Source #
Cannot list the parents of a Directory root.
DirectoryAlreadyExistsException
_DirectoryAlreadyExistsException :: AsError a => Fold a ServiceError Source #
Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.
DirectoryDeletedException
_DirectoryDeletedException :: AsError a => Fold 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.
DirectoryNotDisabledException
_DirectoryNotDisabledException :: AsError a => Fold a ServiceError Source #
An operation can only operate on a disabled directory.
DirectoryNotEnabledException
_DirectoryNotEnabledException :: AsError a => Fold a ServiceError Source #
Operations are only permitted on enabled directories.
FacetAlreadyExistsException
_FacetAlreadyExistsException :: AsError a => Fold a ServiceError Source #
A facet with the same name already exists.
FacetInUseException
_FacetInUseException :: AsError a => Fold a ServiceError Source #
Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.
FacetNotFoundException
_FacetNotFoundException :: AsError a => Fold a ServiceError Source #
The specified Facet could not be found.
FacetValidationException
_FacetValidationException :: AsError a => Fold a ServiceError Source #
The Facet that you provided was not well formed or could not be validated with the schema.
IncompatibleSchemaException
_IncompatibleSchemaException :: AsError a => Fold 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.
IndexedAttributeMissingException
_IndexedAttributeMissingException :: AsError a => Fold a ServiceError Source #
An object has been attempted to be attached to an object that does not have the appropriate attribute value.
InternalServiceException
_InternalServiceException :: AsError a => Fold 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.
InvalidArnException
_InvalidArnException :: AsError a => Fold a ServiceError Source #
Indicates that the provided ARN value is not valid.
InvalidAttachmentException
_InvalidAttachmentException :: AsError a => Fold a ServiceError Source #
Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
InvalidFacetUpdateException
_InvalidFacetUpdateException :: AsError a => Fold a ServiceError Source #
An attempt to modify a Facet resulted in an invalid schema exception.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
Indicates that the NextToken value is not valid.
InvalidRuleException
_InvalidRuleException :: AsError a => Fold a ServiceError Source #
Occurs when any of the rule parameter keys or values are invalid.
InvalidSchemaDocException
_InvalidSchemaDocException :: AsError a => Fold a ServiceError Source #
Indicates that the provided SchemaDoc value is not valid.
InvalidTaggingRequestException
_InvalidTaggingRequestException :: AsError a => Fold 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.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
Indicates that limits are exceeded. See Limits for more information.
LinkNameAlreadyInUseException
_LinkNameAlreadyInUseException :: AsError a => Fold a ServiceError Source #
Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
NotIndexException
_NotIndexException :: AsError a => Fold a ServiceError Source #
Indicates that the requested operation can only operate on index objects.
NotNodeException
_NotNodeException :: AsError a => Fold 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.
NotPolicyException
_NotPolicyException :: AsError a => Fold a ServiceError Source #
Indicates that the requested operation can only operate on policy objects.
ObjectAlreadyDetachedException
_ObjectAlreadyDetachedException :: AsError a => Fold a ServiceError Source #
Indicates that the object is not attached to the index.
ObjectNotDetachedException
_ObjectNotDetachedException :: AsError a => Fold a ServiceError Source #
Indicates that the requested operation cannot be completed because the object has not been detached from the tree.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource could not be found.
RetryableConflictException
_RetryableConflictException :: AsError a => Fold 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.
SchemaAlreadyExistsException
_SchemaAlreadyExistsException :: AsError a => Fold 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.
SchemaAlreadyPublishedException
_SchemaAlreadyPublishedException :: AsError a => Fold a ServiceError Source #
Indicates that a schema is already published.
StillContainsLinksException
_StillContainsLinksException :: AsError a => Fold a ServiceError Source #
The object could not be deleted because links still exist. Remove the links and then try the operation again.
UnsupportedIndexTypeException
_UnsupportedIndexTypeException :: AsError a => Fold a ServiceError Source #
Indicates that the requested index type is not supported.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Indicates that your request is malformed in some manner. See the exception message.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AddFacetToObject
data AddFacetToObject Source #
See: newAddFacetToObject smart constructor.
Constructors
| AddFacetToObject' (Maybe [AttributeKeyAndValue]) Text SchemaFacet ObjectReference |
Instances
Arguments
| :: Text | |
| -> SchemaFacet | |
| -> ObjectReference | |
| -> AddFacetToObject |
Create a value of AddFacetToObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AddFacetToObject, addFacetToObject_objectAttributeList - Attributes on the facet that you are adding to the object.
AddFacetToObject, addFacetToObject_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where the object resides. For more information, see arns.
AddFacetToObject, addFacetToObject_schemaFacet - Identifiers for the facet that you are adding to the object. See
SchemaFacet for details.
AddFacetToObject, addFacetToObject_objectReference - A reference to the object you are adding the specified facet to.
data AddFacetToObjectResponse Source #
See: newAddFacetToObjectResponse smart constructor.
Constructors
| AddFacetToObjectResponse' Int |
Instances
newAddFacetToObjectResponse Source #
Create a value of AddFacetToObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AddFacetToObjectResponse', addFacetToObjectResponse_httpStatus - The response's http status code.
ApplySchema
data ApplySchema Source #
See: newApplySchema smart constructor.
Constructors
| ApplySchema' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ApplySchema |
Create a value of ApplySchema with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:publishedSchemaArn:ApplySchema', applySchema_publishedSchemaArn - Published schema Amazon Resource Name (ARN) that needs to be copied. For
more information, see arns.
ApplySchema, applySchema_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
into which the schema is copied. For more information, see arns.
data ApplySchemaResponse Source #
See: newApplySchemaResponse smart constructor.
Instances
newApplySchemaResponse Source #
Arguments
| :: Int | |
| -> ApplySchemaResponse |
Create a value of ApplySchemaResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appliedSchemaArn:ApplySchemaResponse', applySchemaResponse_appliedSchemaArn - The applied schema ARN that is associated with the copied schema in the
Directory. You can use this ARN to describe the schema information
applied on this directory. For more information, see arns.
ApplySchema, applySchemaResponse_directoryArn - The ARN that is associated with the Directory. For more information, see
arns.
$sel:httpStatus:ApplySchemaResponse', applySchemaResponse_httpStatus - The response's http status code.
AttachObject
data AttachObject Source #
See: newAttachObject smart constructor.
Constructors
| AttachObject' Text ObjectReference ObjectReference Text |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ObjectReference | |
| -> Text | |
| -> AttachObject |
Create a value of AttachObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AttachObject, attachObject_directoryArn - Amazon Resource Name (ARN) that is associated with the Directory where
both objects reside. For more information, see arns.
AttachObject, attachObject_parentReference - The parent object reference.
AttachObject, attachObject_childReference - The child object reference to be attached to the object.
AttachObject, attachObject_linkName - The link name with which the child object is attached to the parent.
data AttachObjectResponse Source #
See: newAttachObjectResponse smart constructor.
Constructors
| AttachObjectResponse' (Maybe Text) Int |
Instances
newAttachObjectResponse Source #
Arguments
| :: Int | |
| -> AttachObjectResponse |
Create a value of AttachObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AttachObjectResponse, attachObjectResponse_attachedObjectIdentifier - The attached ObjectIdentifier, which is the child ObjectIdentifier.
$sel:httpStatus:AttachObjectResponse', attachObjectResponse_httpStatus - The response's http status code.
AttachPolicy
data AttachPolicy Source #
See: newAttachPolicy smart constructor.
Constructors
| AttachPolicy' Text ObjectReference ObjectReference |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ObjectReference | |
| -> AttachPolicy |
Create a value of AttachPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AttachPolicy, attachPolicy_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where both objects reside. For more information, see arns.
AttachPolicy, attachPolicy_policyReference - The reference that is associated with the policy object.
AttachPolicy, attachPolicy_objectReference - The reference that identifies the object to which the policy will be
attached.
data AttachPolicyResponse Source #
See: newAttachPolicyResponse smart constructor.
Constructors
| AttachPolicyResponse' Int |
Instances
newAttachPolicyResponse Source #
Arguments
| :: Int | |
| -> AttachPolicyResponse |
Create a value of AttachPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AttachPolicyResponse', attachPolicyResponse_httpStatus - The response's http status code.
AttachToIndex
data AttachToIndex Source #
See: newAttachToIndex smart constructor.
Constructors
| AttachToIndex' Text ObjectReference ObjectReference |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ObjectReference | |
| -> AttachToIndex |
Create a value of AttachToIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AttachToIndex, attachToIndex_directoryArn - The Amazon Resource Name (ARN) of the directory where the object and
index exist.
AttachToIndex, attachToIndex_indexReference - A reference to the index that you are attaching the object to.
AttachToIndex, attachToIndex_targetReference - A reference to the object that you are attaching to the index.
data AttachToIndexResponse Source #
See: newAttachToIndexResponse smart constructor.
Constructors
| AttachToIndexResponse' (Maybe Text) Int |
Instances
newAttachToIndexResponse Source #
Create a value of AttachToIndexResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AttachToIndexResponse, attachToIndexResponse_attachedObjectIdentifier - The ObjectIdentifier of the object that was attached to the index.
$sel:httpStatus:AttachToIndexResponse', attachToIndexResponse_httpStatus - The response's http status code.
AttachTypedLink
data AttachTypedLink Source #
See: newAttachTypedLink smart constructor.
Constructors
| AttachTypedLink' Text ObjectReference ObjectReference TypedLinkSchemaAndFacetName [AttributeNameAndValue] |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ObjectReference | |
| -> TypedLinkSchemaAndFacetName | |
| -> AttachTypedLink |
Create a value of AttachTypedLink with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AttachTypedLink, attachTypedLink_directoryArn - The Amazon Resource Name (ARN) of the directory where you want to attach
the typed link.
AttachTypedLink, attachTypedLink_sourceObjectReference - Identifies the source object that the typed link will attach to.
AttachTypedLink, attachTypedLink_targetObjectReference - Identifies the target object that the typed link will attach to.
AttachTypedLink, attachTypedLink_typedLinkFacet - Identifies the typed link facet that is associated with the typed link.
AttachTypedLink, attachTypedLink_attributes - A set of attributes that are associated with the typed link.
data AttachTypedLinkResponse Source #
See: newAttachTypedLinkResponse smart constructor.
Constructors
| AttachTypedLinkResponse' (Maybe TypedLinkSpecifier) Int |
Instances
newAttachTypedLinkResponse Source #
Create a value of AttachTypedLinkResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AttachTypedLinkResponse, attachTypedLinkResponse_typedLinkSpecifier - Returns a typed link specifier as output.
$sel:httpStatus:AttachTypedLinkResponse', attachTypedLinkResponse_httpStatus - The response's http status code.
BatchRead
See: newBatchRead smart constructor.
Constructors
| BatchRead' (Maybe ConsistencyLevel) Text [BatchReadOperation] |
Instances
Create a value of BatchRead with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:BatchRead', batchRead_consistencyLevel - Represents the manner and timing in which the successful write or update
of an object is reflected in a subsequent read operation of that same
object.
BatchRead, batchRead_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory.
For more information, see arns.
$sel:operations:BatchRead', batchRead_operations - A list of operations that are part of the batch.
data BatchReadResponse Source #
See: newBatchReadResponse smart constructor.
Constructors
| BatchReadResponse' (Maybe [BatchReadOperationResponse]) Int |
Instances
Arguments
| :: Int | |
| -> BatchReadResponse |
Create a value of BatchReadResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:responses:BatchReadResponse', batchReadResponse_responses - A list of all the responses for each batch read.
$sel:httpStatus:BatchReadResponse', batchReadResponse_httpStatus - The response's http status code.
BatchWrite
data BatchWrite Source #
See: newBatchWrite smart constructor.
Constructors
| BatchWrite' Text [BatchWriteOperation] |
Instances
Arguments
| :: Text | |
| -> BatchWrite |
Create a value of BatchWrite with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchWrite, batchWrite_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory.
For more information, see arns.
$sel:operations:BatchWrite', batchWrite_operations - A list of operations that are part of the batch.
data BatchWriteResponse Source #
See: newBatchWriteResponse smart constructor.
Constructors
| BatchWriteResponse' (Maybe [BatchWriteOperationResponse]) Int |
Instances
newBatchWriteResponse Source #
Arguments
| :: Int | |
| -> BatchWriteResponse |
Create a value of BatchWriteResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:responses:BatchWriteResponse', batchWriteResponse_responses - A list of all the responses for each batch write.
$sel:httpStatus:BatchWriteResponse', batchWriteResponse_httpStatus - The response's http status code.
CreateDirectory
data CreateDirectory Source #
See: newCreateDirectory smart constructor.
Constructors
| CreateDirectory' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateDirectory |
Create a value of CreateDirectory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDirectory, createDirectory_name - The name of the Directory. Should be unique per account, per region.
CreateDirectory, createDirectory_schemaArn - The Amazon Resource Name (ARN) of the published schema that will be
copied into the data Directory. For more information, see arns.
data CreateDirectoryResponse Source #
See: newCreateDirectoryResponse smart constructor.
Instances
newCreateDirectoryResponse Source #
Create a value of CreateDirectoryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateDirectoryResponse', createDirectoryResponse_httpStatus - The response's http status code.
CreateDirectoryResponse, createDirectoryResponse_directoryArn - The ARN that is associated with the Directory. For more information, see
arns.
CreateDirectory, createDirectoryResponse_name - The name of the Directory.
CreateDirectoryResponse, createDirectoryResponse_objectIdentifier - The root object node of the created directory.
$sel:appliedSchemaArn:CreateDirectoryResponse', createDirectoryResponse_appliedSchemaArn - The ARN of the published schema in the Directory. Once a published
schema is copied into the directory, it has its own ARN, which is
referred to applied schema ARN. For more information, see arns.
CreateFacet
data CreateFacet Source #
See: newCreateFacet smart constructor.
Constructors
| CreateFacet' (Maybe [FacetAttribute]) (Maybe FacetStyle) (Maybe ObjectType) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateFacet |
Create a value of CreateFacet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateFacet, createFacet_attributes - The attributes that are associated with the Facet.
CreateFacet, createFacet_facetStyle - There are two different styles that you can define on any given facet,
Static and Dynamic. For static facets, all attributes must be
defined in the schema. For dynamic facets, attributes can be defined
during data plane operations.
CreateFacet, createFacet_objectType - Specifies whether a given object created from this facet is of type
node, leaf node, policy or index.
- Node: Can have multiple children but one parent.
- Leaf node: Cannot have children but can have multiple parents.
- Policy: Allows you to store a policy document and policy type. For more information, see Policies.
- Index: Can be created with the Index API.
CreateFacet, createFacet_schemaArn - The schema ARN in which the new Facet will be created. For more
information, see arns.
CreateFacet, createFacet_name - The name of the Facet, which is unique for a given schema.
data CreateFacetResponse Source #
See: newCreateFacetResponse smart constructor.
Constructors
| CreateFacetResponse' Int |
Instances
newCreateFacetResponse Source #
Arguments
| :: Int | |
| -> CreateFacetResponse |
Create a value of CreateFacetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateFacetResponse', createFacetResponse_httpStatus - The response's http status code.
CreateIndex
data CreateIndex Source #
See: newCreateIndex smart constructor.
Constructors
| CreateIndex' (Maybe Text) (Maybe ObjectReference) Text [AttributeKey] Bool |
Instances
Arguments
| :: Text | |
| -> Bool | |
| -> CreateIndex |
Create a value of CreateIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateIndex, createIndex_linkName - The name of the link between the parent object and the index object.
CreateIndex, createIndex_parentReference - A reference to the parent object that contains the index object.
CreateIndex, createIndex_directoryArn - The ARN of the directory where the index should be created.
CreateIndex, createIndex_orderedIndexedAttributeList - Specifies the attributes that should be indexed on. Currently only a
single attribute is supported.
CreateIndex, createIndex_isUnique - Indicates whether the attribute that is being indexed has unique values
or not.
data CreateIndexResponse Source #
See: newCreateIndexResponse smart constructor.
Constructors
| CreateIndexResponse' (Maybe Text) Int |
Instances
newCreateIndexResponse Source #
Arguments
| :: Int | |
| -> CreateIndexResponse |
Create a value of CreateIndexResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateIndexResponse, createIndexResponse_objectIdentifier - The ObjectIdentifier of the index created by this operation.
$sel:httpStatus:CreateIndexResponse', createIndexResponse_httpStatus - The response's http status code.
CreateObject
data CreateObject Source #
See: newCreateObject smart constructor.
Constructors
| CreateObject' (Maybe Text) (Maybe [AttributeKeyAndValue]) (Maybe ObjectReference) Text [SchemaFacet] |
Instances
Arguments
| :: Text | |
| -> CreateObject |
Create a value of CreateObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateObject, createObject_linkName - The name of link that is used to attach this object to a parent.
CreateObject, createObject_objectAttributeList - The attribute map whose attribute ARN contains the key and attribute
value as the map value.
CreateObject, createObject_parentReference - If specified, the parent reference to which this object will be
attached.
CreateObject, createObject_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory in
which the object will be created. For more information, see arns.
CreateObject, createObject_schemaFacets - A list of schema facets to be associated with the object. Do not provide
minor version components. See SchemaFacet for details.
data CreateObjectResponse Source #
See: newCreateObjectResponse smart constructor.
Constructors
| CreateObjectResponse' (Maybe Text) Int |
Instances
newCreateObjectResponse Source #
Arguments
| :: Int | |
| -> CreateObjectResponse |
Create a value of CreateObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateObjectResponse, createObjectResponse_objectIdentifier - The identifier that is associated with the object.
$sel:httpStatus:CreateObjectResponse', createObjectResponse_httpStatus - The response's http status code.
CreateSchema
data CreateSchema Source #
See: newCreateSchema smart constructor.
Constructors
| CreateSchema' Text |
Instances
Arguments
| :: Text | |
| -> CreateSchema |
Create a value of CreateSchema with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateSchema, createSchema_name - The name that is associated with the schema. This is unique to each
account and in each region.
data CreateSchemaResponse Source #
See: newCreateSchemaResponse smart constructor.
Constructors
| CreateSchemaResponse' (Maybe Text) Int |
Instances
newCreateSchemaResponse Source #
Arguments
| :: Int | |
| -> CreateSchemaResponse |
Create a value of CreateSchemaResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateSchemaResponse, createSchemaResponse_schemaArn - The Amazon Resource Name (ARN) that is associated with the schema. For
more information, see arns.
$sel:httpStatus:CreateSchemaResponse', createSchemaResponse_httpStatus - The response's http status code.
CreateTypedLinkFacet
data CreateTypedLinkFacet Source #
See: newCreateTypedLinkFacet smart constructor.
Constructors
| CreateTypedLinkFacet' Text TypedLinkFacet |
Instances
newCreateTypedLinkFacet Source #
Arguments
| :: Text | |
| -> TypedLinkFacet | |
| -> CreateTypedLinkFacet |
Create a value of CreateTypedLinkFacet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateTypedLinkFacet, createTypedLinkFacet_schemaArn - The Amazon Resource Name (ARN) that is associated with the schema. For
more information, see arns.
$sel:facet:CreateTypedLinkFacet', createTypedLinkFacet_facet - Facet structure that is associated with the typed link facet.
data CreateTypedLinkFacetResponse Source #
See: newCreateTypedLinkFacetResponse smart constructor.
Constructors
| CreateTypedLinkFacetResponse' Int |
Instances
newCreateTypedLinkFacetResponse Source #
Create a value of CreateTypedLinkFacetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateTypedLinkFacetResponse', createTypedLinkFacetResponse_httpStatus - The response's http status code.
DeleteDirectory
data DeleteDirectory Source #
See: newDeleteDirectory smart constructor.
Constructors
| DeleteDirectory' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDirectory |
Create a value of DeleteDirectory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDirectory, deleteDirectory_directoryArn - The ARN of the directory to delete.
data DeleteDirectoryResponse Source #
See: newDeleteDirectoryResponse smart constructor.
Constructors
| DeleteDirectoryResponse' Int Text |
Instances
newDeleteDirectoryResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DeleteDirectoryResponse |
Create a value of DeleteDirectoryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDirectoryResponse', deleteDirectoryResponse_httpStatus - The response's http status code.
DeleteDirectory, deleteDirectoryResponse_directoryArn - The ARN of the deleted directory.
DeleteFacet
data DeleteFacet Source #
See: newDeleteFacet smart constructor.
Constructors
| DeleteFacet' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteFacet |
Create a value of DeleteFacet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteFacet, deleteFacet_schemaArn - The Amazon Resource Name (ARN) that is associated with the Facet. For
more information, see arns.
DeleteFacet, deleteFacet_name - The name of the facet to delete.
data DeleteFacetResponse Source #
See: newDeleteFacetResponse smart constructor.
Constructors
| DeleteFacetResponse' Int |
Instances
newDeleteFacetResponse Source #
Arguments
| :: Int | |
| -> DeleteFacetResponse |
Create a value of DeleteFacetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteFacetResponse', deleteFacetResponse_httpStatus - The response's http status code.
DeleteObject
data DeleteObject Source #
See: newDeleteObject smart constructor.
Constructors
| DeleteObject' Text ObjectReference |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> DeleteObject |
Create a value of DeleteObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteObject, deleteObject_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where the object resides. For more information, see arns.
DeleteObject, deleteObject_objectReference - A reference that identifies the object.
data DeleteObjectResponse Source #
See: newDeleteObjectResponse smart constructor.
Constructors
| DeleteObjectResponse' Int |
Instances
newDeleteObjectResponse Source #
Arguments
| :: Int | |
| -> DeleteObjectResponse |
Create a value of DeleteObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteObjectResponse', deleteObjectResponse_httpStatus - The response's http status code.
DeleteSchema
data DeleteSchema Source #
See: newDeleteSchema smart constructor.
Constructors
| DeleteSchema' Text |
Instances
Arguments
| :: Text | |
| -> DeleteSchema |
Create a value of DeleteSchema with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSchema, deleteSchema_schemaArn - The Amazon Resource Name (ARN) of the development schema. For more
information, see arns.
data DeleteSchemaResponse Source #
See: newDeleteSchemaResponse smart constructor.
Constructors
| DeleteSchemaResponse' (Maybe Text) Int |
Instances
newDeleteSchemaResponse Source #
Arguments
| :: Int | |
| -> DeleteSchemaResponse |
Create a value of DeleteSchemaResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSchema, deleteSchemaResponse_schemaArn - The input ARN that is returned as part of the response. For more
information, see arns.
$sel:httpStatus:DeleteSchemaResponse', deleteSchemaResponse_httpStatus - The response's http status code.
DeleteTypedLinkFacet
data DeleteTypedLinkFacet Source #
See: newDeleteTypedLinkFacet smart constructor.
Constructors
| DeleteTypedLinkFacet' Text Text |
Instances
newDeleteTypedLinkFacet Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteTypedLinkFacet |
Create a value of DeleteTypedLinkFacet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteTypedLinkFacet, deleteTypedLinkFacet_schemaArn - The Amazon Resource Name (ARN) that is associated with the schema. For
more information, see arns.
DeleteTypedLinkFacet, deleteTypedLinkFacet_name - The unique name of the typed link facet.
data DeleteTypedLinkFacetResponse Source #
See: newDeleteTypedLinkFacetResponse smart constructor.
Constructors
| DeleteTypedLinkFacetResponse' Int |
Instances
newDeleteTypedLinkFacetResponse Source #
Create a value of DeleteTypedLinkFacetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteTypedLinkFacetResponse', deleteTypedLinkFacetResponse_httpStatus - The response's http status code.
DetachFromIndex
data DetachFromIndex Source #
See: newDetachFromIndex smart constructor.
Constructors
| DetachFromIndex' Text ObjectReference ObjectReference |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ObjectReference | |
| -> DetachFromIndex |
Create a value of DetachFromIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DetachFromIndex, detachFromIndex_directoryArn - The Amazon Resource Name (ARN) of the directory the index and object
exist in.
DetachFromIndex, detachFromIndex_indexReference - A reference to the index object.
DetachFromIndex, detachFromIndex_targetReference - A reference to the object being detached from the index.
data DetachFromIndexResponse Source #
See: newDetachFromIndexResponse smart constructor.
Constructors
| DetachFromIndexResponse' (Maybe Text) Int |
Instances
newDetachFromIndexResponse Source #
Create a value of DetachFromIndexResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DetachFromIndexResponse, detachFromIndexResponse_detachedObjectIdentifier - The ObjectIdentifier of the object that was detached from the index.
$sel:httpStatus:DetachFromIndexResponse', detachFromIndexResponse_httpStatus - The response's http status code.
DetachObject
data DetachObject Source #
See: newDetachObject smart constructor.
Constructors
| DetachObject' Text ObjectReference Text |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> Text | |
| -> DetachObject |
Create a value of DetachObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DetachObject, detachObject_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where objects reside. For more information, see arns.
DetachObject, detachObject_parentReference - The parent reference from which the object with the specified link name
is detached.
DetachObject, detachObject_linkName - The link name associated with the object that needs to be detached.
data DetachObjectResponse Source #
See: newDetachObjectResponse smart constructor.
Constructors
| DetachObjectResponse' (Maybe Text) Int |
Instances
newDetachObjectResponse Source #
Arguments
| :: Int | |
| -> DetachObjectResponse |
Create a value of DetachObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DetachObjectResponse, detachObjectResponse_detachedObjectIdentifier - The ObjectIdentifier that was detached from the object.
$sel:httpStatus:DetachObjectResponse', detachObjectResponse_httpStatus - The response's http status code.
DetachPolicy
data DetachPolicy Source #
See: newDetachPolicy smart constructor.
Constructors
| DetachPolicy' Text ObjectReference ObjectReference |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ObjectReference | |
| -> DetachPolicy |
Create a value of DetachPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DetachPolicy, detachPolicy_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where both objects reside. For more information, see arns.
DetachPolicy, detachPolicy_policyReference - Reference that identifies the policy object.
DetachPolicy, detachPolicy_objectReference - Reference that identifies the object whose policy object will be
detached.
data DetachPolicyResponse Source #
See: newDetachPolicyResponse smart constructor.
Constructors
| DetachPolicyResponse' Int |
Instances
newDetachPolicyResponse Source #
Arguments
| :: Int | |
| -> DetachPolicyResponse |
Create a value of DetachPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DetachPolicyResponse', detachPolicyResponse_httpStatus - The response's http status code.
DetachTypedLink
data DetachTypedLink Source #
See: newDetachTypedLink smart constructor.
Constructors
| DetachTypedLink' Text TypedLinkSpecifier |
Instances
Arguments
| :: Text | |
| -> TypedLinkSpecifier | |
| -> DetachTypedLink |
Create a value of DetachTypedLink with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DetachTypedLink, detachTypedLink_directoryArn - The Amazon Resource Name (ARN) of the directory where you want to detach
the typed link.
DetachTypedLink, detachTypedLink_typedLinkSpecifier - Used to accept a typed link specifier as input.
data DetachTypedLinkResponse Source #
See: newDetachTypedLinkResponse smart constructor.
Constructors
| DetachTypedLinkResponse' | |
Instances
newDetachTypedLinkResponse :: DetachTypedLinkResponse Source #
Create a value of DetachTypedLinkResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DisableDirectory
data DisableDirectory Source #
See: newDisableDirectory smart constructor.
Constructors
| DisableDirectory' Text |
Instances
Arguments
| :: Text | |
| -> DisableDirectory |
Create a value of DisableDirectory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisableDirectory, disableDirectory_directoryArn - The ARN of the directory to disable.
data DisableDirectoryResponse Source #
See: newDisableDirectoryResponse smart constructor.
Constructors
| DisableDirectoryResponse' Int Text |
Instances
newDisableDirectoryResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DisableDirectoryResponse |
Create a value of DisableDirectoryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisableDirectoryResponse', disableDirectoryResponse_httpStatus - The response's http status code.
DisableDirectory, disableDirectoryResponse_directoryArn - The ARN of the directory that has been disabled.
EnableDirectory
data EnableDirectory Source #
See: newEnableDirectory smart constructor.
Constructors
| EnableDirectory' Text |
Instances
Arguments
| :: Text | |
| -> EnableDirectory |
Create a value of EnableDirectory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
EnableDirectory, enableDirectory_directoryArn - The ARN of the directory to enable.
data EnableDirectoryResponse Source #
See: newEnableDirectoryResponse smart constructor.
Constructors
| EnableDirectoryResponse' Int Text |
Instances
newEnableDirectoryResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> EnableDirectoryResponse |
Create a value of EnableDirectoryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:EnableDirectoryResponse', enableDirectoryResponse_httpStatus - The response's http status code.
EnableDirectory, enableDirectoryResponse_directoryArn - The ARN of the enabled directory.
GetAppliedSchemaVersion
data GetAppliedSchemaVersion Source #
See: newGetAppliedSchemaVersion smart constructor.
Constructors
| GetAppliedSchemaVersion' Text |
Instances
newGetAppliedSchemaVersion Source #
Arguments
| :: Text | |
| -> GetAppliedSchemaVersion |
Create a value of GetAppliedSchemaVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetAppliedSchemaVersion, getAppliedSchemaVersion_schemaArn - The ARN of the applied schema.
data GetAppliedSchemaVersionResponse Source #
See: newGetAppliedSchemaVersionResponse smart constructor.
Constructors
| GetAppliedSchemaVersionResponse' (Maybe Text) Int |
Instances
newGetAppliedSchemaVersionResponse Source #
Create a value of GetAppliedSchemaVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appliedSchemaArn:GetAppliedSchemaVersionResponse', getAppliedSchemaVersionResponse_appliedSchemaArn - Current applied schema ARN, including the minor version in use if one
was provided.
$sel:httpStatus:GetAppliedSchemaVersionResponse', getAppliedSchemaVersionResponse_httpStatus - The response's http status code.
GetDirectory
data GetDirectory Source #
See: newGetDirectory smart constructor.
Constructors
| GetDirectory' Text |
Instances
Arguments
| :: Text | |
| -> GetDirectory |
Create a value of GetDirectory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDirectory, getDirectory_directoryArn - The ARN of the directory.
data GetDirectoryResponse Source #
See: newGetDirectoryResponse smart constructor.
Constructors
| GetDirectoryResponse' Int Directory |
Instances
newGetDirectoryResponse Source #
Arguments
| :: Int | |
| -> Directory | |
| -> GetDirectoryResponse |
Create a value of GetDirectoryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetDirectoryResponse', getDirectoryResponse_httpStatus - The response's http status code.
$sel:directory:GetDirectoryResponse', getDirectoryResponse_directory - Metadata about the directory.
GetFacet
See: newGetFacet smart constructor.
Instances
Create a value of GetFacet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetFacet, getFacet_schemaArn - The Amazon Resource Name (ARN) that is associated with the Facet. For
more information, see arns.
GetFacet, getFacet_name - The name of the facet to retrieve.
data GetFacetResponse Source #
See: newGetFacetResponse smart constructor.
Constructors
| GetFacetResponse' (Maybe Facet) Int |
Instances
Arguments
| :: Int | |
| -> GetFacetResponse |
Create a value of GetFacetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:facet:GetFacetResponse', getFacetResponse_facet - The Facet structure that is associated with the facet.
$sel:httpStatus:GetFacetResponse', getFacetResponse_httpStatus - The response's http status code.
GetLinkAttributes
data GetLinkAttributes Source #
See: newGetLinkAttributes smart constructor.
Constructors
| GetLinkAttributes' (Maybe ConsistencyLevel) Text TypedLinkSpecifier [Text] |
Instances
Create a value of GetLinkAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:GetLinkAttributes', getLinkAttributes_consistencyLevel - The consistency level at which to retrieve the attributes on a typed
link.
GetLinkAttributes, getLinkAttributes_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where the typed link resides. For more information, see arns or
Typed Links.
GetLinkAttributes, getLinkAttributes_typedLinkSpecifier - Allows a typed link specifier to be accepted as input.
GetLinkAttributes, getLinkAttributes_attributeNames - A list of attribute names whose values will be retrieved.
data GetLinkAttributesResponse Source #
See: newGetLinkAttributesResponse smart constructor.
Constructors
| GetLinkAttributesResponse' (Maybe [AttributeKeyAndValue]) Int |
Instances
newGetLinkAttributesResponse Source #
Create a value of GetLinkAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetLinkAttributesResponse, getLinkAttributesResponse_attributes - The attributes that are associated with the typed link.
$sel:httpStatus:GetLinkAttributesResponse', getLinkAttributesResponse_httpStatus - The response's http status code.
GetObjectAttributes
data GetObjectAttributes Source #
See: newGetObjectAttributes smart constructor.
Constructors
| GetObjectAttributes' (Maybe ConsistencyLevel) Text ObjectReference SchemaFacet [Text] |
Instances
newGetObjectAttributes Source #
Arguments
| :: Text | |
| -> ObjectReference | |
| -> SchemaFacet | |
| -> GetObjectAttributes |
Create a value of GetObjectAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:GetObjectAttributes', getObjectAttributes_consistencyLevel - The consistency level at which to retrieve the attributes on an object.
GetObjectAttributes, getObjectAttributes_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where the object resides.
GetObjectAttributes, getObjectAttributes_objectReference - Reference that identifies the object whose attributes will be retrieved.
GetObjectAttributes, getObjectAttributes_schemaFacet - Identifier for the facet whose attributes will be retrieved. See
SchemaFacet for details.
GetObjectAttributes, getObjectAttributes_attributeNames - List of attribute names whose values will be retrieved.
data GetObjectAttributesResponse Source #
See: newGetObjectAttributesResponse smart constructor.
Constructors
| GetObjectAttributesResponse' (Maybe [AttributeKeyAndValue]) Int |
Instances
newGetObjectAttributesResponse Source #
Create a value of GetObjectAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetObjectAttributesResponse, getObjectAttributesResponse_attributes - The attributes that are associated with the object.
$sel:httpStatus:GetObjectAttributesResponse', getObjectAttributesResponse_httpStatus - The response's http status code.
GetObjectInformation
data GetObjectInformation Source #
See: newGetObjectInformation smart constructor.
Constructors
| GetObjectInformation' (Maybe ConsistencyLevel) Text ObjectReference |
Instances
newGetObjectInformation Source #
Create a value of GetObjectInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:GetObjectInformation', getObjectInformation_consistencyLevel - The consistency level at which to retrieve the object information.
GetObjectInformation, getObjectInformation_directoryArn - The ARN of the directory being retrieved.
GetObjectInformation, getObjectInformation_objectReference - A reference to the object.
data GetObjectInformationResponse Source #
See: newGetObjectInformationResponse smart constructor.
Constructors
| GetObjectInformationResponse' (Maybe Text) (Maybe [SchemaFacet]) Int |
Instances
newGetObjectInformationResponse Source #
Create a value of GetObjectInformationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetObjectInformationResponse, getObjectInformationResponse_objectIdentifier - The ObjectIdentifier of the specified object.
GetObjectInformationResponse, getObjectInformationResponse_schemaFacets - The facets attached to the specified object. Although the response does
not include minor version information, the most recently applied minor
version of each Facet is in effect. See GetAppliedSchemaVersion for
details.
$sel:httpStatus:GetObjectInformationResponse', getObjectInformationResponse_httpStatus - The response's http status code.
GetSchemaAsJson
data GetSchemaAsJson Source #
See: newGetSchemaAsJson smart constructor.
Constructors
| GetSchemaAsJson' Text |
Instances
Arguments
| :: Text | |
| -> GetSchemaAsJson |
Create a value of GetSchemaAsJson with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSchemaAsJson, getSchemaAsJson_schemaArn - The ARN of the schema to retrieve.
data GetSchemaAsJsonResponse Source #
See: newGetSchemaAsJsonResponse smart constructor.
Instances
newGetSchemaAsJsonResponse Source #
Create a value of GetSchemaAsJsonResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:document:GetSchemaAsJsonResponse', getSchemaAsJsonResponse_document - The JSON representation of the schema document.
GetSchemaAsJsonResponse, getSchemaAsJsonResponse_name - The name of the retrieved schema.
$sel:httpStatus:GetSchemaAsJsonResponse', getSchemaAsJsonResponse_httpStatus - The response's http status code.
GetTypedLinkFacetInformation
data GetTypedLinkFacetInformation Source #
See: newGetTypedLinkFacetInformation smart constructor.
Constructors
| GetTypedLinkFacetInformation' Text Text |
Instances
newGetTypedLinkFacetInformation Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetTypedLinkFacetInformation |
Create a value of GetTypedLinkFacetInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTypedLinkFacetInformation, getTypedLinkFacetInformation_schemaArn - The Amazon Resource Name (ARN) that is associated with the schema. For
more information, see arns.
GetTypedLinkFacetInformation, getTypedLinkFacetInformation_name - The unique name of the typed link facet.
data GetTypedLinkFacetInformationResponse Source #
See: newGetTypedLinkFacetInformationResponse smart constructor.
Constructors
| GetTypedLinkFacetInformationResponse' (Maybe [Text]) Int |
Instances
newGetTypedLinkFacetInformationResponse Source #
Arguments
| :: Int | |
| -> GetTypedLinkFacetInformationResponse |
Create a value of GetTypedLinkFacetInformationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTypedLinkFacetInformationResponse, getTypedLinkFacetInformationResponse_identityAttributeOrder - The order of identity attributes for the facet, from most significant to
least significant. The ability to filter typed links considers the order
that the attributes are defined on the typed link facet. When providing
ranges to typed link selection, any inexact ranges must be specified at
the end. Any attributes that do not have a range specified are presumed
to match the entire range. Filters are interpreted in the order of the
attributes on the typed link facet, not the order in which they are
supplied to any API calls. For more information about identity
attributes, see
Typed Links.
$sel:httpStatus:GetTypedLinkFacetInformationResponse', getTypedLinkFacetInformationResponse_httpStatus - The response's http status code.
ListAppliedSchemaArns (Paginated)
data ListAppliedSchemaArns Source #
See: newListAppliedSchemaArns smart constructor.
Instances
newListAppliedSchemaArns Source #
Arguments
| :: Text | |
| -> ListAppliedSchemaArns |
Create a value of ListAppliedSchemaArns with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListAppliedSchemaArns, listAppliedSchemaArns_maxResults - The maximum number of results to retrieve.
ListAppliedSchemaArns, listAppliedSchemaArns_nextToken - The pagination token.
ListAppliedSchemaArns, listAppliedSchemaArns_schemaArn - The response for ListAppliedSchemaArns when this parameter is used
will list all minor version ARNs for a major version.
ListAppliedSchemaArns, listAppliedSchemaArns_directoryArn - The ARN of the directory you are listing.
data ListAppliedSchemaArnsResponse Source #
See: newListAppliedSchemaArnsResponse smart constructor.
Instances
newListAppliedSchemaArnsResponse Source #
Create a value of ListAppliedSchemaArnsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListAppliedSchemaArns, listAppliedSchemaArnsResponse_nextToken - The pagination token.
$sel:schemaArns:ListAppliedSchemaArnsResponse', listAppliedSchemaArnsResponse_schemaArns - The ARNs of schemas that are applied to the directory.
$sel:httpStatus:ListAppliedSchemaArnsResponse', listAppliedSchemaArnsResponse_httpStatus - The response's http status code.
ListAttachedIndices (Paginated)
data ListAttachedIndices Source #
See: newListAttachedIndices smart constructor.
Constructors
| ListAttachedIndices' (Maybe ConsistencyLevel) (Maybe Natural) (Maybe Text) Text ObjectReference |
Instances
newListAttachedIndices Source #
Create a value of ListAttachedIndices with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:ListAttachedIndices', listAttachedIndices_consistencyLevel - The consistency level to use for this operation.
ListAttachedIndices, listAttachedIndices_maxResults - The maximum number of results to retrieve.
ListAttachedIndices, listAttachedIndices_nextToken - The pagination token.
ListAttachedIndices, listAttachedIndices_directoryArn - The ARN of the directory.
ListAttachedIndices, listAttachedIndices_targetReference - A reference to the object that has indices attached.
data ListAttachedIndicesResponse Source #
See: newListAttachedIndicesResponse smart constructor.
Constructors
| ListAttachedIndicesResponse' (Maybe [IndexAttachment]) (Maybe Text) Int |
Instances
newListAttachedIndicesResponse Source #
Create a value of ListAttachedIndicesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListAttachedIndicesResponse, listAttachedIndicesResponse_indexAttachments - The indices attached to the specified object.
ListAttachedIndices, listAttachedIndicesResponse_nextToken - The pagination token.
$sel:httpStatus:ListAttachedIndicesResponse', listAttachedIndicesResponse_httpStatus - The response's http status code.
ListDevelopmentSchemaArns (Paginated)
data ListDevelopmentSchemaArns Source #
See: newListDevelopmentSchemaArns smart constructor.
Constructors
| ListDevelopmentSchemaArns' (Maybe Natural) (Maybe Text) |
Instances
newListDevelopmentSchemaArns :: ListDevelopmentSchemaArns Source #
Create a value of ListDevelopmentSchemaArns with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListDevelopmentSchemaArns, listDevelopmentSchemaArns_maxResults - The maximum number of results to retrieve.
ListDevelopmentSchemaArns, listDevelopmentSchemaArns_nextToken - The pagination token.
data ListDevelopmentSchemaArnsResponse Source #
See: newListDevelopmentSchemaArnsResponse smart constructor.
Instances
newListDevelopmentSchemaArnsResponse Source #
Arguments
| :: Int | |
| -> ListDevelopmentSchemaArnsResponse |
Create a value of ListDevelopmentSchemaArnsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListDevelopmentSchemaArns, listDevelopmentSchemaArnsResponse_nextToken - The pagination token.
$sel:schemaArns:ListDevelopmentSchemaArnsResponse', listDevelopmentSchemaArnsResponse_schemaArns - The ARNs of retrieved development schemas.
$sel:httpStatus:ListDevelopmentSchemaArnsResponse', listDevelopmentSchemaArnsResponse_httpStatus - The response's http status code.
ListDirectories (Paginated)
data ListDirectories Source #
See: newListDirectories smart constructor.
Constructors
| ListDirectories' (Maybe Natural) (Maybe Text) (Maybe DirectoryState) |
Instances
newListDirectories :: ListDirectories Source #
Create a value of ListDirectories with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListDirectories, listDirectories_maxResults - The maximum number of results to retrieve.
ListDirectories, listDirectories_nextToken - The pagination token.
ListDirectories, listDirectories_state - The state of the directories in the list. Can be either Enabled,
Disabled, or Deleted.
data ListDirectoriesResponse Source #
See: newListDirectoriesResponse smart constructor.
Constructors
| ListDirectoriesResponse' (Maybe Text) Int [Directory] |
Instances
newListDirectoriesResponse Source #
Create a value of ListDirectoriesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListDirectories, listDirectoriesResponse_nextToken - The pagination token.
$sel:httpStatus:ListDirectoriesResponse', listDirectoriesResponse_httpStatus - The response's http status code.
$sel:directories:ListDirectoriesResponse', listDirectoriesResponse_directories - Lists all directories that are associated with your account in
pagination fashion.
ListFacetAttributes (Paginated)
data ListFacetAttributes Source #
See: newListFacetAttributes smart constructor.
Instances
newListFacetAttributes Source #
Arguments
| :: Text | |
| -> Text | |
| -> ListFacetAttributes |
Create a value of ListFacetAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListFacetAttributes, listFacetAttributes_maxResults - The maximum number of results to retrieve.
ListFacetAttributes, listFacetAttributes_nextToken - The pagination token.
ListFacetAttributes, listFacetAttributes_schemaArn - The ARN of the schema where the facet resides.
ListFacetAttributes, listFacetAttributes_name - The name of the facet whose attributes will be retrieved.
data ListFacetAttributesResponse Source #
See: newListFacetAttributesResponse smart constructor.
Constructors
| ListFacetAttributesResponse' (Maybe [FacetAttribute]) (Maybe Text) Int |
Instances
newListFacetAttributesResponse Source #
Create a value of ListFacetAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListFacetAttributesResponse, listFacetAttributesResponse_attributes - The attributes attached to the facet.
ListFacetAttributes, listFacetAttributesResponse_nextToken - The pagination token.
$sel:httpStatus:ListFacetAttributesResponse', listFacetAttributesResponse_httpStatus - The response's http status code.
ListFacetNames (Paginated)
data ListFacetNames Source #
See: newListFacetNames smart constructor.
Instances
Arguments
| :: Text | |
| -> ListFacetNames |
Create a value of ListFacetNames with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListFacetNames, listFacetNames_maxResults - The maximum number of results to retrieve.
ListFacetNames, listFacetNames_nextToken - The pagination token.
ListFacetNames, listFacetNames_schemaArn - The Amazon Resource Name (ARN) to retrieve facet names from.
data ListFacetNamesResponse Source #
See: newListFacetNamesResponse smart constructor.
Instances
newListFacetNamesResponse Source #
Create a value of ListFacetNamesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:facetNames:ListFacetNamesResponse', listFacetNamesResponse_facetNames - The names of facets that exist within the schema.
ListFacetNames, listFacetNamesResponse_nextToken - The pagination token.
$sel:httpStatus:ListFacetNamesResponse', listFacetNamesResponse_httpStatus - The response's http status code.
ListIncomingTypedLinks (Paginated)
data ListIncomingTypedLinks Source #
See: newListIncomingTypedLinks smart constructor.
Constructors
| ListIncomingTypedLinks' (Maybe ConsistencyLevel) (Maybe [TypedLinkAttributeRange]) (Maybe TypedLinkSchemaAndFacetName) (Maybe Natural) (Maybe Text) Text ObjectReference |
Instances
newListIncomingTypedLinks Source #
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ListIncomingTypedLinks |
Create a value of ListIncomingTypedLinks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:ListIncomingTypedLinks', listIncomingTypedLinks_consistencyLevel - The consistency level to execute the request at.
ListIncomingTypedLinks, listIncomingTypedLinks_filterAttributeRanges - Provides range filters for multiple attributes. When providing ranges to
typed link selection, any inexact ranges must be specified at the end.
Any attributes that do not have a range specified are presumed to match
the entire range.
ListIncomingTypedLinks, listIncomingTypedLinks_filterTypedLink - Filters are interpreted in the order of the attributes on the typed link
facet, not the order in which they are supplied to any API calls.
ListIncomingTypedLinks, listIncomingTypedLinks_maxResults - The maximum number of results to retrieve.
ListIncomingTypedLinks, listIncomingTypedLinks_nextToken - The pagination token.
ListIncomingTypedLinks, listIncomingTypedLinks_directoryArn - The Amazon Resource Name (ARN) of the directory where you want to list
the typed links.
ListIncomingTypedLinks, listIncomingTypedLinks_objectReference - Reference that identifies the object whose attributes will be listed.
data ListIncomingTypedLinksResponse Source #
See: newListIncomingTypedLinksResponse smart constructor.
Constructors
| ListIncomingTypedLinksResponse' (Maybe [TypedLinkSpecifier]) (Maybe Text) Int |
Instances
newListIncomingTypedLinksResponse Source #
Create a value of ListIncomingTypedLinksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListIncomingTypedLinksResponse, listIncomingTypedLinksResponse_linkSpecifiers - Returns one or more typed link specifiers as output.
ListIncomingTypedLinks, listIncomingTypedLinksResponse_nextToken - The pagination token.
$sel:httpStatus:ListIncomingTypedLinksResponse', listIncomingTypedLinksResponse_httpStatus - The response's http status code.
ListIndex (Paginated)
See: newListIndex smart constructor.
Constructors
| ListIndex' (Maybe ConsistencyLevel) (Maybe Natural) (Maybe Text) (Maybe [ObjectAttributeRange]) Text ObjectReference |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ListIndex |
Create a value of ListIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:ListIndex', listIndex_consistencyLevel - The consistency level to execute the request at.
ListIndex, listIndex_maxResults - The maximum number of objects in a single page to retrieve from the
index during a request. For more information, see
Amazon Cloud Directory Limits.
ListIndex, listIndex_nextToken - The pagination token.
ListIndex, listIndex_rangesOnIndexedValues - Specifies the ranges of indexed values that you want to query.
ListIndex, listIndex_directoryArn - The ARN of the directory that the index exists in.
ListIndex, listIndex_indexReference - The reference to the index to list.
data ListIndexResponse Source #
See: newListIndexResponse smart constructor.
Constructors
| ListIndexResponse' (Maybe [IndexAttachment]) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> ListIndexResponse |
Create a value of ListIndexResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListIndexResponse, listIndexResponse_indexAttachments - The objects and indexed values attached to the index.
ListIndex, listIndexResponse_nextToken - The pagination token.
$sel:httpStatus:ListIndexResponse', listIndexResponse_httpStatus - The response's http status code.
ListManagedSchemaArns (Paginated)
data ListManagedSchemaArns Source #
See: newListManagedSchemaArns smart constructor.
Instances
newListManagedSchemaArns :: ListManagedSchemaArns Source #
Create a value of ListManagedSchemaArns with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListManagedSchemaArns, listManagedSchemaArns_maxResults - The maximum number of results to retrieve.
ListManagedSchemaArns, listManagedSchemaArns_nextToken - The pagination token.
ListManagedSchemaArns, listManagedSchemaArns_schemaArn - The response for ListManagedSchemaArns. When this parameter is used, all
minor version ARNs for a major version are listed.
data ListManagedSchemaArnsResponse Source #
See: newListManagedSchemaArnsResponse smart constructor.
Instances
newListManagedSchemaArnsResponse Source #
Create a value of ListManagedSchemaArnsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListManagedSchemaArns, listManagedSchemaArnsResponse_nextToken - The pagination token.
$sel:schemaArns:ListManagedSchemaArnsResponse', listManagedSchemaArnsResponse_schemaArns - The ARNs for all AWS managed schemas.
$sel:httpStatus:ListManagedSchemaArnsResponse', listManagedSchemaArnsResponse_httpStatus - The response's http status code.
ListObjectAttributes (Paginated)
data ListObjectAttributes Source #
See: newListObjectAttributes smart constructor.
Constructors
| ListObjectAttributes' (Maybe ConsistencyLevel) (Maybe SchemaFacet) (Maybe Natural) (Maybe Text) Text ObjectReference |
Instances
newListObjectAttributes Source #
Create a value of ListObjectAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:ListObjectAttributes', listObjectAttributes_consistencyLevel - Represents the manner and timing in which the successful write or update
of an object is reflected in a subsequent read operation of that same
object.
ListObjectAttributes, listObjectAttributes_facetFilter - Used to filter the list of object attributes that are associated with a
certain facet.
ListObjectAttributes, listObjectAttributes_maxResults - The maximum number of items to be retrieved in a single call. This is an
approximate number.
ListObjectAttributes, listObjectAttributes_nextToken - The pagination token.
ListObjectAttributes, listObjectAttributes_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where the object resides. For more information, see arns.
ListObjectAttributes, listObjectAttributes_objectReference - The reference that identifies the object whose attributes will be
listed.
data ListObjectAttributesResponse Source #
See: newListObjectAttributesResponse smart constructor.
Constructors
| ListObjectAttributesResponse' (Maybe [AttributeKeyAndValue]) (Maybe Text) Int |
Instances
newListObjectAttributesResponse Source #
Create a value of ListObjectAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListObjectAttributesResponse, listObjectAttributesResponse_attributes - Attributes map that is associated with the object. AttributeArn is the
key, and attribute value is the value.
ListObjectAttributes, listObjectAttributesResponse_nextToken - The pagination token.
$sel:httpStatus:ListObjectAttributesResponse', listObjectAttributesResponse_httpStatus - The response's http status code.
ListObjectChildren
data ListObjectChildren Source #
See: newListObjectChildren smart constructor.
Constructors
| ListObjectChildren' (Maybe ConsistencyLevel) (Maybe Natural) (Maybe Text) Text ObjectReference |
Instances
newListObjectChildren Source #
Create a value of ListObjectChildren with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:ListObjectChildren', listObjectChildren_consistencyLevel - Represents the manner and timing in which the successful write or update
of an object is reflected in a subsequent read operation of that same
object.
ListObjectChildren, listObjectChildren_maxResults - The maximum number of items to be retrieved in a single call. This is an
approximate number.
ListObjectChildren, listObjectChildren_nextToken - The pagination token.
ListObjectChildren, listObjectChildren_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where the object resides. For more information, see arns.
ListObjectChildren, listObjectChildren_objectReference - The reference that identifies the object for which child objects are
being listed.
data ListObjectChildrenResponse Source #
See: newListObjectChildrenResponse smart constructor.
Instances
newListObjectChildrenResponse Source #
Create a value of ListObjectChildrenResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListObjectChildrenResponse, listObjectChildrenResponse_children - Children structure, which is a map with key as the LinkName and
ObjectIdentifier as the value.
ListObjectChildren, listObjectChildrenResponse_nextToken - The pagination token.
$sel:httpStatus:ListObjectChildrenResponse', listObjectChildrenResponse_httpStatus - The response's http status code.
ListObjectParentPaths (Paginated)
data ListObjectParentPaths Source #
See: newListObjectParentPaths smart constructor.
Constructors
| ListObjectParentPaths' (Maybe Natural) (Maybe Text) Text ObjectReference |
Instances
newListObjectParentPaths Source #
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ListObjectParentPaths |
Create a value of ListObjectParentPaths with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListObjectParentPaths, listObjectParentPaths_maxResults - The maximum number of items to be retrieved in a single call. This is an
approximate number.
ListObjectParentPaths, listObjectParentPaths_nextToken - The pagination token.
ListObjectParentPaths, listObjectParentPaths_directoryArn - The ARN of the directory to which the parent path applies.
ListObjectParentPaths, listObjectParentPaths_objectReference - The reference that identifies the object whose parent paths are listed.
data ListObjectParentPathsResponse Source #
See: newListObjectParentPathsResponse smart constructor.
Constructors
| ListObjectParentPathsResponse' (Maybe Text) (Maybe [PathToObjectIdentifiers]) Int |
Instances
newListObjectParentPathsResponse Source #
Create a value of ListObjectParentPathsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListObjectParentPaths, listObjectParentPathsResponse_nextToken - The pagination token.
ListObjectParentPathsResponse, listObjectParentPathsResponse_pathToObjectIdentifiersList - Returns the path to the ObjectIdentifiers that are associated with the
directory.
$sel:httpStatus:ListObjectParentPathsResponse', listObjectParentPathsResponse_httpStatus - The response's http status code.
ListObjectParents
data ListObjectParents Source #
See: newListObjectParents smart constructor.
Constructors
| ListObjectParents' (Maybe ConsistencyLevel) (Maybe Bool) (Maybe Natural) (Maybe Text) Text ObjectReference |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ListObjectParents |
Create a value of ListObjectParents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:ListObjectParents', listObjectParents_consistencyLevel - Represents the manner and timing in which the successful write or update
of an object is reflected in a subsequent read operation of that same
object.
$sel:includeAllLinksToEachParent:ListObjectParents', listObjectParents_includeAllLinksToEachParent - When set to True, returns all ListObjectParentsResponse$ParentLinks.
There could be multiple links between a parent-child pair.
ListObjectParents, listObjectParents_maxResults - The maximum number of items to be retrieved in a single call. This is an
approximate number.
ListObjectParents, listObjectParents_nextToken - The pagination token.
ListObjectParents, listObjectParents_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where the object resides. For more information, see arns.
ListObjectParents, listObjectParents_objectReference - The reference that identifies the object for which parent objects are
being listed.
data ListObjectParentsResponse Source #
See: newListObjectParentsResponse smart constructor.
Constructors
| ListObjectParentsResponse' (Maybe Text) (Maybe [ObjectIdentifierAndLinkNameTuple]) (Maybe (HashMap Text Text)) Int |
Instances
newListObjectParentsResponse Source #
Create a value of ListObjectParentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListObjectParents, listObjectParentsResponse_nextToken - The pagination token.
ListObjectParentsResponse, listObjectParentsResponse_parentLinks - Returns a list of parent reference and LinkName Tuples.
$sel:parents:ListObjectParentsResponse', listObjectParentsResponse_parents - The parent structure, which is a map with key as the ObjectIdentifier
and LinkName as the value.
$sel:httpStatus:ListObjectParentsResponse', listObjectParentsResponse_httpStatus - The response's http status code.
ListObjectPolicies (Paginated)
data ListObjectPolicies Source #
See: newListObjectPolicies smart constructor.
Constructors
| ListObjectPolicies' (Maybe ConsistencyLevel) (Maybe Natural) (Maybe Text) Text ObjectReference |
Instances
newListObjectPolicies Source #
Create a value of ListObjectPolicies with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:ListObjectPolicies', listObjectPolicies_consistencyLevel - Represents the manner and timing in which the successful write or update
of an object is reflected in a subsequent read operation of that same
object.
ListObjectPolicies, listObjectPolicies_maxResults - The maximum number of items to be retrieved in a single call. This is an
approximate number.
ListObjectPolicies, listObjectPolicies_nextToken - The pagination token.
ListObjectPolicies, listObjectPolicies_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where objects reside. For more information, see arns.
ListObjectPolicies, listObjectPolicies_objectReference - Reference that identifies the object for which policies will be listed.
data ListObjectPoliciesResponse Source #
See: newListObjectPoliciesResponse smart constructor.
Instances
newListObjectPoliciesResponse Source #
Create a value of ListObjectPoliciesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListObjectPoliciesResponse, listObjectPoliciesResponse_attachedPolicyIds - A list of policy ObjectIdentifiers, that are attached to the object.
ListObjectPolicies, listObjectPoliciesResponse_nextToken - The pagination token.
$sel:httpStatus:ListObjectPoliciesResponse', listObjectPoliciesResponse_httpStatus - The response's http status code.
ListOutgoingTypedLinks (Paginated)
data ListOutgoingTypedLinks Source #
See: newListOutgoingTypedLinks smart constructor.
Constructors
| ListOutgoingTypedLinks' (Maybe ConsistencyLevel) (Maybe [TypedLinkAttributeRange]) (Maybe TypedLinkSchemaAndFacetName) (Maybe Natural) (Maybe Text) Text ObjectReference |
Instances
newListOutgoingTypedLinks Source #
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ListOutgoingTypedLinks |
Create a value of ListOutgoingTypedLinks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:ListOutgoingTypedLinks', listOutgoingTypedLinks_consistencyLevel - The consistency level to execute the request at.
ListOutgoingTypedLinks, listOutgoingTypedLinks_filterAttributeRanges - Provides range filters for multiple attributes. When providing ranges to
typed link selection, any inexact ranges must be specified at the end.
Any attributes that do not have a range specified are presumed to match
the entire range.
ListOutgoingTypedLinks, listOutgoingTypedLinks_filterTypedLink - Filters are interpreted in the order of the attributes defined on the
typed link facet, not the order they are supplied to any API calls.
ListOutgoingTypedLinks, listOutgoingTypedLinks_maxResults - The maximum number of results to retrieve.
ListOutgoingTypedLinks, listOutgoingTypedLinks_nextToken - The pagination token.
ListOutgoingTypedLinks, listOutgoingTypedLinks_directoryArn - The Amazon Resource Name (ARN) of the directory where you want to list
the typed links.
ListOutgoingTypedLinks, listOutgoingTypedLinks_objectReference - A reference that identifies the object whose attributes will be listed.
data ListOutgoingTypedLinksResponse Source #
See: newListOutgoingTypedLinksResponse smart constructor.
Constructors
| ListOutgoingTypedLinksResponse' (Maybe Text) (Maybe [TypedLinkSpecifier]) Int |
Instances
newListOutgoingTypedLinksResponse Source #
Create a value of ListOutgoingTypedLinksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListOutgoingTypedLinks, listOutgoingTypedLinksResponse_nextToken - The pagination token.
ListOutgoingTypedLinksResponse, listOutgoingTypedLinksResponse_typedLinkSpecifiers - Returns a typed link specifier as output.
$sel:httpStatus:ListOutgoingTypedLinksResponse', listOutgoingTypedLinksResponse_httpStatus - The response's http status code.
ListPolicyAttachments (Paginated)
data ListPolicyAttachments Source #
See: newListPolicyAttachments smart constructor.
Constructors
| ListPolicyAttachments' (Maybe ConsistencyLevel) (Maybe Natural) (Maybe Text) Text ObjectReference |
Instances
newListPolicyAttachments Source #
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ListPolicyAttachments |
Create a value of ListPolicyAttachments with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistencyLevel:ListPolicyAttachments', listPolicyAttachments_consistencyLevel - Represents the manner and timing in which the successful write or update
of an object is reflected in a subsequent read operation of that same
object.
ListPolicyAttachments, listPolicyAttachments_maxResults - The maximum number of items to be retrieved in a single call. This is an
approximate number.
ListPolicyAttachments, listPolicyAttachments_nextToken - The pagination token.
ListPolicyAttachments, listPolicyAttachments_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where objects reside. For more information, see arns.
ListPolicyAttachments, listPolicyAttachments_policyReference - The reference that identifies the policy object.
data ListPolicyAttachmentsResponse Source #
See: newListPolicyAttachmentsResponse smart constructor.
Instances
newListPolicyAttachmentsResponse Source #
Create a value of ListPolicyAttachmentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPolicyAttachments, listPolicyAttachmentsResponse_nextToken - The pagination token.
ListPolicyAttachmentsResponse, listPolicyAttachmentsResponse_objectIdentifiers - A list of ObjectIdentifiers to which the policy is attached.
$sel:httpStatus:ListPolicyAttachmentsResponse', listPolicyAttachmentsResponse_httpStatus - The response's http status code.
ListPublishedSchemaArns (Paginated)
data ListPublishedSchemaArns Source #
See: newListPublishedSchemaArns smart constructor.
Instances
newListPublishedSchemaArns :: ListPublishedSchemaArns Source #
Create a value of ListPublishedSchemaArns with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPublishedSchemaArns, listPublishedSchemaArns_maxResults - The maximum number of results to retrieve.
ListPublishedSchemaArns, listPublishedSchemaArns_nextToken - The pagination token.
ListPublishedSchemaArns, listPublishedSchemaArns_schemaArn - The response for ListPublishedSchemaArns when this parameter is used
will list all minor version ARNs for a major version.
data ListPublishedSchemaArnsResponse Source #
See: newListPublishedSchemaArnsResponse smart constructor.
Instances
newListPublishedSchemaArnsResponse Source #
Create a value of ListPublishedSchemaArnsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPublishedSchemaArns, listPublishedSchemaArnsResponse_nextToken - The pagination token.
$sel:schemaArns:ListPublishedSchemaArnsResponse', listPublishedSchemaArnsResponse_schemaArns - The ARNs of published schemas.
$sel:httpStatus:ListPublishedSchemaArnsResponse', listPublishedSchemaArnsResponse_httpStatus - The response's http status code.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource, listTagsForResource_maxResults - The MaxResults parameter sets the maximum number of results returned
in a single page. This is for future use and is not supported currently.
ListTagsForResource, listTagsForResource_nextToken - The pagination token. This is for future use. Currently pagination is
not supported for tagging.
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the resource. Tagging is only
supported for directories.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource, listTagsForResourceResponse_nextToken - The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - A list of tag key value pairs that are associated with the response.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListTypedLinkFacetAttributes (Paginated)
data ListTypedLinkFacetAttributes Source #
See: newListTypedLinkFacetAttributes smart constructor.
Instances
newListTypedLinkFacetAttributes Source #
Arguments
| :: Text | |
| -> Text | |
| -> ListTypedLinkFacetAttributes |
Create a value of ListTypedLinkFacetAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTypedLinkFacetAttributes, listTypedLinkFacetAttributes_maxResults - The maximum number of results to retrieve.
ListTypedLinkFacetAttributes, listTypedLinkFacetAttributes_nextToken - The pagination token.
ListTypedLinkFacetAttributes, listTypedLinkFacetAttributes_schemaArn - The Amazon Resource Name (ARN) that is associated with the schema. For
more information, see arns.
ListTypedLinkFacetAttributes, listTypedLinkFacetAttributes_name - The unique name of the typed link facet.
data ListTypedLinkFacetAttributesResponse Source #
See: newListTypedLinkFacetAttributesResponse smart constructor.
Constructors
| ListTypedLinkFacetAttributesResponse' (Maybe [TypedLinkAttributeDefinition]) (Maybe Text) Int |
Instances
newListTypedLinkFacetAttributesResponse Source #
Arguments
| :: Int | |
| -> ListTypedLinkFacetAttributesResponse |
Create a value of ListTypedLinkFacetAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTypedLinkFacetAttributesResponse, listTypedLinkFacetAttributesResponse_attributes - An ordered set of attributes associate with the typed link.
ListTypedLinkFacetAttributes, listTypedLinkFacetAttributesResponse_nextToken - The pagination token.
$sel:httpStatus:ListTypedLinkFacetAttributesResponse', listTypedLinkFacetAttributesResponse_httpStatus - The response's http status code.
ListTypedLinkFacetNames (Paginated)
data ListTypedLinkFacetNames Source #
See: newListTypedLinkFacetNames smart constructor.
Instances
newListTypedLinkFacetNames Source #
Arguments
| :: Text | |
| -> ListTypedLinkFacetNames |
Create a value of ListTypedLinkFacetNames with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTypedLinkFacetNames, listTypedLinkFacetNames_maxResults - The maximum number of results to retrieve.
ListTypedLinkFacetNames, listTypedLinkFacetNames_nextToken - The pagination token.
ListTypedLinkFacetNames, listTypedLinkFacetNames_schemaArn - The Amazon Resource Name (ARN) that is associated with the schema. For
more information, see arns.
data ListTypedLinkFacetNamesResponse Source #
See: newListTypedLinkFacetNamesResponse smart constructor.
Instances
newListTypedLinkFacetNamesResponse Source #
Create a value of ListTypedLinkFacetNamesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:facetNames:ListTypedLinkFacetNamesResponse', listTypedLinkFacetNamesResponse_facetNames - The names of typed link facets that exist within the schema.
ListTypedLinkFacetNames, listTypedLinkFacetNamesResponse_nextToken - The pagination token.
$sel:httpStatus:ListTypedLinkFacetNamesResponse', listTypedLinkFacetNamesResponse_httpStatus - The response's http status code.
LookupPolicy (Paginated)
data LookupPolicy Source #
See: newLookupPolicy smart constructor.
Constructors
| LookupPolicy' (Maybe Natural) (Maybe Text) Text ObjectReference |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> LookupPolicy |
Create a value of LookupPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
LookupPolicy, lookupPolicy_maxResults - The maximum number of items to be retrieved in a single call. This is an
approximate number.
LookupPolicy, lookupPolicy_nextToken - The token to request the next page of results.
LookupPolicy, lookupPolicy_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory.
For more information, see arns.
LookupPolicy, lookupPolicy_objectReference - Reference that identifies the object whose policies will be looked up.
data LookupPolicyResponse Source #
See: newLookupPolicyResponse smart constructor.
Constructors
| LookupPolicyResponse' (Maybe Text) (Maybe [PolicyToPath]) Int |
Instances
newLookupPolicyResponse Source #
Arguments
| :: Int | |
| -> LookupPolicyResponse |
Create a value of LookupPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
LookupPolicy, lookupPolicyResponse_nextToken - The pagination token.
LookupPolicyResponse, lookupPolicyResponse_policyToPathList - Provides list of path to policies. Policies contain PolicyId,
ObjectIdentifier, and PolicyType. For more information, see
Policies.
$sel:httpStatus:LookupPolicyResponse', lookupPolicyResponse_httpStatus - The response's http status code.
PublishSchema
data PublishSchema Source #
See: newPublishSchema smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> PublishSchema |
Create a value of PublishSchema with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minorVersion:PublishSchema', publishSchema_minorVersion - The minor version under which the schema will be published. This
parameter is recommended. Schemas have both a major and minor version
associated with them.
PublishSchema, publishSchema_name - The new name under which the schema will be published. If this is not
provided, the development schema is considered.
$sel:developmentSchemaArn:PublishSchema', publishSchema_developmentSchemaArn - The Amazon Resource Name (ARN) that is associated with the development
schema. For more information, see arns.
$sel:version:PublishSchema', publishSchema_version - The major version under which the schema will be published. Schemas have
both a major and minor version associated with them.
data PublishSchemaResponse Source #
See: newPublishSchemaResponse smart constructor.
Constructors
| PublishSchemaResponse' (Maybe Text) Int |
Instances
newPublishSchemaResponse Source #
Create a value of PublishSchemaResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:publishedSchemaArn:PublishSchemaResponse', publishSchemaResponse_publishedSchemaArn - The ARN that is associated with the published schema. For more
information, see arns.
$sel:httpStatus:PublishSchemaResponse', publishSchemaResponse_httpStatus - The response's http status code.
PutSchemaFromJson
data PutSchemaFromJson Source #
See: newPutSchemaFromJson smart constructor.
Constructors
| PutSchemaFromJson' Text Text |
Instances
Create a value of PutSchemaFromJson with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutSchemaFromJson, putSchemaFromJson_schemaArn - The ARN of the schema to update.
$sel:document:PutSchemaFromJson', putSchemaFromJson_document - The replacement JSON schema.
data PutSchemaFromJsonResponse Source #
See: newPutSchemaFromJsonResponse smart constructor.
Constructors
| PutSchemaFromJsonResponse' (Maybe Text) Int |
Instances
newPutSchemaFromJsonResponse Source #
Create a value of PutSchemaFromJsonResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:PutSchemaFromJsonResponse', putSchemaFromJsonResponse_arn - The ARN of the schema to update.
$sel:httpStatus:PutSchemaFromJsonResponse', putSchemaFromJsonResponse_httpStatus - The response's http status code.
RemoveFacetFromObject
data RemoveFacetFromObject Source #
See: newRemoveFacetFromObject smart constructor.
Constructors
| RemoveFacetFromObject' Text SchemaFacet ObjectReference |
Instances
newRemoveFacetFromObject Source #
Arguments
| :: Text | |
| -> SchemaFacet | |
| -> ObjectReference | |
| -> RemoveFacetFromObject |
Create a value of RemoveFacetFromObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RemoveFacetFromObject, removeFacetFromObject_directoryArn - The ARN of the directory in which the object resides.
RemoveFacetFromObject, removeFacetFromObject_schemaFacet - The facet to remove. See SchemaFacet for details.
RemoveFacetFromObject, removeFacetFromObject_objectReference - A reference to the object to remove the facet from.
data RemoveFacetFromObjectResponse Source #
See: newRemoveFacetFromObjectResponse smart constructor.
Constructors
| RemoveFacetFromObjectResponse' Int |
Instances
newRemoveFacetFromObjectResponse Source #
Create a value of RemoveFacetFromObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RemoveFacetFromObjectResponse', removeFacetFromObjectResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the resource. Tagging is only
supported for directories.
$sel:tags:TagResource', tagResource_tags - A list of tag key-value pairs.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the resource. Tagging is only
supported for directories.
$sel:tagKeys:UntagResource', untagResource_tagKeys - Keys of the tag that need to be removed from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateFacet
data UpdateFacet Source #
See: newUpdateFacet smart constructor.
Constructors
| UpdateFacet' (Maybe [FacetAttributeUpdate]) (Maybe ObjectType) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateFacet |
Create a value of UpdateFacet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateFacet, updateFacet_attributeUpdates - List of attributes that need to be updated in a given schema Facet. Each
attribute is followed by AttributeAction, which specifies the type of
update operation to perform.
UpdateFacet, updateFacet_objectType - The object type that is associated with the facet. See
CreateFacetRequest$ObjectType for more details.
UpdateFacet, updateFacet_schemaArn - The Amazon Resource Name (ARN) that is associated with the Facet. For
more information, see arns.
UpdateFacet, updateFacet_name - The name of the facet.
data UpdateFacetResponse Source #
See: newUpdateFacetResponse smart constructor.
Constructors
| UpdateFacetResponse' Int |
Instances
newUpdateFacetResponse Source #
Arguments
| :: Int | |
| -> UpdateFacetResponse |
Create a value of UpdateFacetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateFacetResponse', updateFacetResponse_httpStatus - The response's http status code.
UpdateLinkAttributes
data UpdateLinkAttributes Source #
See: newUpdateLinkAttributes smart constructor.
Constructors
| UpdateLinkAttributes' Text TypedLinkSpecifier [LinkAttributeUpdate] |
Instances
newUpdateLinkAttributes Source #
Arguments
| :: Text | |
| -> TypedLinkSpecifier | |
| -> UpdateLinkAttributes |
Create a value of UpdateLinkAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateLinkAttributes, updateLinkAttributes_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where the updated typed link resides. For more information, see arns or
Typed Links.
UpdateLinkAttributes, updateLinkAttributes_typedLinkSpecifier - Allows a typed link specifier to be accepted as input.
UpdateLinkAttributes, updateLinkAttributes_attributeUpdates - The attributes update structure.
data UpdateLinkAttributesResponse Source #
See: newUpdateLinkAttributesResponse smart constructor.
Constructors
| UpdateLinkAttributesResponse' Int |
Instances
newUpdateLinkAttributesResponse Source #
Create a value of UpdateLinkAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateLinkAttributesResponse', updateLinkAttributesResponse_httpStatus - The response's http status code.
UpdateObjectAttributes
data UpdateObjectAttributes Source #
See: newUpdateObjectAttributes smart constructor.
Constructors
| UpdateObjectAttributes' Text ObjectReference [ObjectAttributeUpdate] |
Instances
newUpdateObjectAttributes Source #
Arguments
| :: Text | |
| -> ObjectReference | |
| -> UpdateObjectAttributes |
Create a value of UpdateObjectAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateObjectAttributes, updateObjectAttributes_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where the object resides. For more information, see arns.
UpdateObjectAttributes, updateObjectAttributes_objectReference - The reference that identifies the object.
UpdateObjectAttributes, updateObjectAttributes_attributeUpdates - The attributes update structure.
data UpdateObjectAttributesResponse Source #
See: newUpdateObjectAttributesResponse smart constructor.
Constructors
| UpdateObjectAttributesResponse' (Maybe Text) Int |
Instances
newUpdateObjectAttributesResponse Source #
Create a value of UpdateObjectAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateObjectAttributesResponse, updateObjectAttributesResponse_objectIdentifier - The ObjectIdentifier of the updated object.
$sel:httpStatus:UpdateObjectAttributesResponse', updateObjectAttributesResponse_httpStatus - The response's http status code.
UpdateSchema
data UpdateSchema Source #
See: newUpdateSchema smart constructor.
Constructors
| UpdateSchema' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateSchema |
Create a value of UpdateSchema with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateSchema, updateSchema_schemaArn - The Amazon Resource Name (ARN) of the development schema. For more
information, see arns.
UpdateSchema, updateSchema_name - The name of the schema.
data UpdateSchemaResponse Source #
See: newUpdateSchemaResponse smart constructor.
Constructors
| UpdateSchemaResponse' (Maybe Text) Int |
Instances
newUpdateSchemaResponse Source #
Arguments
| :: Int | |
| -> UpdateSchemaResponse |
Create a value of UpdateSchemaResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateSchema, updateSchemaResponse_schemaArn - The ARN that is associated with the updated schema. For more
information, see arns.
$sel:httpStatus:UpdateSchemaResponse', updateSchemaResponse_httpStatus - The response's http status code.
UpdateTypedLinkFacet
data UpdateTypedLinkFacet Source #
See: newUpdateTypedLinkFacet smart constructor.
Constructors
| UpdateTypedLinkFacet' Text Text [TypedLinkFacetAttributeUpdate] [Text] |
Instances
newUpdateTypedLinkFacet Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateTypedLinkFacet |
Create a value of UpdateTypedLinkFacet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTypedLinkFacet, updateTypedLinkFacet_schemaArn - The Amazon Resource Name (ARN) that is associated with the schema. For
more information, see arns.
UpdateTypedLinkFacet, updateTypedLinkFacet_name - The unique name of the typed link facet.
UpdateTypedLinkFacet, updateTypedLinkFacet_attributeUpdates - Attributes update structure.
UpdateTypedLinkFacet, updateTypedLinkFacet_identityAttributeOrder - The order of identity attributes for the facet, from most significant to
least significant. The ability to filter typed links considers the order
that the attributes are defined on the typed link facet. When providing
ranges to a typed link selection, any inexact ranges must be specified
at the end. Any attributes that do not have a range specified are
presumed to match the entire range. Filters are interpreted in the order
of the attributes on the typed link facet, not the order in which they
are supplied to any API calls. For more information about identity
attributes, see
Typed Links.
data UpdateTypedLinkFacetResponse Source #
See: newUpdateTypedLinkFacetResponse smart constructor.
Constructors
| UpdateTypedLinkFacetResponse' Int |
Instances
newUpdateTypedLinkFacetResponse Source #
Create a value of UpdateTypedLinkFacetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateTypedLinkFacetResponse', updateTypedLinkFacetResponse_httpStatus - The response's http status code.
UpgradeAppliedSchema
data UpgradeAppliedSchema Source #
See: newUpgradeAppliedSchema smart constructor.
Constructors
| UpgradeAppliedSchema' (Maybe Bool) Text Text |
Instances
newUpgradeAppliedSchema Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpgradeAppliedSchema |
Create a value of UpgradeAppliedSchema with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:UpgradeAppliedSchema', upgradeAppliedSchema_dryRun - Used for testing whether the major version schemas are backward
compatible or not. If schema compatibility fails, an exception would be
thrown else the call would succeed but no changes will be saved. This
parameter is optional.
$sel:publishedSchemaArn:UpgradeAppliedSchema', upgradeAppliedSchema_publishedSchemaArn - The revision of the published schema to upgrade the directory to.
UpgradeAppliedSchema, upgradeAppliedSchema_directoryArn - The ARN for the directory to which the upgraded schema will be applied.
data UpgradeAppliedSchemaResponse Source #
See: newUpgradeAppliedSchemaResponse smart constructor.
Instances
newUpgradeAppliedSchemaResponse Source #
Create a value of UpgradeAppliedSchemaResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpgradeAppliedSchema, upgradeAppliedSchemaResponse_directoryArn - The ARN of the directory that is returned as part of the response.
$sel:upgradedSchemaArn:UpgradeAppliedSchemaResponse', upgradeAppliedSchemaResponse_upgradedSchemaArn - The ARN of the upgraded schema that is returned as part of the response.
$sel:httpStatus:UpgradeAppliedSchemaResponse', upgradeAppliedSchemaResponse_httpStatus - The response's http status code.
UpgradePublishedSchema
data UpgradePublishedSchema Source #
See: newUpgradePublishedSchema smart constructor.
Instances
newUpgradePublishedSchema Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpgradePublishedSchema |
Create a value of UpgradePublishedSchema with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:UpgradePublishedSchema', upgradePublishedSchema_dryRun - Used for testing whether the Development schema provided is backwards
compatible, or not, with the publish schema provided by the user to be
upgraded. If schema compatibility fails, an exception would be thrown
else the call would succeed. This parameter is optional and defaults to
false.
$sel:developmentSchemaArn:UpgradePublishedSchema', upgradePublishedSchema_developmentSchemaArn - The ARN of the development schema with the changes used for the upgrade.
$sel:publishedSchemaArn:UpgradePublishedSchema', upgradePublishedSchema_publishedSchemaArn - The ARN of the published schema to be upgraded.
$sel:minorVersion:UpgradePublishedSchema', upgradePublishedSchema_minorVersion - Identifies the minor version of the published schema that will be
created. This parameter is NOT optional.
data UpgradePublishedSchemaResponse Source #
See: newUpgradePublishedSchemaResponse smart constructor.
Constructors
| UpgradePublishedSchemaResponse' (Maybe Text) Int |
Instances
newUpgradePublishedSchemaResponse Source #
Create a value of UpgradePublishedSchemaResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:upgradedSchemaArn:UpgradePublishedSchemaResponse', upgradePublishedSchemaResponse_upgradedSchemaArn - The ARN of the upgraded schema that is returned as part of the response.
$sel:httpStatus:UpgradePublishedSchemaResponse', upgradePublishedSchemaResponse_httpStatus - The response's http status code.
Types
BatchReadExceptionType
newtype BatchReadExceptionType Source #
Constructors
| BatchReadExceptionType' | |
Fields | |
Bundled Patterns
Instances
ConsistencyLevel
newtype ConsistencyLevel Source #
Constructors
| ConsistencyLevel' | |
Fields | |
Bundled Patterns
| pattern ConsistencyLevel_EVENTUAL :: ConsistencyLevel | |
| pattern ConsistencyLevel_SERIALIZABLE :: ConsistencyLevel |
Instances
DirectoryState
newtype DirectoryState Source #
Constructors
| DirectoryState' | |
Fields | |
Bundled Patterns
| pattern DirectoryState_DELETED :: DirectoryState | |
| pattern DirectoryState_DISABLED :: DirectoryState | |
| pattern DirectoryState_ENABLED :: DirectoryState |
Instances
FacetAttributeType
newtype FacetAttributeType Source #
Constructors
| FacetAttributeType' | |
Fields | |
Bundled Patterns
| pattern FacetAttributeType_BINARY :: FacetAttributeType | |
| pattern FacetAttributeType_BOOLEAN :: FacetAttributeType | |
| pattern FacetAttributeType_DATETIME :: FacetAttributeType | |
| pattern FacetAttributeType_NUMBER :: FacetAttributeType | |
| pattern FacetAttributeType_STRING :: FacetAttributeType | |
| pattern FacetAttributeType_VARIANT :: FacetAttributeType |
Instances
FacetStyle
newtype FacetStyle Source #
Constructors
| FacetStyle' | |
Fields | |
Bundled Patterns
| pattern FacetStyle_DYNAMIC :: FacetStyle | |
| pattern FacetStyle_STATIC :: FacetStyle |
Instances
ObjectType
newtype ObjectType Source #
Constructors
| ObjectType' | |
Fields | |
Bundled Patterns
| pattern ObjectType_INDEX :: ObjectType | |
| pattern ObjectType_LEAF_NODE :: ObjectType | |
| pattern ObjectType_NODE :: ObjectType | |
| pattern ObjectType_POLICY :: ObjectType |
Instances
RangeMode
Constructors
| RangeMode' | |
Fields | |
Bundled Patterns
| pattern RangeMode_EXCLUSIVE :: RangeMode | |
| pattern RangeMode_FIRST :: RangeMode | |
| pattern RangeMode_INCLUSIVE :: RangeMode | |
| pattern RangeMode_LAST :: RangeMode | |
| pattern RangeMode_LAST_BEFORE_MISSING_VALUES :: RangeMode |
Instances
RequiredAttributeBehavior
newtype RequiredAttributeBehavior Source #
Constructors
| RequiredAttributeBehavior' | |
Fields | |
Bundled Patterns
| pattern RequiredAttributeBehavior_NOT_REQUIRED :: RequiredAttributeBehavior | |
| pattern RequiredAttributeBehavior_REQUIRED_ALWAYS :: RequiredAttributeBehavior |
Instances
RuleType
Constructors
| RuleType' | |
Fields
| |
Bundled Patterns
| pattern RuleType_BINARY_LENGTH :: RuleType | |
| pattern RuleType_NUMBER_COMPARISON :: RuleType | |
| pattern RuleType_STRING_FROM_SET :: RuleType | |
| pattern RuleType_STRING_LENGTH :: RuleType |
Instances
UpdateActionType
newtype UpdateActionType Source #
Constructors
| UpdateActionType' | |
Fields | |
Bundled Patterns
| pattern UpdateActionType_CREATE_OR_UPDATE :: UpdateActionType | |
| pattern UpdateActionType_DELETE :: UpdateActionType |
Instances
AttributeKey
data AttributeKey Source #
A unique identifier for an attribute.
See: newAttributeKey smart constructor.
Constructors
| AttributeKey' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AttributeKey |
Create a value of AttributeKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:schemaArn:AttributeKey', attributeKey_schemaArn - The Amazon Resource Name (ARN) of the schema that contains the facet and
attribute.
$sel:facetName:AttributeKey', attributeKey_facetName - The name of the facet that the attribute exists within.
$sel:name:AttributeKey', attributeKey_name - The name of the attribute.
AttributeKeyAndValue
data AttributeKeyAndValue Source #
The combination of an attribute key and an attribute value.
See: newAttributeKeyAndValue smart constructor.
Constructors
| AttributeKeyAndValue' AttributeKey TypedAttributeValue |
Instances
newAttributeKeyAndValue Source #
Arguments
| :: AttributeKey | |
| -> TypedAttributeValue | |
| -> AttributeKeyAndValue |
Create a value of AttributeKeyAndValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:AttributeKeyAndValue', attributeKeyAndValue_key - The key of the attribute.
$sel:value:AttributeKeyAndValue', attributeKeyAndValue_value - The value of the attribute.
AttributeNameAndValue
data AttributeNameAndValue Source #
Identifies the attribute name and value for a typed link.
See: newAttributeNameAndValue smart constructor.
Constructors
| AttributeNameAndValue' Text TypedAttributeValue |
Instances
newAttributeNameAndValue Source #
Arguments
| :: Text | |
| -> TypedAttributeValue | |
| -> AttributeNameAndValue |
Create a value of AttributeNameAndValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeName:AttributeNameAndValue', attributeNameAndValue_attributeName - The attribute name of the typed link.
$sel:value:AttributeNameAndValue', attributeNameAndValue_value - The value for the typed link.
BatchAddFacetToObject
data BatchAddFacetToObject Source #
Represents the output of a batch add facet to object operation.
See: newBatchAddFacetToObject smart constructor.
Constructors
| BatchAddFacetToObject' SchemaFacet [AttributeKeyAndValue] ObjectReference |
Instances
newBatchAddFacetToObject Source #
Arguments
| :: SchemaFacet | |
| -> ObjectReference | |
| -> BatchAddFacetToObject |
Create a value of BatchAddFacetToObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:schemaFacet:BatchAddFacetToObject', batchAddFacetToObject_schemaFacet - Represents the facet being added to the object.
$sel:objectAttributeList:BatchAddFacetToObject', batchAddFacetToObject_objectAttributeList - The attributes to set on the object.
$sel:objectReference:BatchAddFacetToObject', batchAddFacetToObject_objectReference - A reference to the object being mutated.
BatchAddFacetToObjectResponse
data BatchAddFacetToObjectResponse Source #
The result of a batch add facet to object operation.
See: newBatchAddFacetToObjectResponse smart constructor.
Constructors
| BatchAddFacetToObjectResponse' | |
Instances
newBatchAddFacetToObjectResponse :: BatchAddFacetToObjectResponse Source #
Create a value of BatchAddFacetToObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
BatchAttachObject
data BatchAttachObject Source #
Represents the output of an AttachObject operation.
See: newBatchAttachObject smart constructor.
Constructors
| BatchAttachObject' ObjectReference ObjectReference Text |
Instances
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> Text | |
| -> BatchAttachObject |
Create a value of BatchAttachObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parentReference:BatchAttachObject', batchAttachObject_parentReference - The parent object reference.
$sel:childReference:BatchAttachObject', batchAttachObject_childReference - The child object reference that is to be attached to the object.
$sel:linkName:BatchAttachObject', batchAttachObject_linkName - The name of the link.
BatchAttachObjectResponse
data BatchAttachObjectResponse Source #
Represents the output batch AttachObject response operation.
See: newBatchAttachObjectResponse smart constructor.
Constructors
| BatchAttachObjectResponse' (Maybe Text) |
Instances
newBatchAttachObjectResponse :: BatchAttachObjectResponse Source #
Create a value of BatchAttachObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attachedObjectIdentifier:BatchAttachObjectResponse', batchAttachObjectResponse_attachedObjectIdentifier - 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: newBatchAttachPolicy smart constructor.
Constructors
| BatchAttachPolicy' ObjectReference ObjectReference |
Instances
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> BatchAttachPolicy |
Create a value of BatchAttachPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyReference:BatchAttachPolicy', batchAttachPolicy_policyReference - The reference that is associated with the policy object.
$sel:objectReference:BatchAttachPolicy', batchAttachPolicy_objectReference - 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: newBatchAttachPolicyResponse smart constructor.
Constructors
| BatchAttachPolicyResponse' | |
Instances
newBatchAttachPolicyResponse :: BatchAttachPolicyResponse Source #
Create a value of BatchAttachPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
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: newBatchAttachToIndex smart constructor.
Constructors
| BatchAttachToIndex' ObjectReference ObjectReference |
Instances
newBatchAttachToIndex Source #
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> BatchAttachToIndex |
Create a value of BatchAttachToIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexReference:BatchAttachToIndex', batchAttachToIndex_indexReference - A reference to the index that you are attaching the object to.
$sel:targetReference:BatchAttachToIndex', batchAttachToIndex_targetReference - 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: newBatchAttachToIndexResponse smart constructor.
Constructors
| BatchAttachToIndexResponse' (Maybe Text) |
Instances
newBatchAttachToIndexResponse :: BatchAttachToIndexResponse Source #
Create a value of BatchAttachToIndexResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attachedObjectIdentifier:BatchAttachToIndexResponse', batchAttachToIndexResponse_attachedObjectIdentifier - 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: newBatchAttachTypedLink smart constructor.
Constructors
| BatchAttachTypedLink' ObjectReference ObjectReference TypedLinkSchemaAndFacetName [AttributeNameAndValue] |
Instances
newBatchAttachTypedLink Source #
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> TypedLinkSchemaAndFacetName | |
| -> BatchAttachTypedLink |
Create a value of BatchAttachTypedLink with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceObjectReference:BatchAttachTypedLink', batchAttachTypedLink_sourceObjectReference - Identifies the source object that the typed link will attach to.
$sel:targetObjectReference:BatchAttachTypedLink', batchAttachTypedLink_targetObjectReference - Identifies the target object that the typed link will attach to.
$sel:typedLinkFacet:BatchAttachTypedLink', batchAttachTypedLink_typedLinkFacet - Identifies the typed link facet that is associated with the typed link.
$sel:attributes:BatchAttachTypedLink', batchAttachTypedLink_attributes - A set of attributes that are associated with the typed link.
BatchAttachTypedLinkResponse
data BatchAttachTypedLinkResponse Source #
Represents the output of a AttachTypedLink response operation.
See: newBatchAttachTypedLinkResponse smart constructor.
Constructors
| BatchAttachTypedLinkResponse' (Maybe TypedLinkSpecifier) |
Instances
newBatchAttachTypedLinkResponse :: BatchAttachTypedLinkResponse Source #
Create a value of BatchAttachTypedLinkResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:typedLinkSpecifier:BatchAttachTypedLinkResponse', batchAttachTypedLinkResponse_typedLinkSpecifier - 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: newBatchCreateIndex smart constructor.
Constructors
| BatchCreateIndex' (Maybe Text) (Maybe Text) (Maybe ObjectReference) [AttributeKey] Bool |
Instances
Arguments
| :: Bool | |
| -> BatchCreateIndex |
Create a value of BatchCreateIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:batchReferenceName:BatchCreateIndex', batchCreateIndex_batchReferenceName - The batch reference name. See
Transaction Support
for more information.
$sel:linkName:BatchCreateIndex', batchCreateIndex_linkName - The name of the link between the parent object and the index object.
$sel:parentReference:BatchCreateIndex', batchCreateIndex_parentReference - A reference to the parent object that contains the index object.
$sel:orderedIndexedAttributeList:BatchCreateIndex', batchCreateIndex_orderedIndexedAttributeList - Specifies the attributes that should be indexed on. Currently only a
single attribute is supported.
$sel:isUnique:BatchCreateIndex', batchCreateIndex_isUnique - 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: newBatchCreateIndexResponse smart constructor.
Constructors
| BatchCreateIndexResponse' (Maybe Text) |
Instances
newBatchCreateIndexResponse :: BatchCreateIndexResponse Source #
Create a value of BatchCreateIndexResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectIdentifier:BatchCreateIndexResponse', batchCreateIndexResponse_objectIdentifier - The ObjectIdentifier of the index created by this operation.
BatchCreateObject
data BatchCreateObject Source #
Represents the output of a CreateObject operation.
See: newBatchCreateObject smart constructor.
Constructors
| BatchCreateObject' (Maybe Text) (Maybe Text) (Maybe ObjectReference) [SchemaFacet] [AttributeKeyAndValue] |
Instances
newBatchCreateObject :: BatchCreateObject Source #
Create a value of BatchCreateObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:batchReferenceName:BatchCreateObject', batchCreateObject_batchReferenceName - The batch reference name. See
Transaction Support
for more information.
$sel:linkName:BatchCreateObject', batchCreateObject_linkName - The name of the link.
$sel:parentReference:BatchCreateObject', batchCreateObject_parentReference - If specified, the parent reference to which this object will be
attached.
$sel:schemaFacet:BatchCreateObject', batchCreateObject_schemaFacet - A list of FacetArns that will be associated with the object. For more
information, see arns.
$sel:objectAttributeList:BatchCreateObject', batchCreateObject_objectAttributeList - 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: newBatchCreateObjectResponse smart constructor.
Constructors
| BatchCreateObjectResponse' (Maybe Text) |
Instances
newBatchCreateObjectResponse :: BatchCreateObjectResponse Source #
Create a value of BatchCreateObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectIdentifier:BatchCreateObjectResponse', batchCreateObjectResponse_objectIdentifier - The ID that is associated with the object.
BatchDeleteObject
data BatchDeleteObject Source #
Represents the output of a DeleteObject operation.
See: newBatchDeleteObject smart constructor.
Constructors
| BatchDeleteObject' ObjectReference |
Instances
Create a value of BatchDeleteObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectReference:BatchDeleteObject', batchDeleteObject_objectReference - The reference that identifies the object.
BatchDeleteObjectResponse
data BatchDeleteObjectResponse Source #
Represents the output of a DeleteObject response operation.
See: newBatchDeleteObjectResponse smart constructor.
Constructors
| BatchDeleteObjectResponse' | |
Instances
newBatchDeleteObjectResponse :: BatchDeleteObjectResponse Source #
Create a value of BatchDeleteObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
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: newBatchDetachFromIndex smart constructor.
Constructors
| BatchDetachFromIndex' ObjectReference ObjectReference |
Instances
newBatchDetachFromIndex Source #
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> BatchDetachFromIndex |
Create a value of BatchDetachFromIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexReference:BatchDetachFromIndex', batchDetachFromIndex_indexReference - A reference to the index object.
$sel:targetReference:BatchDetachFromIndex', batchDetachFromIndex_targetReference - A reference to the object being detached from the index.
BatchDetachFromIndexResponse
data BatchDetachFromIndexResponse Source #
Represents the output of a DetachFromIndex response operation.
See: newBatchDetachFromIndexResponse smart constructor.
Constructors
| BatchDetachFromIndexResponse' (Maybe Text) |
Instances
newBatchDetachFromIndexResponse :: BatchDetachFromIndexResponse Source #
Create a value of BatchDetachFromIndexResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:detachedObjectIdentifier:BatchDetachFromIndexResponse', batchDetachFromIndexResponse_detachedObjectIdentifier - The ObjectIdentifier of the object that was detached from the index.
BatchDetachObject
data BatchDetachObject Source #
Represents the output of a DetachObject operation.
See: newBatchDetachObject smart constructor.
Constructors
| BatchDetachObject' (Maybe Text) ObjectReference Text |
Instances
Arguments
| :: ObjectReference | |
| -> Text | |
| -> BatchDetachObject |
Create a value of BatchDetachObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:batchReferenceName:BatchDetachObject', batchDetachObject_batchReferenceName - The batch reference name. See
Transaction Support
for more information.
$sel:parentReference:BatchDetachObject', batchDetachObject_parentReference - Parent reference from which the object with the specified link name is
detached.
$sel:linkName:BatchDetachObject', batchDetachObject_linkName - The name of the link.
BatchDetachObjectResponse
data BatchDetachObjectResponse Source #
Represents the output of a DetachObject response operation.
See: newBatchDetachObjectResponse smart constructor.
Constructors
| BatchDetachObjectResponse' (Maybe Text) |
Instances
newBatchDetachObjectResponse :: BatchDetachObjectResponse Source #
Create a value of BatchDetachObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:detachedObjectIdentifier:BatchDetachObjectResponse', batchDetachObjectResponse_detachedObjectIdentifier - 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: newBatchDetachPolicy smart constructor.
Constructors
| BatchDetachPolicy' ObjectReference ObjectReference |
Instances
Arguments
| :: ObjectReference | |
| -> ObjectReference | |
| -> BatchDetachPolicy |
Create a value of BatchDetachPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyReference:BatchDetachPolicy', batchDetachPolicy_policyReference - Reference that identifies the policy object.
$sel:objectReference:BatchDetachPolicy', batchDetachPolicy_objectReference - Reference that identifies the object whose policy object will be
detached.
BatchDetachPolicyResponse
data BatchDetachPolicyResponse Source #
Represents the output of a DetachPolicy response operation.
See: newBatchDetachPolicyResponse smart constructor.
Constructors
| BatchDetachPolicyResponse' | |
Instances
newBatchDetachPolicyResponse :: BatchDetachPolicyResponse Source #
Create a value of BatchDetachPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
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: newBatchDetachTypedLink smart constructor.
Constructors
| BatchDetachTypedLink' TypedLinkSpecifier |
Instances
newBatchDetachTypedLink Source #
Create a value of BatchDetachTypedLink with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:typedLinkSpecifier:BatchDetachTypedLink', batchDetachTypedLink_typedLinkSpecifier - Used to accept a typed link specifier as input.
BatchDetachTypedLinkResponse
data BatchDetachTypedLinkResponse Source #
Represents the output of a DetachTypedLink response operation.
See: newBatchDetachTypedLinkResponse smart constructor.
Constructors
| BatchDetachTypedLinkResponse' | |
Instances
newBatchDetachTypedLinkResponse :: BatchDetachTypedLinkResponse Source #
Create a value of BatchDetachTypedLinkResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
BatchGetLinkAttributes
data BatchGetLinkAttributes Source #
Retrieves attributes that are associated with a typed link inside a BatchRead operation. For more information, see GetLinkAttributes and BatchReadRequest$Operations.
See: newBatchGetLinkAttributes smart constructor.
Constructors
| BatchGetLinkAttributes' TypedLinkSpecifier [Text] |
Instances
newBatchGetLinkAttributes Source #
Arguments
| :: TypedLinkSpecifier | |
| -> BatchGetLinkAttributes |
Create a value of BatchGetLinkAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:typedLinkSpecifier:BatchGetLinkAttributes', batchGetLinkAttributes_typedLinkSpecifier - Allows a typed link specifier to be accepted as input.
$sel:attributeNames:BatchGetLinkAttributes', batchGetLinkAttributes_attributeNames - A list of attribute names whose values will be retrieved.
BatchGetLinkAttributesResponse
data BatchGetLinkAttributesResponse Source #
Represents the output of a GetLinkAttributes response operation.
See: newBatchGetLinkAttributesResponse smart constructor.
Constructors
| BatchGetLinkAttributesResponse' (Maybe [AttributeKeyAndValue]) |
Instances
newBatchGetLinkAttributesResponse :: BatchGetLinkAttributesResponse Source #
Create a value of BatchGetLinkAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:BatchGetLinkAttributesResponse', batchGetLinkAttributesResponse_attributes - The attributes that are associated with the typed link.
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: newBatchGetObjectAttributes smart constructor.
Constructors
| BatchGetObjectAttributes' ObjectReference SchemaFacet [Text] |
Instances
newBatchGetObjectAttributes Source #
Arguments
| :: ObjectReference | |
| -> SchemaFacet | |
| -> BatchGetObjectAttributes |
Create a value of BatchGetObjectAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectReference:BatchGetObjectAttributes', batchGetObjectAttributes_objectReference - Reference that identifies the object whose attributes will be retrieved.
$sel:schemaFacet:BatchGetObjectAttributes', batchGetObjectAttributes_schemaFacet - Identifier for the facet whose attributes will be retrieved. See
SchemaFacet for details.
$sel:attributeNames:BatchGetObjectAttributes', batchGetObjectAttributes_attributeNames - List of attribute names whose values will be retrieved.
BatchGetObjectAttributesResponse
data BatchGetObjectAttributesResponse Source #
Represents the output of a GetObjectAttributes response operation.
See: newBatchGetObjectAttributesResponse smart constructor.
Constructors
| BatchGetObjectAttributesResponse' (Maybe [AttributeKeyAndValue]) |
Instances
newBatchGetObjectAttributesResponse :: BatchGetObjectAttributesResponse Source #
Create a value of BatchGetObjectAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:BatchGetObjectAttributesResponse', batchGetObjectAttributesResponse_attributes - 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: newBatchGetObjectInformation smart constructor.
Constructors
| BatchGetObjectInformation' ObjectReference |
Instances
newBatchGetObjectInformation Source #
Arguments
| :: ObjectReference | |
| -> BatchGetObjectInformation |
Create a value of BatchGetObjectInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectReference:BatchGetObjectInformation', batchGetObjectInformation_objectReference - A reference to the object.
BatchGetObjectInformationResponse
data BatchGetObjectInformationResponse Source #
Represents the output of a GetObjectInformation response operation.
See: newBatchGetObjectInformationResponse smart constructor.
Constructors
| BatchGetObjectInformationResponse' (Maybe Text) (Maybe [SchemaFacet]) |
Instances
newBatchGetObjectInformationResponse :: BatchGetObjectInformationResponse Source #
Create a value of BatchGetObjectInformationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectIdentifier:BatchGetObjectInformationResponse', batchGetObjectInformationResponse_objectIdentifier - The ObjectIdentifier of the specified object.
$sel:schemaFacets:BatchGetObjectInformationResponse', batchGetObjectInformationResponse_schemaFacets - 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: newBatchListAttachedIndices smart constructor.
Constructors
| BatchListAttachedIndices' (Maybe Natural) (Maybe Text) ObjectReference |
Instances
newBatchListAttachedIndices Source #
Arguments
| :: ObjectReference | |
| -> BatchListAttachedIndices |
Create a value of BatchListAttachedIndices with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:BatchListAttachedIndices', batchListAttachedIndices_maxResults - The maximum number of results to retrieve.
$sel:nextToken:BatchListAttachedIndices', batchListAttachedIndices_nextToken - The pagination token.
$sel:targetReference:BatchListAttachedIndices', batchListAttachedIndices_targetReference - A reference to the object that has indices attached.
BatchListAttachedIndicesResponse
data BatchListAttachedIndicesResponse Source #
Represents the output of a ListAttachedIndices response operation.
See: newBatchListAttachedIndicesResponse smart constructor.
Constructors
| BatchListAttachedIndicesResponse' (Maybe [IndexAttachment]) (Maybe Text) |
Instances
newBatchListAttachedIndicesResponse :: BatchListAttachedIndicesResponse Source #
Create a value of BatchListAttachedIndicesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexAttachments:BatchListAttachedIndicesResponse', batchListAttachedIndicesResponse_indexAttachments - The indices attached to the specified object.
$sel:nextToken:BatchListAttachedIndicesResponse', batchListAttachedIndicesResponse_nextToken - 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: newBatchListIncomingTypedLinks smart constructor.
Constructors
| BatchListIncomingTypedLinks' (Maybe [TypedLinkAttributeRange]) (Maybe TypedLinkSchemaAndFacetName) (Maybe Natural) (Maybe Text) ObjectReference |
Instances
newBatchListIncomingTypedLinks Source #
Arguments
| :: ObjectReference | |
| -> BatchListIncomingTypedLinks |
Create a value of BatchListIncomingTypedLinks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filterAttributeRanges:BatchListIncomingTypedLinks', batchListIncomingTypedLinks_filterAttributeRanges - Provides range filters for multiple attributes. When providing ranges to
typed link selection, any inexact ranges must be specified at the end.
Any attributes that do not have a range specified are presumed to match
the entire range.
$sel:filterTypedLink:BatchListIncomingTypedLinks', batchListIncomingTypedLinks_filterTypedLink - Filters are interpreted in the order of the attributes on the typed link
facet, not the order in which they are supplied to any API calls.
$sel:maxResults:BatchListIncomingTypedLinks', batchListIncomingTypedLinks_maxResults - The maximum number of results to retrieve.
$sel:nextToken:BatchListIncomingTypedLinks', batchListIncomingTypedLinks_nextToken - The pagination token.
$sel:objectReference:BatchListIncomingTypedLinks', batchListIncomingTypedLinks_objectReference - The reference that identifies the object whose attributes will be
listed.
BatchListIncomingTypedLinksResponse
data BatchListIncomingTypedLinksResponse Source #
Represents the output of a ListIncomingTypedLinks response operation.
See: newBatchListIncomingTypedLinksResponse smart constructor.
Constructors
| BatchListIncomingTypedLinksResponse' (Maybe [TypedLinkSpecifier]) (Maybe Text) |
Instances
newBatchListIncomingTypedLinksResponse :: BatchListIncomingTypedLinksResponse Source #
Create a value of BatchListIncomingTypedLinksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:linkSpecifiers:BatchListIncomingTypedLinksResponse', batchListIncomingTypedLinksResponse_linkSpecifiers - Returns one or more typed link specifiers as output.
$sel:nextToken:BatchListIncomingTypedLinksResponse', batchListIncomingTypedLinksResponse_nextToken - 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: newBatchListIndex smart constructor.
Constructors
| BatchListIndex' (Maybe Natural) (Maybe Text) (Maybe [ObjectAttributeRange]) ObjectReference |
Instances
Create a value of BatchListIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:BatchListIndex', batchListIndex_maxResults - The maximum number of results to retrieve.
$sel:nextToken:BatchListIndex', batchListIndex_nextToken - The pagination token.
$sel:rangesOnIndexedValues:BatchListIndex', batchListIndex_rangesOnIndexedValues - Specifies the ranges of indexed values that you want to query.
$sel:indexReference:BatchListIndex', batchListIndex_indexReference - The reference to the index to list.
BatchListIndexResponse
data BatchListIndexResponse Source #
Represents the output of a ListIndex response operation.
See: newBatchListIndexResponse smart constructor.
Constructors
| BatchListIndexResponse' (Maybe [IndexAttachment]) (Maybe Text) |
Instances
newBatchListIndexResponse :: BatchListIndexResponse Source #
Create a value of BatchListIndexResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexAttachments:BatchListIndexResponse', batchListIndexResponse_indexAttachments - The objects and indexed values attached to the index.
$sel:nextToken:BatchListIndexResponse', batchListIndexResponse_nextToken - The pagination token.
BatchListObjectAttributes
data BatchListObjectAttributes Source #
Represents the output of a ListObjectAttributes operation.
See: newBatchListObjectAttributes smart constructor.
Constructors
| BatchListObjectAttributes' (Maybe SchemaFacet) (Maybe Natural) (Maybe Text) ObjectReference |
Instances
newBatchListObjectAttributes Source #
Arguments
| :: ObjectReference | |
| -> BatchListObjectAttributes |
Create a value of BatchListObjectAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:facetFilter:BatchListObjectAttributes', batchListObjectAttributes_facetFilter - Used to filter the list of object attributes that are associated with a
certain facet.
$sel:maxResults:BatchListObjectAttributes', batchListObjectAttributes_maxResults - The maximum number of items to be retrieved in a single call. This is an
approximate number.
$sel:nextToken:BatchListObjectAttributes', batchListObjectAttributes_nextToken - The pagination token.
$sel:objectReference:BatchListObjectAttributes', batchListObjectAttributes_objectReference - Reference of the object whose attributes need to be listed.
BatchListObjectAttributesResponse
data BatchListObjectAttributesResponse Source #
Represents the output of a ListObjectAttributes response operation.
See: newBatchListObjectAttributesResponse smart constructor.
Constructors
| BatchListObjectAttributesResponse' (Maybe [AttributeKeyAndValue]) (Maybe Text) |
Instances
newBatchListObjectAttributesResponse :: BatchListObjectAttributesResponse Source #
Create a value of BatchListObjectAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:BatchListObjectAttributesResponse', batchListObjectAttributesResponse_attributes - The attributes map that is associated with the object. AttributeArn is
the key; attribute value is the value.
$sel:nextToken:BatchListObjectAttributesResponse', batchListObjectAttributesResponse_nextToken - The pagination token.
BatchListObjectChildren
data BatchListObjectChildren Source #
Represents the output of a ListObjectChildren operation.
See: newBatchListObjectChildren smart constructor.
Constructors
| BatchListObjectChildren' (Maybe Natural) (Maybe Text) ObjectReference |
Instances
newBatchListObjectChildren Source #
Create a value of BatchListObjectChildren with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:BatchListObjectChildren', batchListObjectChildren_maxResults - Maximum number of items to be retrieved in a single call. This is an
approximate number.
$sel:nextToken:BatchListObjectChildren', batchListObjectChildren_nextToken - The pagination token.
$sel:objectReference:BatchListObjectChildren', batchListObjectChildren_objectReference - Reference of the object for which child objects are being listed.
BatchListObjectChildrenResponse
data BatchListObjectChildrenResponse Source #
Represents the output of a ListObjectChildren response operation.
See: newBatchListObjectChildrenResponse smart constructor.
Instances
newBatchListObjectChildrenResponse :: BatchListObjectChildrenResponse Source #
Create a value of BatchListObjectChildrenResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:children:BatchListObjectChildrenResponse', batchListObjectChildrenResponse_children - The children structure, which is a map with the key as the LinkName
and ObjectIdentifier as the value.
$sel:nextToken:BatchListObjectChildrenResponse', batchListObjectChildrenResponse_nextToken - 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: newBatchListObjectParentPaths smart constructor.
Constructors
| BatchListObjectParentPaths' (Maybe Natural) (Maybe Text) ObjectReference |
Instances
newBatchListObjectParentPaths Source #
Arguments
| :: ObjectReference | |
| -> BatchListObjectParentPaths |
Create a value of BatchListObjectParentPaths with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:BatchListObjectParentPaths', batchListObjectParentPaths_maxResults - The maximum number of results to retrieve.
$sel:nextToken:BatchListObjectParentPaths', batchListObjectParentPaths_nextToken - The pagination token.
$sel:objectReference:BatchListObjectParentPaths', batchListObjectParentPaths_objectReference - The reference that identifies the object whose attributes will be
listed.
BatchListObjectParentPathsResponse
data BatchListObjectParentPathsResponse Source #
Represents the output of a ListObjectParentPaths response operation.
See: newBatchListObjectParentPathsResponse smart constructor.
Constructors
| BatchListObjectParentPathsResponse' (Maybe Text) (Maybe [PathToObjectIdentifiers]) |
Instances
newBatchListObjectParentPathsResponse :: BatchListObjectParentPathsResponse Source #
Create a value of BatchListObjectParentPathsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:BatchListObjectParentPathsResponse', batchListObjectParentPathsResponse_nextToken - The pagination token.
$sel:pathToObjectIdentifiersList:BatchListObjectParentPathsResponse', batchListObjectParentPathsResponse_pathToObjectIdentifiersList - Returns the path to the ObjectIdentifiers that are associated with the
directory.
BatchListObjectParents
data BatchListObjectParents Source #
Lists parent objects that are associated with a given object in pagination fashion.
See: newBatchListObjectParents smart constructor.
Constructors
| BatchListObjectParents' (Maybe Natural) (Maybe Text) ObjectReference |
Instances
newBatchListObjectParents Source #
Create a value of BatchListObjectParents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:BatchListObjectParents', batchListObjectParents_maxResults - The maximum number of items to be retrieved in a single call. This is an
approximate number.
$sel:nextToken:BatchListObjectParents', batchListObjectParents_nextToken - The pagination token.
$sel:objectReference:BatchListObjectParents', batchListObjectParents_objectReference - Undocumented member.
BatchListObjectParentsResponse
data BatchListObjectParentsResponse Source #
Represents the output of a ListObjectParents response operation.
See: newBatchListObjectParentsResponse smart constructor.
Constructors
| BatchListObjectParentsResponse' (Maybe Text) (Maybe [ObjectIdentifierAndLinkNameTuple]) |
Instances
newBatchListObjectParentsResponse :: BatchListObjectParentsResponse Source #
Create a value of BatchListObjectParentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:BatchListObjectParentsResponse', batchListObjectParentsResponse_nextToken - The pagination token.
$sel:parentLinks:BatchListObjectParentsResponse', batchListObjectParentsResponse_parentLinks - Returns a list of parent reference and LinkName Tuples.
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: newBatchListObjectPolicies smart constructor.
Constructors
| BatchListObjectPolicies' (Maybe Natural) (Maybe Text) ObjectReference |
Instances
newBatchListObjectPolicies Source #
Create a value of BatchListObjectPolicies with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:BatchListObjectPolicies', batchListObjectPolicies_maxResults - The maximum number of results to retrieve.
$sel:nextToken:BatchListObjectPolicies', batchListObjectPolicies_nextToken - The pagination token.
$sel:objectReference:BatchListObjectPolicies', batchListObjectPolicies_objectReference - The reference that identifies the object whose attributes will be
listed.
BatchListObjectPoliciesResponse
data BatchListObjectPoliciesResponse Source #
Represents the output of a ListObjectPolicies response operation.
See: newBatchListObjectPoliciesResponse smart constructor.
Constructors
| BatchListObjectPoliciesResponse' (Maybe [Text]) (Maybe Text) |
Instances
newBatchListObjectPoliciesResponse :: BatchListObjectPoliciesResponse Source #
Create a value of BatchListObjectPoliciesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attachedPolicyIds:BatchListObjectPoliciesResponse', batchListObjectPoliciesResponse_attachedPolicyIds - A list of policy ObjectIdentifiers, that are attached to the object.
$sel:nextToken:BatchListObjectPoliciesResponse', batchListObjectPoliciesResponse_nextToken - The pagination token.
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: newBatchListOutgoingTypedLinks smart constructor.
Constructors
| BatchListOutgoingTypedLinks' (Maybe [TypedLinkAttributeRange]) (Maybe TypedLinkSchemaAndFacetName) (Maybe Natural) (Maybe Text) ObjectReference |
Instances
newBatchListOutgoingTypedLinks Source #
Arguments
| :: ObjectReference | |
| -> BatchListOutgoingTypedLinks |
Create a value of BatchListOutgoingTypedLinks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filterAttributeRanges:BatchListOutgoingTypedLinks', batchListOutgoingTypedLinks_filterAttributeRanges - Provides range filters for multiple attributes. When providing ranges to
typed link selection, any inexact ranges must be specified at the end.
Any attributes that do not have a range specified are presumed to match
the entire range.
$sel:filterTypedLink:BatchListOutgoingTypedLinks', batchListOutgoingTypedLinks_filterTypedLink - Filters are interpreted in the order of the attributes defined on the
typed link facet, not the order they are supplied to any API calls.
$sel:maxResults:BatchListOutgoingTypedLinks', batchListOutgoingTypedLinks_maxResults - The maximum number of results to retrieve.
$sel:nextToken:BatchListOutgoingTypedLinks', batchListOutgoingTypedLinks_nextToken - The pagination token.
$sel:objectReference:BatchListOutgoingTypedLinks', batchListOutgoingTypedLinks_objectReference - The reference that identifies the object whose attributes will be
listed.
BatchListOutgoingTypedLinksResponse
data BatchListOutgoingTypedLinksResponse Source #
Represents the output of a ListOutgoingTypedLinks response operation.
See: newBatchListOutgoingTypedLinksResponse smart constructor.
Constructors
| BatchListOutgoingTypedLinksResponse' (Maybe Text) (Maybe [TypedLinkSpecifier]) |
Instances
newBatchListOutgoingTypedLinksResponse :: BatchListOutgoingTypedLinksResponse Source #
Create a value of BatchListOutgoingTypedLinksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:BatchListOutgoingTypedLinksResponse', batchListOutgoingTypedLinksResponse_nextToken - The pagination token.
$sel:typedLinkSpecifiers:BatchListOutgoingTypedLinksResponse', batchListOutgoingTypedLinksResponse_typedLinkSpecifiers - Returns a typed link specifier as output.
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: newBatchListPolicyAttachments smart constructor.
Constructors
| BatchListPolicyAttachments' (Maybe Natural) (Maybe Text) ObjectReference |
Instances
newBatchListPolicyAttachments Source #
Arguments
| :: ObjectReference | |
| -> BatchListPolicyAttachments |
Create a value of BatchListPolicyAttachments with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:BatchListPolicyAttachments', batchListPolicyAttachments_maxResults - The maximum number of results to retrieve.
$sel:nextToken:BatchListPolicyAttachments', batchListPolicyAttachments_nextToken - The pagination token.
$sel:policyReference:BatchListPolicyAttachments', batchListPolicyAttachments_policyReference - The reference that identifies the policy object.
BatchListPolicyAttachmentsResponse
data BatchListPolicyAttachmentsResponse Source #
Represents the output of a ListPolicyAttachments response operation.
See: newBatchListPolicyAttachmentsResponse smart constructor.
Constructors
| BatchListPolicyAttachmentsResponse' (Maybe Text) (Maybe [Text]) |
Instances
newBatchListPolicyAttachmentsResponse :: BatchListPolicyAttachmentsResponse Source #
Create a value of BatchListPolicyAttachmentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:BatchListPolicyAttachmentsResponse', batchListPolicyAttachmentsResponse_nextToken - The pagination token.
$sel:objectIdentifiers:BatchListPolicyAttachmentsResponse', batchListPolicyAttachmentsResponse_objectIdentifiers - A list of ObjectIdentifiers to which the policy is attached.
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: newBatchLookupPolicy smart constructor.
Constructors
| BatchLookupPolicy' (Maybe Natural) (Maybe Text) ObjectReference |
Instances
Create a value of BatchLookupPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:BatchLookupPolicy', batchLookupPolicy_maxResults - The maximum number of results to retrieve.
$sel:nextToken:BatchLookupPolicy', batchLookupPolicy_nextToken - The pagination token.
$sel:objectReference:BatchLookupPolicy', batchLookupPolicy_objectReference - Reference that identifies the object whose policies will be looked up.
BatchLookupPolicyResponse
data BatchLookupPolicyResponse Source #
Represents the output of a LookupPolicy response operation.
See: newBatchLookupPolicyResponse smart constructor.
Constructors
| BatchLookupPolicyResponse' (Maybe Text) (Maybe [PolicyToPath]) |
Instances
newBatchLookupPolicyResponse :: BatchLookupPolicyResponse Source #
Create a value of BatchLookupPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:BatchLookupPolicyResponse', batchLookupPolicyResponse_nextToken - The pagination token.
$sel:policyToPathList:BatchLookupPolicyResponse', batchLookupPolicyResponse_policyToPathList - 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: newBatchReadException smart constructor.
Constructors
| BatchReadException' (Maybe Text) (Maybe BatchReadExceptionType) |
Instances
newBatchReadException :: BatchReadException Source #
Create a value of BatchReadException with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:BatchReadException', batchReadException_message - An exception message that is associated with the failure.
$sel:type':BatchReadException', batchReadException_type - A type of exception, such as InvalidArnException.
BatchReadOperation
data BatchReadOperation Source #
Represents the output of a BatchRead operation.
See: newBatchReadOperation smart constructor.
Constructors
Instances
newBatchReadOperation :: BatchReadOperation Source #
Create a value of BatchReadOperation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:getLinkAttributes:BatchReadOperation', batchReadOperation_getLinkAttributes - Retrieves attributes that are associated with a typed link.
$sel:getObjectAttributes:BatchReadOperation', batchReadOperation_getObjectAttributes - Retrieves attributes within a facet that are associated with an object.
$sel:getObjectInformation:BatchReadOperation', batchReadOperation_getObjectInformation - Retrieves metadata about an object.
$sel:listAttachedIndices:BatchReadOperation', batchReadOperation_listAttachedIndices - Lists indices attached to an object.
$sel:listIncomingTypedLinks:BatchReadOperation', batchReadOperation_listIncomingTypedLinks - Returns a paginated list of all the incoming TypedLinkSpecifier
information for an object. It also supports filtering by typed link
facet and identity attributes. For more information, see
Typed Links.
$sel:listIndex:BatchReadOperation', batchReadOperation_listIndex - Lists objects attached to the specified index.
$sel:listObjectAttributes:BatchReadOperation', batchReadOperation_listObjectAttributes - Lists all attributes that are associated with an object.
$sel:listObjectChildren:BatchReadOperation', batchReadOperation_listObjectChildren - Returns a paginated list of child objects that are associated with a
given object.
$sel:listObjectParentPaths:BatchReadOperation', batchReadOperation_listObjectParentPaths - Retrieves all available parent paths for any object type such as node,
leaf node, policy node, and index node objects. For more information
about objects, see
Directory Structure.
$sel:listObjectParents:BatchReadOperation', batchReadOperation_listObjectParents - Lists parent objects that are associated with a given object in
pagination fashion.
$sel:listObjectPolicies:BatchReadOperation', batchReadOperation_listObjectPolicies - Returns policies attached to an object in pagination fashion.
$sel:listOutgoingTypedLinks:BatchReadOperation', batchReadOperation_listOutgoingTypedLinks - Returns a paginated list of all the outgoing TypedLinkSpecifier
information for an object. It also supports filtering by typed link
facet and identity attributes. For more information, see
Typed Links.
$sel:listPolicyAttachments:BatchReadOperation', batchReadOperation_listPolicyAttachments - Returns all of the ObjectIdentifiers to which a given policy is
attached.
$sel:lookupPolicy:BatchReadOperation', batchReadOperation_lookupPolicy - Lists all policies from the root of the Directory to the object
specified. If there are no policies present, an empty list is returned.
If policies are present, and if some objects don't have the policies
attached, it returns the ObjectIdentifier for such objects. If
policies are present, it returns ObjectIdentifier, policyId, and
policyType. Paths that don't lead to the root from the target object
are ignored. For more information, see
Policies.
BatchReadOperationResponse
data BatchReadOperationResponse Source #
Represents the output of a BatchRead response operation.
See: newBatchReadOperationResponse smart constructor.
Constructors
| BatchReadOperationResponse' (Maybe BatchReadException) (Maybe BatchReadSuccessfulResponse) |
Instances
newBatchReadOperationResponse :: BatchReadOperationResponse Source #
Create a value of BatchReadOperationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exceptionResponse:BatchReadOperationResponse', batchReadOperationResponse_exceptionResponse - Identifies which operation in a batch has failed.
$sel:successfulResponse:BatchReadOperationResponse', batchReadOperationResponse_successfulResponse - Identifies which operation in a batch has succeeded.
BatchReadSuccessfulResponse
data BatchReadSuccessfulResponse Source #
Represents the output of a BatchRead success response operation.
See: newBatchReadSuccessfulResponse smart constructor.
Constructors
Instances
newBatchReadSuccessfulResponse :: BatchReadSuccessfulResponse Source #
Create a value of BatchReadSuccessfulResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:getLinkAttributes:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_getLinkAttributes - The list of attributes to retrieve from the typed link.
$sel:getObjectAttributes:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_getObjectAttributes - Retrieves attributes within a facet that are associated with an object.
$sel:getObjectInformation:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_getObjectInformation - Retrieves metadata about an object.
$sel:listAttachedIndices:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listAttachedIndices - Lists indices attached to an object.
$sel:listIncomingTypedLinks:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listIncomingTypedLinks - Returns a paginated list of all the incoming TypedLinkSpecifier
information for an object. It also supports filtering by typed link
facet and identity attributes. For more information, see
Typed Links.
$sel:listIndex:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listIndex - Lists objects attached to the specified index.
$sel:listObjectAttributes:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listObjectAttributes - Lists all attributes that are associated with an object.
$sel:listObjectChildren:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listObjectChildren - Returns a paginated list of child objects that are associated with a
given object.
$sel:listObjectParentPaths:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listObjectParentPaths - Retrieves all available parent paths for any object type such as node,
leaf node, policy node, and index node objects. For more information
about objects, see
Directory Structure.
$sel:listObjectParents:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listObjectParents - The list of parent objects to retrieve.
$sel:listObjectPolicies:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listObjectPolicies - Returns policies attached to an object in pagination fashion.
$sel:listOutgoingTypedLinks:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listOutgoingTypedLinks - Returns a paginated list of all the outgoing TypedLinkSpecifier
information for an object. It also supports filtering by typed link
facet and identity attributes. For more information, see
Typed Links.
$sel:listPolicyAttachments:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listPolicyAttachments - Returns all of the ObjectIdentifiers to which a given policy is
attached.
$sel:lookupPolicy:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_lookupPolicy - Lists all policies from the root of the Directory to the object
specified. If there are no policies present, an empty list is returned.
If policies are present, and if some objects don't have the policies
attached, it returns the ObjectIdentifier for such objects. If
policies are present, it returns ObjectIdentifier, policyId, and
policyType. Paths that don't lead to the root from the target object
are ignored. For more information, see
Policies.
BatchRemoveFacetFromObject
data BatchRemoveFacetFromObject Source #
A batch operation to remove a facet from an object.
See: newBatchRemoveFacetFromObject smart constructor.
Constructors
| BatchRemoveFacetFromObject' SchemaFacet ObjectReference |
Instances
newBatchRemoveFacetFromObject Source #
Arguments
| :: SchemaFacet | |
| -> ObjectReference | |
| -> BatchRemoveFacetFromObject |
Create a value of BatchRemoveFacetFromObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:schemaFacet:BatchRemoveFacetFromObject', batchRemoveFacetFromObject_schemaFacet - The facet to remove from the object.
$sel:objectReference:BatchRemoveFacetFromObject', batchRemoveFacetFromObject_objectReference - A reference to the object whose facet will be removed.
BatchRemoveFacetFromObjectResponse
data BatchRemoveFacetFromObjectResponse Source #
An empty result that represents success.
See: newBatchRemoveFacetFromObjectResponse smart constructor.
Constructors
| BatchRemoveFacetFromObjectResponse' | |
Instances
newBatchRemoveFacetFromObjectResponse :: BatchRemoveFacetFromObjectResponse Source #
Create a value of BatchRemoveFacetFromObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
BatchUpdateLinkAttributes
data BatchUpdateLinkAttributes Source #
Updates a given typed link’s attributes inside a BatchRead operation.
Attributes to be updated must not contribute to the typed link’s
identity, as defined by its IdentityAttributeOrder. For more
information, see UpdateLinkAttributes and BatchReadRequest$Operations.
See: newBatchUpdateLinkAttributes smart constructor.
Constructors
| BatchUpdateLinkAttributes' TypedLinkSpecifier [LinkAttributeUpdate] |
Instances
newBatchUpdateLinkAttributes Source #
Arguments
| :: TypedLinkSpecifier | |
| -> BatchUpdateLinkAttributes |
Create a value of BatchUpdateLinkAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:typedLinkSpecifier:BatchUpdateLinkAttributes', batchUpdateLinkAttributes_typedLinkSpecifier - Allows a typed link specifier to be accepted as input.
$sel:attributeUpdates:BatchUpdateLinkAttributes', batchUpdateLinkAttributes_attributeUpdates - The attributes update structure.
BatchUpdateLinkAttributesResponse
data BatchUpdateLinkAttributesResponse Source #
Represents the output of a UpdateLinkAttributes response operation.
See: newBatchUpdateLinkAttributesResponse smart constructor.
Constructors
| BatchUpdateLinkAttributesResponse' | |
Instances
newBatchUpdateLinkAttributesResponse :: BatchUpdateLinkAttributesResponse Source #
Create a value of BatchUpdateLinkAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
BatchUpdateObjectAttributes
data BatchUpdateObjectAttributes Source #
Represents the output of a BatchUpdate operation.
See: newBatchUpdateObjectAttributes smart constructor.
Constructors
| BatchUpdateObjectAttributes' ObjectReference [ObjectAttributeUpdate] |
Instances
newBatchUpdateObjectAttributes Source #
Arguments
| :: ObjectReference | |
| -> BatchUpdateObjectAttributes |
Create a value of BatchUpdateObjectAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectReference:BatchUpdateObjectAttributes', batchUpdateObjectAttributes_objectReference - Reference that identifies the object.
$sel:attributeUpdates:BatchUpdateObjectAttributes', batchUpdateObjectAttributes_attributeUpdates - Attributes update structure.
BatchUpdateObjectAttributesResponse
data BatchUpdateObjectAttributesResponse Source #
Represents the output of a BatchUpdate response operation.
See: newBatchUpdateObjectAttributesResponse smart constructor.
Constructors
| BatchUpdateObjectAttributesResponse' (Maybe Text) |
Instances
newBatchUpdateObjectAttributesResponse :: BatchUpdateObjectAttributesResponse Source #
Create a value of BatchUpdateObjectAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectIdentifier:BatchUpdateObjectAttributesResponse', batchUpdateObjectAttributesResponse_objectIdentifier - ID that is associated with the object.
BatchWriteOperation
data BatchWriteOperation Source #
Represents the output of a BatchWrite operation.
See: newBatchWriteOperation smart constructor.
Constructors
Instances
newBatchWriteOperation :: BatchWriteOperation Source #
Create a value of BatchWriteOperation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addFacetToObject:BatchWriteOperation', batchWriteOperation_addFacetToObject - A batch operation that adds a facet to an object.
$sel:attachObject:BatchWriteOperation', batchWriteOperation_attachObject - Attaches an object to a Directory.
$sel:attachPolicy:BatchWriteOperation', batchWriteOperation_attachPolicy - Attaches a policy object to a regular object. An object can have a
limited number of attached policies.
$sel:attachToIndex:BatchWriteOperation', batchWriteOperation_attachToIndex - Attaches the specified object to the specified index.
$sel:attachTypedLink:BatchWriteOperation', batchWriteOperation_attachTypedLink - Attaches a typed link to a specified source and target object. For more
information, see
Typed Links.
$sel:createIndex:BatchWriteOperation', batchWriteOperation_createIndex - Creates an index object. See
Indexing and search
for more information.
$sel:createObject:BatchWriteOperation', batchWriteOperation_createObject - Creates an object.
$sel:deleteObject:BatchWriteOperation', batchWriteOperation_deleteObject - Deletes an object in a Directory.
$sel:detachFromIndex:BatchWriteOperation', batchWriteOperation_detachFromIndex - Detaches the specified object from the specified index.
$sel:detachObject:BatchWriteOperation', batchWriteOperation_detachObject - Detaches an object from a Directory.
$sel:detachPolicy:BatchWriteOperation', batchWriteOperation_detachPolicy - Detaches a policy from a Directory.
$sel:detachTypedLink:BatchWriteOperation', batchWriteOperation_detachTypedLink - Detaches a typed link from a specified source and target object. For
more information, see
Typed Links.
$sel:removeFacetFromObject:BatchWriteOperation', batchWriteOperation_removeFacetFromObject - A batch operation that removes a facet from an object.
$sel:updateLinkAttributes:BatchWriteOperation', batchWriteOperation_updateLinkAttributes - Updates a given object's attributes.
$sel:updateObjectAttributes:BatchWriteOperation', batchWriteOperation_updateObjectAttributes - Updates a given object's attributes.
BatchWriteOperationResponse
data BatchWriteOperationResponse Source #
Represents the output of a BatchWrite response operation.
See: newBatchWriteOperationResponse smart constructor.
Constructors
Instances
newBatchWriteOperationResponse :: BatchWriteOperationResponse Source #
Create a value of BatchWriteOperationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addFacetToObject:BatchWriteOperationResponse', batchWriteOperationResponse_addFacetToObject - The result of an add facet to object batch operation.
$sel:attachObject:BatchWriteOperationResponse', batchWriteOperationResponse_attachObject - Attaches an object to a Directory.
$sel:attachPolicy:BatchWriteOperationResponse', batchWriteOperationResponse_attachPolicy - Attaches a policy object to a regular object. An object can have a
limited number of attached policies.
$sel:attachToIndex:BatchWriteOperationResponse', batchWriteOperationResponse_attachToIndex - Attaches the specified object to the specified index.
$sel:attachTypedLink:BatchWriteOperationResponse', batchWriteOperationResponse_attachTypedLink - Attaches a typed link to a specified source and target object. For more
information, see
Typed Links.
$sel:createIndex:BatchWriteOperationResponse', batchWriteOperationResponse_createIndex - Creates an index object. See
Indexing and search
for more information.
$sel:createObject:BatchWriteOperationResponse', batchWriteOperationResponse_createObject - Creates an object in a Directory.
$sel:deleteObject:BatchWriteOperationResponse', batchWriteOperationResponse_deleteObject - Deletes an object in a Directory.
$sel:detachFromIndex:BatchWriteOperationResponse', batchWriteOperationResponse_detachFromIndex - Detaches the specified object from the specified index.
$sel:detachObject:BatchWriteOperationResponse', batchWriteOperationResponse_detachObject - Detaches an object from a Directory.
$sel:detachPolicy:BatchWriteOperationResponse', batchWriteOperationResponse_detachPolicy - Detaches a policy from a Directory.
$sel:detachTypedLink:BatchWriteOperationResponse', batchWriteOperationResponse_detachTypedLink - Detaches a typed link from a specified source and target object. For
more information, see
Typed Links.
$sel:removeFacetFromObject:BatchWriteOperationResponse', batchWriteOperationResponse_removeFacetFromObject - The result of a batch remove facet from object operation.
$sel:updateLinkAttributes:BatchWriteOperationResponse', batchWriteOperationResponse_updateLinkAttributes - Represents the output of a BatchWrite response operation.
$sel:updateObjectAttributes:BatchWriteOperationResponse', batchWriteOperationResponse_updateObjectAttributes - Updates a given object’s attributes.
Directory
Directory structure that includes the directory name and directory ARN.
See: newDirectory smart constructor.
Constructors
| Directory' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DirectoryState) |
Instances
newDirectory :: Directory Source #
Create a value of Directory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationDateTime:Directory', directory_creationDateTime - The date and time when the directory was created.
$sel:directoryArn:Directory', directory_directoryArn - The Amazon Resource Name (ARN) that is associated with the directory.
For more information, see arns.
$sel:name:Directory', directory_name - The name of the directory.
$sel:state:Directory', directory_state - The state of the directory. Can be either Enabled, Disabled, or
Deleted.
Facet
A structure that contains Name, ARN, Attributes, Rules, and
ObjectTypes. See
Facets
for more information.
See: newFacet smart constructor.
Constructors
| Facet' (Maybe FacetStyle) (Maybe Text) (Maybe ObjectType) |
Instances
| FromJSON Facet Source # | |
| Generic Facet Source # | |
| Read Facet Source # | |
| Show Facet Source # | |
| NFData Facet Source # | |
Defined in Amazonka.CloudDirectory.Types.Facet | |
| Eq Facet Source # | |
| Hashable Facet Source # | |
Defined in Amazonka.CloudDirectory.Types.Facet | |
| type Rep Facet Source # | |
Defined in Amazonka.CloudDirectory.Types.Facet type Rep Facet = D1 ('MetaData "Facet" "Amazonka.CloudDirectory.Types.Facet" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "Facet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "facetStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FacetStyle)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "objectType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectType))))) | |
Create a value of Facet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:facetStyle:Facet', facet_facetStyle - There are two different styles that you can define on any given facet,
Static and Dynamic. For static facets, all attributes must be
defined in the schema. For dynamic facets, attributes can be defined
during data plane operations.
$sel:name:Facet', facet_name - The name of the Facet.
$sel:objectType:Facet', facet_objectType - 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: newFacetAttribute smart constructor.
Constructors
| FacetAttribute' (Maybe FacetAttributeDefinition) (Maybe FacetAttributeReference) (Maybe RequiredAttributeBehavior) Text |
Instances
Arguments
| :: Text | |
| -> FacetAttribute |
Create a value of FacetAttribute with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeDefinition:FacetAttribute', facetAttribute_attributeDefinition - A facet attribute consists of either a definition or a reference. This
structure contains the attribute definition. See
Attribute References
for more information.
$sel:attributeReference:FacetAttribute', facetAttribute_attributeReference - An attribute reference that is associated with the attribute. See
Attribute References
for more information.
$sel:requiredBehavior:FacetAttribute', facetAttribute_requiredBehavior - The required behavior of the FacetAttribute.
$sel:name:FacetAttribute', facetAttribute_name - The name of the facet attribute.
FacetAttributeDefinition
data FacetAttributeDefinition Source #
A facet attribute definition. See Attribute References for more information.
See: newFacetAttributeDefinition smart constructor.
Constructors
| FacetAttributeDefinition' (Maybe TypedAttributeValue) (Maybe Bool) (Maybe (HashMap Text Rule)) FacetAttributeType |
Instances
newFacetAttributeDefinition Source #
Create a value of FacetAttributeDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:FacetAttributeDefinition', facetAttributeDefinition_defaultValue - The default value of the attribute (if configured).
$sel:isImmutable:FacetAttributeDefinition', facetAttributeDefinition_isImmutable - Whether the attribute is mutable or not.
$sel:rules:FacetAttributeDefinition', facetAttributeDefinition_rules - Validation rules attached to the attribute definition.
FacetAttributeDefinition, facetAttributeDefinition_type - 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: newFacetAttributeReference smart constructor.
Constructors
| FacetAttributeReference' Text Text |
Instances
newFacetAttributeReference Source #
Arguments
| :: Text | |
| -> Text | |
| -> FacetAttributeReference |
Create a value of FacetAttributeReference with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetFacetName:FacetAttributeReference', facetAttributeReference_targetFacetName - The target facet name that is associated with the facet reference. See
Attribute References
for more information.
$sel:targetAttributeName:FacetAttributeReference', facetAttributeReference_targetAttributeName - 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: newFacetAttributeUpdate smart constructor.
Constructors
| FacetAttributeUpdate' (Maybe UpdateActionType) (Maybe FacetAttribute) |
Instances
newFacetAttributeUpdate :: FacetAttributeUpdate Source #
Create a value of FacetAttributeUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:FacetAttributeUpdate', facetAttributeUpdate_action - The action to perform when updating the attribute.
$sel:attribute:FacetAttributeUpdate', facetAttributeUpdate_attribute - The attribute to update.
IndexAttachment
data IndexAttachment Source #
Represents an index and an attached object.
See: newIndexAttachment smart constructor.
Constructors
| IndexAttachment' (Maybe [AttributeKeyAndValue]) (Maybe Text) |
Instances
newIndexAttachment :: IndexAttachment Source #
Create a value of IndexAttachment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexedAttributes:IndexAttachment', indexAttachment_indexedAttributes - The indexed attribute values.
$sel:objectIdentifier:IndexAttachment', indexAttachment_objectIdentifier - In response to ListIndex, the ObjectIdentifier of the object attached
to the index. In response to ListAttachedIndices, the ObjectIdentifier
of the index attached to the object. This field will always contain the
ObjectIdentifier of the object on the opposite side of the attachment
specified in the query.
LinkAttributeAction
data LinkAttributeAction Source #
The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.
See: newLinkAttributeAction smart constructor.
Constructors
| LinkAttributeAction' (Maybe UpdateActionType) (Maybe TypedAttributeValue) |
Instances
newLinkAttributeAction :: LinkAttributeAction Source #
Create a value of LinkAttributeAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeActionType:LinkAttributeAction', linkAttributeAction_attributeActionType - A type that can be either UPDATE_OR_CREATE or DELETE.
$sel:attributeUpdateValue:LinkAttributeAction', linkAttributeAction_attributeUpdateValue - The value that you want to update to.
LinkAttributeUpdate
data LinkAttributeUpdate Source #
Structure that contains attribute update information.
See: newLinkAttributeUpdate smart constructor.
Constructors
| LinkAttributeUpdate' (Maybe LinkAttributeAction) (Maybe AttributeKey) |
Instances
newLinkAttributeUpdate :: LinkAttributeUpdate Source #
Create a value of LinkAttributeUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeAction:LinkAttributeUpdate', linkAttributeUpdate_attributeAction - The action to perform as part of the attribute update.
$sel:attributeKey:LinkAttributeUpdate', linkAttributeUpdate_attributeKey - The key of the attribute being updated.
ObjectAttributeAction
data ObjectAttributeAction Source #
The action to take on the object attribute.
See: newObjectAttributeAction smart constructor.
Constructors
| ObjectAttributeAction' (Maybe UpdateActionType) (Maybe TypedAttributeValue) |
Instances
newObjectAttributeAction :: ObjectAttributeAction Source #
Create a value of ObjectAttributeAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectAttributeActionType:ObjectAttributeAction', objectAttributeAction_objectAttributeActionType - A type that can be either Update or Delete.
$sel:objectAttributeUpdateValue:ObjectAttributeAction', objectAttributeAction_objectAttributeUpdateValue - The value that you want to update to.
ObjectAttributeRange
data ObjectAttributeRange Source #
A range of attributes.
See: newObjectAttributeRange smart constructor.
Constructors
| ObjectAttributeRange' (Maybe AttributeKey) (Maybe TypedAttributeValueRange) |
Instances
newObjectAttributeRange :: ObjectAttributeRange Source #
Create a value of ObjectAttributeRange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeKey:ObjectAttributeRange', objectAttributeRange_attributeKey - The key of the attribute that the attribute range covers.
$sel:range:ObjectAttributeRange', objectAttributeRange_range - The range of attribute values being selected.
ObjectAttributeUpdate
data ObjectAttributeUpdate Source #
Structure that contains attribute update information.
See: newObjectAttributeUpdate smart constructor.
Constructors
| ObjectAttributeUpdate' (Maybe ObjectAttributeAction) (Maybe AttributeKey) |
Instances
newObjectAttributeUpdate :: ObjectAttributeUpdate Source #
Create a value of ObjectAttributeUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectAttributeAction:ObjectAttributeUpdate', objectAttributeUpdate_objectAttributeAction - The action to perform as part of the attribute update.
$sel:objectAttributeKey:ObjectAttributeUpdate', objectAttributeUpdate_objectAttributeKey - The key of the attribute being updated.
ObjectIdentifierAndLinkNameTuple
data ObjectIdentifierAndLinkNameTuple Source #
A pair of ObjectIdentifier and LinkName.
See: newObjectIdentifierAndLinkNameTuple smart constructor.
Constructors
| ObjectIdentifierAndLinkNameTuple' (Maybe Text) (Maybe Text) |
Instances
newObjectIdentifierAndLinkNameTuple :: ObjectIdentifierAndLinkNameTuple Source #
Create a value of ObjectIdentifierAndLinkNameTuple with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:linkName:ObjectIdentifierAndLinkNameTuple', objectIdentifierAndLinkNameTuple_linkName - The name of the link between the parent and the child object.
$sel:objectIdentifier:ObjectIdentifierAndLinkNameTuple', objectIdentifierAndLinkNameTuple_objectIdentifier - The ID that is associated with the object.
ObjectReference
data ObjectReference Source #
The reference that identifies an object.
See: newObjectReference smart constructor.
Constructors
| ObjectReference' (Maybe Text) |
Instances
newObjectReference :: ObjectReference Source #
Create a value of ObjectReference with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:selector:ObjectReference', objectReference_selector - A path selector supports easy selection of an object by the
parent/child links leading to it from the directory root. Use the link
names from each parent/child link to construct the path. Path selectors
start with a slash (/) and link names are separated by slashes. For
more information about paths, see
Access Objects.
You can identify an object in one of the following ways:
- $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.
- /some/path - Identifies the object based on path
- #SomeBatchReference - Identifies the object in a batch call
PathToObjectIdentifiers
data PathToObjectIdentifiers Source #
Returns the path to the ObjectIdentifiers that is associated with the
directory.
See: newPathToObjectIdentifiers smart constructor.
Constructors
| PathToObjectIdentifiers' (Maybe [Text]) (Maybe Text) |
Instances
newPathToObjectIdentifiers :: PathToObjectIdentifiers Source #
Create a value of PathToObjectIdentifiers with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectIdentifiers:PathToObjectIdentifiers', pathToObjectIdentifiers_objectIdentifiers - Lists ObjectIdentifiers starting from directory root to the object in
the request.
$sel:path:PathToObjectIdentifiers', pathToObjectIdentifiers_path - 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: newPolicyAttachment smart constructor.
Instances
newPolicyAttachment :: PolicyAttachment Source #
Create a value of PolicyAttachment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectIdentifier:PolicyAttachment', policyAttachment_objectIdentifier - The ObjectIdentifier that is associated with PolicyAttachment.
$sel:policyId:PolicyAttachment', policyAttachment_policyId - The ID of PolicyAttachment.
$sel:policyType:PolicyAttachment', policyAttachment_policyType - The type of policy that can be 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: newPolicyToPath smart constructor.
Constructors
| PolicyToPath' (Maybe Text) (Maybe [PolicyAttachment]) |
Instances
newPolicyToPath :: PolicyToPath Source #
Create a value of PolicyToPath with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:path:PolicyToPath', policyToPath_path - The path that is referenced from the root.
$sel:policies:PolicyToPath', policyToPath_policies - List of policy objects.
Rule
Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.
See: newRule smart constructor.
Instances
| FromJSON Rule Source # | |
| ToJSON Rule Source # | |
Defined in Amazonka.CloudDirectory.Types.Rule | |
| Generic Rule Source # | |
| Read Rule Source # | |
| Show Rule Source # | |
| NFData Rule Source # | |
Defined in Amazonka.CloudDirectory.Types.Rule | |
| Eq Rule Source # | |
| Hashable Rule Source # | |
Defined in Amazonka.CloudDirectory.Types.Rule | |
| type Rep Rule Source # | |
Defined in Amazonka.CloudDirectory.Types.Rule type Rep Rule = D1 ('MetaData "Rule" "Amazonka.CloudDirectory.Types.Rule" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "Rule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleType)))) | |
Create a value of Rule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameters:Rule', rule_parameters - The minimum and maximum parameters that are associated with the rule.
$sel:type':Rule', rule_type - The type of attribute validation rule.
SchemaFacet
data SchemaFacet Source #
A facet.
See: newSchemaFacet smart constructor.
Constructors
| SchemaFacet' (Maybe Text) (Maybe Text) |
Instances
newSchemaFacet :: SchemaFacet Source #
Create a value of SchemaFacet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:facetName:SchemaFacet', schemaFacet_facetName - The name of the facet. If this value is set, SchemaArn must also be set.
$sel:schemaArn:SchemaFacet', schemaFacet_schemaArn - The ARN of the schema that contains the facet with no minor component.
See arns and
In-Place Schema Upgrade
for a description of when to provide minor versions. If this value is
set, FacetName must also be set.
Tag
The tag structure that contains a tag key and value.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.CloudDirectory.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.CloudDirectory.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.CloudDirectory.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.CloudDirectory.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CloudDirectory.Types.Tag" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The key that is associated with the tag.
$sel:value:Tag', tag_value - The value that is associated with the tag.
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: newTypedAttributeValue smart constructor.
Constructors
| TypedAttributeValue' (Maybe Base64) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) |
Instances
newTypedAttributeValue :: TypedAttributeValue Source #
Create a value of TypedAttributeValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:binaryValue:TypedAttributeValue', typedAttributeValue_binaryValue - 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.
$sel:booleanValue:TypedAttributeValue', typedAttributeValue_booleanValue - A Boolean data value.
$sel:datetimeValue:TypedAttributeValue', typedAttributeValue_datetimeValue - A date and time value.
$sel:numberValue:TypedAttributeValue', typedAttributeValue_numberValue - A number data value.
$sel:stringValue:TypedAttributeValue', typedAttributeValue_stringValue - A string data value.
TypedAttributeValueRange
data TypedAttributeValueRange Source #
A range of attribute values. For more information, see Range Filters.
See: newTypedAttributeValueRange smart constructor.
Constructors
| TypedAttributeValueRange' (Maybe TypedAttributeValue) (Maybe TypedAttributeValue) RangeMode RangeMode |
Instances
newTypedAttributeValueRange Source #
Arguments
| :: RangeMode | |
| -> RangeMode | |
| -> TypedAttributeValueRange |
Create a value of TypedAttributeValueRange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endValue:TypedAttributeValueRange', typedAttributeValueRange_endValue - The attribute value to terminate the range at.
$sel:startValue:TypedAttributeValueRange', typedAttributeValueRange_startValue - The value to start the range at.
$sel:startMode:TypedAttributeValueRange', typedAttributeValueRange_startMode - The inclusive or exclusive range start.
$sel:endMode:TypedAttributeValueRange', typedAttributeValueRange_endMode - The inclusive or exclusive range end.
TypedLinkAttributeDefinition
data TypedLinkAttributeDefinition Source #
A typed link attribute definition.
See: newTypedLinkAttributeDefinition smart constructor.
Constructors
| TypedLinkAttributeDefinition' (Maybe TypedAttributeValue) (Maybe Bool) (Maybe (HashMap Text Rule)) Text FacetAttributeType RequiredAttributeBehavior |
Instances
newTypedLinkAttributeDefinition Source #
Arguments
| :: Text | |
| -> FacetAttributeType | |
| -> RequiredAttributeBehavior | |
| -> TypedLinkAttributeDefinition |
Create a value of TypedLinkAttributeDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:TypedLinkAttributeDefinition', typedLinkAttributeDefinition_defaultValue - The default value of the attribute (if configured).
$sel:isImmutable:TypedLinkAttributeDefinition', typedLinkAttributeDefinition_isImmutable - Whether the attribute is mutable or not.
$sel:rules:TypedLinkAttributeDefinition', typedLinkAttributeDefinition_rules - Validation rules that are attached to the attribute definition.
$sel:name:TypedLinkAttributeDefinition', typedLinkAttributeDefinition_name - The unique name of the typed link attribute.
TypedLinkAttributeDefinition, typedLinkAttributeDefinition_type - The type of the attribute.
$sel:requiredBehavior:TypedLinkAttributeDefinition', typedLinkAttributeDefinition_requiredBehavior - The required behavior of the TypedLinkAttributeDefinition.
TypedLinkAttributeRange
data TypedLinkAttributeRange Source #
Identifies the range of attributes that are used by a specified filter.
See: newTypedLinkAttributeRange smart constructor.
Constructors
| TypedLinkAttributeRange' (Maybe Text) TypedAttributeValueRange |
Instances
newTypedLinkAttributeRange Source #
Create a value of TypedLinkAttributeRange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeName:TypedLinkAttributeRange', typedLinkAttributeRange_attributeName - The unique name of the typed link attribute.
$sel:range:TypedLinkAttributeRange', typedLinkAttributeRange_range - 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: newTypedLinkFacet smart constructor.
Constructors
| TypedLinkFacet' Text [TypedLinkAttributeDefinition] [Text] |
Instances
Arguments
| :: Text | |
| -> TypedLinkFacet |
Create a value of TypedLinkFacet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TypedLinkFacet, typedLinkFacet_name - The unique name of the typed link facet.
$sel:attributes:TypedLinkFacet', typedLinkFacet_attributes - A set of key-value pairs associated with the typed link. Typed link
attributes are used when you have data values that are related to the
link itself, and not to one of the two objects being linked. Identity
attributes also serve to distinguish the link from others of the same
type between the same objects.
$sel:identityAttributeOrder:TypedLinkFacet', typedLinkFacet_identityAttributeOrder - The set of attributes that distinguish links made from this facet from
each other, in the order of significance. Listing typed links can filter
on the values of these attributes. See ListOutgoingTypedLinks and
ListIncomingTypedLinks for details.
TypedLinkFacetAttributeUpdate
data TypedLinkFacetAttributeUpdate Source #
A typed link facet attribute update.
See: newTypedLinkFacetAttributeUpdate smart constructor.
Instances
newTypedLinkFacetAttributeUpdate Source #
Create a value of TypedLinkFacetAttributeUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attribute:TypedLinkFacetAttributeUpdate', typedLinkFacetAttributeUpdate_attribute - The attribute to update.
$sel:action:TypedLinkFacetAttributeUpdate', typedLinkFacetAttributeUpdate_action - 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: newTypedLinkSchemaAndFacetName smart constructor.
Constructors
| TypedLinkSchemaAndFacetName' Text Text |
Instances
newTypedLinkSchemaAndFacetName Source #
Arguments
| :: Text | |
| -> Text | |
| -> TypedLinkSchemaAndFacetName |
Create a value of TypedLinkSchemaAndFacetName with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:schemaArn:TypedLinkSchemaAndFacetName', typedLinkSchemaAndFacetName_schemaArn - The Amazon Resource Name (ARN) that is associated with the schema. For
more information, see arns.
$sel:typedLinkName:TypedLinkSchemaAndFacetName', typedLinkSchemaAndFacetName_typedLinkName - 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: newTypedLinkSpecifier smart constructor.
Constructors
| TypedLinkSpecifier' TypedLinkSchemaAndFacetName ObjectReference ObjectReference [AttributeNameAndValue] |
Instances
newTypedLinkSpecifier Source #
Arguments
| :: TypedLinkSchemaAndFacetName | |
| -> ObjectReference | |
| -> ObjectReference | |
| -> TypedLinkSpecifier |
Create a value of TypedLinkSpecifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:typedLinkFacet:TypedLinkSpecifier', typedLinkSpecifier_typedLinkFacet - Identifies the typed link facet that is associated with the typed link.
$sel:sourceObjectReference:TypedLinkSpecifier', typedLinkSpecifier_sourceObjectReference - Identifies the source object that the typed link will attach to.
$sel:targetObjectReference:TypedLinkSpecifier', typedLinkSpecifier_targetObjectReference - Identifies the target object that the typed link will attach to.
$sel:identityAttributeValues:TypedLinkSpecifier', typedLinkSpecifier_identityAttributeValues - Identifies the attribute value to update.