2025/09/19 - AWS License Manager User Subscriptions - 11 updated api methods
Changes Added support for cross-account Active Directories.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}
Response {'InstanceUserSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}}
Associates the user to an EC2 instance to utilize user-based subscriptions.
See also: AWS API Documentation
Request Syntax
client.associate_user(
Username='string',
InstanceId='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
Domain='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The user name from the identity provider.
string
[REQUIRED]
The ID of the EC2 instance that provides the user-based subscription.
dict
[REQUIRED]
The identity provider for the user.
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) --
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 domain name of the Active Directory that contains information for the user to associate.
dict
The tags that apply for the user association.
(string) --
(string) --
dict
Response Syntax
{
'InstanceUserSummary': {
'Username': 'string',
'InstanceId': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
'Status': 'string',
'InstanceUserArn': 'string',
'StatusMessage': 'string',
'Domain': 'string',
'AssociationDate': 'string',
'DisassociationDate': 'string'
}
}
Response Structure
(dict) --
InstanceUserSummary (dict) --
Metadata that describes the associate user operation.
Username (string) --
The user name from the identity provider for the user.
InstanceId (string) --
The ID of the EC2 instance that provides user-based subscriptions.
IdentityProvider (dict) --
The IdentityProvider resource specifies details about 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) --
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 user associated with an EC2 instance.
InstanceUserArn (string) --
The Amazon Resource Name (ARN) that identifies the instance user.
StatusMessage (string) --
The status message for users of an EC2 instance.
Domain (string) --
The domain name of the Active Directory that contains the user information for the product subscription.
AssociationDate (string) --
The date a user was associated with an EC2 instance.
DisassociationDate (string) --
The date a user was disassociated from an EC2 instance.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}
Response {'IdentityProviderSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}},
'OwnerAccountId': 'string'}}
Deregisters the Active Directory identity provider from License Manager user-based subscriptions.
See also: AWS API Documentation
Request Syntax
client.deregister_identity_provider(
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
Product='string',
IdentityProviderArn='string'
)
dict
An object that specifies details for the Active Directory 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) --
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 | REMOTE_DESKTOP_SERVICES
string
The Amazon Resource Name (ARN) that identifies the identity provider to deregister.
dict
Response Syntax
{
'IdentityProviderSummary': {
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
'Settings': {
'Subnets': [
'string',
],
'SecurityGroupId': 'string'
},
'Product': 'string',
'Status': 'string',
'IdentityProviderArn': 'string',
'FailureMessage': 'string',
'OwnerAccountId': 'string'
}
}
Response Structure
(dict) --
IdentityProviderSummary (dict) --
Metadata that describes the results of an identity provider operation.
IdentityProvider (dict) --
The IdentityProvider resource contains information about an 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) --
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.
Settings (dict) --
The Settings resource contains details about the registered identity provider’s product related configuration settings, such as the subnets to provision VPC endpoints.
Subnets (list) --
The subnets defined for the registered identity provider.
(string) --
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.
Product (string) --
The name of the user-based subscription product.
Status (string) --
The status of the identity provider.
IdentityProviderArn (string) --
The Amazon Resource Name (ARN) of the identity provider.
FailureMessage (string) --
The failure message associated with an identity provider.
OwnerAccountId (string) --
The AWS Account ID of the owner of this resource.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}
Response {'InstanceUserSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}}
Disassociates the user from an EC2 instance providing user-based subscriptions.
See also: AWS API Documentation
Request Syntax
client.disassociate_user(
Username='string',
InstanceId='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
InstanceUserArn='string',
Domain='string'
)
string
The user name from the Active Directory identity provider for the user.
string
The ID of the EC2 instance which provides user-based subscriptions.
dict
An object that specifies details for the Active Directory 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) --
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 Amazon Resource Name (ARN) of the user to disassociate from the EC2 instance.
string
The domain name of the Active Directory that contains information for the user to disassociate.
dict
Response Syntax
{
'InstanceUserSummary': {
'Username': 'string',
'InstanceId': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
'Status': 'string',
'InstanceUserArn': 'string',
'StatusMessage': 'string',
'Domain': 'string',
'AssociationDate': 'string',
'DisassociationDate': 'string'
}
}
Response Structure
(dict) --
InstanceUserSummary (dict) --
Metadata that describes the associate user operation.
Username (string) --
The user name from the identity provider for the user.
InstanceId (string) --
The ID of the EC2 instance that provides user-based subscriptions.
IdentityProvider (dict) --
The IdentityProvider resource specifies details about 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) --
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 user associated with an EC2 instance.
InstanceUserArn (string) --
The Amazon Resource Name (ARN) that identifies the instance user.
StatusMessage (string) --
The status message for users of an EC2 instance.
Domain (string) --
The domain name of the Active Directory that contains the user information for the product subscription.
AssociationDate (string) --
The date a user was associated with an EC2 instance.
DisassociationDate (string) --
The date a user was disassociated from an EC2 instance.
{'IdentityProviderSummaries': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}},
'OwnerAccountId': 'string'}}
Lists the Active Directory identity providers for user-based subscriptions.
See also: AWS API Documentation
Request Syntax
client.list_identity_providers(
MaxResults=123,
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
],
NextToken='string'
)
integer
The maximum number of results to return from a single request.
list
You can use the following filters to streamline results:
Product
DirectoryId
(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
{
'IdentityProviderSummaries': [
{
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
'Settings': {
'Subnets': [
'string',
],
'SecurityGroupId': 'string'
},
'Product': 'string',
'Status': 'string',
'IdentityProviderArn': 'string',
'FailureMessage': 'string',
'OwnerAccountId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IdentityProviderSummaries (list) --
An array of IdentityProviderSummary resources that contain details about the Active Directory identity providers that meet the request criteria.
(dict) --
Describes an identity provider.
IdentityProvider (dict) --
The IdentityProvider resource contains information about an 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) --
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.
Settings (dict) --
The Settings resource contains details about the registered identity provider’s product related configuration settings, such as the subnets to provision VPC endpoints.
Subnets (list) --
The subnets defined for the registered identity provider.
(string) --
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.
Product (string) --
The name of the user-based subscription product.
Status (string) --
The status of the identity provider.
IdentityProviderArn (string) --
The Amazon Resource Name (ARN) of the identity provider.
FailureMessage (string) --
The failure message associated with an identity provider.
OwnerAccountId (string) --
The AWS Account ID of the owner of this resource.
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.
{'InstanceSummaries': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED',
'DirectoryId': 'string',
'IsSharedActiveDirectory': 'boolean'}},
'OwnerAccountId': 'string'}}
Lists the EC2 instances providing user-based subscriptions.
See also: AWS API Documentation
Request Syntax
client.list_instances(
MaxResults=123,
NextToken='string',
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
]
)
integer
The maximum number of results to return from a single request.
string
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
list
You can use the following filters to streamline results:
Status
InstanceId
(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.
dict
Response Syntax
{
'InstanceSummaries': [
{
'InstanceId': 'string',
'Status': 'string',
'Products': [
'string',
],
'LastStatusCheckDate': 'string',
'StatusMessage': 'string',
'OwnerAccountId': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceSummaries (list) --
An array of InstanceSummary resources that contain details about the instances that provide user-based subscriptions and also meet the request criteria.
(dict) --
Describes an EC2 instance providing user-based subscriptions.
InstanceId (string) --
The ID of the EC2 instance, which provides user-based subscriptions.
Status (string) --
The status of an EC2 instance resource.
Products (list) --
A list of provided user-based subscription products.
(string) --
LastStatusCheckDate (string) --
The date of the last status check.
StatusMessage (string) --
The status message for an EC2 instance.
OwnerAccountId (string) --
The AWS Account ID of the owner of this resource.
IdentityProvider (dict) --
The IdentityProvider resource specifies details about 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) --
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.
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}
Response {'ProductUserSummaries': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}}
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',
],
'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 | 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) --
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',
],
'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'
},
],
'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) --
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.
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}
Response {'InstanceUserSummaries': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}}
Lists user associations for an identity provider.
See also: AWS API Documentation
Request Syntax
client.list_user_associations(
InstanceId='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'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
[REQUIRED]
The ID of the EC2 instance, which provides user-based subscriptions.
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) --
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
{
'InstanceUserSummaries': [
{
'Username': 'string',
'InstanceId': 'string',
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
'Status': 'string',
'InstanceUserArn': 'string',
'StatusMessage': 'string',
'Domain': 'string',
'AssociationDate': 'string',
'DisassociationDate': '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.
Username (string) --
The user name from the identity provider for the user.
InstanceId (string) --
The ID of the EC2 instance that provides user-based subscriptions.
IdentityProvider (dict) --
The IdentityProvider resource specifies details about 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) --
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 user associated with an EC2 instance.
InstanceUserArn (string) --
The Amazon Resource Name (ARN) that identifies the instance user.
StatusMessage (string) --
The status message for users of an EC2 instance.
Domain (string) --
The domain name of the Active Directory that contains the user information for the product subscription.
AssociationDate (string) --
The date a user was associated with an EC2 instance.
DisassociationDate (string) --
The date a user was disassociated from an EC2 instance.
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}
Response {'IdentityProviderSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}},
'OwnerAccountId': 'string'}}
Registers an identity provider for user-based subscriptions.
See also: AWS API Documentation
Request Syntax
client.register_identity_provider(
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
Product='string',
Settings={
'Subnets': [
'string',
],
'SecurityGroupId': 'string'
},
Tags={
'string': 'string'
}
)
dict
[REQUIRED]
An object that specifies details for the identity provider to register.
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) --
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 | REMOTE_DESKTOP_SERVICES
dict
The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
Subnets (list) -- [REQUIRED]
The subnets defined for the registered identity provider.
(string) --
SecurityGroupId (string) -- [REQUIRED]
A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
dict
The tags that apply to the identity provider's registration.
(string) --
(string) --
dict
Response Syntax
{
'IdentityProviderSummary': {
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
'Settings': {
'Subnets': [
'string',
],
'SecurityGroupId': 'string'
},
'Product': 'string',
'Status': 'string',
'IdentityProviderArn': 'string',
'FailureMessage': 'string',
'OwnerAccountId': 'string'
}
}
Response Structure
(dict) --
IdentityProviderSummary (dict) --
Metadata that describes the results of an identity provider operation.
IdentityProvider (dict) --
The IdentityProvider resource contains information about an 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) --
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.
Settings (dict) --
The Settings resource contains details about the registered identity provider’s product related configuration settings, such as the subnets to provision VPC endpoints.
Subnets (list) --
The subnets defined for the registered identity provider.
(string) --
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.
Product (string) --
The name of the user-based subscription product.
Status (string) --
The status of the identity provider.
IdentityProviderArn (string) --
The Amazon Resource Name (ARN) of the identity provider.
FailureMessage (string) --
The failure message associated with an identity provider.
OwnerAccountId (string) --
The AWS Account ID of the owner of this resource.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}
Response {'ProductUserSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}}
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',
],
'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) --
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 | 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',
],
'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'
}
}
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) --
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}
Response {'ProductUserSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}}
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',
],
'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) --
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 | 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',
],
'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'
}
}
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) --
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}}}
Response {'IdentityProviderSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'IsSharedActiveDirectory': 'boolean'}},
'OwnerAccountId': 'string'}}
Updates additional product configuration settings for the registered identity provider.
See also: AWS API Documentation
Request Syntax
client.update_identity_provider_settings(
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
Product='string',
IdentityProviderArn='string',
UpdateSettings={
'AddSubnets': [
'string',
],
'RemoveSubnets': [
'string',
],
'SecurityGroupId': 'string'
}
)
dict
Refers to an 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) --
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 | REMOTE_DESKTOP_SERVICES
string
The Amazon Resource Name (ARN) of the identity provider to update.
dict
[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:
Subnets which you want to add to provision VPC endpoints.
Subnets which you want to remove the VPC endpoints from.
Security group ID which permits traffic to the VPC endpoints.
AddSubnets (list) -- [REQUIRED]
The ID of one or more subnets in which License Manager will create a VPC endpoint for products that require connectivity to activation servers.
(string) --
RemoveSubnets (list) -- [REQUIRED]
The ID of one or more subnets to remove.
(string) --
SecurityGroupId (string) --
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': {
'IdentityProvider': {
'ActiveDirectoryIdentityProvider': {
'DirectoryId': 'string',
'ActiveDirectorySettings': {
'DomainName': 'string',
'DomainIpv4List': [
'string',
],
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'IsSharedActiveDirectory': True|False
}
},
'Settings': {
'Subnets': [
'string',
],
'SecurityGroupId': 'string'
},
'Product': 'string',
'Status': 'string',
'IdentityProviderArn': 'string',
'FailureMessage': 'string',
'OwnerAccountId': 'string'
}
}
Response Structure
(dict) --
IdentityProviderSummary (dict) --
Describes an identity provider.
IdentityProvider (dict) --
The IdentityProvider resource contains information about an 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) --
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.
Settings (dict) --
The Settings resource contains details about the registered identity provider’s product related configuration settings, such as the subnets to provision VPC endpoints.
Subnets (list) --
The subnets defined for the registered identity provider.
(string) --
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.
Product (string) --
The name of the user-based subscription product.
Status (string) --
The status of the identity provider.
IdentityProviderArn (string) --
The Amazon Resource Name (ARN) of the identity provider.
FailureMessage (string) --
The failure message associated with an identity provider.
OwnerAccountId (string) --
The AWS Account ID of the owner of this resource.