LicenseManagerUserSubscriptions / Paginator / ListIdentityProviders

ListIdentityProviders

class LicenseManagerUserSubscriptions.Paginator.ListIdentityProviders

paginator = client.get_paginator('list_identity_providers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from LicenseManagerUserSubscriptions.Client.list_identity_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

{
    'IdentityProviderSummaries': [
        {
            'FailureMessage': 'string',
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'DirectoryId': 'string'
                }
            },
            'Product': 'string',
            'Settings': {
                'SecurityGroupId': 'string',
                'Subnets': [
                    'string',
                ]
            },
            'Status': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • IdentityProviderSummaries (list) –

    Metadata that describes the list identity providers operation.

    • (dict) –

      Describes an identity provider.

      • FailureMessage (string) –

        The failure message associated with an identity provider.

      • IdentityProvider (dict) –

        An object that specifies details for the identity provider.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: ActiveDirectoryIdentityProvider. 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'}
        

        • ActiveDirectoryIdentityProvider (dict) –

          An object that details an Active Directory identity provider.

          • DirectoryId (string) –

            The directory ID for an Active Directory identity provider.

      • Product (string) –

        The name of the user-based subscription product.

      • Settings (dict) –

        An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.

        • SecurityGroupId (string) –

          A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.

        • Subnets (list) –

          The subnets defined for the registered identity provider.

          • (string) –

      • Status (string) –

        The status of an identity provider.