pub struct Client { /* private fields */ }
Expand description

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 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_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§

source§

impl Client

source

pub fn accept_grant(&self) -> AcceptGrantFluentBuilder

Constructs a fluent builder for the AcceptGrant operation.

source§

impl Client

source

pub fn check_in_license(&self) -> CheckInLicenseFluentBuilder

Constructs a fluent builder for the CheckInLicense operation.

source§

impl Client

source

pub fn checkout_borrow_license(&self) -> CheckoutBorrowLicenseFluentBuilder

Constructs a fluent builder for the CheckoutBorrowLicense operation.

source§

impl Client

source

pub fn checkout_license(&self) -> CheckoutLicenseFluentBuilder

Constructs a fluent builder for the CheckoutLicense operation.

source§

impl Client

source

pub fn create_grant(&self) -> CreateGrantFluentBuilder

Constructs a fluent builder for the CreateGrant operation.

source§

impl Client

source

pub fn create_grant_version(&self) -> CreateGrantVersionFluentBuilder

Constructs a fluent builder for the CreateGrantVersion operation.

source§

impl Client

source

pub fn create_license(&self) -> CreateLicenseFluentBuilder

Constructs a fluent builder for the CreateLicense operation.

source§

impl Client

source

pub fn create_license_configuration( &self ) -> CreateLicenseConfigurationFluentBuilder

Constructs a fluent builder for the CreateLicenseConfiguration operation.

source§

impl Client

source

pub fn create_license_conversion_task_for_resource( &self ) -> CreateLicenseConversionTaskForResourceFluentBuilder

Constructs a fluent builder for the CreateLicenseConversionTaskForResource operation.

source§

impl Client

source

pub fn create_license_manager_report_generator( &self ) -> CreateLicenseManagerReportGeneratorFluentBuilder

Constructs a fluent builder for the CreateLicenseManagerReportGenerator operation.

source§

impl Client

source

pub fn create_license_version(&self) -> CreateLicenseVersionFluentBuilder

Constructs a fluent builder for the CreateLicenseVersion operation.

source§

impl Client

source

pub fn create_token(&self) -> CreateTokenFluentBuilder

Constructs a fluent builder for the CreateToken operation.

source§

impl Client

source

pub fn delete_grant(&self) -> DeleteGrantFluentBuilder

Constructs a fluent builder for the DeleteGrant operation.

source§

impl Client

source

pub fn delete_license(&self) -> DeleteLicenseFluentBuilder

Constructs a fluent builder for the DeleteLicense operation.

source§

impl Client

source

pub fn delete_license_configuration( &self ) -> DeleteLicenseConfigurationFluentBuilder

Constructs a fluent builder for the DeleteLicenseConfiguration operation.

source§

impl Client

source

pub fn delete_license_manager_report_generator( &self ) -> DeleteLicenseManagerReportGeneratorFluentBuilder

Constructs a fluent builder for the DeleteLicenseManagerReportGenerator operation.

source§

impl Client

source

pub fn delete_token(&self) -> DeleteTokenFluentBuilder

Constructs a fluent builder for the DeleteToken operation.

source§

impl Client

source

pub fn extend_license_consumption( &self ) -> ExtendLicenseConsumptionFluentBuilder

Constructs a fluent builder for the ExtendLicenseConsumption operation.

source§

impl Client

source

pub fn get_access_token(&self) -> GetAccessTokenFluentBuilder

Constructs a fluent builder for the GetAccessToken operation.

source§

impl Client

source

pub fn get_grant(&self) -> GetGrantFluentBuilder

Constructs a fluent builder for the GetGrant operation.

source§

impl Client

source

pub fn get_license(&self) -> GetLicenseFluentBuilder

Constructs a fluent builder for the GetLicense operation.

source§

impl Client

source

pub fn get_license_configuration(&self) -> GetLicenseConfigurationFluentBuilder

Constructs a fluent builder for the GetLicenseConfiguration operation.

source§

impl Client

source

pub fn get_license_conversion_task( &self ) -> GetLicenseConversionTaskFluentBuilder

Constructs a fluent builder for the GetLicenseConversionTask operation.

source§

impl Client

source

pub fn get_license_manager_report_generator( &self ) -> GetLicenseManagerReportGeneratorFluentBuilder

Constructs a fluent builder for the GetLicenseManagerReportGenerator operation.

source§

impl Client

source

pub fn get_license_usage(&self) -> GetLicenseUsageFluentBuilder

Constructs a fluent builder for the GetLicenseUsage operation.

source§

impl Client

source

pub fn get_service_settings(&self) -> GetServiceSettingsFluentBuilder

Constructs a fluent builder for the GetServiceSettings operation.

source§

impl Client

source

pub fn list_associations_for_license_configuration( &self ) -> ListAssociationsForLicenseConfigurationFluentBuilder

Constructs a fluent builder for the ListAssociationsForLicenseConfiguration operation.

source§

impl Client

source

pub fn list_distributed_grants(&self) -> ListDistributedGrantsFluentBuilder

Constructs a fluent builder for the ListDistributedGrants operation.

source§

impl Client

source

pub fn list_failures_for_license_configuration_operations( &self ) -> ListFailuresForLicenseConfigurationOperationsFluentBuilder

Constructs a fluent builder for the ListFailuresForLicenseConfigurationOperations operation.

source§

impl Client

source

pub fn list_license_configurations( &self ) -> ListLicenseConfigurationsFluentBuilder

Constructs a fluent builder for the ListLicenseConfigurations operation.

source§

impl Client

source

pub fn list_license_conversion_tasks( &self ) -> ListLicenseConversionTasksFluentBuilder

Constructs a fluent builder for the ListLicenseConversionTasks operation.

source§

impl Client

source

pub fn list_license_manager_report_generators( &self ) -> ListLicenseManagerReportGeneratorsFluentBuilder

Constructs a fluent builder for the ListLicenseManagerReportGenerators operation.

source§

impl Client

source

pub fn list_license_specifications_for_resource( &self ) -> ListLicenseSpecificationsForResourceFluentBuilder

Constructs a fluent builder for the ListLicenseSpecificationsForResource operation.

source§

impl Client

source

pub fn list_license_versions(&self) -> ListLicenseVersionsFluentBuilder

Constructs a fluent builder for the ListLicenseVersions operation.

source§

impl Client

source

pub fn list_licenses(&self) -> ListLicensesFluentBuilder

Constructs a fluent builder for the ListLicenses operation.

source§

impl Client

source

pub fn list_received_grants(&self) -> ListReceivedGrantsFluentBuilder

Constructs a fluent builder for the ListReceivedGrants operation.

source§

impl Client

source

pub fn list_received_grants_for_organization( &self ) -> ListReceivedGrantsForOrganizationFluentBuilder

Constructs a fluent builder for the ListReceivedGrantsForOrganization operation.

source§

impl Client

source

pub fn list_received_licenses(&self) -> ListReceivedLicensesFluentBuilder

Constructs a fluent builder for the ListReceivedLicenses operation.

source§

impl Client

source

pub fn list_received_licenses_for_organization( &self ) -> ListReceivedLicensesForOrganizationFluentBuilder

Constructs a fluent builder for the ListReceivedLicensesForOrganization operation.

source§

impl Client

source

pub fn list_resource_inventory(&self) -> ListResourceInventoryFluentBuilder

Constructs a fluent builder for the ListResourceInventory operation.

source§

impl Client

source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

source§

impl Client

source

pub fn list_tokens(&self) -> ListTokensFluentBuilder

Constructs a fluent builder for the ListTokens operation.

source§

impl Client

source

pub fn list_usage_for_license_configuration( &self ) -> ListUsageForLicenseConfigurationFluentBuilder

Constructs a fluent builder for the ListUsageForLicenseConfiguration operation.

source§

impl Client

source

pub fn reject_grant(&self) -> RejectGrantFluentBuilder

Constructs a fluent builder for the RejectGrant operation.

source§

impl Client

source

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

source§

impl Client

source

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

source§

impl Client

source

pub fn update_license_configuration( &self ) -> UpdateLicenseConfigurationFluentBuilder

Constructs a fluent builder for the UpdateLicenseConfiguration operation.

source§

impl Client

source

pub fn update_license_manager_report_generator( &self ) -> UpdateLicenseManagerReportGeneratorFluentBuilder

Constructs a fluent builder for the UpdateLicenseManagerReportGenerator operation.

source§

impl Client

source§

impl Client

source

pub fn update_service_settings(&self) -> UpdateServiceSettingsFluentBuilder

Constructs a fluent builder for the UpdateServiceSettings operation.

source§

impl Client

source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic if the conf has retry or timeouts enabled without a sleep_impl. If you experience this panic, it can be fixed by setting the sleep_impl, or by disabling retries and timeouts.

source

pub fn config(&self) -> &Config

Returns the client’s configuration.

source§

impl Client

source

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.

Trait Implementations§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more