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.RAM.ListPrincipals

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the principals that you have shared resources with or that have shared resources with you.

This operation returns paginated results.

Synopsis

data ListPrincipals = ListPrincipals' {
- resourceType :: Maybe Text
- principals :: Maybe [Text]
- nextToken :: Maybe Text
- resourceArn :: Maybe Text
- maxResults :: Maybe Natural
- resourceShareArns :: Maybe [Text]
- resourceOwner :: ResourceOwner
}
newListPrincipals :: ResourceOwner -> ListPrincipals
listPrincipals_resourceType :: Lens' ListPrincipals (Maybe Text)
listPrincipals_principals :: Lens' ListPrincipals (Maybe [Text])
listPrincipals_nextToken :: Lens' ListPrincipals (Maybe Text)
listPrincipals_resourceArn :: Lens' ListPrincipals (Maybe Text)
listPrincipals_maxResults :: Lens' ListPrincipals (Maybe Natural)
listPrincipals_resourceShareArns :: Lens' ListPrincipals (Maybe [Text])
listPrincipals_resourceOwner :: Lens' ListPrincipals ResourceOwner
data ListPrincipalsResponse = ListPrincipalsResponse' {
- principals :: Maybe [Principal]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListPrincipalsResponse :: Int -> ListPrincipalsResponse
listPrincipalsResponse_principals :: Lens' ListPrincipalsResponse (Maybe [Principal])
listPrincipalsResponse_nextToken :: Lens' ListPrincipalsResponse (Maybe Text)
listPrincipalsResponse_httpStatus :: Lens' ListPrincipalsResponse Int

Creating a Request

data ListPrincipals Source #

See: newListPrincipals smart constructor.

Constructors

ListPrincipals'

Fields

resourceType :: Maybe Text
The resource type.
Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan
principals :: Maybe [Text]
The principals.
nextToken :: Maybe Text
The token for the next page of results.
resourceArn :: Maybe Text
The Amazon Resource Name (ARN) of the resource.
maxResults :: Maybe Natural
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
resourceShareArns :: Maybe [Text]
The Amazon Resource Names (ARN) of the resource shares.
resourceOwner :: ResourceOwner
The type of owner.

Instances

Instances details

Eq ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods (==) :: ListPrincipals -> ListPrincipals -> Bool # (/=) :: ListPrincipals -> ListPrincipals -> Bool #
Read ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods readsPrec :: Int -> ReadS ListPrincipals # readList :: ReadS [ListPrincipals] # readPrec :: ReadPrec ListPrincipals # readListPrec :: ReadPrec [ListPrincipals] #
Show ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods showsPrec :: Int -> ListPrincipals -> ShowS # show :: ListPrincipals -> String # showList :: [ListPrincipals] -> ShowS #
Generic ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Associated Types type Rep ListPrincipals :: Type -> Type # Methods from :: ListPrincipals -> Rep ListPrincipals x # to :: Rep ListPrincipals x -> ListPrincipals #
NFData ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods rnf :: ListPrincipals -> () #
Hashable ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods hashWithSalt :: Int -> ListPrincipals -> Int # hash :: ListPrincipals -> Int #
ToJSON ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods toJSON :: ListPrincipals -> Value # toEncoding :: ListPrincipals -> Encoding # toJSONList :: [ListPrincipals] -> Value # toEncodingList :: [ListPrincipals] -> Encoding #
AWSPager ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods page :: ListPrincipals -> AWSResponse ListPrincipals -> Maybe ListPrincipals #
AWSRequest ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Associated Types type AWSResponse ListPrincipals # Methods request :: ListPrincipals -> Request ListPrincipals # response :: MonadResource m => Logger -> Service -> Proxy ListPrincipals -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPrincipals))) #
ToHeaders ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods toHeaders :: ListPrincipals -> [Header] #
ToPath ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods toPath :: ListPrincipals -> ByteString #
ToQuery ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods toQuery :: ListPrincipals -> QueryString #
type Rep ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals type Rep ListPrincipals = D1 ('MetaData "ListPrincipals" "Amazonka.RAM.ListPrincipals" "libZSservicesZSamazonka-ramZSamazonka-ram" 'False) (C1 ('MetaCons "ListPrincipals'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "principals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "resourceShareArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "resourceOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceOwner)))))
type AWSResponse ListPrincipals Source #
Instance details Defined in Amazonka.RAM.ListPrincipals type AWSResponse ListPrincipals = ListPrincipalsResponse

newListPrincipals Source #

Arguments

:: ResourceOwner	`$sel:resourceOwner:ListPrincipals'`
-> ListPrincipals

Create a value of ListPrincipals 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:resourceType:ListPrincipals', listPrincipals_resourceType - The resource type.

$sel:principals:ListPrincipals', listPrincipals_principals - The principals.

$sel:nextToken:ListPrincipals', listPrincipals_nextToken - The token for the next page of results.

$sel:resourceArn:ListPrincipals', listPrincipals_resourceArn - The Amazon Resource Name (ARN) of the resource.

$sel:maxResults:ListPrincipals', listPrincipals_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

$sel:resourceShareArns:ListPrincipals', listPrincipals_resourceShareArns - The Amazon Resource Names (ARN) of the resource shares.

$sel:resourceOwner:ListPrincipals', listPrincipals_resourceOwner - The type of owner.

Request Lenses

listPrincipals_resourceType :: Lens' ListPrincipals (Maybe Text) Source #

The resource type.

listPrincipals_principals :: Lens' ListPrincipals (Maybe [Text]) Source #

The principals.

listPrincipals_nextToken :: Lens' ListPrincipals (Maybe Text) Source #

The token for the next page of results.

listPrincipals_resourceArn :: Lens' ListPrincipals (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

listPrincipals_maxResults :: Lens' ListPrincipals (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

listPrincipals_resourceShareArns :: Lens' ListPrincipals (Maybe [Text]) Source #

The Amazon Resource Names (ARN) of the resource shares.

listPrincipals_resourceOwner :: Lens' ListPrincipals ResourceOwner Source #

The type of owner.

Destructuring the Response

data ListPrincipalsResponse Source #

See: newListPrincipalsResponse smart constructor.

Constructors

ListPrincipalsResponse'
Fields principals :: Maybe [Principal] The principals. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListPrincipalsResponse Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods (==) :: ListPrincipalsResponse -> ListPrincipalsResponse -> Bool # (/=) :: ListPrincipalsResponse -> ListPrincipalsResponse -> Bool #
Read ListPrincipalsResponse Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods readsPrec :: Int -> ReadS ListPrincipalsResponse # readList :: ReadS [ListPrincipalsResponse] # readPrec :: ReadPrec ListPrincipalsResponse # readListPrec :: ReadPrec [ListPrincipalsResponse] #
Show ListPrincipalsResponse Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods showsPrec :: Int -> ListPrincipalsResponse -> ShowS # show :: ListPrincipalsResponse -> String # showList :: [ListPrincipalsResponse] -> ShowS #
Generic ListPrincipalsResponse Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Associated Types type Rep ListPrincipalsResponse :: Type -> Type # Methods from :: ListPrincipalsResponse -> Rep ListPrincipalsResponse x # to :: Rep ListPrincipalsResponse x -> ListPrincipalsResponse #
NFData ListPrincipalsResponse Source #
Instance details Defined in Amazonka.RAM.ListPrincipals Methods rnf :: ListPrincipalsResponse -> () #
type Rep ListPrincipalsResponse Source #
Instance details Defined in Amazonka.RAM.ListPrincipals type Rep ListPrincipalsResponse = D1 ('MetaData "ListPrincipalsResponse" "Amazonka.RAM.ListPrincipals" "libZSservicesZSamazonka-ramZSamazonka-ram" 'False) (C1 ('MetaCons "ListPrincipalsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "principals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Principal])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPrincipalsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListPrincipalsResponse'`
-> ListPrincipalsResponse

Create a value of ListPrincipalsResponse 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:principals:ListPrincipals', listPrincipalsResponse_principals - The principals.

$sel:nextToken:ListPrincipals', listPrincipalsResponse_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:httpStatus:ListPrincipalsResponse', listPrincipalsResponse_httpStatus - The response's http status code.

Response Lenses

listPrincipalsResponse_principals :: Lens' ListPrincipalsResponse (Maybe [Principal]) Source #

The principals.

listPrincipalsResponse_nextToken :: Lens' ListPrincipalsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

listPrincipalsResponse_httpStatus :: Lens' ListPrincipalsResponse Int Source #

The response's http status code.