2024/11/14 - AWS License Manager User Subscriptions - 6 new10 updated api methods
Changes New and updated API operations to support License Included User-based Subscription of Microsoft Remote Desktop Services (RDS).
Removes tags from a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
list
[REQUIRED]
The tag keys to remove from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a LicenseServerEndpoint resource.
See also: AWS API Documentation
Request Syntax
client.delete_license_server_endpoint(
LicenseServerEndpointArn='string',
ServerType='RDS_SAL'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the LicenseServerEndpoint resource to delete.
string
[REQUIRED]
The type of License Server that the delete request refers to.
dict
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.
Returns the list of tags for the specified resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
The tags for the specified resource.
(string) --
(string) --
Creates a network endpoint for the Remote Desktop Services (RDS) license server.
See also: AWS API Documentation
Request Syntax
client.create_license_server_endpoint(
IdentityProviderArn='string',
LicenseServerSettings={
'ServerSettings': {
'RdsSalSettings': {
'RdsSalCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
}
}
},
'ServerType': 'RDS_SAL'
},
Tags={
'string': 'string'
}
)
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.
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.
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.
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.
dict
The tags that apply for the license server endpoint.
(string) --
(string) --
dict
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.
Adds tags to a resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to tag.
dict
[REQUIRED]
The tags to apply to the specified resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
List the Remote Desktop Services (RDS) License Server endpoints
See also: AWS API Documentation
Request Syntax
client.list_license_server_endpoints(
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
],
MaxResults=123,
NextToken='string'
)
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.
integer
The maximum number of results to return from a single request.
string
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
dict
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'Tags': {'string': 'string'}}
Response {'InstanceUserSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'InstanceUserArn': 'string'}}
Associates the user to an EC2 instance to utilize user-based subscriptions.
See also: AWS API Documentation
Request Syntax
client.associate_user(
Domain='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'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'
)
string
The domain name of the Active Directory that contains information for the user to associate.
dict
[REQUIRED]
The identity provider for the user.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
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.
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.
string
[REQUIRED]
The ID of the EC2 instance that provides the user-based subscription.
dict
The tags that apply for the user association.
(string) --
(string) --
string
[REQUIRED]
The user name from the identity provider.
dict
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.
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.
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'IdentityProviderArn': 'string'}
Response {'IdentityProviderSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'IdentityProviderArn': 'string'}}
Deregisters the Active Directory identity provider from License Manager user-based subscriptions.
See also: AWS API Documentation
Request Syntax
client.deregister_identity_provider(
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'ActiveDirectorySettings': {
'DomainCredentialsProvider': {
'SecretsManagerCredentialsProvider': {
'SecretId': 'string'
}
},
'DomainIpv4List': [
'string',
],
'DomainName': 'string',
'DomainNetworkSettings': {
'Subnets': [
'string',
]
}
},
'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
'DirectoryId': 'string'
}
},
IdentityProviderArn='string',
Product='string'
)
dict
An object that specifies details for the Active Directory identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
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.
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.
string
The Amazon Resource Name (ARN) that identifies the identity provider to deregister.
string
The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS
dict
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.
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.
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'InstanceUserArn': 'string'}
Response {'InstanceUserSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'InstanceUserArn': 'string'}}
Disassociates the user from an EC2 instance providing user-based subscriptions.
See also: AWS API Documentation
Request Syntax
client.disassociate_user(
Domain='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'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'
)
string
The domain name of the Active Directory that contains information for the user to disassociate.
dict
An object that specifies details for the Active Directory identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
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.
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.
string
The ID of the EC2 instance which provides user-based subscriptions.
string
The Amazon Resource Name (ARN) of the user to disassociate from the EC2 instance.
string
The user name from the Active Directory identity provider for the user.
dict
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.
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.
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.
{'Filters': [{'Attribute': 'string', 'Operation': 'string', 'Value': 'string'}]}
Response {'IdentityProviderSummaries': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'IdentityProviderArn': 'string'}}
Lists the Active Directory identity providers for user-based subscriptions.
See also: AWS API Documentation
Request Syntax
client.list_identity_providers(
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
],
MaxResults=123,
NextToken='string'
)
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.
integer
The maximum number of results to return from a single request.
string
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
dict
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.
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.
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}}}
Response {'ProductUserSummaries': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'ProductUserArn': 'string'}}
Lists the user-based subscription products available from an identity provider.
See also: AWS API Documentation
Request Syntax
client.list_product_subscriptions(
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
],
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'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'
)
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.
dict
[REQUIRED]
An object that specifies details for the identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
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.
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.
integer
The maximum number of results to return from a single request.
string
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
string
The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS
dict
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.
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.
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}}}
Response {'InstanceUserSummaries': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'InstanceUserArn': 'string'}}
Lists user associations for an identity provider.
See also: AWS API Documentation
Request Syntax
client.list_user_associations(
Filters=[
{
'Attribute': 'string',
'Operation': 'string',
'Value': 'string'
},
],
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'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'
)
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.
dict
[REQUIRED]
An object that specifies details for the identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
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.
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.
string
[REQUIRED]
The ID of the EC2 instance, which provides user-based subscriptions.
integer
The maximum number of results to return from a single request.
string
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
dict
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.
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.
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'Tags': {'string': 'string'}}
Response {'IdentityProviderSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'IdentityProviderArn': 'string'}}
Registers an identity provider for user-based subscriptions.
See also: AWS API Documentation
Request Syntax
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'
}
)
dict
[REQUIRED]
An object that specifies details for the identity provider to register.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
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.
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.
string
[REQUIRED]
The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS
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) --
dict
The tags that apply to the identity provider's registration.
(string) --
(string) --
dict
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.
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.
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'Tags': {'string': 'string'}}
Response {'ProductUserSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'ProductUserArn': 'string'}}
Starts a product subscription for a user with the specified identity provider.
See also: AWS API Documentation
Request Syntax
client.start_product_subscription(
Domain='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'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'
)
string
The domain name of the Active Directory that contains the user for whom to start the product subscription.
dict
[REQUIRED]
An object that specifies details for the identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
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.
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.
string
[REQUIRED]
The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS
dict
The tags that apply to the product subscription.
(string) --
(string) --
string
[REQUIRED]
The user name from the identity provider of the user.
dict
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.
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.
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'ProductUserArn': 'string'}
Response {'ProductUserSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'ProductUserArn': 'string'}}
Stops a product subscription for a user with the specified identity provider.
See also: AWS API Documentation
Request Syntax
client.stop_product_subscription(
Domain='string',
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'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'
)
string
The domain name of the Active Directory that contains the user for whom to stop the product subscription.
dict
An object that specifies details for the identity provider.
ActiveDirectoryIdentityProvider (dict) --
The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
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.
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.
string
The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS
string
The Amazon Resource Name (ARN) of the product user.
string
The user name from the identity provider for the user.
dict
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.
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.
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.
{'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'IdentityProviderArn': 'string'}
Response {'IdentityProviderSummary': {'IdentityProvider': {'ActiveDirectoryIdentityProvider': {'ActiveDirectorySettings': {'DomainCredentialsProvider': {'SecretsManagerCredentialsProvider': {'SecretId': 'string'}},
'DomainIpv4List': ['string'],
'DomainName': 'string',
'DomainNetworkSettings': {'Subnets': ['string']}},
'ActiveDirectoryType': 'SELF_MANAGED '
'| '
'AWS_MANAGED'}},
'IdentityProviderArn': 'string'}}
Updates additional product configuration settings for the registered identity provider.
See also: AWS API Documentation
Request Syntax
client.update_identity_provider_settings(
IdentityProvider={
'ActiveDirectoryIdentityProvider': {
'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'
}
)
dict
Refers to an identity provider.
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.
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.
string
The Amazon Resource Name (ARN) of the identity provider to update.
string
The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS
dict
[REQUIRED]
Updates the registered identity provider’s product related configuration settings. You can update any combination of settings in a single operation such as the:
Subnets which you want to add to provision VPC endpoints.
Subnets which you want to remove the VPC endpoints from.
Security group ID which permits traffic to the VPC endpoints.
AddSubnets (list) -- [REQUIRED]
The ID of one or more subnets in which License Manager will create a VPC endpoint for products that require connectivity to activation servers.
(string) --
RemoveSubnets (list) -- [REQUIRED]
The ID of one or more subnets to remove.
(string) --
SecurityGroupId (string) --
A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoints for activation servers.
dict
Response Syntax
{
'IdentityProviderSummary': {
'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.
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.
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.