SSOAdmin / Paginator / ListApplicationProviders

ListApplicationProviders#

class SSOAdmin.Paginator.ListApplicationProviders#
paginator = client.get_paginator('list_application_providers')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

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

{
    'ApplicationProviders': [
        {
            'ApplicationProviderArn': 'string',
            'DisplayData': {
                'Description': 'string',
                'DisplayName': 'string',
                'IconUrl': 'string'
            },
            'FederationProtocol': 'SAML'|'OAUTH',
            'ResourceServerConfig': {
                'Scopes': {
                    'string': {
                        'DetailedTitle': 'string',
                        'LongDescription': 'string'
                    }
                }
            }
        },
    ],

}

Response Structure

  • (dict) –

    • ApplicationProviders (list) –

      An array list of structures that describe application providers.

      • (dict) –

        A structure that describes a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.

        • ApplicationProviderArn (string) –

          The ARN of the application provider.

        • DisplayData (dict) –

          A structure that describes how IAM Identity Center represents the application provider in the portal.

          • Description (string) –

            The description of the application provider that appears in the portal.

          • DisplayName (string) –

            The name of the application provider that appears in the portal.

          • IconUrl (string) –

            A URL that points to an icon that represents the application provider.

        • FederationProtocol (string) –

          The protocol that the application provider uses to perform federation.

        • ResourceServerConfig (dict) –

          A structure that describes the application provider’s resource server.

          • Scopes (dict) –

            A list of the IAM Identity Center access scopes that are associated with this resource server.

            • (string) –

              • (dict) –

                A structure that describes details for an IAM Identity Center access scope that is associated with a resource server.

                • DetailedTitle (string) –

                  The title of an access scope for a resource server.

                • LongDescription (string) –

                  The description of an access scope for a resource server.