LicenseManagerUserSubscriptions / Client / list_product_subscriptions

list_product_subscriptions#

LicenseManagerUserSubscriptions.Client.list_product_subscriptions(**kwargs)#

Lists the user-based subscription products available from an identity provider.

Request Syntax

response = client.list_product_subscriptions(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': 'string'
        },
    ],
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    MaxResults=123,
    NextToken='string',
    Product='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.
MaxResults (integer) – Maximum number of results to return in a single call.
NextToken (string) – Token for the next set of results.
Product (string) –
[REQUIRED]

The name of the user-based subscription product.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- NextToken (string) –
  
  Token for the next set of results.
- 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.

Exceptions

LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededException
LicenseManagerUserSubscriptions.Client.exceptions.ConflictException
LicenseManagerUserSubscriptions.Client.exceptions.ValidationException
LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingException
LicenseManagerUserSubscriptions.Client.exceptions.InternalServerException
LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundException
LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedException