SSOAdmin / Client / list_application_assignments

list_application_assignments#

SSOAdmin.Client.list_application_assignments(**kwargs)#

Lists Amazon Web Services account users that are assigned to an application.

See also: AWS API Documentation

Request Syntax

response = client.list_application_assignments(
    ApplicationArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ApplicationArn (string) –

    [REQUIRED]

    Specifies the ARN of the application.

  • MaxResults (integer) – Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • NextToken (string) – Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s NextToken response to request the next page of results.

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Exceptions