Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTSiteWise.DescribeAccessPolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.

Synopsis

Creating a Request

data DescribeAccessPolicy Source #

See: newDescribeAccessPolicy smart constructor.

Constructors

DescribeAccessPolicy'
Fields accessPolicyId :: Text The ID of the access policy.

Instances

Instances details

Eq DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods (==) :: DescribeAccessPolicy -> DescribeAccessPolicy -> Bool # (/=) :: DescribeAccessPolicy -> DescribeAccessPolicy -> Bool #
Read DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods readsPrec :: Int -> ReadS DescribeAccessPolicy # readList :: ReadS [DescribeAccessPolicy] # readPrec :: ReadPrec DescribeAccessPolicy # readListPrec :: ReadPrec [DescribeAccessPolicy] #
Show DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods showsPrec :: Int -> DescribeAccessPolicy -> ShowS # show :: DescribeAccessPolicy -> String # showList :: [DescribeAccessPolicy] -> ShowS #
Generic DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Associated Types type Rep DescribeAccessPolicy :: Type -> Type # Methods from :: DescribeAccessPolicy -> Rep DescribeAccessPolicy x # to :: Rep DescribeAccessPolicy x -> DescribeAccessPolicy #
NFData DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods rnf :: DescribeAccessPolicy -> () #
Hashable DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods hashWithSalt :: Int -> DescribeAccessPolicy -> Int # hash :: DescribeAccessPolicy -> Int #
AWSRequest DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Associated Types type AWSResponse DescribeAccessPolicy # Methods request :: DescribeAccessPolicy -> Request DescribeAccessPolicy # response :: MonadResource m => Logger -> Service -> Proxy DescribeAccessPolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAccessPolicy))) #
ToHeaders DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods toHeaders :: DescribeAccessPolicy -> [Header] #
ToPath DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods toPath :: DescribeAccessPolicy -> ByteString #
ToQuery DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods toQuery :: DescribeAccessPolicy -> QueryString #
type Rep DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy type Rep DescribeAccessPolicy = D1 ('MetaData "DescribeAccessPolicy" "Amazonka.IoTSiteWise.DescribeAccessPolicy" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DescribeAccessPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessPolicyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeAccessPolicy Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy type AWSResponse DescribeAccessPolicy = DescribeAccessPolicyResponse

newDescribeAccessPolicy Source #

Arguments

:: Text	`$sel:accessPolicyId:DescribeAccessPolicy'`
-> DescribeAccessPolicy

Create a value of DescribeAccessPolicy 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:accessPolicyId:DescribeAccessPolicy', describeAccessPolicy_accessPolicyId - The ID of the access policy.

Request Lenses

describeAccessPolicy_accessPolicyId :: Lens' DescribeAccessPolicy Text Source #

The ID of the access policy.

Destructuring the Response

data DescribeAccessPolicyResponse Source #

See: newDescribeAccessPolicyResponse smart constructor.

Constructors

DescribeAccessPolicyResponse'

Fields

httpStatus :: Int
The response's http status code.
accessPolicyId :: Text
The ID of the access policy.

accessPolicyArn :: Text

The ARN of the access policy, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

accessPolicyIdentity :: Identity
The identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) to which this access policy applies.
accessPolicyResource :: Resource
The IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.
accessPolicyPermission :: Permission
The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.
accessPolicyCreationDate :: POSIX
The date the access policy was created, in Unix epoch time.
accessPolicyLastUpdateDate :: POSIX
The date the access policy was last updated, in Unix epoch time.

Instances

Instances details

Eq DescribeAccessPolicyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods (==) :: DescribeAccessPolicyResponse -> DescribeAccessPolicyResponse -> Bool # (/=) :: DescribeAccessPolicyResponse -> DescribeAccessPolicyResponse -> Bool #
Read DescribeAccessPolicyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods readsPrec :: Int -> ReadS DescribeAccessPolicyResponse # readList :: ReadS [DescribeAccessPolicyResponse] # readPrec :: ReadPrec DescribeAccessPolicyResponse # readListPrec :: ReadPrec [DescribeAccessPolicyResponse] #
Show DescribeAccessPolicyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods showsPrec :: Int -> DescribeAccessPolicyResponse -> ShowS # show :: DescribeAccessPolicyResponse -> String # showList :: [DescribeAccessPolicyResponse] -> ShowS #
Generic DescribeAccessPolicyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Associated Types type Rep DescribeAccessPolicyResponse :: Type -> Type # Methods from :: DescribeAccessPolicyResponse -> Rep DescribeAccessPolicyResponse x # to :: Rep DescribeAccessPolicyResponse x -> DescribeAccessPolicyResponse #
NFData DescribeAccessPolicyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy Methods rnf :: DescribeAccessPolicyResponse -> () #
type Rep DescribeAccessPolicyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAccessPolicy type Rep DescribeAccessPolicyResponse = D1 ('MetaData "DescribeAccessPolicyResponse" "Amazonka.IoTSiteWise.DescribeAccessPolicy" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DescribeAccessPolicyResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "accessPolicyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "accessPolicyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "accessPolicyIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Identity))) :: ((S1 ('MetaSel ('Just "accessPolicyResource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Resource) :: S1 ('MetaSel ('Just "accessPolicyPermission") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Permission)) :: (S1 ('MetaSel ('Just "accessPolicyCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "accessPolicyLastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newDescribeAccessPolicyResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAccessPolicyResponse'`
-> Text	`$sel:accessPolicyId:DescribeAccessPolicy'`
-> Text	`$sel:accessPolicyArn:DescribeAccessPolicyResponse'`
-> Identity	`$sel:accessPolicyIdentity:DescribeAccessPolicyResponse'`
-> Resource	`$sel:accessPolicyResource:DescribeAccessPolicyResponse'`
-> Permission	`$sel:accessPolicyPermission:DescribeAccessPolicyResponse'`
-> UTCTime	`$sel:accessPolicyCreationDate:DescribeAccessPolicyResponse'`
-> UTCTime	`$sel:accessPolicyLastUpdateDate:DescribeAccessPolicyResponse'`
-> DescribeAccessPolicyResponse

Create a value of DescribeAccessPolicyResponse 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:DescribeAccessPolicyResponse', describeAccessPolicyResponse_httpStatus - The response's http status code.

$sel:accessPolicyId:DescribeAccessPolicy', describeAccessPolicyResponse_accessPolicyId - The ID of the access policy.

$sel:accessPolicyArn:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyArn - The ARN of the access policy, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

$sel:accessPolicyIdentity:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyIdentity - The identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) to which this access policy applies.

$sel:accessPolicyResource:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyResource - The IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.

$sel:accessPolicyPermission:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyPermission - The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.

$sel:accessPolicyCreationDate:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyCreationDate - The date the access policy was created, in Unix epoch time.

$sel:accessPolicyLastUpdateDate:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyLastUpdateDate - The date the access policy was last updated, in Unix epoch time.

Response Lenses

describeAccessPolicyResponse_httpStatus :: Lens' DescribeAccessPolicyResponse Int Source #

The response's http status code.

describeAccessPolicyResponse_accessPolicyId :: Lens' DescribeAccessPolicyResponse Text Source #

The ID of the access policy.

describeAccessPolicyResponse_accessPolicyArn :: Lens' DescribeAccessPolicyResponse Text Source #

The ARN of the access policy, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

describeAccessPolicyResponse_accessPolicyIdentity :: Lens' DescribeAccessPolicyResponse Identity Source #

The identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) to which this access policy applies.

describeAccessPolicyResponse_accessPolicyResource :: Lens' DescribeAccessPolicyResponse Resource Source #

The IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.

describeAccessPolicyResponse_accessPolicyPermission :: Lens' DescribeAccessPolicyResponse Permission Source #

The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.

describeAccessPolicyResponse_accessPolicyCreationDate :: Lens' DescribeAccessPolicyResponse UTCTime Source #

The date the access policy was created, in Unix epoch time.

describeAccessPolicyResponse_accessPolicyLastUpdateDate :: Lens' DescribeAccessPolicyResponse UTCTime Source #

The date the access policy was last updated, in Unix epoch time.