Struct Client

pub struct Client { /* private fields */ }

Client for AWS License Manager

Client for invoking operations on AWS License Manager. Each operation on AWS License Manager 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_licensemanager::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_licensemanager::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 AcceptGrant operation has a Client::accept_grant, 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.accept_grant()
    .grant_arn("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 accept_grant(&self) -> AcceptGrantFluentBuilder

Constructs a fluent builder for the AcceptGrant operation.

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

    Amazon Resource Name (ARN) of the grant.

    
    
• On success, responds with AcceptGrantOutput with field(s):
  • grant_arn(Option<String>):

    Grant ARN.

  • status(Option<GrantStatus>):

    Grant status.

  • version(Option<String>):

    Grant version.

• On failure, responds with SdkError<AcceptGrantError>

impl Client

pub fn check_in_license(&self) -> CheckInLicenseFluentBuilder

Constructs a fluent builder for the CheckInLicense operation.

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

    License consumption token.

    
    
  • beneficiary(impl Into<String>) / set_beneficiary(Option<String>):
    required: false
    

    License beneficiary.

    
    
• On success, responds with CheckInLicenseOutput
• On failure, responds with SdkError<CheckInLicenseError>

impl Client

pub fn checkout_borrow_license(&self) -> CheckoutBorrowLicenseFluentBuilder

Constructs a fluent builder for the CheckoutBorrowLicense operation.

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

    Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.

    
    
  • entitlements(EntitlementData) / set_entitlements(Option<Vec::<EntitlementData>>):
    required: true
    

    License entitlements. Partial checkouts are not supported.

    
    
  • digital_signature_method(DigitalSignatureMethod) / set_digital_signature_method(Option<DigitalSignatureMethod>):
    required: true
    

    Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.

    
    
  • node_id(impl Into<String>) / set_node_id(Option<String>):
    required: false
    

    Node ID.

    
    
  • checkout_metadata(Metadata) / set_checkout_metadata(Option<Vec::<Metadata>>):
    required: false
    

    Information about constraints.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with CheckoutBorrowLicenseOutput with field(s):
  • license_arn(Option<String>):

    Amazon Resource Name (ARN) of the license.

  • license_consumption_token(Option<String>):

    License consumption token.

  • entitlements_allowed(Option<Vec::<EntitlementData>>):

    Allowed license entitlements.

  • node_id(Option<String>):

    Node ID.

  • signed_token(Option<String>):

    Signed token.

  • issued_at(Option<String>):

    Date and time at which the license checkout is issued.

  • expiration(Option<String>):

    Date and time at which the license checkout expires.

  • checkout_metadata(Option<Vec::<Metadata>>):

    Information about constraints.

• On failure, responds with SdkError<CheckoutBorrowLicenseError>

impl Client

pub fn checkout_license(&self) -> CheckoutLicenseFluentBuilder

Constructs a fluent builder for the CheckoutLicense operation.

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

    Product SKU.

    
    
  • checkout_type(CheckoutType) / set_checkout_type(Option<CheckoutType>):
    required: true
    

    Checkout type.

    
    
  • key_fingerprint(impl Into<String>) / set_key_fingerprint(Option<String>):
    required: true
    

    Key fingerprint identifying the license.

    
    
  • entitlements(EntitlementData) / set_entitlements(Option<Vec::<EntitlementData>>):
    required: true
    

    License entitlements.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • beneficiary(impl Into<String>) / set_beneficiary(Option<String>):
    required: false
    

    License beneficiary.

    
    
  • node_id(impl Into<String>) / set_node_id(Option<String>):
    required: false
    

    Node ID.

    
    
• On success, responds with CheckoutLicenseOutput with field(s):
  • checkout_type(Option<CheckoutType>):

    Checkout type.

  • license_consumption_token(Option<String>):

    License consumption token.

  • entitlements_allowed(Option<Vec::<EntitlementData>>):

    Allowed license entitlements.

  • signed_token(Option<String>):

    Signed token.

  • node_id(Option<String>):

    Node ID.

  • issued_at(Option<String>):

    Date and time at which the license checkout is issued.

  • expiration(Option<String>):

    Date and time at which the license checkout expires.

  • license_arn(Option<String>):

    Amazon Resource Name (ARN) of the checkout license.

• On failure, responds with SdkError<CheckoutLicenseError>

impl Client

pub fn create_grant(&self) -> CreateGrantFluentBuilder

Constructs a fluent builder for the CreateGrant operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • grant_name(impl Into<String>) / set_grant_name(Option<String>):
    required: true
    

    Grant name.

    
    
  • license_arn(impl Into<String>) / set_license_arn(Option<String>):
    required: true
    

    Amazon Resource Name (ARN) of the license.

    
    
  • principals(impl Into<String>) / set_principals(Option<Vec::<String>>):
    required: true
    

    The grant principals. You can specify one of the following as an Amazon Resource Name (ARN):

    • An Amazon Web Services account, which includes only the account specified.

    • An organizational unit (OU), which includes all accounts in the OU.

    • An organization, which will include all accounts across your organization.

    
    
  • home_region(impl Into<String>) / set_home_region(Option<String>):
    required: true
    

    Home Region of the grant.

    
    
  • allowed_operations(AllowedOperation) / set_allowed_operations(Option<Vec::<AllowedOperation>>):
    required: true
    

    Allowed operations for the grant.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to add to the grant. For more information about tagging support in License Manager, see the TagResource operation.

    
    
• On success, responds with CreateGrantOutput with field(s):
  • grant_arn(Option<String>):

    Grant ARN.

  • status(Option<GrantStatus>):

    Grant status.

  • version(Option<String>):

    Grant version.

• On failure, responds with SdkError<CreateGrantError>

impl Client

pub fn create_grant_version(&self) -> CreateGrantVersionFluentBuilder

Constructs a fluent builder for the CreateGrantVersion operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • grant_arn(impl Into<String>) / set_grant_arn(Option<String>):
    required: true
    

    Amazon Resource Name (ARN) of the grant.

    
    
  • grant_name(impl Into<String>) / set_grant_name(Option<String>):
    required: false
    

    Grant name.

    
    
  • allowed_operations(AllowedOperation) / set_allowed_operations(Option<Vec::<AllowedOperation>>):
    required: false
    

    Allowed operations for the grant.

    
    
  • status(GrantStatus) / set_status(Option<GrantStatus>):
    required: false
    

    Grant status.

    
    
  • status_reason(impl Into<String>) / set_status_reason(Option<String>):
    required: false
    

    Grant status reason.

    
    
  • source_version(impl Into<String>) / set_source_version(Option<String>):
    required: false
    

    Current version of the grant.

    
    
  • options(Options) / set_options(Option<Options>):
    required: false
    

    The options specified for the grant.

    
    
• On success, responds with CreateGrantVersionOutput with field(s):
  • grant_arn(Option<String>):

    Grant ARN.

  • status(Option<GrantStatus>):

    Grant status.

  • version(Option<String>):

    New version of the grant.

• On failure, responds with SdkError<CreateGrantVersionError>

impl Client

pub fn create_license(&self) -> CreateLicenseFluentBuilder

Constructs a fluent builder for the CreateLicense operation.

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

    License name.

    
    
  • product_name(impl Into<String>) / set_product_name(Option<String>):
    required: true
    

    Product name.

    
    
  • product_sku(impl Into<String>) / set_product_sku(Option<String>):
    required: true
    

    Product SKU.

    
    
  • issuer(Issuer) / set_issuer(Option<Issuer>):
    required: true
    

    License issuer.

    
    
  • home_region(impl Into<String>) / set_home_region(Option<String>):
    required: true
    

    Home Region for the license.

    
    
  • validity(DatetimeRange) / set_validity(Option<DatetimeRange>):
    required: true
    

    Date and time range during which the license is valid, in ISO8601-UTC format.

    
    
  • entitlements(Entitlement) / set_entitlements(Option<Vec::<Entitlement>>):
    required: true
    

    License entitlements.

    
    
  • beneficiary(impl Into<String>) / set_beneficiary(Option<String>):
    required: true
    

    License beneficiary.

    
    
  • consumption_configuration(ConsumptionConfiguration) / set_consumption_configuration(Option<ConsumptionConfiguration>):
    required: true
    

    Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

    
    
  • license_metadata(Metadata) / set_license_metadata(Option<Vec::<Metadata>>):
    required: false
    

    Information about the license.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to add to the license. For more information about tagging support in License Manager, see the TagResource operation.

    
    
• On success, responds with CreateLicenseOutput with field(s):
  • license_arn(Option<String>):

    Amazon Resource Name (ARN) of the license.

  • status(Option<LicenseStatus>):

    License status.

  • version(Option<String>):

    License version.

• On failure, responds with SdkError<CreateLicenseError>

impl Client

pub fn create_license_configuration( &self, ) -> CreateLicenseConfigurationFluentBuilder

Constructs a fluent builder for the CreateLicenseConfiguration operation.

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

    Name of the license configuration.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Description of the license configuration.

    
    
  • license_counting_type(LicenseCountingType) / set_license_counting_type(Option<LicenseCountingType>):
    required: true
    

    Dimension used to track the license inventory.

    
    
  • license_count(i64) / set_license_count(Option<i64>):
    required: false
    

    Number of licenses managed by the license configuration.

    
    
  • license_count_hard_limit(bool) / set_license_count_hard_limit(Option<bool>):
    required: false
    

    Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

    
    
  • license_rules(impl Into<String>) / set_license_rules(Option<Vec::<String>>):
    required: false
    

    License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.

    • Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores

    • Instances dimension: allowedTenancy | maximumVcpus | minimumVcpus

    • Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets

    • vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus

    The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to add to the license configuration.

    
    
  • disassociate_when_not_found(bool) / set_disassociate_when_not_found(Option<bool>):
    required: false
    

    When true, disassociates a resource when software is uninstalled.

    
    
  • product_information_list(ProductInformation) / set_product_information_list(Option<Vec::<ProductInformation>>):
    required: false
    

    Product information.

    
    
• On success, responds with CreateLicenseConfigurationOutput with field(s):
  • license_configuration_arn(Option<String>):

    Amazon Resource Name (ARN) of the license configuration.

• On failure, responds with SdkError<CreateLicenseConfigurationError>

impl Client

pub fn create_license_conversion_task_for_resource( &self, ) -> CreateLicenseConversionTaskForResourceFluentBuilder

Constructs a fluent builder for the CreateLicenseConversionTaskForResource operation.

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

    Amazon Resource Name (ARN) of the resource you are converting the license type for.

    
    
  • source_license_context(LicenseConversionContext) / set_source_license_context(Option<LicenseConversionContext>):
    required: true
    

    Information that identifies the license type you are converting from. For the structure of the source license, see Convert a license type using the CLI in the License Manager User Guide.

    
    
  • destination_license_context(LicenseConversionContext) / set_destination_license_context(Option<LicenseConversionContext>):
    required: true
    

    Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the CLI in the License Manager User Guide.

    
    
• On success, responds with CreateLicenseConversionTaskForResourceOutput with field(s):
  • license_conversion_task_id(Option<String>):

    The ID of the created license type conversion task.

• On failure, responds with SdkError<CreateLicenseConversionTaskForResourceError>

impl Client

pub fn create_license_manager_report_generator( &self, ) -> CreateLicenseManagerReportGeneratorFluentBuilder

Constructs a fluent builder for the CreateLicenseManagerReportGenerator operation.

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

    Name of the report generator.

    
    
  • r#type(ReportType) / set_type(Option<Vec::<ReportType>>):
    required: true
    

    Type of reports to generate. The following report types an be generated:

    • License configuration report - Reports the number and details of consumed licenses for a license configuration.

    • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

    
    
  • report_context(ReportContext) / set_report_context(Option<ReportContext>):
    required: true
    

    Defines the type of license configuration the report generator tracks.

    
    
  • report_frequency(ReportFrequency) / set_report_frequency(Option<ReportFrequency>):
    required: true
    

    Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Description of the report generator.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to add to the report generator.

    
    
• On success, responds with CreateLicenseManagerReportGeneratorOutput with field(s):
  • license_manager_report_generator_arn(Option<String>):

    The Amazon Resource Name (ARN) of the new report generator.

• On failure, responds with SdkError<CreateLicenseManagerReportGeneratorError>

impl Client

pub fn create_license_version(&self) -> CreateLicenseVersionFluentBuilder

Constructs a fluent builder for the CreateLicenseVersion operation.

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

    Amazon Resource Name (ARN) of the license.

    
    
  • license_name(impl Into<String>) / set_license_name(Option<String>):
    required: true
    

    License name.

    
    
  • product_name(impl Into<String>) / set_product_name(Option<String>):
    required: true
    

    Product name.

    
    
  • issuer(Issuer) / set_issuer(Option<Issuer>):
    required: true
    

    License issuer.

    
    
  • home_region(impl Into<String>) / set_home_region(Option<String>):
    required: true
    

    Home Region of the license.

    
    
  • validity(DatetimeRange) / set_validity(Option<DatetimeRange>):
    required: true
    

    Date and time range during which the license is valid, in ISO8601-UTC format.

    
    
  • license_metadata(Metadata) / set_license_metadata(Option<Vec::<Metadata>>):
    required: false
    

    Information about the license.

    
    
  • entitlements(Entitlement) / set_entitlements(Option<Vec::<Entitlement>>):
    required: true
    

    License entitlements.

    
    
  • consumption_configuration(ConsumptionConfiguration) / set_consumption_configuration(Option<ConsumptionConfiguration>):
    required: true
    

    Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

    
    
  • status(LicenseStatus) / set_status(Option<LicenseStatus>):
    required: true
    

    License status.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • source_version(impl Into<String>) / set_source_version(Option<String>):
    required: false
    

    Current version of the license.

    
    
• On success, responds with CreateLicenseVersionOutput with field(s):
  • license_arn(Option<String>):

    License ARN.

  • version(Option<String>):

    New version of the license.

  • status(Option<LicenseStatus>):

    License status.

• On failure, responds with SdkError<CreateLicenseVersionError>

impl Client

pub fn create_token(&self) -> CreateTokenFluentBuilder

Constructs a fluent builder for the CreateToken operation.

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

    Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.

    
    
  • role_arns(impl Into<String>) / set_role_arns(Option<Vec::<String>>):
    required: false
    

    Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.

    
    
  • expiration_in_days(i32) / set_expiration_in_days(Option<i32>):
    required: false
    

    Token expiration, in days, counted from token creation. The default is 365 days.

    
    
  • token_properties(impl Into<String>) / set_token_properties(Option<Vec::<String>>):
    required: false
    

    Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    Idempotency token, valid for 10 minutes.

    
    
• On success, responds with CreateTokenOutput with field(s):
  • token_id(Option<String>):

    Token ID.

  • token_type(Option<TokenType>):

    Token type.

  • token(Option<String>):

    Refresh token, encoded as a JWT token.

• On failure, responds with SdkError<CreateTokenError>

impl Client

pub fn delete_grant(&self) -> DeleteGrantFluentBuilder

Constructs a fluent builder for the DeleteGrant operation.

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

    Amazon Resource Name (ARN) of the grant.

    
    
  • status_reason(impl Into<String>) / set_status_reason(Option<String>):
    required: false
    

    The Status reason for the delete request.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: true
    

    Current version of the grant.

    
    
• On success, responds with DeleteGrantOutput with field(s):
  • grant_arn(Option<String>):

    Grant ARN.

  • status(Option<GrantStatus>):

    Grant status.

  • version(Option<String>):

    Grant version.

• On failure, responds with SdkError<DeleteGrantError>

impl Client

pub fn delete_license(&self) -> DeleteLicenseFluentBuilder

Constructs a fluent builder for the DeleteLicense operation.

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

    Amazon Resource Name (ARN) of the license.

    
    
  • source_version(impl Into<String>) / set_source_version(Option<String>):
    required: true
    

    Current version of the license.

    
    
• On success, responds with DeleteLicenseOutput with field(s):
  • status(Option<LicenseDeletionStatus>):

    License status.

  • deletion_date(Option<String>):

    Date when the license is deleted.

• On failure, responds with SdkError<DeleteLicenseError>

impl Client

pub fn delete_license_configuration( &self, ) -> DeleteLicenseConfigurationFluentBuilder

Constructs a fluent builder for the DeleteLicenseConfiguration operation.

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

    ID of the license configuration.

    
    
• On success, responds with DeleteLicenseConfigurationOutput
• On failure, responds with SdkError<DeleteLicenseConfigurationError>

impl Client

pub fn delete_license_manager_report_generator( &self, ) -> DeleteLicenseManagerReportGeneratorFluentBuilder

Constructs a fluent builder for the DeleteLicenseManagerReportGenerator operation.

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

    Amazon Resource Name (ARN) of the report generator to be deleted.

    
    
• On success, responds with DeleteLicenseManagerReportGeneratorOutput
• On failure, responds with SdkError<DeleteLicenseManagerReportGeneratorError>

impl Client

pub fn delete_token(&self) -> DeleteTokenFluentBuilder

Constructs a fluent builder for the DeleteToken operation.

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

    Token ID.

    
    
• On success, responds with DeleteTokenOutput
• On failure, responds with SdkError<DeleteTokenError>

impl Client

pub fn extend_license_consumption( &self, ) -> ExtendLicenseConsumptionFluentBuilder

Constructs a fluent builder for the ExtendLicenseConsumption operation.

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

    License consumption token.

    
    
  • dry_run(bool) / set_dry_run(Option<bool>):
    required: false
    

    Checks whether you have the required permissions for the action, without actually making the request. Provides an error response if you do not have the required permissions.

    
    
• On success, responds with ExtendLicenseConsumptionOutput with field(s):
  • license_consumption_token(Option<String>):

    License consumption token.

  • expiration(Option<String>):

    Date and time at which the license consumption expires.

• On failure, responds with SdkError<ExtendLicenseConsumptionError>

impl Client

pub fn get_access_token(&self) -> GetAccessTokenFluentBuilder

Constructs a fluent builder for the GetAccessToken operation.

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

    Refresh token, encoded as a JWT token.

    
    
  • token_properties(impl Into<String>) / set_token_properties(Option<Vec::<String>>):
    required: false
    

    Token properties to validate against those present in the JWT token.

    
    
• On success, responds with GetAccessTokenOutput with field(s):
  • access_token(Option<String>):

    Temporary access token.

• On failure, responds with SdkError<GetAccessTokenError>

impl Client

pub fn get_grant(&self) -> GetGrantFluentBuilder

Constructs a fluent builder for the GetGrant operation.

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

    Amazon Resource Name (ARN) of the grant.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    Grant version.

    
    
• On success, responds with GetGrantOutput with field(s):
  • grant(Option<Grant>):

    Grant details.

• On failure, responds with SdkError<GetGrantError>

impl Client

pub fn get_license(&self) -> GetLicenseFluentBuilder

Constructs a fluent builder for the GetLicense operation.

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

    Amazon Resource Name (ARN) of the license.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    License version.

    
    
• On success, responds with GetLicenseOutput with field(s):
  • license(Option<License>):

    License details.

• On failure, responds with SdkError<GetLicenseError>

impl Client

pub fn get_license_configuration(&self) -> GetLicenseConfigurationFluentBuilder

Constructs a fluent builder for the GetLicenseConfiguration operation.

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

    Amazon Resource Name (ARN) of the license configuration.

    
    
• On success, responds with GetLicenseConfigurationOutput with field(s):
  • license_configuration_id(Option<String>):

    Unique ID for the license configuration.

  • license_configuration_arn(Option<String>):

    Amazon Resource Name (ARN) of the license configuration.

  • name(Option<String>):

    Name of the license configuration.

  • description(Option<String>):

    Description of the license configuration.

  • license_counting_type(Option<LicenseCountingType>):

    Dimension for which the licenses are counted.

  • license_rules(Option<Vec::<String>>):

    License rules.

  • license_count(Option<i64>):

    Number of available licenses.

  • license_count_hard_limit(Option<bool>):

    Sets the number of available licenses as a hard limit.

  • consumed_licenses(Option<i64>):

    Number of licenses assigned to resources.

  • status(Option<String>):

    License configuration status.

  • owner_account_id(Option<String>):

    Account ID of the owner of the license configuration.

  • consumed_license_summary_list(Option<Vec::<ConsumedLicenseSummary>>):

    Summaries of the licenses consumed by resources.

  • managed_resource_summary_list(Option<Vec::<ManagedResourceSummary>>):

    Summaries of the managed resources.

  • tags(Option<Vec::<Tag>>):

    Tags for the license configuration.

  • product_information_list(Option<Vec::<ProductInformation>>):

    Product information.

  • automated_discovery_information(Option<AutomatedDiscoveryInformation>):

    Automated discovery information.

  • disassociate_when_not_found(Option<bool>):

    When true, disassociates a resource when software is uninstalled.

• On failure, responds with SdkError<GetLicenseConfigurationError>

impl Client

pub fn get_license_conversion_task( &self, ) -> GetLicenseConversionTaskFluentBuilder

Constructs a fluent builder for the GetLicenseConversionTask operation.

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

    ID of the license type conversion task to retrieve information on.

    
    
• On success, responds with GetLicenseConversionTaskOutput with field(s):
  • license_conversion_task_id(Option<String>):

    ID of the license type conversion task.

  • resource_arn(Option<String>):

    Amazon Resource Names (ARN) of the resources the license conversion task is associated with.

  • source_license_context(Option<LicenseConversionContext>):

    Information about the license type converted from.

  • destination_license_context(Option<LicenseConversionContext>):

    Information about the license type converted to.

  • status_message(Option<String>):

    The status message for the conversion task.

  • status(Option<LicenseConversionTaskStatus>):

    Status of the license type conversion task.

  • start_time(Option<DateTime>):

    Time at which the license type conversion task was started .

  • license_conversion_time(Option<DateTime>):

    Amount of time to complete the license type conversion.

  • end_time(Option<DateTime>):

    Time at which the license type conversion task was completed.

• On failure, responds with SdkError<GetLicenseConversionTaskError>

impl Client

pub fn get_license_manager_report_generator( &self, ) -> GetLicenseManagerReportGeneratorFluentBuilder

Constructs a fluent builder for the GetLicenseManagerReportGenerator operation.

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

    Amazon Resource Name (ARN) of the report generator.

    
    
• On success, responds with GetLicenseManagerReportGeneratorOutput with field(s):
  • report_generator(Option<ReportGenerator>):

    A report generator that creates periodic reports about your license configurations.

• On failure, responds with SdkError<GetLicenseManagerReportGeneratorError>

impl Client

pub fn get_license_usage(&self) -> GetLicenseUsageFluentBuilder

Constructs a fluent builder for the GetLicenseUsage operation.

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

    Amazon Resource Name (ARN) of the license.

    
    
• On success, responds with GetLicenseUsageOutput with field(s):
  • license_usage(Option<LicenseUsage>):

    License usage details.

• On failure, responds with SdkError<GetLicenseUsageError>

impl Client

pub fn get_service_settings(&self) -> GetServiceSettingsFluentBuilder

Constructs a fluent builder for the GetServiceSettings operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetServiceSettingsOutput with field(s):
  • s3_bucket_arn(Option<String>):

    Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.

  • sns_topic_arn(Option<String>):

    SNS topic configured to receive notifications from License Manager.

  • organization_configuration(Option<OrganizationConfiguration>):

    Indicates whether Organizations is integrated with License Manager for cross-account discovery.

  • enable_cross_accounts_discovery(Option<bool>):

    Indicates whether cross-account discovery is enabled.

  • license_manager_resource_share_arn(Option<String>):

    Amazon Resource Name (ARN) of the resource share. The License Manager management account provides member accounts with access to this share.

• On failure, responds with SdkError<GetServiceSettingsError>

impl Client

pub fn list_associations_for_license_configuration( &self, ) -> ListAssociationsForLicenseConfigurationFluentBuilder

Constructs a fluent builder for the ListAssociationsForLicenseConfiguration operation.

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

    Amazon Resource Name (ARN) of a license configuration.

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

    Maximum number of results to return in a single call.

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

    Token for the next set of results.

    
    
• On success, responds with ListAssociationsForLicenseConfigurationOutput with field(s):
  • license_configuration_associations(Option<Vec::<LicenseConfigurationAssociation>>):

    Information about the associations for the license configuration.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListAssociationsForLicenseConfigurationError>

impl Client

pub fn list_distributed_grants(&self) -> ListDistributedGrantsFluentBuilder

Constructs a fluent builder for the ListDistributedGrants operation.

• The fluent builder is configurable:
  • grant_arns(impl Into<String>) / set_grant_arns(Option<Vec::<String>>):
    required: false
    

    Amazon Resource Names (ARNs) of the grants.

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

    Filters to scope the results. The following filters are supported:

    • LicenseArn

    • GrantStatus

    • GranteePrincipalARN

    • ProductSKU

    • LicenseIssuerName

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

    Token for the next set of results.

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

    Maximum number of results to return in a single call.

    
    
• On success, responds with ListDistributedGrantsOutput with field(s):
  • grants(Option<Vec::<Grant>>):

    Distributed grant details.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListDistributedGrantsError>

impl Client

pub fn list_failures_for_license_configuration_operations( &self, ) -> ListFailuresForLicenseConfigurationOperationsFluentBuilder

Constructs a fluent builder for the ListFailuresForLicenseConfigurationOperations operation.

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

    Amazon Resource Name of the license configuration.

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

    Maximum number of results to return in a single call.

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

    Token for the next set of results.

    
    
• On success, responds with ListFailuresForLicenseConfigurationOperationsOutput with field(s):
  • license_operation_failure_list(Option<Vec::<LicenseOperationFailure>>):

    License configuration operations that failed.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListFailuresForLicenseConfigurationOperationsError>

impl Client

pub fn list_license_configurations( &self, ) -> ListLicenseConfigurationsFluentBuilder

Constructs a fluent builder for the ListLicenseConfigurations operation.

• The fluent builder is configurable:
  • license_configuration_arns(impl Into<String>) / set_license_configuration_arns(Option<Vec::<String>>):
    required: false
    

    Amazon Resource Names (ARN) of the license configurations.

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

    Maximum number of results to return in a single call.

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

    Token for the next set of results.

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

    Filters to scope the results. The following filters and logical operators are supported:

    • licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket.

    • enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used.

    • usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded.

    
    
• On success, responds with ListLicenseConfigurationsOutput with field(s):
  • license_configurations(Option<Vec::<LicenseConfiguration>>):

    Information about the license configurations.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListLicenseConfigurationsError>

impl Client

pub fn list_license_conversion_tasks( &self, ) -> ListLicenseConversionTasksFluentBuilder

Constructs a fluent builder for the ListLicenseConversionTasks operation.

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

    Token for the next set of results.

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

    Maximum number of results to return in a single call.

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

    Filters to scope the results. Valid filters are ResourceArns and Status.

    
    
• On success, responds with ListLicenseConversionTasksOutput with field(s):
  • license_conversion_tasks(Option<Vec::<LicenseConversionTask>>):

    Information about the license configuration tasks for your account.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListLicenseConversionTasksError>

impl Client

pub fn list_license_manager_report_generators( &self, ) -> ListLicenseManagerReportGeneratorsFluentBuilder

Constructs a fluent builder for the ListLicenseManagerReportGenerators operation.

• The fluent builder is configurable:
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Filters to scope the results. The following filters are supported:

    • LicenseConfigurationArn

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

    Token for the next set of results.

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

    Maximum number of results to return in a single call.

    
    
• On success, responds with ListLicenseManagerReportGeneratorsOutput with field(s):
  • report_generators(Option<Vec::<ReportGenerator>>):

    A report generator that creates periodic reports about your license configurations.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListLicenseManagerReportGeneratorsError>

impl Client

pub fn list_license_specifications_for_resource( &self, ) -> ListLicenseSpecificationsForResourceFluentBuilder

Constructs a fluent builder for the ListLicenseSpecificationsForResource operation.

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

    Amazon Resource Name (ARN) of a resource that has an associated license configuration.

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

    Maximum number of results to return in a single call.

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

    Token for the next set of results.

    
    
• On success, responds with ListLicenseSpecificationsForResourceOutput with field(s):
  • license_specifications(Option<Vec::<LicenseSpecification>>):

    License configurations associated with a resource.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListLicenseSpecificationsForResourceError>

impl Client

pub fn list_license_versions(&self) -> ListLicenseVersionsFluentBuilder

Constructs a fluent builder for the ListLicenseVersions operation.

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

    Amazon Resource Name (ARN) of the license.

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

    Token for the next set of results.

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

    Maximum number of results to return in a single call.

    
    
• On success, responds with ListLicenseVersionsOutput with field(s):
  • licenses(Option<Vec::<License>>):

    License details.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListLicenseVersionsError>

impl Client

pub fn list_licenses(&self) -> ListLicensesFluentBuilder

Constructs a fluent builder for the ListLicenses operation.

• The fluent builder is configurable:
  • license_arns(impl Into<String>) / set_license_arns(Option<Vec::<String>>):
    required: false
    

    Amazon Resource Names (ARNs) of the licenses.

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

    Filters to scope the results. The following filters are supported:

    • Beneficiary

    • ProductSKU

    • Fingerprint

    • Status

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

    Token for the next set of results.

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

    Maximum number of results to return in a single call.

    
    
• On success, responds with ListLicensesOutput with field(s):
  • licenses(Option<Vec::<License>>):

    License details.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListLicensesError>

impl Client

pub fn list_received_grants(&self) -> ListReceivedGrantsFluentBuilder

Constructs a fluent builder for the ListReceivedGrants operation.

• The fluent builder is configurable:
  • grant_arns(impl Into<String>) / set_grant_arns(Option<Vec::<String>>):
    required: false
    

    Amazon Resource Names (ARNs) of the grants.

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

    Filters to scope the results. The following filters are supported:

    • ProductSKU

    • LicenseIssuerName

    • LicenseArn

    • GrantStatus

    • GranterAccountId

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

    Token for the next set of results.

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

    Maximum number of results to return in a single call.

    
    
• On success, responds with ListReceivedGrantsOutput with field(s):
  • grants(Option<Vec::<Grant>>):

    Received grant details.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListReceivedGrantsError>

impl Client

pub fn list_received_grants_for_organization( &self, ) -> ListReceivedGrantsForOrganizationFluentBuilder

Constructs a fluent builder for the ListReceivedGrantsForOrganization operation.

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

    The Amazon Resource Name (ARN) of the received license.

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

    Filters to scope the results. The following filters are supported:

    • ParentArn

    • GranteePrincipalArn

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

    Token for the next set of results.

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

    Maximum number of results to return in a single call.

    
    
• On success, responds with ListReceivedGrantsForOrganizationOutput with field(s):
  • grants(Option<Vec::<Grant>>):

    Lists the grants the organization has received.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListReceivedGrantsForOrganizationError>

impl Client

pub fn list_received_licenses(&self) -> ListReceivedLicensesFluentBuilder

Constructs a fluent builder for the ListReceivedLicenses operation.

• The fluent builder is configurable:
  • license_arns(impl Into<String>) / set_license_arns(Option<Vec::<String>>):
    required: false
    

    Amazon Resource Names (ARNs) of the licenses.

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

    Filters to scope the results. The following filters are supported:

    • ProductSKU

    • Status

    • Fingerprint

    • IssuerName

    • Beneficiary

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

    Token for the next set of results.

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

    Maximum number of results to return in a single call.

    
    
• On success, responds with ListReceivedLicensesOutput with field(s):
  • licenses(Option<Vec::<GrantedLicense>>):

    Received license details.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListReceivedLicensesError>

impl Client

pub fn list_received_licenses_for_organization( &self, ) -> ListReceivedLicensesForOrganizationFluentBuilder

Constructs a fluent builder for the ListReceivedLicensesForOrganization operation.

• The fluent builder is configurable:
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Filters to scope the results. The following filters are supported:

    • Beneficiary

    • ProductSKU

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

    Token for the next set of results.

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

    Maximum number of results to return in a single call.

    
    
• On success, responds with ListReceivedLicensesForOrganizationOutput with field(s):
  • licenses(Option<Vec::<GrantedLicense>>):

    Lists the licenses the organization has received.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListReceivedLicensesForOrganizationError>

impl Client

pub fn list_resource_inventory(&self) -> ListResourceInventoryFluentBuilder

Constructs a fluent builder for the ListResourceInventory operation.

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

    Maximum number of results to return in a single call.

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

    Token for the next set of results.

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

    Filters to scope the results. The following filters and logical operators are supported:

    • account_id - The ID of the Amazon Web Services account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.

    • application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH.

    • license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS. Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

    • platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH.

    • resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS.

    • tag: - The key/value combination of a tag assigned to the resource. Logical operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).

    
    
• On success, responds with ListResourceInventoryOutput with field(s):
  • resource_inventory_list(Option<Vec::<ResourceInventory>>):

    Information about the resources.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListResourceInventoryError>

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
    

    Amazon Resource Name (ARN) of the resource.

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

    Information about the tags.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_tokens(&self) -> ListTokensFluentBuilder

Constructs a fluent builder for the ListTokens operation.

• The fluent builder is configurable:
  • token_ids(impl Into<String>) / set_token_ids(Option<Vec::<String>>):
    required: false
    

    Token IDs.

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

    Filters to scope the results. The following filter is supported:

    • LicenseArns

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

    Token for the next set of results.

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

    Maximum number of results to return in a single call.

    
    
• On success, responds with ListTokensOutput with field(s):
  • tokens(Option<Vec::<TokenData>>):

    Received token details.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListTokensError>

impl Client

pub fn list_usage_for_license_configuration( &self, ) -> ListUsageForLicenseConfigurationFluentBuilder

Constructs a fluent builder for the ListUsageForLicenseConfiguration operation.

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

    Amazon Resource Name (ARN) of the license configuration.

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

    Maximum number of results to return in a single call.

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

    Token for the next set of results.

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

    Filters to scope the results. The following filters and logical operators are supported:

    • resourceArn - The ARN of the license configuration resource.

    • resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE).

    • resourceAccount - The ID of the account that owns the resource.

    
    
• On success, responds with ListUsageForLicenseConfigurationOutput with field(s):
  • license_configuration_usage_list(Option<Vec::<LicenseConfigurationUsage>>):

    Information about the license configurations.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListUsageForLicenseConfigurationError>

impl Client

pub fn reject_grant(&self) -> RejectGrantFluentBuilder

Constructs a fluent builder for the RejectGrant operation.

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

    Amazon Resource Name (ARN) of the grant.

    
    
• On success, responds with RejectGrantOutput with field(s):
  • grant_arn(Option<String>):

    Grant ARN.

  • status(Option<GrantStatus>):

    Grant status.

  • version(Option<String>):

    Grant version.

• On failure, responds with SdkError<RejectGrantError>

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
    

    Amazon Resource Name (ARN) of the resource. The following examples provide an example ARN for each supported resource in License Manager:

    • Licenses - arn:aws:license-manager::111122223333:license:l-EXAMPLE2da7646d6861033667f20e895

    • Grants - arn:aws:license-manager::111122223333:grant:g-EXAMPLE7b19f4a0ab73679b0beb52707

    • License configurations - arn:aws:license-manager:us-east-1:111122223333:license-configuration:lic-EXAMPLE6a788d4c8acd4264ff0ecf2ed2d

    • Report generators - arn:aws:license-manager:us-east-1:111122223333:report-generator:r-EXAMPLE825b4a4f8fe5a3e0c88824e5fc6

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    One or more tags.

    
    
• 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
    

    Amazon Resource Name (ARN) of the resource.

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

    Keys identifying the tags to remove.

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

impl Client

pub fn update_license_configuration( &self, ) -> UpdateLicenseConfigurationFluentBuilder

Constructs a fluent builder for the UpdateLicenseConfiguration operation.

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

    Amazon Resource Name (ARN) of the license configuration.

    
    
  • license_configuration_status(LicenseConfigurationStatus) / set_license_configuration_status(Option<LicenseConfigurationStatus>):
    required: false
    

    New status of the license configuration.

    
    
  • license_rules(impl Into<String>) / set_license_rules(Option<Vec::<String>>):
    required: false
    

    New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.

    
    
  • license_count(i64) / set_license_count(Option<i64>):
    required: false
    

    New number of licenses managed by the license configuration.

    
    
  • license_count_hard_limit(bool) / set_license_count_hard_limit(Option<bool>):
    required: false
    

    New hard limit of the number of available licenses.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    New name of the license configuration.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    New description of the license configuration.

    
    
  • product_information_list(ProductInformation) / set_product_information_list(Option<Vec::<ProductInformation>>):
    required: false
    

    New product information.

    
    
  • disassociate_when_not_found(bool) / set_disassociate_when_not_found(Option<bool>):
    required: false
    

    When true, disassociates a resource when software is uninstalled.

    
    
• On success, responds with UpdateLicenseConfigurationOutput
• On failure, responds with SdkError<UpdateLicenseConfigurationError>

impl Client

pub fn update_license_manager_report_generator( &self, ) -> UpdateLicenseManagerReportGeneratorFluentBuilder

Constructs a fluent builder for the UpdateLicenseManagerReportGenerator operation.

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

    Amazon Resource Name (ARN) of the report generator to update.

    
    
  • report_generator_name(impl Into<String>) / set_report_generator_name(Option<String>):
    required: true
    

    Name of the report generator.

    
    
  • r#type(ReportType) / set_type(Option<Vec::<ReportType>>):
    required: true
    

    Type of reports to generate. The following report types are supported:

    • License configuration report - Reports the number and details of consumed licenses for a license configuration.

    • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

    
    
  • report_context(ReportContext) / set_report_context(Option<ReportContext>):
    required: true
    

    The report context.

    
    
  • report_frequency(ReportFrequency) / set_report_frequency(Option<ReportFrequency>):
    required: true
    

    Frequency by which reports are generated.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Description of the report generator.

    
    
• On success, responds with UpdateLicenseManagerReportGeneratorOutput
• On failure, responds with SdkError<UpdateLicenseManagerReportGeneratorError>

impl Client

pub fn update_license_specifications_for_resource( &self, ) -> UpdateLicenseSpecificationsForResourceFluentBuilder

Constructs a fluent builder for the UpdateLicenseSpecificationsForResource operation.

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

    Amazon Resource Name (ARN) of the Amazon Web Services resource.

    
    
  • add_license_specifications(LicenseSpecification) / set_add_license_specifications(Option<Vec::<LicenseSpecification>>):
    required: false
    

    ARNs of the license configurations to add.

    
    
  • remove_license_specifications(LicenseSpecification) / set_remove_license_specifications(Option<Vec::<LicenseSpecification>>):
    required: false
    

    ARNs of the license configurations to remove.

    
    
• On success, responds with UpdateLicenseSpecificationsForResourceOutput
• On failure, responds with SdkError<UpdateLicenseSpecificationsForResourceError>

impl Client

pub fn update_service_settings(&self) -> UpdateServiceSettingsFluentBuilder

Constructs a fluent builder for the UpdateServiceSettings operation.

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

    Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.

    
    
  • sns_topic_arn(impl Into<String>) / set_sns_topic_arn(Option<String>):
    required: false
    

    Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.

    
    
  • organization_configuration(OrganizationConfiguration) / set_organization_configuration(Option<OrganizationConfiguration>):
    required: false
    

    Enables integration with Organizations for cross-account discovery.

    
    
  • enable_cross_accounts_discovery(bool) / set_enable_cross_accounts_discovery(Option<bool>):
    required: false
    

    Activates cross-account discovery.

    
    
• On success, responds with UpdateServiceSettingsOutput
• On failure, responds with SdkError<UpdateServiceSettingsError>

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.