Struct Client 

pub struct Client { /* private fields */ }

Client for AWS License Manager User Subscriptions

Client for invoking operations on AWS License Manager User Subscriptions. Each operation on AWS License Manager User Subscriptions is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_licensemanagerusersubscriptions::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_licensemanagerusersubscriptions::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateUser operation has a Client::associate_user, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_user()
    .username("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_user(&self) -> AssociateUserFluentBuilder

Constructs a fluent builder for the AssociateUser operation.

• The fluent builder is configurable:
  • username(impl Into<String>) / set_username(Option<String>):
    required: true
    

    The user name from the identity provider.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The ID of the EC2 instance that provides the user-based subscription.

    
    
  • identity_provider(IdentityProvider) / set_identity_provider(Option<IdentityProvider>):
    required: true
    

    The identity provider for the user.

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: false
    

    The domain name of the Active Directory that contains information for the user to associate.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags that apply for the user association.

    
    
• On success, responds with AssociateUserOutput with field(s):
  • instance_user_summary(Option<InstanceUserSummary>):

    Metadata that describes the associate user operation.

• On failure, responds with SdkError<AssociateUserError>

impl Client

pub fn create_license_server_endpoint( &self, ) -> CreateLicenseServerEndpointFluentBuilder

Constructs a fluent builder for the CreateLicenseServerEndpoint operation.

• The fluent builder is configurable:
  • identity_provider_arn(impl Into<String>) / set_identity_provider_arn(Option<String>):
    required: true
    

    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.

    
    
  • license_server_settings(LicenseServerSettings) / set_license_server_settings(Option<LicenseServerSettings>):
    required: true
    

    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.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags that apply for the license server endpoint.

    
    
• On success, responds with CreateLicenseServerEndpointOutput with field(s):
  • identity_provider_arn(Option<String>):

    The Amazon Resource Name (ARN) of the identity provider specified in the request.

  • license_server_endpoint_arn(Option<String>):

    The ARN of the LicenseServerEndpoint resource.

• On failure, responds with SdkError<CreateLicenseServerEndpointError>

impl Client

pub fn delete_license_server_endpoint( &self, ) -> DeleteLicenseServerEndpointFluentBuilder

Constructs a fluent builder for the DeleteLicenseServerEndpoint operation.

• The fluent builder is configurable:
  • license_server_endpoint_arn(impl Into<String>) / set_license_server_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that identifies the LicenseServerEndpoint resource to delete.

    
    
  • server_type(ServerType) / set_server_type(Option<ServerType>):
    required: true
    

    The type of License Server that the delete request refers to.

    
    
• On success, responds with DeleteLicenseServerEndpointOutput with field(s):
  • license_server_endpoint(Option<LicenseServerEndpoint>):

    Shows details from the LicenseServerEndpoint resource that was deleted.

• On failure, responds with SdkError<DeleteLicenseServerEndpointError>

impl Client

pub fn deregister_identity_provider( &self, ) -> DeregisterIdentityProviderFluentBuilder

Constructs a fluent builder for the DeregisterIdentityProvider operation.

• The fluent builder is configurable:
  • identity_provider(IdentityProvider) / set_identity_provider(Option<IdentityProvider>):
    required: false
    

    An object that specifies details for the Active Directory identity provider.

    
    
  • product(impl Into<String>) / set_product(Option<String>):
    required: false
    

    The name of the user-based subscription product.

    Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

    
    
  • identity_provider_arn(impl Into<String>) / set_identity_provider_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) that identifies the identity provider to deregister.

    
    
• On success, responds with DeregisterIdentityProviderOutput with field(s):
  • identity_provider_summary(Option<IdentityProviderSummary>):

    Metadata that describes the results of an identity provider operation.

• On failure, responds with SdkError<DeregisterIdentityProviderError>

impl Client

pub fn disassociate_user(&self) -> DisassociateUserFluentBuilder

Constructs a fluent builder for the DisassociateUser operation.

• The fluent builder is configurable:
  • username(impl Into<String>) / set_username(Option<String>):
    required: false
    

    The user name from the Active Directory identity provider for the user.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: false
    

    The ID of the EC2 instance which provides user-based subscriptions.

    
    
  • identity_provider(IdentityProvider) / set_identity_provider(Option<IdentityProvider>):
    required: false
    

    An object that specifies details for the Active Directory identity provider.

    
    
  • instance_user_arn(impl Into<String>) / set_instance_user_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the user to disassociate from the EC2 instance.

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: false
    

    The domain name of the Active Directory that contains information for the user to disassociate.

    
    
• On success, responds with DisassociateUserOutput with field(s):
  • instance_user_summary(Option<InstanceUserSummary>):

    Metadata that describes the associate user operation.

• On failure, responds with SdkError<DisassociateUserError>

impl Client

pub fn list_identity_providers(&self) -> ListIdentityProvidersFluentBuilder

Constructs a fluent builder for the ListIdentityProviders operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return from a single request.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    You can use the following filters to streamline results:

    • Product

    • DirectoryId

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to specify where to start paginating. This is the nextToken from a previously truncated response.

    
    
• On success, responds with ListIdentityProvidersOutput with field(s):
  • identity_provider_summaries(Vec::<IdentityProviderSummary>):

    An array of IdentityProviderSummary resources that contain details about the Active Directory identity providers that meet the request criteria.

  • next_token(Option<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.

• On failure, responds with SdkError<ListIdentityProvidersError>

impl Client

pub fn list_instances(&self) -> ListInstancesFluentBuilder

Constructs a fluent builder for the ListInstances operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return from a single request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to specify where to start paginating. This is the nextToken from a previously truncated response.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    You can use the following filters to streamline results:

    • Status

    • InstanceId

    
    
• On success, responds with ListInstancesOutput with field(s):
  • instance_summaries(Option<Vec::<InstanceSummary>>):

    An array of InstanceSummary resources that contain details about the instances that provide user-based subscriptions and also meet the request criteria.

  • next_token(Option<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.

• On failure, responds with SdkError<ListInstancesError>

impl Client

pub fn list_license_server_endpoints( &self, ) -> ListLicenseServerEndpointsFluentBuilder

Constructs a fluent builder for the ListLicenseServerEndpoints operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return from a single request.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    You can use the following filters to streamline results:

    • IdentityProviderArn

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to specify where to start paginating. This is the nextToken from a previously truncated response.

    
    
• On success, responds with ListLicenseServerEndpointsOutput with field(s):
  • license_server_endpoints(Option<Vec::<LicenseServerEndpoint>>):

    An array of LicenseServerEndpoint resources that contain detailed information about the RDS License Servers that meet the request criteria.

  • next_token(Option<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.

• On failure, responds with SdkError<ListLicenseServerEndpointsError>

impl Client

pub fn list_product_subscriptions( &self, ) -> ListProductSubscriptionsFluentBuilder

Constructs a fluent builder for the ListProductSubscriptions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • product(impl Into<String>) / set_product(Option<String>):
    required: false
    

    The name of the user-based subscription product.

    Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

    
    
  • identity_provider(IdentityProvider) / set_identity_provider(Option<IdentityProvider>):
    required: true
    

    An object that specifies details for the identity provider.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return from a single request.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    You can use the following filters to streamline results:

    • Status

    • Username

    • Domain

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to specify where to start paginating. This is the nextToken from a previously truncated response.

    
    
• On success, responds with ListProductSubscriptionsOutput with field(s):
  • product_user_summaries(Option<Vec::<ProductUserSummary>>):

    Metadata that describes the list product subscriptions operation.

  • next_token(Option<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.

• On failure, responds with SdkError<ListProductSubscriptionsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags for the specified resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_user_associations(&self) -> ListUserAssociationsFluentBuilder

Constructs a fluent builder for the ListUserAssociations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The ID of the EC2 instance, which provides user-based subscriptions.

    
    
  • identity_provider(IdentityProvider) / set_identity_provider(Option<IdentityProvider>):
    required: true
    

    An object that specifies details for the identity provider.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return from a single request.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    You can use the following filters to streamline results:

    • Status

    • Username

    • Domain

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to specify where to start paginating. This is the nextToken from a previously truncated response.

    
    
• On success, responds with ListUserAssociationsOutput with field(s):
  • instance_user_summaries(Option<Vec::<InstanceUserSummary>>):

    Metadata that describes the list user association operation.

  • next_token(Option<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.

• On failure, responds with SdkError<ListUserAssociationsError>

impl Client

pub fn register_identity_provider( &self, ) -> RegisterIdentityProviderFluentBuilder

Constructs a fluent builder for the RegisterIdentityProvider operation.

• The fluent builder is configurable:
  • identity_provider(IdentityProvider) / set_identity_provider(Option<IdentityProvider>):
    required: true
    

    An object that specifies details for the identity provider to register.

    
    
  • product(impl Into<String>) / set_product(Option<String>):
    required: true
    

    The name of the user-based subscription product.

    Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

    
    
  • settings(Settings) / set_settings(Option<Settings>):
    required: false
    

    The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags that apply to the identity provider’s registration.

    
    
• On success, responds with RegisterIdentityProviderOutput with field(s):
  • identity_provider_summary(Option<IdentityProviderSummary>):

    Metadata that describes the results of an identity provider operation.

• On failure, responds with SdkError<RegisterIdentityProviderError>

impl Client

pub fn start_product_subscription( &self, ) -> StartProductSubscriptionFluentBuilder

Constructs a fluent builder for the StartProductSubscription operation.

• The fluent builder is configurable:
  • username(impl Into<String>) / set_username(Option<String>):
    required: true
    

    The user name from the identity provider of the user.

    
    
  • identity_provider(IdentityProvider) / set_identity_provider(Option<IdentityProvider>):
    required: true
    

    An object that specifies details for the identity provider.

    
    
  • product(impl Into<String>) / set_product(Option<String>):
    required: true
    

    The name of the user-based subscription product.

    Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: false
    

    The domain name of the Active Directory that contains the user for whom to start the product subscription.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags that apply to the product subscription.

    
    
• On success, responds with StartProductSubscriptionOutput with field(s):
  • product_user_summary(Option<ProductUserSummary>):

    Metadata that describes the start product subscription operation.

• On failure, responds with SdkError<StartProductSubscriptionError>

impl Client

pub fn stop_product_subscription(&self) -> StopProductSubscriptionFluentBuilder

Constructs a fluent builder for the StopProductSubscription operation.

• The fluent builder is configurable:
  • username(impl Into<String>) / set_username(Option<String>):
    required: false
    

    The user name from the identity provider for the user.

    
    
  • identity_provider(IdentityProvider) / set_identity_provider(Option<IdentityProvider>):
    required: false
    

    An object that specifies details for the identity provider.

    
    
  • product(impl Into<String>) / set_product(Option<String>):
    required: false
    

    The name of the user-based subscription product.

    Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

    
    
  • product_user_arn(impl Into<String>) / set_product_user_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the product user.

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: false
    

    The domain name of the Active Directory that contains the user for whom to stop the product subscription.

    
    
• On success, responds with StopProductSubscriptionOutput with field(s):
  • product_user_summary(Option<ProductUserSummary>):

    Metadata that describes the start product subscription operation.

• On failure, responds with SdkError<StopProductSubscriptionError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource that you want to tag.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags to apply to the specified resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_identity_provider_settings( &self, ) -> UpdateIdentityProviderSettingsFluentBuilder

Constructs a fluent builder for the UpdateIdentityProviderSettings operation.

• The fluent builder is configurable:
  • identity_provider(IdentityProvider) / set_identity_provider(Option<IdentityProvider>):
    required: false
    

    Refers to an identity provider.

    
    
  • product(impl Into<String>) / set_product(Option<String>):
    required: false
    

    The name of the user-based subscription product.

    Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

    
    
  • identity_provider_arn(impl Into<String>) / set_identity_provider_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the identity provider to update.

    
    
  • update_settings(UpdateSettings) / set_update_settings(Option<UpdateSettings>):
    required: true
    

    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.

    
    
• On success, responds with UpdateIdentityProviderSettingsOutput with field(s):
  • identity_provider_summary(Option<IdentityProviderSummary>):

    Describes an identity provider.

• On failure, responds with SdkError<UpdateIdentityProviderSettingsError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.