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.Types.BatchReadOperation

Description

Synopsis

Documentation

data BatchReadOperation Source #

Represents the output of a BatchRead operation.

See: newBatchReadOperation smart constructor.

Constructors

BatchReadOperation'

Fields

getLinkAttributes :: Maybe BatchGetLinkAttributes
Retrieves attributes that are associated with a typed link.
getObjectAttributes :: Maybe BatchGetObjectAttributes
Retrieves attributes within a facet that are associated with an object.
getObjectInformation :: Maybe BatchGetObjectInformation
Retrieves metadata about an object.
listAttachedIndices :: Maybe BatchListAttachedIndices
Lists indices attached to an object.
listIncomingTypedLinks :: Maybe BatchListIncomingTypedLinks
Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.
listIndex :: Maybe BatchListIndex
Lists objects attached to the specified index.
listObjectAttributes :: Maybe BatchListObjectAttributes
Lists all attributes that are associated with an object.
listObjectChildren :: Maybe BatchListObjectChildren
Returns a paginated list of child objects that are associated with a given object.
listObjectParentPaths :: Maybe BatchListObjectParentPaths
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.
listObjectParents :: Maybe BatchListObjectParents
Lists parent objects that are associated with a given object in pagination fashion.
listObjectPolicies :: Maybe BatchListObjectPolicies
Returns policies attached to an object in pagination fashion.
listOutgoingTypedLinks :: Maybe BatchListOutgoingTypedLinks
Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.
listPolicyAttachments :: Maybe BatchListPolicyAttachments
Returns all of the ObjectIdentifiers to which a given policy is attached.
lookupPolicy :: Maybe BatchLookupPolicy
Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

Instances

Instances details

ToJSON BatchReadOperation Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchReadOperation Methods toJSON :: BatchReadOperation -> Value # toEncoding :: BatchReadOperation -> Encoding # toJSONList :: [BatchReadOperation] -> Value # toEncodingList :: [BatchReadOperation] -> Encoding #
Generic BatchReadOperation Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchReadOperation Associated Types type Rep BatchReadOperation :: Type -> Type # Methods from :: BatchReadOperation -> Rep BatchReadOperation x # to :: Rep BatchReadOperation x -> BatchReadOperation #
Read BatchReadOperation Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchReadOperation Methods readsPrec :: Int -> ReadS BatchReadOperation # readList :: ReadS [BatchReadOperation] # readPrec :: ReadPrec BatchReadOperation # readListPrec :: ReadPrec [BatchReadOperation] #
Show BatchReadOperation Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchReadOperation Methods showsPrec :: Int -> BatchReadOperation -> ShowS # show :: BatchReadOperation -> String # showList :: [BatchReadOperation] -> ShowS #
NFData BatchReadOperation Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchReadOperation Methods rnf :: BatchReadOperation -> () #
Eq BatchReadOperation Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchReadOperation Methods (==) :: BatchReadOperation -> BatchReadOperation -> Bool # (/=) :: BatchReadOperation -> BatchReadOperation -> Bool #
Hashable BatchReadOperation Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchReadOperation Methods hashWithSalt :: Int -> BatchReadOperation -> Int # hash :: BatchReadOperation -> Int #
type Rep BatchReadOperation Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchReadOperation type Rep BatchReadOperation = D1 ('MetaData "BatchReadOperation" "Amazonka.CloudDirectory.Types.BatchReadOperation" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "BatchReadOperation'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "getLinkAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchGetLinkAttributes)) :: (S1 ('MetaSel ('Just "getObjectAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchGetObjectAttributes)) :: S1 ('MetaSel ('Just "getObjectInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchGetObjectInformation)))) :: ((S1 ('MetaSel ('Just "listAttachedIndices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchListAttachedIndices)) :: S1 ('MetaSel ('Just "listIncomingTypedLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchListIncomingTypedLinks))) :: (S1 ('MetaSel ('Just "listIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchListIndex)) :: S1 ('MetaSel ('Just "listObjectAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchListObjectAttributes))))) :: ((S1 ('MetaSel ('Just "listObjectChildren") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchListObjectChildren)) :: (S1 ('MetaSel ('Just "listObjectParentPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchListObjectParentPaths)) :: S1 ('MetaSel ('Just "listObjectParents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchListObjectParents)))) :: ((S1 ('MetaSel ('Just "listObjectPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchListObjectPolicies)) :: S1 ('MetaSel ('Just "listOutgoingTypedLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchListOutgoingTypedLinks))) :: (S1 ('MetaSel ('Just "listPolicyAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchListPolicyAttachments)) :*: S1 ('MetaSel ('Just "lookupPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchLookupPolicy)))))))

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.

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

Retrieves attributes that are associated with a typed link.

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

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

batchReadOperation_getObjectInformation :: Lens' BatchReadOperation (Maybe BatchGetObjectInformation) Source #

Retrieves metadata about an object.

batchReadOperation_listAttachedIndices :: Lens' BatchReadOperation (Maybe BatchListAttachedIndices) Source #

Lists indices attached to an object.

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

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

batchReadOperation_listIndex :: Lens' BatchReadOperation (Maybe BatchListIndex) Source #

Lists objects attached to the specified index.

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

Lists all attributes that are associated with an object.

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

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

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

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

batchReadOperation_listObjectParents :: Lens' BatchReadOperation (Maybe BatchListObjectParents) Source #

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

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

Returns policies attached to an object in pagination fashion.

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

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

batchReadOperation_listPolicyAttachments :: Lens' BatchReadOperation (Maybe BatchListPolicyAttachments) Source #

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

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

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