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.
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'
)
list
An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.
(dict) --
A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
Attribute (string) --
The name of an attribute to use as a filter.
Operation (string) --
The type of search (For example, eq, geq, leq)
Value (string) --
Value of the filter.
integer
Maximum number of results to return in a single call.
string
Token for the next set of results.
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.
(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.
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'
)
list
An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.
(dict) --
A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
Attribute (string) --
The name of an attribute to use as a filter.
Operation (string) --
The type of search (For example, eq, geq, leq)
Value (string) --
Value of the filter.
dict
[REQUIRED]
An object that specifies details for the identity provider.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.
ActiveDirectoryIdentityProvider (dict) --
An object that details an Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
integer
Maximum number of results to return in a single call.
string
Token for the next set of results.
string
[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.
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'
)
string
The domain name of the user.
dict
[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.
ActiveDirectoryIdentityProvider (dict) --
An object that details an Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
string
[REQUIRED]
The ID of the EC2 instance, which provides user-based subscriptions.
string
[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.
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'
)
dict
[REQUIRED]
An object that specifies details for the identity provider.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.
ActiveDirectoryIdentityProvider (dict) --
An object that details an Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
string
[REQUIRED]
The name of the user-based subscription product.
dict
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.
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 an identity provider.
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'
)
list
An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.
(dict) --
A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
Attribute (string) --
The name of an attribute to use as a filter.
Operation (string) --
The type of search (For example, eq, geq, leq)
Value (string) --
Value of the filter.
dict
[REQUIRED]
An object that specifies details for the identity provider.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.
ActiveDirectoryIdentityProvider (dict) --
An object that details an Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
string
[REQUIRED]
The ID of the EC2 instance, which provides user-based subscriptions.
integer
Maximum number of results to return in a single call.
string
Token for the next set of results.
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.
Lists the identity providers for user-based subscriptions.
See also: AWS API Documentation
Request Syntax
client.list_identity_providers(
MaxResults=123,
NextToken='string'
)
integer
Maximum number of results to return in a single call.
string
Token for the next set of results.
dict
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.
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 an identity provider.
NextToken (string) --
Token for the next set of results.
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'
)
string
The domain name of the user.
dict
[REQUIRED]
An object that specifies details for the identity provider.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.
ActiveDirectoryIdentityProvider (dict) --
An object that details an Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
string
[REQUIRED]
The name of the user-based subscription product.
string
[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.
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'
)
dict
[REQUIRED]
An object that specifies details for the identity provider.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.
ActiveDirectoryIdentityProvider (dict) --
An object that details an Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
string
[REQUIRED]
The name of the user-based subscription product.
dict
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.
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 an identity provider.
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'
)
string
The domain name of the user.
dict
[REQUIRED]
An object that specifies details for the identity provider.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.
ActiveDirectoryIdentityProvider (dict) --
An object that details an Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
string
[REQUIRED]
The ID of the EC2 instance, which provides user-based subscriptions.
string
[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.
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'
)
string
The domain name of the user.
dict
[REQUIRED]
An object that specifies details for the identity provider.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.
ActiveDirectoryIdentityProvider (dict) --
An object that details an Active Directory identity provider.
DirectoryId (string) --
The directory ID for an Active Directory identity provider.
string
[REQUIRED]
The name of the user-based subscription product.
string
[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.