2026/08/26 - AWS License Manager User Subscriptions - 3 updated api methods
Changes Released support for License Expiry field in ListProductSubscriptions API
{'ProductUserSummaries': {'LicenseExpirationDate': 'string'}}
Lists the user-based subscription products available from an identity provider.
See also: AWS API Documentation
Request Syntax
client.list_product_subscriptions(
Product='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainIpv6List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
MaxResults=123,
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
],
NextToken='string'
)
string
The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | OFFICE_STANDARD | REMOTE_DESKTOP_SERVICES
dict
[REQUIRED]
An object that specifies details for the identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
ActiveDirectorySettings (dict) --
The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
DomainName (string) --
The domain name for the Active Directory.
DomainIpv4List (list) --
A list of domain IPv4 addresses that are used for the Active Directory.
(string) --
DomainIpv6List (list) --
A list of domain IPv6 addresses that are used for the Active Directory.
(string) --
DomainCredentialsProvider (dict) --
Points to the CredentialsProvider resource that contains information about the credential provider for user administration.
SecretsManagerCredentialsProvider (dict) --
Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
SecretId (string) --
The ID of the Secrets Manager secret that contains credentials.
DomainNetworkSettings (dict) --
The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.
Subnets (list) -- [REQUIRED]
Contains a list of subnets that apply for the Active Directory domain.
(string) --
ActiveDirectoryType (string) --
The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
IsSharedActiveDirectory (boolean) --
Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
integer
The maximum number of results to return from a single request.
list
You can use the following filters to streamline results:
Status
Username
Domain
(dict) --
A filter name and value pair that is used to return more specific results from a describe or list operation. You can use 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.
string
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
dict
Response Syntax
{
'ProductUserSummaries': [
{
'Username': 'string',
'Product': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainIpv6List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
'Status': 'string',
'ProductUserArn': 'string',
'StatusMessage': 'string',
'Domain': 'string',
'SubscriptionStartDate': 'string',
'SubscriptionEndDate': 'string',
'LicenseExpirationDate': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProductUserSummaries (list) --
Metadata that describes the list product subscriptions operation.
(dict) --
A summary of the user-based subscription products for a specific user.
Username (string) --
The user name from the identity provider for this product user.
Product (string) --
The name of the user-based subscription product.
IdentityProvider (dict) --
An object that specifies details for the identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
ActiveDirectorySettings (dict) --
The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
DomainName (string) --
The domain name for the Active Directory.
DomainIpv4List (list) --
A list of domain IPv4 addresses that are used for the Active Directory.
(string) --
DomainIpv6List (list) --
A list of domain IPv6 addresses that are used for the Active Directory.
(string) --
DomainCredentialsProvider (dict) --
Points to the CredentialsProvider resource that contains information about the credential provider for user administration.
SecretsManagerCredentialsProvider (dict) --
Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
SecretId (string) --
The ID of the Secrets Manager secret that contains credentials.
DomainNetworkSettings (dict) --
The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.
Subnets (list) --
Contains a list of subnets that apply for the Active Directory domain.
(string) --
ActiveDirectoryType (string) --
The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
IsSharedActiveDirectory (boolean) --
Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
Status (string) --
The status of a product for this user.
ProductUserArn (string) --
The Amazon Resource Name (ARN) for this product user.
StatusMessage (string) --
The status message for a product for this user.
Domain (string) --
The domain name of the Active Directory that contains the user information for the product subscription.
SubscriptionStartDate (string) --
The start date of a subscription.
SubscriptionEndDate (string) --
The end date of a subscription.
LicenseExpirationDate (string) --
The expiration date of the license associated with this subscription, in ISO 8601 UTC format (for example, 2025-03-15T00:00:00Z).
This field applies only to subscriptions that use license server endpoints, such as Remote Desktop Services (RDS) Subscriber Access License (SAL). It returns null for products that don't use license-based subscriptions.
NextToken (string) --
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
{'ProductUserSummary': {'LicenseExpirationDate': 'string'}}
Starts a product subscription for a user with the specified identity provider.
See also: AWS API Documentation
Request Syntax
client.start_product_subscription(
Username='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainIpv6List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
Product='string',
Domain='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The user name from the identity provider of the user.
dict
[REQUIRED]
An object that specifies details for the identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
ActiveDirectorySettings (dict) --
The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
DomainName (string) --
The domain name for the Active Directory.
DomainIpv4List (list) --
A list of domain IPv4 addresses that are used for the Active Directory.
(string) --
DomainIpv6List (list) --
A list of domain IPv6 addresses that are used for the Active Directory.
(string) --
DomainCredentialsProvider (dict) --
Points to the CredentialsProvider resource that contains information about the credential provider for user administration.
SecretsManagerCredentialsProvider (dict) --
Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
SecretId (string) --
The ID of the Secrets Manager secret that contains credentials.
DomainNetworkSettings (dict) --
The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.
Subnets (list) -- [REQUIRED]
Contains a list of subnets that apply for the Active Directory domain.
(string) --
ActiveDirectoryType (string) --
The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
IsSharedActiveDirectory (boolean) --
Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
string
[REQUIRED]
The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | OFFICE_STANDARD | REMOTE_DESKTOP_SERVICES
string
The domain name of the Active Directory that contains the user for whom to start the product subscription.
dict
The tags that apply to the product subscription.
(string) --
(string) --
dict
Response Syntax
{
'ProductUserSummary': {
'Username': 'string',
'Product': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainIpv6List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
'Status': 'string',
'ProductUserArn': 'string',
'StatusMessage': 'string',
'Domain': 'string',
'SubscriptionStartDate': 'string',
'SubscriptionEndDate': 'string',
'LicenseExpirationDate': 'string'
}
}
Response Structure
(dict) --
ProductUserSummary (dict) --
Metadata that describes the start product subscription operation.
Username (string) --
The user name from the identity provider for this product user.
Product (string) --
The name of the user-based subscription product.
IdentityProvider (dict) --
An object that specifies details for the identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
ActiveDirectorySettings (dict) --
The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
DomainName (string) --
The domain name for the Active Directory.
DomainIpv4List (list) --
A list of domain IPv4 addresses that are used for the Active Directory.
(string) --
DomainIpv6List (list) --
A list of domain IPv6 addresses that are used for the Active Directory.
(string) --
DomainCredentialsProvider (dict) --
Points to the CredentialsProvider resource that contains information about the credential provider for user administration.
SecretsManagerCredentialsProvider (dict) --
Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
SecretId (string) --
The ID of the Secrets Manager secret that contains credentials.
DomainNetworkSettings (dict) --
The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.
Subnets (list) --
Contains a list of subnets that apply for the Active Directory domain.
(string) --
ActiveDirectoryType (string) --
The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
IsSharedActiveDirectory (boolean) --
Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
Status (string) --
The status of a product for this user.
ProductUserArn (string) --
The Amazon Resource Name (ARN) for this product user.
StatusMessage (string) --
The status message for a product for this user.
Domain (string) --
The domain name of the Active Directory that contains the user information for the product subscription.
SubscriptionStartDate (string) --
The start date of a subscription.
SubscriptionEndDate (string) --
The end date of a subscription.
LicenseExpirationDate (string) --
The expiration date of the license associated with this subscription, in ISO 8601 UTC format (for example, 2025-03-15T00:00:00Z).
This field applies only to subscriptions that use license server endpoints, such as Remote Desktop Services (RDS) Subscriber Access License (SAL). It returns null for products that don't use license-based subscriptions.
{'ProductUserSummary': {'LicenseExpirationDate': 'string'}}
Stops a product subscription for a user with the specified identity provider.
See also: AWS API Documentation
Request Syntax
client.stop_product_subscription(
Username='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainIpv6List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
Product='string',
ProductUserArn='string',
Domain='string'
)
string
The user name from the identity provider for the user.
dict
An object that specifies details for the identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
ActiveDirectorySettings (dict) --
The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
DomainName (string) --
The domain name for the Active Directory.
DomainIpv4List (list) --
A list of domain IPv4 addresses that are used for the Active Directory.
(string) --
DomainIpv6List (list) --
A list of domain IPv6 addresses that are used for the Active Directory.
(string) --
DomainCredentialsProvider (dict) --
Points to the CredentialsProvider resource that contains information about the credential provider for user administration.
SecretsManagerCredentialsProvider (dict) --
Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
SecretId (string) --
The ID of the Secrets Manager secret that contains credentials.
DomainNetworkSettings (dict) --
The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.
Subnets (list) -- [REQUIRED]
Contains a list of subnets that apply for the Active Directory domain.
(string) --
ActiveDirectoryType (string) --
The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
IsSharedActiveDirectory (boolean) --
Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
string
The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | OFFICE_STANDARD | REMOTE_DESKTOP_SERVICES
string
The Amazon Resource Name (ARN) of the product user.
string
The domain name of the Active Directory that contains the user for whom to stop the product subscription.
dict
Response Syntax
{
'ProductUserSummary': {
'Username': 'string',
'Product': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainIpv6List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
'Status': 'string',
'ProductUserArn': 'string',
'StatusMessage': 'string',
'Domain': 'string',
'SubscriptionStartDate': 'string',
'SubscriptionEndDate': 'string',
'LicenseExpirationDate': 'string'
}
}
Response Structure
(dict) --
ProductUserSummary (dict) --
Metadata that describes the start product subscription operation.
Username (string) --
The user name from the identity provider for this product user.
Product (string) --
The name of the user-based subscription product.
IdentityProvider (dict) --
An object that specifies details for the identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
ActiveDirectorySettings (dict) --
The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
DomainName (string) --
The domain name for the Active Directory.
DomainIpv4List (list) --
A list of domain IPv4 addresses that are used for the Active Directory.
(string) --
DomainIpv6List (list) --
A list of domain IPv6 addresses that are used for the Active Directory.
(string) --
DomainCredentialsProvider (dict) --
Points to the CredentialsProvider resource that contains information about the credential provider for user administration.
SecretsManagerCredentialsProvider (dict) --
Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
SecretId (string) --
The ID of the Secrets Manager secret that contains credentials.
DomainNetworkSettings (dict) --
The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.
Subnets (list) --
Contains a list of subnets that apply for the Active Directory domain.
(string) --
ActiveDirectoryType (string) --
The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
IsSharedActiveDirectory (boolean) --
Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
Status (string) --
The status of a product for this user.
ProductUserArn (string) --
The Amazon Resource Name (ARN) for this product user.
StatusMessage (string) --
The status message for a product for this user.
Domain (string) --
The domain name of the Active Directory that contains the user information for the product subscription.
SubscriptionStartDate (string) --
The start date of a subscription.
SubscriptionEndDate (string) --
The end date of a subscription.
LicenseExpirationDate (string) --
The expiration date of the license associated with this subscription, in ISO 8601 UTC format (for example, 2025-03-15T00:00:00Z).
This field applies only to subscriptions that use license server endpoints, such as Remote Desktop Services (RDS) Subscriber Access License (SAL). It returns null for products that don't use license-based subscriptions.