LicenseManagerUserSubscriptions / Paginator / ListProductSubscriptions

ListProductSubscriptions#

class LicenseManagerUserSubscriptions.Paginator.ListProductSubscriptions#
paginator = client.get_paginator('list_product_subscriptions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from LicenseManagerUserSubscriptions.Client.list_product_subscriptions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': 'string'
        },
    ],
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • Filters (list) –

    An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.

    • (dict) –

      A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

      • Attribute (string) –

        The name of an attribute to use as a filter.

      • Operation (string) –

        The type of search (For example, eq, geq, leq)

      • Value (string) –

        Value of the filter.

  • IdentityProvider (dict) –

    [REQUIRED]

    An object that specifies details for the identity provider.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.

    • ActiveDirectoryIdentityProvider (dict) –

      An object that details an Active Directory identity provider.

      • DirectoryId (string) –

        The directory ID for an Active Directory identity provider.

  • Product (string) –

    [REQUIRED]

    The name of the user-based subscription product.

  • 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

{
    'ProductUserSummaries': [
        {
            'Domain': 'string',
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'DirectoryId': 'string'
                }
            },
            'Product': 'string',
            'Status': 'string',
            'StatusMessage': 'string',
            'SubscriptionEndDate': 'string',
            'SubscriptionStartDate': 'string',
            'Username': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • ProductUserSummaries (list) –

      Metadata that describes the list product subscriptions operation.

      • (dict) –

        The summary of the user-based subscription products for a user.

        • Domain (string) –

          The domain name of the user.

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

        • Status (string) –

          The status of a product for a user.

        • StatusMessage (string) –

          The status message for a product for a user.

        • SubscriptionEndDate (string) –

          The end date of a subscription.

        • SubscriptionStartDate (string) –

          The start date of a subscription.

        • Username (string) –

          The user name from the identity provider of the user.