libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTSiteWise.ListAccessPolicies

Description

Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).

This operation returns paginated results.

Synopsis

Creating a Request

data ListAccessPolicies Source #

See: newListAccessPolicies smart constructor.

Constructors

ListAccessPolicies' 

Fields

  • resourceId :: Maybe Text

    The ID of the resource. This parameter is required if you specify resourceType.

  • resourceType :: Maybe ResourceType

    The type of resource (portal or project). This parameter is required if you specify resourceId.

  • identityType :: Maybe IdentityType

    The type of identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user). This parameter is required if you specify identityId.

  • nextToken :: Maybe Text

    The token to be used for the next set of paginated results.

  • iamArn :: Maybe Text

    The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.

  • identityId :: Maybe Text

    The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.

  • maxResults :: Maybe Natural

    The maximum number of results to return for each paginated request.

    Default: 50

Instances

Instances details
Eq ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

Read ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

Show ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

Generic ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

Associated Types

type Rep ListAccessPolicies :: Type -> Type #

NFData ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

Methods

rnf :: ListAccessPolicies -> () #

Hashable ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

AWSPager ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

AWSRequest ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

Associated Types

type AWSResponse ListAccessPolicies #

ToHeaders ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

ToPath ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

ToQuery ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

type Rep ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

type Rep ListAccessPolicies = D1 ('MetaData "ListAccessPolicies" "Amazonka.IoTSiteWise.ListAccessPolicies" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "ListAccessPolicies'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType)) :*: S1 ('MetaSel ('Just "identityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityType)))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListAccessPolicies Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

newListAccessPolicies :: ListAccessPolicies Source #

Create a value of ListAccessPolicies 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:resourceId:ListAccessPolicies', listAccessPolicies_resourceId - The ID of the resource. This parameter is required if you specify resourceType.

$sel:resourceType:ListAccessPolicies', listAccessPolicies_resourceType - The type of resource (portal or project). This parameter is required if you specify resourceId.

$sel:identityType:ListAccessPolicies', listAccessPolicies_identityType - The type of identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user). This parameter is required if you specify identityId.

$sel:nextToken:ListAccessPolicies', listAccessPolicies_nextToken - The token to be used for the next set of paginated results.

$sel:iamArn:ListAccessPolicies', listAccessPolicies_iamArn - The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.

$sel:identityId:ListAccessPolicies', listAccessPolicies_identityId - The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.

$sel:maxResults:ListAccessPolicies', listAccessPolicies_maxResults - The maximum number of results to return for each paginated request.

Default: 50

Request Lenses

listAccessPolicies_resourceId :: Lens' ListAccessPolicies (Maybe Text) Source #

The ID of the resource. This parameter is required if you specify resourceType.

listAccessPolicies_resourceType :: Lens' ListAccessPolicies (Maybe ResourceType) Source #

The type of resource (portal or project). This parameter is required if you specify resourceId.

listAccessPolicies_identityType :: Lens' ListAccessPolicies (Maybe IdentityType) Source #

The type of identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user). This parameter is required if you specify identityId.

listAccessPolicies_nextToken :: Lens' ListAccessPolicies (Maybe Text) Source #

The token to be used for the next set of paginated results.

listAccessPolicies_iamArn :: Lens' ListAccessPolicies (Maybe Text) Source #

The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.

listAccessPolicies_identityId :: Lens' ListAccessPolicies (Maybe Text) Source #

The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.

listAccessPolicies_maxResults :: Lens' ListAccessPolicies (Maybe Natural) Source #

The maximum number of results to return for each paginated request.

Default: 50

Destructuring the Response

data ListAccessPoliciesResponse Source #

See: newListAccessPoliciesResponse smart constructor.

Constructors

ListAccessPoliciesResponse' 

Fields

Instances

Instances details
Eq ListAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

Read ListAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

Show ListAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

Generic ListAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

Associated Types

type Rep ListAccessPoliciesResponse :: Type -> Type #

NFData ListAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

type Rep ListAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAccessPolicies

type Rep ListAccessPoliciesResponse = D1 ('MetaData "ListAccessPoliciesResponse" "Amazonka.IoTSiteWise.ListAccessPolicies" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "ListAccessPoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "accessPolicySummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AccessPolicySummary]))))

newListAccessPoliciesResponse Source #

Create a value of ListAccessPoliciesResponse 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:ListAccessPolicies', listAccessPoliciesResponse_nextToken - The token for the next set of results, or null if there are no additional results.

$sel:httpStatus:ListAccessPoliciesResponse', listAccessPoliciesResponse_httpStatus - The response's http status code.

$sel:accessPolicySummaries:ListAccessPoliciesResponse', listAccessPoliciesResponse_accessPolicySummaries - A list that summarizes each access policy.

Response Lenses

listAccessPoliciesResponse_nextToken :: Lens' ListAccessPoliciesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.