SSOAdmin / Paginator / ListApplicationAssignments

ListApplicationAssignments#

class SSOAdmin.Paginator.ListApplicationAssignments#
paginator = client.get_paginator('list_application_assignments')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApplicationArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • ApplicationArn (string) –

    [REQUIRED]

    Specifies the ARN of the application.

  • 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

{
    'ApplicationAssignments': [
        {
            'ApplicationArn': 'string',
            'PrincipalId': 'string',
            'PrincipalType': 'USER'|'GROUP'
        },
    ],

}

Response Structure

  • (dict) –

    • ApplicationAssignments (list) –

      The list of users assigned to an application.

      • (dict) –

        A structure that describes an assignment of a principal to an application.

        • ApplicationArn (string) –

          The ARN of the application that has principals assigned.

        • PrincipalId (string) –

          The unique identifier of the principal assigned to the application.

        • PrincipalType (string) –

          The type of the principal assigned to the application.