SSOAdmin / Paginator / ListApplicationAuthenticationMethods

ListApplicationAuthenticationMethods

class SSOAdmin.Paginator.ListApplicationAuthenticationMethods

paginator = client.get_paginator('list_application_authentication_methods')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ApplicationArn (string) –

  [REQUIRED]

  Specifies the ARN of the application with the authentication methods you want to list.

• 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.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'AuthenticationMethods': [
        {
            'AuthenticationMethod': {
                'Iam': {
                    'ActorPolicy': {...}|[...]|123|123.4|'string'|True|None
                }
            },
            'AuthenticationMethodType': 'IAM'
        },
    ],

}

Response Structure

• (dict) –

  • AuthenticationMethods (list) –

    An array list of authentication methods for the specified application.

    • (dict) –

      A structure that describes an authentication method and its type.

      • AuthenticationMethod (dict) –

        A structure that describes an authentication method. The contents of this structure is determined by the AuthenticationMethodType.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: Iam. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • Iam (dict) –

          A structure that describes details for IAM authentication.

          • ActorPolicy (document) –

            An IAM policy document in JSON.

      • AuthenticationMethodType (string) –

        The type of authentication that is used by this method.