AWS License Manager User Subscriptions

2022/08/02 - AWS License Manager User Subscriptions - 10 new api methods

Changes  This release supports user based subscription for Microsoft Visual Studio Professional and Enterprise on EC2.

ListProductSubscriptions (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_product_subscriptions(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': 'string'
        },
    ],
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    MaxResults=123,
    NextToken='string',
    Product='string'
)
type Filters

list

param Filters

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.

type IdentityProvider

dict

param IdentityProvider

[REQUIRED]

An object that specifies details for the identity provider.

  • ActiveDirectoryIdentityProvider (dict) --

    An object that details an Active Directory identity provider.

    • DirectoryId (string) --

      The directory ID for an Active Directory identity provider.

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

type NextToken

string

param NextToken

Token for the next set of results.

type Product

string

param Product

[REQUIRED]

The name of the user-based subscription product.

rtype

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.

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

AssociateUser (new) Link ¶

Associates the user to an EC2 instance to utilize user-based subscriptions.

See also: AWS API Documentation

Request Syntax

client.associate_user(
    Domain='string',
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    InstanceId='string',
    Username='string'
)
type Domain

string

param Domain

The domain name of the user.

type IdentityProvider

dict

param IdentityProvider

[REQUIRED]

The identity provider of the user.

  • ActiveDirectoryIdentityProvider (dict) --

    An object that details an Active Directory identity provider.

    • DirectoryId (string) --

      The directory ID for an Active Directory identity provider.

type InstanceId

string

param InstanceId

[REQUIRED]

The ID of the EC2 instance, which provides user-based subscriptions.

type Username

string

param Username

[REQUIRED]

The user name from the identity provider for the user.

rtype

dict

returns

Response Syntax

{
    'InstanceUserSummary': {
        'AssociationDate': 'string',
        'DisassociationDate': 'string',
        'Domain': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'DirectoryId': 'string'
            }
        },
        'InstanceId': 'string',
        'Status': 'string',
        'StatusMessage': 'string',
        'Username': 'string'
    }
}

Response Structure

  • (dict) --

    • InstanceUserSummary (dict) --

      Metadata that describes the associate user operation.

      • AssociationDate (string) --

        The date a user was associated with an EC2 instance.

      • DisassociationDate (string) --

        The date a user was disassociated from an EC2 instance.

      • Domain (string) --

        The domain name of the user.

      • IdentityProvider (dict) --

        An object that specifies details for the identity provider.

        • ActiveDirectoryIdentityProvider (dict) --

          An object that details an Active Directory identity provider.

          • DirectoryId (string) --

            The directory ID for an Active Directory identity provider.

      • InstanceId (string) --

        The ID of the EC2 instance, which provides user-based subscriptions.

      • Status (string) --

        The status of a user associated with an EC2 instance.

      • StatusMessage (string) --

        The status message for users of an EC2 instance.

      • Username (string) --

        The user name from the identity provider for the user.

ListUserAssociations (new) Link ¶

Lists user associations for an identity provider.

See also: AWS API Documentation

Request Syntax

client.list_user_associations(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': 'string'
        },
    ],
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    InstanceId='string',
    MaxResults=123,
    NextToken='string'
)
type Filters

list

param Filters

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.

type IdentityProvider

dict

param IdentityProvider

[REQUIRED]

An object that specifies details for the identity provider.

  • ActiveDirectoryIdentityProvider (dict) --

    An object that details an Active Directory identity provider.

    • DirectoryId (string) --

      The directory ID for an Active Directory identity provider.

type InstanceId

string

param InstanceId

[REQUIRED]

The ID of the EC2 instance, which provides user-based subscriptions.

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

type NextToken

string

param NextToken

Token for the next set of results.

rtype

dict

returns

Response Syntax

{
    'InstanceUserSummaries': [
        {
            'AssociationDate': 'string',
            'DisassociationDate': 'string',
            'Domain': 'string',
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'DirectoryId': 'string'
                }
            },
            'InstanceId': 'string',
            'Status': 'string',
            'StatusMessage': 'string',
            'Username': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • InstanceUserSummaries (list) --

      Metadata that describes the list user association operation.

      • (dict) --

        Describes users of an EC2 instance providing user-based subscriptions.

        • AssociationDate (string) --

          The date a user was associated with an EC2 instance.

        • DisassociationDate (string) --

          The date a user was disassociated from an EC2 instance.

        • Domain (string) --

          The domain name of the user.

        • IdentityProvider (dict) --

          An object that specifies details for the identity provider.

          • ActiveDirectoryIdentityProvider (dict) --

            An object that details an Active Directory identity provider.

            • DirectoryId (string) --

              The directory ID for an Active Directory identity provider.

        • InstanceId (string) --

          The ID of the EC2 instance, which provides user-based subscriptions.

        • Status (string) --

          The status of a user associated with an EC2 instance.

        • StatusMessage (string) --

          The status message for users of an EC2 instance.

        • Username (string) --

          The user name from the identity provider for the user.

    • NextToken (string) --

      Token for the next set of results.

ListInstances (new) Link ¶

Lists the EC2 instances providing user-based subscriptions.

See also: AWS API Documentation

Request Syntax

client.list_instances(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': 'string'
        },
    ],
    MaxResults=123,
    NextToken='string'
)
type Filters

list

param Filters

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.

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

type NextToken

string

param NextToken

Token for the next set of results.

rtype

dict

returns

Response Syntax

{
    'InstanceSummaries': [
        {
            'InstanceId': 'string',
            'LastStatusCheckDate': 'string',
            'Products': [
                'string',
            ],
            'Status': 'string',
            'StatusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • InstanceSummaries (list) --

      Metadata that describes the list instances operation.

      • (dict) --

        Describes an EC2 instance providing user-based subscriptions.

        • InstanceId (string) --

          The ID of the EC2 instance, which provides user-based subscriptions.

        • LastStatusCheckDate (string) --

          The date of the last status check.

        • Products (list) --

          A list of provided user-based subscription products.

          • (string) --

        • Status (string) --

          The status of an EC2 instance resource.

        • StatusMessage (string) --

          The status message for an EC2 instance.

    • NextToken (string) --

      Token for the next set of results.

ListIdentityProviders (new) Link ¶

Lists the identity providers for user-based subscriptions.

See also: AWS API Documentation

Request Syntax

client.list_identity_providers(
    MaxResults=123,
    NextToken='string'
)
type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

type NextToken

string

param NextToken

Token for the next set of results.

rtype

dict

returns

Response Syntax

{
    'IdentityProviderSummaries': [
        {
            'FailureMessage': 'string',
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'DirectoryId': 'string'
                }
            },
            'Product': 'string',
            'Status': 'string'
        },
    ],
    'NextToken': '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.

          • 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 an identity provider.

    • NextToken (string) --

      Token for the next set of results.

DeregisterIdentityProvider (new) Link ¶

Deregisters the identity provider from providing user-based subscriptions.

See also: AWS API Documentation

Request Syntax

client.deregister_identity_provider(
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string'
)
type IdentityProvider

dict

param IdentityProvider

[REQUIRED]

An object that specifies details for the identity provider.

  • ActiveDirectoryIdentityProvider (dict) --

    An object that details an Active Directory identity provider.

    • DirectoryId (string) --

      The directory ID for an Active Directory identity provider.

type Product

string

param Product

[REQUIRED]

The name of the user-based subscription product.

rtype

dict

returns

Response Syntax

{
    'IdentityProviderSummary': {
        'FailureMessage': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'DirectoryId': 'string'
            }
        },
        'Product': 'string',
        'Status': 'string'
    }
}

Response Structure

  • (dict) --

    • IdentityProviderSummary (dict) --

      Metadata that describes the results of an identity provider operation.

      • FailureMessage (string) --

        The failure message associated with an identity provider.

      • IdentityProvider (dict) --

        An object that specifies details for the identity provider.

        • 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 an identity provider.

RegisterIdentityProvider (new) Link ¶

Registers an identity provider for user-based subscriptions.

See also: AWS API Documentation

Request Syntax

client.register_identity_provider(
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string'
)
type IdentityProvider

dict

param IdentityProvider

[REQUIRED]

An object that specifies details for the identity provider.

  • ActiveDirectoryIdentityProvider (dict) --

    An object that details an Active Directory identity provider.

    • DirectoryId (string) --

      The directory ID for an Active Directory identity provider.

type Product

string

param Product

[REQUIRED]

The name of the user-based subscription product.

rtype

dict

returns

Response Syntax

{
    'IdentityProviderSummary': {
        'FailureMessage': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'DirectoryId': 'string'
            }
        },
        'Product': 'string',
        'Status': 'string'
    }
}

Response Structure

  • (dict) --

    • IdentityProviderSummary (dict) --

      Metadata that describes the results of an identity provider operation.

      • FailureMessage (string) --

        The failure message associated with an identity provider.

      • IdentityProvider (dict) --

        An object that specifies details for the identity provider.

        • 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 an identity provider.

StopProductSubscription (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

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

string

param Domain

The domain name of the user.

type IdentityProvider

dict

param IdentityProvider

[REQUIRED]

An object that specifies details for the identity provider.

  • ActiveDirectoryIdentityProvider (dict) --

    An object that details an Active Directory identity provider.

    • DirectoryId (string) --

      The directory ID for an Active Directory identity provider.

type Product

string

param Product

[REQUIRED]

The name of the user-based subscription product.

type Username

string

param Username

[REQUIRED]

The user name from the identity provider for the user.

rtype

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.

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

DisassociateUser (new) Link ¶

Disassociates the user from an EC2 instance providing user-based subscriptions.

See also: AWS API Documentation

Request Syntax

client.disassociate_user(
    Domain='string',
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    InstanceId='string',
    Username='string'
)
type Domain

string

param Domain

The domain name of the user.

type IdentityProvider

dict

param IdentityProvider

[REQUIRED]

An object that specifies details for the identity provider.

  • ActiveDirectoryIdentityProvider (dict) --

    An object that details an Active Directory identity provider.

    • DirectoryId (string) --

      The directory ID for an Active Directory identity provider.

type InstanceId

string

param InstanceId

[REQUIRED]

The ID of the EC2 instance, which provides user-based subscriptions.

type Username

string

param Username

[REQUIRED]

The user name from the identity provider for the user.

rtype

dict

returns

Response Syntax

{
    'InstanceUserSummary': {
        'AssociationDate': 'string',
        'DisassociationDate': 'string',
        'Domain': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'DirectoryId': 'string'
            }
        },
        'InstanceId': 'string',
        'Status': 'string',
        'StatusMessage': 'string',
        'Username': 'string'
    }
}

Response Structure

  • (dict) --

    • InstanceUserSummary (dict) --

      Metadata that describes the associate user operation.

      • AssociationDate (string) --

        The date a user was associated with an EC2 instance.

      • DisassociationDate (string) --

        The date a user was disassociated from an EC2 instance.

      • Domain (string) --

        The domain name of the user.

      • IdentityProvider (dict) --

        An object that specifies details for the identity provider.

        • ActiveDirectoryIdentityProvider (dict) --

          An object that details an Active Directory identity provider.

          • DirectoryId (string) --

            The directory ID for an Active Directory identity provider.

      • InstanceId (string) --

        The ID of the EC2 instance, which provides user-based subscriptions.

      • Status (string) --

        The status of a user associated with an EC2 instance.

      • StatusMessage (string) --

        The status message for users of an EC2 instance.

      • Username (string) --

        The user name from the identity provider for the user.

StartProductSubscription (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

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

string

param Domain

The domain name of the user.

type IdentityProvider

dict

param IdentityProvider

[REQUIRED]

An object that specifies details for the identity provider.

  • ActiveDirectoryIdentityProvider (dict) --

    An object that details an Active Directory identity provider.

    • DirectoryId (string) --

      The directory ID for an Active Directory identity provider.

type Product

string

param Product

[REQUIRED]

The name of the user-based subscription product.

type Username

string

param Username

[REQUIRED]

The user name from the identity provider of the user.

rtype

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.

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