Table of Contents
LicenseManagerUserSubscriptions.Client¶A low-level client representing AWS License Manager User Subscriptions
With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.
import boto3
client = boto3.client('license-manager-user-subscriptions')
These are the available methods:
associate_user()can_paginate()close()deregister_identity_provider()disassociate_user()get_paginator()get_waiter()list_identity_providers()list_instances()list_product_subscriptions()list_user_associations()register_identity_provider()start_product_subscription()stop_product_subscription()update_identity_provider_settings()associate_user(**kwargs)¶Associates the user to an EC2 instance to utilize user-based subscriptions.
Note
Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide .
See also: AWS API Documentation
Request Syntax
response = client.associate_user(
Domain='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
InstanceId='string',
Username='string'
)
[REQUIRED]
The identity provider of the user.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
[REQUIRED]
The ID of the EC2 instance, which provides user-based subscriptions.
[REQUIRED]
The user name from the identity provider for the user.
dict
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.
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.
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.
Exceptions
LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededExceptionLicenseManagerUserSubscriptions.Client.exceptions.ConflictExceptionLicenseManagerUserSubscriptions.Client.exceptions.ValidationExceptionLicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExceptionLicenseManagerUserSubscriptions.Client.exceptions.InternalServerExceptionLicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundExceptionLicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
deregister_identity_provider(**kwargs)¶Deregisters the identity provider from providing user-based subscriptions.
See also: AWS API Documentation
Request Syntax
response = client.deregister_identity_provider(
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
Product='string'
)
[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.
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
[REQUIRED]
The name of the user-based subscription product.
dict
Response Syntax
{
'IdentityProviderSummary': {
'FailureMessage': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
'Product': 'string',
'Settings': {
'SecurityGroupId': 'string',
'Subnets': [
'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.
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.
Settings (dict) --
An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
SecurityGroupId (string) --
A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
Subnets (list) --
The subnets defined for the registered identity provider.
Status (string) --
The status of an identity provider.
Exceptions
LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededExceptionLicenseManagerUserSubscriptions.Client.exceptions.ConflictExceptionLicenseManagerUserSubscriptions.Client.exceptions.ValidationExceptionLicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExceptionLicenseManagerUserSubscriptions.Client.exceptions.InternalServerExceptionLicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundExceptionLicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedExceptiondisassociate_user(**kwargs)¶Disassociates the user from an EC2 instance providing user-based subscriptions.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_user(
Domain='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
InstanceId='string',
Username='string'
)
[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.
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
[REQUIRED]
The ID of the EC2 instance, which provides user-based subscriptions.
[REQUIRED]
The user name from the identity provider for the user.
dict
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.
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.
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.
Exceptions
LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededExceptionLicenseManagerUserSubscriptions.Client.exceptions.ConflictExceptionLicenseManagerUserSubscriptions.Client.exceptions.ValidationExceptionLicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExceptionLicenseManagerUserSubscriptions.Client.exceptions.InternalServerExceptionLicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundExceptionLicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_identity_providers(**kwargs)¶Lists the identity providers for user-based subscriptions.
See also: AWS API Documentation
Request Syntax
response = client.list_identity_providers(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'IdentityProviderSummaries': [
{
'FailureMessage': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
'Product': 'string',
'Settings': {
'SecurityGroupId': 'string',
'Subnets': [
'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.
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.
Settings (dict) --
An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
SecurityGroupId (string) --
A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
Subnets (list) --
The subnets defined for the registered identity provider.
Status (string) --
The status of an identity provider.
NextToken (string) --
Token for the next set of results.
Exceptions
LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededExceptionLicenseManagerUserSubscriptions.Client.exceptions.ConflictExceptionLicenseManagerUserSubscriptions.Client.exceptions.ValidationExceptionLicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExceptionLicenseManagerUserSubscriptions.Client.exceptions.InternalServerExceptionLicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundExceptionLicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedExceptionlist_instances(**kwargs)¶Lists the EC2 instances providing user-based subscriptions.
See also: AWS API Documentation
Request Syntax
response = client.list_instances(
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
],
MaxResults=123,
NextToken='string'
)
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.
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.
The name of an attribute to use as a filter.
The type of search (For example, eq, geq, leq)
Value of the filter.
dict
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.
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.
Exceptions
LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededExceptionLicenseManagerUserSubscriptions.Client.exceptions.ConflictExceptionLicenseManagerUserSubscriptions.Client.exceptions.ValidationExceptionLicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExceptionLicenseManagerUserSubscriptions.Client.exceptions.InternalServerExceptionLicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundExceptionLicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedExceptionlist_product_subscriptions(**kwargs)¶Lists the user-based subscription products available from an identity provider.
See also: AWS API Documentation
Request Syntax
response = client.list_product_subscriptions(
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
],
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
MaxResults=123,
NextToken='string',
Product='string'
)
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.
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.
The name of an attribute to use as a filter.
The type of search (For example, eq, geq, leq)
Value of the filter.
[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.
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
[REQUIRED]
The name of the user-based subscription product.
dict
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.ServiceQuotaExceededExceptionLicenseManagerUserSubscriptions.Client.exceptions.ConflictExceptionLicenseManagerUserSubscriptions.Client.exceptions.ValidationExceptionLicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExceptionLicenseManagerUserSubscriptions.Client.exceptions.InternalServerExceptionLicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundExceptionLicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedExceptionlist_user_associations(**kwargs)¶Lists user associations for an identity provider.
See also: AWS API Documentation
Request Syntax
response = client.list_user_associations(
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
],
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
InstanceId='string',
MaxResults=123,
NextToken='string'
)
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.
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.
The name of an attribute to use as a filter.
The type of search (For example, eq, geq, leq)
Value of the filter.
[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.
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
[REQUIRED]
The ID of the EC2 instance, which provides user-based subscriptions.
dict
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.
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.
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.
Exceptions
LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededExceptionLicenseManagerUserSubscriptions.Client.exceptions.ConflictExceptionLicenseManagerUserSubscriptions.Client.exceptions.ValidationExceptionLicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExceptionLicenseManagerUserSubscriptions.Client.exceptions.InternalServerExceptionLicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundExceptionLicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedExceptionregister_identity_provider(**kwargs)¶Registers an identity provider for user-based subscriptions.
See also: AWS API Documentation
Request Syntax
response = client.register_identity_provider(
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
Product='string',
Settings={
'SecurityGroupId': 'string',
'Subnets': [
'string',
]
}
)
[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.
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
[REQUIRED]
The name of the user-based subscription product.
The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
The subnets defined for the registered identity provider.
dict
Response Syntax
{
'IdentityProviderSummary': {
'FailureMessage': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
'Product': 'string',
'Settings': {
'SecurityGroupId': 'string',
'Subnets': [
'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.
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.
Settings (dict) --
An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
SecurityGroupId (string) --
A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
Subnets (list) --
The subnets defined for the registered identity provider.
Status (string) --
The status of an identity provider.
Exceptions
LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededExceptionLicenseManagerUserSubscriptions.Client.exceptions.ConflictExceptionLicenseManagerUserSubscriptions.Client.exceptions.ValidationExceptionLicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExceptionLicenseManagerUserSubscriptions.Client.exceptions.InternalServerExceptionLicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundExceptionLicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedExceptionstart_product_subscription(**kwargs)¶Starts a product subscription for a user with the specified identity provider.
Note
Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide .
See also: AWS API Documentation
Request Syntax
response = client.start_product_subscription(
Domain='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
Product='string',
Username='string'
)
[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.
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
[REQUIRED]
The name of the user-based subscription product.
[REQUIRED]
The user name from the identity provider of the user.
dict
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.ServiceQuotaExceededExceptionLicenseManagerUserSubscriptions.Client.exceptions.ConflictExceptionLicenseManagerUserSubscriptions.Client.exceptions.ValidationExceptionLicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExceptionLicenseManagerUserSubscriptions.Client.exceptions.InternalServerExceptionLicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundExceptionLicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedExceptionstop_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'
)
[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.
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
[REQUIRED]
The name of the user-based subscription product.
[REQUIRED]
The user name from the identity provider for the user.
dict
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.ServiceQuotaExceededExceptionLicenseManagerUserSubscriptions.Client.exceptions.ConflictExceptionLicenseManagerUserSubscriptions.Client.exceptions.ValidationExceptionLicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExceptionLicenseManagerUserSubscriptions.Client.exceptions.InternalServerExceptionLicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundExceptionLicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedExceptionupdate_identity_provider_settings(**kwargs)¶Updates additional product configuration settings for the registered identity provider.
See also: AWS API Documentation
Request Syntax
response = client.update_identity_provider_settings(
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
Product='string',
UpdateSettings={
'AddSubnets': [
'string',
],
'RemoveSubnets': [
'string',
],
'SecurityGroupId': 'string'
}
)
[REQUIRED]
Details about an identity provider.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
[REQUIRED]
The name of the user-based subscription product.
[REQUIRED]
Updates the registered identity provider’s product related configuration settings. You can update any combination of settings in a single operation such as the:
The ID of one or more subnets in which License Manager will create a VPC endpoint for products that require connectivity to activation servers.
The ID of one or more subnets to remove.
A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoints for activation servers.
dict
Response Syntax
{
'IdentityProviderSummary': {
'FailureMessage': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
'Product': 'string',
'Settings': {
'SecurityGroupId': 'string',
'Subnets': [
'string',
]
},
'Status': 'string'
}
}
Response Structure
(dict) --
IdentityProviderSummary (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.
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.
Settings (dict) --
An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
SecurityGroupId (string) --
A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
Subnets (list) --
The subnets defined for the registered identity provider.
Status (string) --
The status of an identity provider.
Exceptions
LicenseManagerUserSubscriptions.Client.exceptions.ValidationExceptionLicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExceptionLicenseManagerUserSubscriptions.Client.exceptions.InternalServerExceptionLicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedExceptionThe available paginators are:
LicenseManagerUserSubscriptions.Paginator.ListIdentityProvidersLicenseManagerUserSubscriptions.Paginator.ListInstancesLicenseManagerUserSubscriptions.Paginator.ListProductSubscriptionsLicenseManagerUserSubscriptions.Paginator.ListUserAssociationsLicenseManagerUserSubscriptions.Paginator.ListIdentityProviders¶paginator = client.get_paginator('list_identity_providers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LicenseManagerUserSubscriptions.Client.list_identity_providers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'IdentityProviderSummaries': [
{
'FailureMessage': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
'Product': 'string',
'Settings': {
'SecurityGroupId': 'string',
'Subnets': [
'string',
]
},
'Status': 'string'
},
],
}
Response Structure
Metadata that describes the list identity providers operation.
Describes an identity provider.
The failure message associated with an identity provider.
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'}
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
The name of the user-based subscription product.
An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
The subnets defined for the registered identity provider.
The status of an identity provider.
LicenseManagerUserSubscriptions.Paginator.ListInstances¶paginator = client.get_paginator('list_instances')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LicenseManagerUserSubscriptions.Client.list_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
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.
The name of an attribute to use as a filter.
The type of search (For example, eq, geq, leq)
Value of the filter.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'InstanceSummaries': [
{
'InstanceId': 'string',
'LastStatusCheckDate': 'string',
'Products': [
'string',
],
'Status': 'string',
'StatusMessage': '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.
Status (string) --
The status of an EC2 instance resource.
StatusMessage (string) --
The status message for an EC2 instance.
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'
}
)
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.
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.
The name of an attribute to use as a filter.
The type of search (For example, eq, geq, leq)
Value of the filter.
[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.
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
[REQUIRED]
The name of the user-based subscription product.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.
LicenseManagerUserSubscriptions.Paginator.ListUserAssociations¶paginator = client.get_paginator('list_user_associations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LicenseManagerUserSubscriptions.Client.list_user_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
],
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
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.
The name of an attribute to use as a filter.
The type of search (For example, eq, geq, leq)
Value of the filter.
[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.
An object that details an Active Directory identity provider.
The directory ID for an Active Directory identity provider.
[REQUIRED]
The ID of the EC2 instance, which provides user-based subscriptions.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'InstanceUserSummaries': [
{
'AssociationDate': 'string',
'DisassociationDate': 'string',
'Domain': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string'
}
},
'InstanceId': 'string',
'Status': 'string',
'StatusMessage': 'string',
'Username': '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.
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.
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.