stop_product_subscription

stop_product_subscription(**kwargs)

Stops a product subscription for a user with the specified identity provider.

See also: AWS API Documentation

Request Syntax

response = client.stop_product_subscription(
    Domain='string',
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string',
    Username='string'
)

Parameters

• Domain (string) -- The domain name of the user.
• 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.

• Username (string) --

  [REQUIRED]

  The user name from the identity provider for the user.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • ProductUserSummary (dict) --

    Metadata that describes the start product subscription operation.

    • 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