ServiceCatalog.Paginator.
ListPrincipalsForPortfolio
¶paginator = client.get_paginator('list_principals_for_portfolio')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_principals_for_portfolio()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
PortfolioId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en
- English (default)jp
- Japanesezh
- Chinese[REQUIRED]
The portfolio identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Principals': [
{
'PrincipalARN': 'string',
'PrincipalType': 'IAM'|'IAM_PATTERN'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Principals (list) --
The PrincipalARN
s and corresponding PrincipalType
s associated with the portfolio.
(dict) --
Information about a principal.
PrincipalARN (string) --
The ARN of the principal (IAM user, role, or group). This field allows for an ARN with no accountID
if the PrincipalType
is an IAM_PATTERN
.
PrincipalType (string) --
The principal type. The supported value is IAM
if you use a fully defined ARN, or IAM_PATTERN
if you use an ARN with no accountID
.
NextToken (string) --
A token to resume pagination.