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.LookupPolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This operation returns paginated results.

Synopsis

data LookupPolicy = LookupPolicy' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- directoryArn :: Text
- objectReference :: ObjectReference
}
newLookupPolicy :: Text -> ObjectReference -> LookupPolicy
lookupPolicy_maxResults :: Lens' LookupPolicy (Maybe Natural)
lookupPolicy_nextToken :: Lens' LookupPolicy (Maybe Text)
lookupPolicy_directoryArn :: Lens' LookupPolicy Text
lookupPolicy_objectReference :: Lens' LookupPolicy ObjectReference
data LookupPolicyResponse = LookupPolicyResponse' {
- nextToken :: Maybe Text
- policyToPathList :: Maybe [PolicyToPath]
- httpStatus :: Int
}
newLookupPolicyResponse :: Int -> LookupPolicyResponse
lookupPolicyResponse_nextToken :: Lens' LookupPolicyResponse (Maybe Text)
lookupPolicyResponse_policyToPathList :: Lens' LookupPolicyResponse (Maybe [PolicyToPath])
lookupPolicyResponse_httpStatus :: Lens' LookupPolicyResponse Int

Creating a Request

data LookupPolicy Source #

See: newLookupPolicy smart constructor.

Constructors

LookupPolicy'

Fields

maxResults :: Maybe Natural
The maximum number of items to be retrieved in a single call. This is an approximate number.
nextToken :: Maybe Text
The token to request the next page of results.
directoryArn :: Text
The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.
objectReference :: ObjectReference
Reference that identifies the object whose policies will be looked up.

Instances

Instances details

ToJSON LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods toJSON :: LookupPolicy -> Value # toEncoding :: LookupPolicy -> Encoding # toJSONList :: [LookupPolicy] -> Value # toEncodingList :: [LookupPolicy] -> Encoding #
ToHeaders LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods toHeaders :: LookupPolicy -> [Header] #
ToPath LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods toPath :: LookupPolicy -> ByteString #
ToQuery LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods toQuery :: LookupPolicy -> QueryString #
AWSPager LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods page :: LookupPolicy -> AWSResponse LookupPolicy -> Maybe LookupPolicy #
AWSRequest LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Associated Types type AWSResponse LookupPolicy # Methods request :: (Service -> Service) -> LookupPolicy -> Request LookupPolicy # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy LookupPolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse LookupPolicy))) #
Generic LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Associated Types type Rep LookupPolicy :: Type -> Type # Methods from :: LookupPolicy -> Rep LookupPolicy x # to :: Rep LookupPolicy x -> LookupPolicy #
Read LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods readsPrec :: Int -> ReadS LookupPolicy # readList :: ReadS [LookupPolicy] # readPrec :: ReadPrec LookupPolicy # readListPrec :: ReadPrec [LookupPolicy] #
Show LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods showsPrec :: Int -> LookupPolicy -> ShowS # show :: LookupPolicy -> String # showList :: [LookupPolicy] -> ShowS #
NFData LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods rnf :: LookupPolicy -> () #
Eq LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods (==) :: LookupPolicy -> LookupPolicy -> Bool # (/=) :: LookupPolicy -> LookupPolicy -> Bool #
Hashable LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods hashWithSalt :: Int -> LookupPolicy -> Int # hash :: LookupPolicy -> Int #
type AWSResponse LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy type AWSResponse LookupPolicy = LookupPolicyResponse
type Rep LookupPolicy Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy type Rep LookupPolicy = D1 ('MetaData "LookupPolicy" "Amazonka.CloudDirectory.LookupPolicy" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "LookupPolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "directoryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "objectReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectReference))))

newLookupPolicy Source #

Arguments

:: Text	`LookupPolicy`
-> ObjectReference	`LookupPolicy`
-> 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.

Request Lenses

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

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

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

The token to request the next page of results.

lookupPolicy_directoryArn :: Lens' LookupPolicy Text Source #

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

lookupPolicy_objectReference :: Lens' LookupPolicy ObjectReference Source #

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

Destructuring the Response

data LookupPolicyResponse Source #

See: newLookupPolicyResponse smart constructor.

Constructors

LookupPolicyResponse'
Fields nextToken :: Maybe Text The pagination token. policyToPathList :: Maybe [PolicyToPath] Provides list of path to policies. Policies contain `PolicyId`, `ObjectIdentifier`, and `PolicyType`. For more information, see Policies. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic LookupPolicyResponse Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Associated Types type Rep LookupPolicyResponse :: Type -> Type # Methods from :: LookupPolicyResponse -> Rep LookupPolicyResponse x # to :: Rep LookupPolicyResponse x -> LookupPolicyResponse #
Read LookupPolicyResponse Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods readsPrec :: Int -> ReadS LookupPolicyResponse # readList :: ReadS [LookupPolicyResponse] # readPrec :: ReadPrec LookupPolicyResponse # readListPrec :: ReadPrec [LookupPolicyResponse] #
Show LookupPolicyResponse Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods showsPrec :: Int -> LookupPolicyResponse -> ShowS # show :: LookupPolicyResponse -> String # showList :: [LookupPolicyResponse] -> ShowS #
NFData LookupPolicyResponse Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods rnf :: LookupPolicyResponse -> () #
Eq LookupPolicyResponse Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy Methods (==) :: LookupPolicyResponse -> LookupPolicyResponse -> Bool # (/=) :: LookupPolicyResponse -> LookupPolicyResponse -> Bool #
type Rep LookupPolicyResponse Source #
Instance details Defined in Amazonka.CloudDirectory.LookupPolicy type Rep LookupPolicyResponse = D1 ('MetaData "LookupPolicyResponse" "Amazonka.CloudDirectory.LookupPolicy" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "LookupPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "policyToPathList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PolicyToPath])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newLookupPolicyResponse Source #

Arguments

:: Int	`$sel:httpStatus:LookupPolicyResponse'`
-> 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.

Response Lenses

lookupPolicyResponse_nextToken :: Lens' LookupPolicyResponse (Maybe Text) Source #

The pagination token.

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

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

lookupPolicyResponse_httpStatus :: Lens' LookupPolicyResponse Int Source #

The response's http status code.