LicenseManagerUserSubscriptions ******************************* Client ====== class 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 * create_license_server_endpoint * delete_license_server_endpoint * deregister_identity_provider * disassociate_user * get_paginator * get_waiter * list_identity_providers * list_instances * list_license_server_endpoints * list_product_subscriptions * list_tags_for_resource * list_user_associations * register_identity_provider * start_product_subscription * stop_product_subscription * tag_resource * untag_resource * update_identity_provider_settings Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListIdentityProviders * ListInstances * ListLicenseServerEndpoints * ListProductSubscriptions * ListUserAssociations LicenseManagerUserSubscriptions / Paginator / ListInstances ListInstances ************* class 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' } ) Parameters: * **Filters** (*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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InstanceSummaries': [ { 'InstanceId': 'string', 'LastStatusCheckDate': 'string', 'Products': [ 'string', ], 'Status': 'string', 'StatusMessage': '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. * **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. LicenseManagerUserSubscriptions / Paginator / ListIdentityProviders ListIdentityProviders ********************* class LicenseManagerUserSubscriptions.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( Filters=[ { 'Attribute': 'string', 'Operation': 'string', 'Value': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IdentityProviderSummaries': [ { 'FailureMessage': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'IdentityProviderArn': 'string', 'Product': 'string', 'Settings': { 'SecurityGroupId': 'string', 'Subnets': [ 'string', ] }, 'Status': '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. * **FailureMessage** *(string) --* The failure message associated with an identity provider. * **IdentityProvider** *(dict) --* The "IdentityProvider" resource contains information about an 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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **IdentityProviderArn** *(string) --* The Amazon Resource Name (ARN) of the identity provider. * **Product** *(string) --* The name of the user-based subscription product. * **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. * **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. * *(string) --* * **Status** *(string) --* The status of the identity provider. LicenseManagerUserSubscriptions / Paginator / ListUserAssociations ListUserAssociations ******************** class 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': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, InstanceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*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. * **IdentityProvider** (*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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the EC2 instance, which provides user-based subscriptions. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InstanceUserSummaries': [ { 'AssociationDate': 'string', 'DisassociationDate': 'string', 'Domain': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'InstanceId': 'string', 'InstanceUserArn': '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 Active Directory that contains the user information for the product subscription. * **IdentityProvider** *(dict) --* The "IdentityProvider" resource specifies details about 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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **InstanceId** *(string) --* The ID of the EC2 instance that provides user-based subscriptions. * **InstanceUserArn** *(string) --* The Amazon Resource Name (ARN) that identifies the instance user. * **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. LicenseManagerUserSubscriptions / Paginator / ListLicenseServerEndpoints ListLicenseServerEndpoints ************************** class LicenseManagerUserSubscriptions.Paginator.ListLicenseServerEndpoints paginator = client.get_paginator('list_license_server_endpoints') paginate(**kwargs) Creates an iterator that will paginate through responses from " LicenseManagerUserSubscriptions.Client.list_license_server_endp oints()". 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' } ) Parameters: * **Filters** (*list*) -- You can use the following filters to streamline results: * IdentityProviderArn * *(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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LicenseServerEndpoints': [ { 'CreationTime': datetime(2015, 1, 1), 'IdentityProviderArn': 'string', 'LicenseServerEndpointArn': 'string', 'LicenseServerEndpointId': 'string', 'LicenseServerEndpointProvisioningStatus': 'PROVISIONING'|'PROVISIONING_FAILED'|'PROVISIONED'|'DELETING'|'DELETION_FAILED'|'DELETED', 'LicenseServers': [ { 'HealthStatus': 'HEALTHY'|'UNHEALTHY'|'NOT_APPLICABLE', 'Ipv4Address': 'string', 'ProvisioningStatus': 'PROVISIONING'|'PROVISIONING_FAILED'|'PROVISIONED'|'DELETING'|'DELETION_FAILED'|'DELETED' }, ], 'ServerEndpoint': { 'Endpoint': 'string' }, 'ServerType': 'RDS_SAL', 'StatusMessage': 'string' }, ], } **Response Structure** * *(dict) --* * **LicenseServerEndpoints** *(list) --* An array of "LicenseServerEndpoint" resources that contain detailed information about the RDS License Servers that meet the request criteria. * *(dict) --* Contains details about a network endpoint for a Remote Desktop Services (RDS) license server. * **CreationTime** *(datetime) --* The timestamp when License Manager created the license server endpoint. * **IdentityProviderArn** *(string) --* The Amazon Resource Name (ARN) of the identity provider that's associated with the RDS license server endpoint. * **LicenseServerEndpointArn** *(string) --* The ARN of the "ServerEndpoint" resource for the RDS license server. * **LicenseServerEndpointId** *(string) --* The ID of the license server endpoint. * **LicenseServerEndpointProvisioningStatus** *(string) --* The current state of the provisioning process for the RDS license server endpoint * **LicenseServers** *(list) --* An array of "LicenseServer" resources that represent the license servers that are accessed through this endpoint. * *(dict) --* Information about a Remote Desktop Services (RDS) license server. * **HealthStatus** *(string) --* The health status of the RDS license server. * **Ipv4Address** *(string) --* A list of domain IPv4 addresses that are used for the RDS license server. * **ProvisioningStatus** *(string) --* The current state of the provisioning process for the RDS license server. * **ServerEndpoint** *(dict) --* The "ServerEndpoint" resource contains the network address of the RDS license server endpoint. * **Endpoint** *(string) --* The network address of the endpoint. * **ServerType** *(string) --* The type of license server. * **StatusMessage** *(string) --* The message associated with the provisioning status, if there is one. LicenseManagerUserSubscriptions / Paginator / ListProductSubscriptions ListProductSubscriptions ************************ class 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_subscriptio ns()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters=[ { 'Attribute': 'string', 'Operation': 'string', 'Value': 'string' }, ], IdentityProvider={ 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, Product='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*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. * **IdentityProvider** (*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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **Product** (*string*) -- The name of the user-based subscription product. Valid values: "VISUAL_STUDIO_ENTERPRISE" | "VISUAL_STUDIO_PROFESSIONAL" | "OFFICE_PROFESSIONAL_PLUS" | "REMOTE_DESKTOP_SERVICES" * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ProductUserSummaries': [ { 'Domain': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'Product': 'string', 'ProductUserArn': '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) --* A summary of the user-based subscription products for a specific user. * **Domain** *(string) --* The domain name of the Active Directory that contains the user information for the product subscription. * **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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **Product** *(string) --* The name of the user-based subscription product. * **ProductUserArn** *(string) --* The Amazon Resource Name (ARN) for this product user. * **Status** *(string) --* The status of a product for this user. * **StatusMessage** *(string) --* The status message for a product for this 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 for this product user. LicenseManagerUserSubscriptions / Client / list_license_server_endpoints list_license_server_endpoints ***************************** LicenseManagerUserSubscriptions.Client.list_license_server_endpoints(**kwargs) List the Remote Desktop Services (RDS) License Server endpoints See also: AWS API Documentation **Request Syntax** response = client.list_license_server_endpoints( Filters=[ { 'Attribute': 'string', 'Operation': 'string', 'Value': 'string' }, ], MaxResults=123, NextToken='string' ) Parameters: * **Filters** (*list*) -- You can use the following filters to streamline results: * IdentityProviderArn * *(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. * **MaxResults** (*integer*) -- The maximum number of results to return from a single request. * **NextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'LicenseServerEndpoints': [ { 'CreationTime': datetime(2015, 1, 1), 'IdentityProviderArn': 'string', 'LicenseServerEndpointArn': 'string', 'LicenseServerEndpointId': 'string', 'LicenseServerEndpointProvisioningStatus': 'PROVISIONING'|'PROVISIONING_FAILED'|'PROVISIONED'|'DELETING'|'DELETION_FAILED'|'DELETED', 'LicenseServers': [ { 'HealthStatus': 'HEALTHY'|'UNHEALTHY'|'NOT_APPLICABLE', 'Ipv4Address': 'string', 'ProvisioningStatus': 'PROVISIONING'|'PROVISIONING_FAILED'|'PROVISIONED'|'DELETING'|'DELETION_FAILED'|'DELETED' }, ], 'ServerEndpoint': { 'Endpoint': 'string' }, 'ServerType': 'RDS_SAL', 'StatusMessage': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **LicenseServerEndpoints** *(list) --* An array of "LicenseServerEndpoint" resources that contain detailed information about the RDS License Servers that meet the request criteria. * *(dict) --* Contains details about a network endpoint for a Remote Desktop Services (RDS) license server. * **CreationTime** *(datetime) --* The timestamp when License Manager created the license server endpoint. * **IdentityProviderArn** *(string) --* The Amazon Resource Name (ARN) of the identity provider that's associated with the RDS license server endpoint. * **LicenseServerEndpointArn** *(string) --* The ARN of the "ServerEndpoint" resource for the RDS license server. * **LicenseServerEndpointId** *(string) --* The ID of the license server endpoint. * **LicenseServerEndpointProvisioningStatus** *(string) --* The current state of the provisioning process for the RDS license server endpoint * **LicenseServers** *(list) --* An array of "LicenseServer" resources that represent the license servers that are accessed through this endpoint. * *(dict) --* Information about a Remote Desktop Services (RDS) license server. * **HealthStatus** *(string) --* The health status of the RDS license server. * **Ipv4Address** *(string) --* A list of domain IPv4 addresses that are used for the RDS license server. * **ProvisioningStatus** *(string) --* The current state of the provisioning process for the RDS license server. * **ServerEndpoint** *(dict) --* The "ServerEndpoint" resource contains the network address of the RDS license server endpoint. * **Endpoint** *(string) --* The network address of the endpoint. * **ServerType** *(string) --* The type of license server. * **StatusMessage** *(string) --* The message associated with the provisioning status, if there is one. * **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. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / get_paginator get_paginator ************* LicenseManagerUserSubscriptions.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. LicenseManagerUserSubscriptions / Client / list_product_subscriptions list_product_subscriptions ************************** LicenseManagerUserSubscriptions.Client.list_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': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, MaxResults=123, NextToken='string', Product='string' ) Parameters: * **Filters** (*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. * **IdentityProvider** (*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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **MaxResults** (*integer*) -- The maximum number of results to return from a single request. * **NextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. * **Product** (*string*) -- The name of the user-based subscription product. Valid values: "VISUAL_STUDIO_ENTERPRISE" | "VISUAL_STUDIO_PROFESSIONAL" | "OFFICE_PROFESSIONAL_PLUS" | "REMOTE_DESKTOP_SERVICES" Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'ProductUserSummaries': [ { 'Domain': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'Product': 'string', 'ProductUserArn': 'string', 'Status': 'string', 'StatusMessage': 'string', 'SubscriptionEndDate': 'string', 'SubscriptionStartDate': 'string', 'Username': 'string' }, ] } **Response Structure** * *(dict) --* * **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. * **ProductUserSummaries** *(list) --* Metadata that describes the list product subscriptions operation. * *(dict) --* A summary of the user-based subscription products for a specific user. * **Domain** *(string) --* The domain name of the Active Directory that contains the user information for the product subscription. * **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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **Product** *(string) --* The name of the user-based subscription product. * **ProductUserArn** *(string) --* The Amazon Resource Name (ARN) for this product user. * **Status** *(string) --* The status of a product for this user. * **StatusMessage** *(string) --* The status message for a product for this 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 for this product user. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / can_paginate can_paginate ************ LicenseManagerUserSubscriptions.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. LicenseManagerUserSubscriptions / Client / list_user_associations list_user_associations ********************** LicenseManagerUserSubscriptions.Client.list_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': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, InstanceId='string', MaxResults=123, NextToken='string' ) Parameters: * **Filters** (*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. * **IdentityProvider** (*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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the EC2 instance, which provides user-based subscriptions. * **MaxResults** (*integer*) -- The maximum number of results to return from a single request. * **NextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'InstanceUserSummaries': [ { 'AssociationDate': 'string', 'DisassociationDate': 'string', 'Domain': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'InstanceId': 'string', 'InstanceUserArn': '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 Active Directory that contains the user information for the product subscription. * **IdentityProvider** *(dict) --* The "IdentityProvider" resource specifies details about 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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **InstanceId** *(string) --* The ID of the EC2 instance that provides user-based subscriptions. * **InstanceUserArn** *(string) --* The Amazon Resource Name (ARN) that identifies the instance user. * **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) --* 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. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / delete_license_server_endpoint delete_license_server_endpoint ****************************** LicenseManagerUserSubscriptions.Client.delete_license_server_endpoint(**kwargs) Deletes a "LicenseServerEndpoint" resource. See also: AWS API Documentation **Request Syntax** response = client.delete_license_server_endpoint( LicenseServerEndpointArn='string', ServerType='RDS_SAL' ) Parameters: * **LicenseServerEndpointArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that identifies the "LicenseServerEndpoint" resource to delete. * **ServerType** (*string*) -- **[REQUIRED]** The type of License Server that the delete request refers to. Return type: dict Returns: **Response Syntax** { 'LicenseServerEndpoint': { 'CreationTime': datetime(2015, 1, 1), 'IdentityProviderArn': 'string', 'LicenseServerEndpointArn': 'string', 'LicenseServerEndpointId': 'string', 'LicenseServerEndpointProvisioningStatus': 'PROVISIONING'|'PROVISIONING_FAILED'|'PROVISIONED'|'DELETING'|'DELETION_FAILED'|'DELETED', 'LicenseServers': [ { 'HealthStatus': 'HEALTHY'|'UNHEALTHY'|'NOT_APPLICABLE', 'Ipv4Address': 'string', 'ProvisioningStatus': 'PROVISIONING'|'PROVISIONING_FAILED'|'PROVISIONED'|'DELETING'|'DELETION_FAILED'|'DELETED' }, ], 'ServerEndpoint': { 'Endpoint': 'string' }, 'ServerType': 'RDS_SAL', 'StatusMessage': 'string' } } **Response Structure** * *(dict) --* * **LicenseServerEndpoint** *(dict) --* Shows details from the "LicenseServerEndpoint" resource that was deleted. * **CreationTime** *(datetime) --* The timestamp when License Manager created the license server endpoint. * **IdentityProviderArn** *(string) --* The Amazon Resource Name (ARN) of the identity provider that's associated with the RDS license server endpoint. * **LicenseServerEndpointArn** *(string) --* The ARN of the "ServerEndpoint" resource for the RDS license server. * **LicenseServerEndpointId** *(string) --* The ID of the license server endpoint. * **LicenseServerEndpointProvisioningStatus** *(string) --* The current state of the provisioning process for the RDS license server endpoint * **LicenseServers** *(list) --* An array of "LicenseServer" resources that represent the license servers that are accessed through this endpoint. * *(dict) --* Information about a Remote Desktop Services (RDS) license server. * **HealthStatus** *(string) --* The health status of the RDS license server. * **Ipv4Address** *(string) --* A list of domain IPv4 addresses that are used for the RDS license server. * **ProvisioningStatus** *(string) --* The current state of the provisioning process for the RDS license server. * **ServerEndpoint** *(dict) --* The "ServerEndpoint" resource contains the network address of the RDS license server endpoint. * **Endpoint** *(string) --* The network address of the endpoint. * **ServerType** *(string) --* The type of license server. * **StatusMessage** *(string) --* The message associated with the provisioning status, if there is one. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / associate_user associate_user ************** LicenseManagerUserSubscriptions.Client.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': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, InstanceId='string', Tags={ 'string': 'string' }, Username='string' ) Parameters: * **Domain** (*string*) -- The domain name of the Active Directory that contains information for the user to associate. * **IdentityProvider** (*dict*) -- **[REQUIRED]** The identity provider for the user. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "ActiveDirectoryIdentityProvider". * **ActiveDirectoryIdentityProvider** *(dict) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the EC2 instance that provides the user-based subscription. * **Tags** (*dict*) -- The tags that apply for the user association. * *(string) --* * *(string) --* * **Username** (*string*) -- **[REQUIRED]** The user name from the identity provider. Return type: dict Returns: **Response Syntax** { 'InstanceUserSummary': { 'AssociationDate': 'string', 'DisassociationDate': 'string', 'Domain': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'InstanceId': 'string', 'InstanceUserArn': '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 Active Directory that contains the user information for the product subscription. * **IdentityProvider** *(dict) --* The "IdentityProvider" resource specifies details about 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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **InstanceId** *(string) --* The ID of the EC2 instance that provides user-based subscriptions. * **InstanceUserArn** *(string) --* The Amazon Resource Name (ARN) that identifies the instance user. * **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.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / start_product_subscription start_product_subscription ************************** LicenseManagerUserSubscriptions.Client.start_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': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, Product='string', Tags={ 'string': 'string' }, Username='string' ) Parameters: * **Domain** (*string*) -- The domain name of the Active Directory that contains the user for whom to start the product subscription. * **IdentityProvider** (*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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **Product** (*string*) -- **[REQUIRED]** The name of the user-based subscription product. Valid values: "VISUAL_STUDIO_ENTERPRISE" | "VISUAL_STUDIO_PROFESSIONAL" | "OFFICE_PROFESSIONAL_PLUS" | "REMOTE_DESKTOP_SERVICES" * **Tags** (*dict*) -- The tags that apply to the product subscription. * *(string) --* * *(string) --* * **Username** (*string*) -- **[REQUIRED]** The user name from the identity provider of the user. Return type: dict Returns: **Response Syntax** { 'ProductUserSummary': { 'Domain': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'Product': 'string', 'ProductUserArn': '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 Active Directory that contains the user information for the product subscription. * **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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **Product** *(string) --* The name of the user-based subscription product. * **ProductUserArn** *(string) --* The Amazon Resource Name (ARN) for this product user. * **Status** *(string) --* The status of a product for this user. * **StatusMessage** *(string) --* The status message for a product for this 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 for this product user. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / list_tags_for_resource list_tags_for_resource ********************** LicenseManagerUserSubscriptions.Client.list_tags_for_resource(**kwargs) Returns the list of tags for the specified resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Tags** *(dict) --* The tags for the specified resource. * *(string) --* * *(string) --* **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" LicenseManagerUserSubscriptions / Client / untag_resource untag_resource ************** LicenseManagerUserSubscriptions.Client.untag_resource(**kwargs) Removes tags from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to remove tags from. * **TagKeys** (*list*) -- **[REQUIRED]** The tag keys to remove from the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" LicenseManagerUserSubscriptions / Client / get_waiter get_waiter ********** LicenseManagerUserSubscriptions.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" LicenseManagerUserSubscriptions / Client / register_identity_provider register_identity_provider ************************** LicenseManagerUserSubscriptions.Client.register_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': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, Product='string', Settings={ 'SecurityGroupId': 'string', 'Subnets': [ 'string', ] }, Tags={ 'string': 'string' } ) Parameters: * **IdentityProvider** (*dict*) -- **[REQUIRED]** An object that specifies details for the identity provider to register. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "ActiveDirectoryIdentityProvider". * **ActiveDirectoryIdentityProvider** *(dict) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **Product** (*string*) -- **[REQUIRED]** The name of the user-based subscription product. Valid values: "VISUAL_STUDIO_ENTERPRISE" | "VISUAL_STUDIO_PROFESSIONAL" | "OFFICE_PROFESSIONAL_PLUS" | "REMOTE_DESKTOP_SERVICES" * **Settings** (*dict*) -- The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints. * **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. * **Subnets** *(list) --* **[REQUIRED]** The subnets defined for the registered identity provider. * *(string) --* * **Tags** (*dict*) -- The tags that apply to the identity provider's registration. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'IdentityProviderSummary': { 'FailureMessage': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'IdentityProviderArn': '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) --* The "IdentityProvider" resource contains information about an 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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **IdentityProviderArn** *(string) --* The Amazon Resource Name (ARN) of the identity provider. * **Product** *(string) --* The name of the user-based subscription product. * **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. * **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. * *(string) --* * **Status** *(string) --* The status of the identity provider. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / deregister_identity_provider deregister_identity_provider **************************** LicenseManagerUserSubscriptions.Client.deregister_identity_provider(**kwargs) Deregisters the Active Directory identity provider from License Manager user-based subscriptions. See also: AWS API Documentation **Request Syntax** response = client.deregister_identity_provider( IdentityProvider={ 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, IdentityProviderArn='string', Product='string' ) Parameters: * **IdentityProvider** (*dict*) -- An object that specifies details for the Active Directory identity provider. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "ActiveDirectoryIdentityProvider". * **ActiveDirectoryIdentityProvider** *(dict) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **IdentityProviderArn** (*string*) -- The Amazon Resource Name (ARN) that identifies the identity provider to deregister. * **Product** (*string*) -- The name of the user-based subscription product. Valid values: "VISUAL_STUDIO_ENTERPRISE" | "VISUAL_STUDIO_PROFESSIONAL" | "OFFICE_PROFESSIONAL_PLUS" | "REMOTE_DESKTOP_SERVICES" Return type: dict Returns: **Response Syntax** { 'IdentityProviderSummary': { 'FailureMessage': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'IdentityProviderArn': '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) --* The "IdentityProvider" resource contains information about an 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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **IdentityProviderArn** *(string) --* The Amazon Resource Name (ARN) of the identity provider. * **Product** *(string) --* The name of the user-based subscription product. * **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. * **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. * *(string) --* * **Status** *(string) --* The status of the identity provider. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / list_instances list_instances ************** LicenseManagerUserSubscriptions.Client.list_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' ) Parameters: * **Filters** (*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. * **MaxResults** (*integer*) -- The maximum number of results to return from a single request. * **NextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'InstanceSummaries': [ { 'InstanceId': 'string', 'LastStatusCheckDate': 'string', 'Products': [ 'string', ], 'Status': 'string', 'StatusMessage': 'string' }, ], '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. * **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) --* 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. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / create_license_server_endpoint create_license_server_endpoint ****************************** LicenseManagerUserSubscriptions.Client.create_license_server_endpoint(**kwargs) Creates a network endpoint for the Remote Desktop Services (RDS) license server. See also: AWS API Documentation **Request Syntax** response = client.create_license_server_endpoint( IdentityProviderArn='string', LicenseServerSettings={ 'ServerSettings': { 'RdsSalSettings': { 'RdsSalCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } } } }, 'ServerType': 'RDS_SAL' }, Tags={ 'string': 'string' } ) Parameters: * **IdentityProviderArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that identifies the "IdentityProvider" resource that contains details about a registered identity provider. In the case of Active Directory, that can be a self-managed Active Directory or an Amazon Web Services Managed Active Directory that contains user identity details. * **LicenseServerSettings** (*dict*) -- **[REQUIRED]** The "LicenseServerSettings" resource to create for the endpoint. The settings include the type of license server and the Secrets Manager secret that enables administrators to add or remove users associated with the license server. * **ServerSettings** *(dict) --* **[REQUIRED]** The "ServerSettings" resource contains the settings for your server. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "RdsSalSettings". * **RdsSalSettings** *(dict) --* The "RdsSalSettings" resource contains settings to configure a specific Remote Desktop Services (RDS) license server. * **RdsSalCredentialsProvider** *(dict) --* **[REQUIRED]** The "CredentialsProvider" resource contains a reference to the credentials provider that's used for RDS license server user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **ServerType** *(string) --* **[REQUIRED]** The type of license server. * **Tags** (*dict*) -- The tags that apply for the license server endpoint. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'IdentityProviderArn': 'string', 'LicenseServerEndpointArn': 'string' } **Response Structure** * *(dict) --* * **IdentityProviderArn** *(string) --* The Amazon Resource Name (ARN) of the identity provider specified in the request. * **LicenseServerEndpointArn** *(string) --* The ARN of the "LicenseServerEndpoint" resource. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / list_identity_providers list_identity_providers *********************** LicenseManagerUserSubscriptions.Client.list_identity_providers(**kwargs) Lists the Active Directory identity providers for user-based subscriptions. See also: AWS API Documentation **Request Syntax** response = client.list_identity_providers( Filters=[ { 'Attribute': 'string', 'Operation': 'string', 'Value': 'string' }, ], MaxResults=123, NextToken='string' ) Parameters: * **Filters** (*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. * **MaxResults** (*integer*) -- The maximum number of results to return from a single request. * **NextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'IdentityProviderSummaries': [ { 'FailureMessage': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'IdentityProviderArn': 'string', 'Product': 'string', 'Settings': { 'SecurityGroupId': 'string', 'Subnets': [ 'string', ] }, 'Status': '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. * **FailureMessage** *(string) --* The failure message associated with an identity provider. * **IdentityProvider** *(dict) --* The "IdentityProvider" resource contains information about an 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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **IdentityProviderArn** *(string) --* The Amazon Resource Name (ARN) of the identity provider. * **Product** *(string) --* The name of the user-based subscription product. * **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. * **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. * *(string) --* * **Status** *(string) --* The status of the identity provider. * **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. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / close close ***** LicenseManagerUserSubscriptions.Client.close() Closes underlying endpoint connections. LicenseManagerUserSubscriptions / Client / disassociate_user disassociate_user ***************** LicenseManagerUserSubscriptions.Client.disassociate_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': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, InstanceId='string', InstanceUserArn='string', Username='string' ) Parameters: * **Domain** (*string*) -- The domain name of the Active Directory that contains information for the user to disassociate. * **IdentityProvider** (*dict*) -- An object that specifies details for the Active Directory identity provider. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "ActiveDirectoryIdentityProvider". * **ActiveDirectoryIdentityProvider** *(dict) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **InstanceId** (*string*) -- The ID of the EC2 instance which provides user-based subscriptions. * **InstanceUserArn** (*string*) -- The Amazon Resource Name (ARN) of the user to disassociate from the EC2 instance. * **Username** (*string*) -- The user name from the Active Directory identity provider for the user. Return type: dict Returns: **Response Syntax** { 'InstanceUserSummary': { 'AssociationDate': 'string', 'DisassociationDate': 'string', 'Domain': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'InstanceId': 'string', 'InstanceUserArn': '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 Active Directory that contains the user information for the product subscription. * **IdentityProvider** *(dict) --* The "IdentityProvider" resource specifies details about 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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **InstanceId** *(string) --* The ID of the EC2 instance that provides user-based subscriptions. * **InstanceUserArn** *(string) --* The Amazon Resource Name (ARN) that identifies the instance user. * **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.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / stop_product_subscription stop_product_subscription ************************* LicenseManagerUserSubscriptions.Client.stop_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': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, Product='string', ProductUserArn='string', Username='string' ) Parameters: * **Domain** (*string*) -- The domain name of the Active Directory that contains the user for whom to stop the product subscription. * **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 can be set: "ActiveDirectoryIdentityProvider". * **ActiveDirectoryIdentityProvider** *(dict) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **Product** (*string*) -- The name of the user-based subscription product. Valid values: "VISUAL_STUDIO_ENTERPRISE" | "VISUAL_STUDIO_PROFESSIONAL" | "OFFICE_PROFESSIONAL_PLUS" | "REMOTE_DESKTOP_SERVICES" * **ProductUserArn** (*string*) -- The Amazon Resource Name (ARN) of the product user. * **Username** (*string*) -- The user name from the identity provider for the user. Return type: dict Returns: **Response Syntax** { 'ProductUserSummary': { 'Domain': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'Product': 'string', 'ProductUserArn': '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 Active Directory that contains the user information for the product subscription. * **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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **Product** *(string) --* The name of the user-based subscription product. * **ProductUserArn** *(string) --* The Amazon Resource Name (ARN) for this product user. * **Status** *(string) --* The status of a product for this user. * **StatusMessage** *(string) --* The status message for a product for this 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 for this product user. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaE xceededException" * "LicenseManagerUserSubscriptions.Client.exceptions.ConflictExcep tion" * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception" LicenseManagerUserSubscriptions / Client / tag_resource tag_resource ************ LicenseManagerUserSubscriptions.Client.tag_resource(**kwargs) Adds tags to a resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to tag. * **Tags** (*dict*) -- **[REQUIRED]** The tags to apply to the specified resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFo undException" LicenseManagerUserSubscriptions / Client / update_identity_provider_settings update_identity_provider_settings ********************************* LicenseManagerUserSubscriptions.Client.update_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': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, IdentityProviderArn='string', Product='string', UpdateSettings={ 'AddSubnets': [ 'string', ], 'RemoveSubnets': [ 'string', ], 'SecurityGroupId': 'string' } ) Parameters: * **IdentityProvider** (*dict*) -- Refers to an identity provider. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "ActiveDirectoryIdentityProvider". * **ActiveDirectoryIdentityProvider** *(dict) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretsManagerCredentialsProvider". * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **IdentityProviderArn** (*string*) -- The Amazon Resource Name (ARN) of the identity provider to update. * **Product** (*string*) -- The name of the user-based subscription product. Valid values: "VISUAL_STUDIO_ENTERPRISE" | "VISUAL_STUDIO_PROFESSIONAL" | "OFFICE_PROFESSIONAL_PLUS" | "REMOTE_DESKTOP_SERVICES" * **UpdateSettings** (*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. Return type: dict Returns: **Response Syntax** { 'IdentityProviderSummary': { 'FailureMessage': 'string', 'IdentityProvider': { 'ActiveDirectoryIdentityProvider': { 'ActiveDirectorySettings': { 'DomainCredentialsProvider': { 'SecretsManagerCredentialsProvider': { 'SecretId': 'string' } }, 'DomainIpv4List': [ 'string', ], 'DomainName': 'string', 'DomainNetworkSettings': { 'Subnets': [ 'string', ] } }, 'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED', 'DirectoryId': 'string' } }, 'IdentityProviderArn': '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) --* The "IdentityProvider" resource contains information about an 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) --* The "ActiveDirectoryIdentityProvider" resource contains settings and other details about a specific 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. * **DomainCredentialsProvider** *(dict) --* Points to the "CredentialsProvider" resource that contains information about the credential provider for user administration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretsManagerCredentialsProvider". 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'} * **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. * **DomainIpv4List** *(list) --* A list of domain IPv4 addresses that are used for the Active Directory. * *(string) --* * **DomainName** *(string) --* The domain name for the Active Directory. * **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. * **DirectoryId** *(string) --* The directory ID for an Active Directory identity provider. * **IdentityProviderArn** *(string) --* The Amazon Resource Name (ARN) of the identity provider. * **Product** *(string) --* The name of the user-based subscription product. * **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. * **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. * *(string) --* * **Status** *(string) --* The status of the identity provider. **Exceptions** * "LicenseManagerUserSubscriptions.Client.exceptions.ValidationExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingExc eption" * "LicenseManagerUserSubscriptions.Client.exceptions.InternalServe rException" * "LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedE xception"