SSOAdmin / Paginator / ListAccountAssignmentsForPrincipal

ListAccountAssignmentsForPrincipal

class SSOAdmin.Paginator.ListAccountAssignmentsForPrincipal

paginator = client.get_paginator('list_account_assignments_for_principal')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_account_assignments_for_principal().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filter={
        'AccountId': 'string'
    },
    InstanceArn='string',
    PrincipalId='string',
    PrincipalType='USER'|'GROUP',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filter (dict) –

  Specifies an Amazon Web Services account ID number. Results are filtered to only those that match this ID number.

  • AccountId (string) –

    The ID number of an Amazon Web Services account that filters the results in the response.

• InstanceArn (string) –

  [REQUIRED]

  Specifies the ARN of the instance of IAM Identity Center that contains the principal.

• PrincipalId (string) –

  [REQUIRED]

  Specifies the principal for which you want to retrieve the list of account assignments.

• PrincipalType (string) –

  [REQUIRED]

  Specifies the type of the principal.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    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.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'AccountAssignments': [
        {
            'AccountId': 'string',
            'PermissionSetArn': 'string',
            'PrincipalId': 'string',
            'PrincipalType': 'USER'|'GROUP'
        },
    ],

}

Response Structure

• (dict) –

  • AccountAssignments (list) –

    An array list of the account assignments for the principal.

    • (dict) –

      A structure that describes an assignment of an Amazon Web Services account to a principal and the permissions that principal has in the account.

      • AccountId (string) –

        The account ID number of the Amazon Web Services account.

      • PermissionSetArn (string) –

        The ARN of the IAM Identity Center permission set assigned to this principal for this Amazon Web Services account.

      • PrincipalId (string) –

        The ID of the principal.

      • PrincipalType (string) –

        The type of the principal.