License Manager User Subscriptions
This page documents function available when using the License_Manager_User_Subscriptions
module, created with @service License_Manager_User_Subscriptions
.
Index
Main.License_Manager_User_Subscriptions.associate_user
Main.License_Manager_User_Subscriptions.deregister_identity_provider
Main.License_Manager_User_Subscriptions.disassociate_user
Main.License_Manager_User_Subscriptions.list_identity_providers
Main.License_Manager_User_Subscriptions.list_instances
Main.License_Manager_User_Subscriptions.list_product_subscriptions
Main.License_Manager_User_Subscriptions.list_user_associations
Main.License_Manager_User_Subscriptions.register_identity_provider
Main.License_Manager_User_Subscriptions.start_product_subscription
Main.License_Manager_User_Subscriptions.stop_product_subscription
Main.License_Manager_User_Subscriptions.update_identity_provider_settings
Documentation
Main.License_Manager_User_Subscriptions.associate_user
— Methodassociate_user(identity_provider, instance_id, username)
associate_user(identity_provider, instance_id, username, params::Dict{String,<:Any})
Associates the user to an EC2 instance to utilize user-based subscriptions. 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.
Arguments
identity_provider
: The identity provider of the user.instance_id
: The ID of the EC2 instance, which provides user-based subscriptions.username
: The user name from the identity provider for the user.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Domain"
: The domain name of the user.
Main.License_Manager_User_Subscriptions.deregister_identity_provider
— Methodderegister_identity_provider(identity_provider, product)
deregister_identity_provider(identity_provider, product, params::Dict{String,<:Any})
Deregisters the identity provider from providing user-based subscriptions.
Arguments
identity_provider
: An object that specifies details for the identity provider.product
: The name of the user-based subscription product.
Main.License_Manager_User_Subscriptions.disassociate_user
— Methoddisassociate_user(identity_provider, instance_id, username)
disassociate_user(identity_provider, instance_id, username, params::Dict{String,<:Any})
Disassociates the user from an EC2 instance providing user-based subscriptions.
Arguments
identity_provider
: An object that specifies details for the identity provider.instance_id
: The ID of the EC2 instance, which provides user-based subscriptions.username
: The user name from the identity provider for the user.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Domain"
: The domain name of the user.
Main.License_Manager_User_Subscriptions.list_identity_providers
— Methodlist_identity_providers()
list_identity_providers(params::Dict{String,<:Any})
Lists the identity providers for user-based subscriptions.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MaxResults"
: Maximum number of results to return in a single call."NextToken"
: Token for the next set of results.
Main.License_Manager_User_Subscriptions.list_instances
— Methodlist_instances()
list_instances(params::Dict{String,<:Any})
Lists the EC2 instances providing user-based subscriptions.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filters"
: An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify."MaxResults"
: Maximum number of results to return in a single call."NextToken"
: Token for the next set of results.
Main.License_Manager_User_Subscriptions.list_product_subscriptions
— Methodlist_product_subscriptions(identity_provider, product)
list_product_subscriptions(identity_provider, product, params::Dict{String,<:Any})
Lists the user-based subscription products available from an identity provider.
Arguments
identity_provider
: An object that specifies details for the identity provider.product
: The name of the user-based subscription product.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filters"
: An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify."MaxResults"
: Maximum number of results to return in a single call."NextToken"
: Token for the next set of results.
Main.License_Manager_User_Subscriptions.list_user_associations
— Methodlist_user_associations(identity_provider, instance_id)
list_user_associations(identity_provider, instance_id, params::Dict{String,<:Any})
Lists user associations for an identity provider.
Arguments
identity_provider
: An object that specifies details for the identity provider.instance_id
: The ID of the EC2 instance, which provides user-based subscriptions.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filters"
: An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify."MaxResults"
: Maximum number of results to return in a single call."NextToken"
: Token for the next set of results.
Main.License_Manager_User_Subscriptions.register_identity_provider
— Methodregister_identity_provider(identity_provider, product)
register_identity_provider(identity_provider, product, params::Dict{String,<:Any})
Registers an identity provider for user-based subscriptions.
Arguments
identity_provider
: An object that specifies details for the identity provider.product
: The name of the user-based subscription product.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Settings"
: The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
Main.License_Manager_User_Subscriptions.start_product_subscription
— Methodstart_product_subscription(identity_provider, product, username)
start_product_subscription(identity_provider, product, username, params::Dict{String,<:Any})
Starts a product subscription for a user with the specified identity provider. 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.
Arguments
identity_provider
: An object that specifies details for the identity provider.product
: The name of the user-based subscription product.username
: The user name from the identity provider of the user.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Domain"
: The domain name of the user.
Main.License_Manager_User_Subscriptions.stop_product_subscription
— Methodstop_product_subscription(identity_provider, product, username)
stop_product_subscription(identity_provider, product, username, params::Dict{String,<:Any})
Stops a product subscription for a user with the specified identity provider.
Arguments
identity_provider
: An object that specifies details for the identity provider.product
: The name of the user-based subscription product.username
: The user name from the identity provider for the user.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Domain"
: The domain name of the user.
Main.License_Manager_User_Subscriptions.update_identity_provider_settings
— Methodupdate_identity_provider_settings(identity_provider, product, update_settings)
update_identity_provider_settings(identity_provider, product, update_settings, params::Dict{String,<:Any})
Updates additional product configuration settings for the registered identity provider.
Arguments
identity_provider
:product
: The name of the user-based subscription product.update_settings
: 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.