Struct aws_sdk_licensemanagerlinuxsubscriptions::Client

pub struct Client { /* private fields */ }

Client for AWS License Manager Linux Subscriptions

Client for invoking operations on AWS License Manager Linux Subscriptions. Each operation on AWS License Manager Linux 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_licensemanagerlinuxsubscriptions::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 Config 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_licensemanagerlinuxsubscriptions::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 ListLinuxSubscriptionInstances operation has a Client::list_linux_subscription_instances, 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.list_linux_subscription_instances()
    .next_token("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 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):
  • linux_subscriptions_discovery(Option<LinuxSubscriptionsDiscovery>):

    Lists if discovery has been enabled for Linux subscriptions.

  • linux_subscriptions_discovery_settings(Option<LinuxSubscriptionsDiscoverySettings>):

    Lists the settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.

  • status(Option<Status>):

    Indicates the status of Linux subscriptions settings being applied.

  • status_message(Option<HashMap::<String, String>>):

    A message which details the Linux subscriptions service settings current status.

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

    The Region in which License Manager displays the aggregated data for Linux subscriptions.

• On failure, responds with SdkError<GetServiceSettingsError>

impl Client

pub fn list_linux_subscription_instances( &self ) -> ListLinuxSubscriptionInstancesFluentBuilder

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

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

    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. For example, you can filter by the name of AmiID with an optional operator to see subscriptions that match, partially match, or don’t match a certain Amazon Machine Image (AMI) ID.

    The valid names for this filter are:

    • AmiID

    • InstanceID

    • AccountID

    • Status

    • Region

    • UsageOperation

    • ProductCode

    • InstanceType

    The valid Operators for this filter are:

    • contains

    • equals

    • Notequal

    
    
  • 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 ListLinuxSubscriptionInstancesOutput with field(s):
  • instances(Option<Vec::<Instance>>):

    An array that contains instance objects.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListLinuxSubscriptionInstancesError>

impl Client

pub fn list_linux_subscriptions(&self) -> ListLinuxSubscriptionsFluentBuilder

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

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

    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. For example, you can filter by the name of Subscription with an optional operator to see subscriptions that match, partially match, or don’t match a certain subscription’s name.

    The valid names for this filter are:

    • Subscription

    The valid Operators for this filter are:

    • contains

    • equals

    • Notequal

    
    
  • 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 ListLinuxSubscriptionsOutput with field(s):
  • subscriptions(Option<Vec::<Subscription>>):

    An array that contains subscription objects.

  • next_token(Option<String>):

    Token for the next set of results.

• On failure, responds with SdkError<ListLinuxSubscriptionsError>

impl Client

pub fn update_service_settings(&self) -> UpdateServiceSettingsFluentBuilder

Constructs a fluent builder for the UpdateServiceSettings operation.

• The fluent builder is configurable:
  • linux_subscriptions_discovery(LinuxSubscriptionsDiscovery) / set_linux_subscriptions_discovery(Option<LinuxSubscriptionsDiscovery>):
    required: true
    

    Describes if the discovery of Linux subscriptions is enabled.

    
    
  • linux_subscriptions_discovery_settings(LinuxSubscriptionsDiscoverySettings) / set_linux_subscriptions_discovery_settings(Option<LinuxSubscriptionsDiscoverySettings>):
    required: true
    

    The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.

    
    
  • allow_update(bool) / set_allow_update(Option<bool>):
    required: false
    

    Describes if updates are allowed to the service settings for Linux subscriptions. If you allow updates, you can aggregate Linux subscription data in more than one home Region.

    
    
• On success, responds with UpdateServiceSettingsOutput with field(s):
  • linux_subscriptions_discovery(Option<LinuxSubscriptionsDiscovery>):

    Lists if discovery has been enabled for Linux subscriptions.

  • linux_subscriptions_discovery_settings(Option<LinuxSubscriptionsDiscoverySettings>):

    The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.

  • status(Option<Status>):

    Indicates the status of Linux subscriptions settings being applied.

  • status_message(Option<HashMap::<String, String>>):

    A message which details the Linux subscriptions service settings current status.

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

    The Region in which License Manager displays the aggregated data for Linux subscriptions.

• 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 copy 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.