Struct Client

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

Client for Amazon AppStream

Client for invoking operations on Amazon AppStream. Each operation on Amazon AppStream 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_appstream::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_appstream::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 AssociateAppBlockBuilderAppBlock operation has a Client::associate_app_block_builder_app_block, 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_app_block_builder_app_block()
    .app_block_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.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations§

Source§

impl Client

Source

pub fn associate_app_block_builder_app_block( &self, ) -> AssociateAppBlockBuilderAppBlockFluentBuilder

Constructs a fluent builder for the AssociateAppBlockBuilderAppBlock operation.

Source§

impl Client

Source

pub fn associate_application_fleet( &self, ) -> AssociateApplicationFleetFluentBuilder

Constructs a fluent builder for the AssociateApplicationFleet operation.

Source§

impl Client

Source

pub fn associate_application_to_entitlement( &self, ) -> AssociateApplicationToEntitlementFluentBuilder

Constructs a fluent builder for the AssociateApplicationToEntitlement operation.

Source§

impl Client

Source

pub fn associate_fleet(&self) -> AssociateFleetFluentBuilder

Constructs a fluent builder for the AssociateFleet operation.

Source§

impl Client

Source

pub fn batch_associate_user_stack(&self) -> BatchAssociateUserStackFluentBuilder

Constructs a fluent builder for the BatchAssociateUserStack operation.

Source§

impl Client

Source

pub fn batch_disassociate_user_stack( &self, ) -> BatchDisassociateUserStackFluentBuilder

Constructs a fluent builder for the BatchDisassociateUserStack operation.

Source§

impl Client

Source

pub fn copy_image(&self) -> CopyImageFluentBuilder

Constructs a fluent builder for the CopyImage operation.

Source§

impl Client

Source

pub fn create_app_block(&self) -> CreateAppBlockFluentBuilder

Constructs a fluent builder for the CreateAppBlock operation.

Source§

impl Client

Source

pub fn create_app_block_builder(&self) -> CreateAppBlockBuilderFluentBuilder

Constructs a fluent builder for the CreateAppBlockBuilder operation.

Source§

impl Client

Source

pub fn create_app_block_builder_streaming_url( &self, ) -> CreateAppBlockBuilderStreamingURLFluentBuilder

Constructs a fluent builder for the CreateAppBlockBuilderStreamingURL operation.

Source§

impl Client

Source

pub fn create_application(&self) -> CreateApplicationFluentBuilder

Constructs a fluent builder for the CreateApplication operation.

Source§

impl Client

Source

pub fn create_directory_config(&self) -> CreateDirectoryConfigFluentBuilder

Constructs a fluent builder for the CreateDirectoryConfig operation.

Source§

impl Client

Source

pub fn create_entitlement(&self) -> CreateEntitlementFluentBuilder

Constructs a fluent builder for the CreateEntitlement operation.

Source§

impl Client

Source

pub fn create_fleet(&self) -> CreateFleetFluentBuilder

Constructs a fluent builder for the CreateFleet operation.

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

      A unique name for the fleet.


    • image_name(impl Into<String>) / set_image_name(Option<String>):
      required: false

      The name of the image used to create the fleet.


    • image_arn(impl Into<String>) / set_image_arn(Option<String>):
      required: false

      The ARN of the public, private, or shared image to use.


    • instance_type(impl Into<String>) / set_instance_type(Option<String>):
      required: true

      The instance type to use when launching fleet instances. The following instance types are available:

      • stream.standard.small

      • stream.standard.medium

      • stream.standard.large

      • stream.standard.xlarge

      • stream.standard.2xlarge

      • stream.compute.large

      • stream.compute.xlarge

      • stream.compute.2xlarge

      • stream.compute.4xlarge

      • stream.compute.8xlarge

      • stream.memory.large

      • stream.memory.xlarge

      • stream.memory.2xlarge

      • stream.memory.4xlarge

      • stream.memory.8xlarge

      • stream.memory.z1d.large

      • stream.memory.z1d.xlarge

      • stream.memory.z1d.2xlarge

      • stream.memory.z1d.3xlarge

      • stream.memory.z1d.6xlarge

      • stream.memory.z1d.12xlarge

      • stream.graphics-design.large

      • stream.graphics-design.xlarge

      • stream.graphics-design.2xlarge

      • stream.graphics-design.4xlarge

      • stream.graphics-desktop.2xlarge

      • stream.graphics.g4dn.xlarge

      • stream.graphics.g4dn.2xlarge

      • stream.graphics.g4dn.4xlarge

      • stream.graphics.g4dn.8xlarge

      • stream.graphics.g4dn.12xlarge

      • stream.graphics.g4dn.16xlarge

      • stream.graphics.g5.xlarge

      • stream.graphics.g5.2xlarge

      • stream.graphics.g5.4xlarge

      • stream.graphics.g5.8xlarge

      • stream.graphics.g5.12xlarge

      • stream.graphics.g5.16xlarge

      • stream.graphics.g5.24xlarge

      • stream.graphics-pro.4xlarge

      • stream.graphics-pro.8xlarge

      • stream.graphics-pro.16xlarge

      The following instance types are available for Elastic fleets:

      • stream.standard.small

      • stream.standard.medium

      • stream.standard.large

      • stream.standard.xlarge

      • stream.standard.2xlarge


    • fleet_type(FleetType) / set_fleet_type(Option<FleetType>):
      required: false

      The fleet type.

      ALWAYS_ON

      Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

      ON_DEMAND

      Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.


    • compute_capacity(ComputeCapacity) / set_compute_capacity(Option<ComputeCapacity>):
      required: false

      The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.


    • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
      required: false

      The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.


    • max_user_duration_in_seconds(i32) / set_max_user_duration_in_seconds(Option<i32>):
      required: false

      The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

      Specify a value between 600 and 432000.


    • disconnect_timeout_in_seconds(i32) / set_disconnect_timeout_in_seconds(Option<i32>):
      required: false

      The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

      Specify a value between 60 and 36000.


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

      The description to display.


    • display_name(impl Into<String>) / set_display_name(Option<String>):
      required: false

      The fleet name to display.


    • enable_default_internet_access(bool) / set_enable_default_internet_access(Option<bool>):
      required: false

      Enables or disables default internet access for the fleet.


    • domain_join_info(DomainJoinInfo) / set_domain_join_info(Option<DomainJoinInfo>):
      required: false

      The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.


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

      The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

      If you do not specify a value, the value is set to an empty string.

      Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

      _ . : / = + \ - @

      For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.


    • idle_disconnect_timeout_in_seconds(i32) / set_idle_disconnect_timeout_in_seconds(Option<i32>):
      required: false

      The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

      To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.

      If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don’t do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.


    • iam_role_arn(impl Into<String>) / set_iam_role_arn(Option<String>):
      required: false

      The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

      For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.


    • stream_view(StreamView) / set_stream_view(Option<StreamView>):
      required: false

      The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

      The default value is APP.


    • platform(PlatformType) / set_platform(Option<PlatformType>):
      required: false

      The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.


    • max_concurrent_sessions(i32) / set_max_concurrent_sessions(Option<i32>):
      required: false

      The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.


    • usb_device_filter_strings(impl Into<String>) / set_usb_device_filter_strings(Option<Vec::<String>>):
      required: false

      The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.


    • session_script_s3_location(S3Location) / set_session_script_s3_location(Option<S3Location>):
      required: false

      The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.


    • max_sessions_per_instance(i32) / set_max_sessions_per_instance(Option<i32>):
      required: false

      The maximum number of user sessions on an instance. This only applies to multi-session fleets.


  • On success, responds with CreateFleetOutput with field(s):
  • On failure, responds with SdkError<CreateFleetError>
Source§

impl Client

Source

pub fn create_image_builder(&self) -> CreateImageBuilderFluentBuilder

Constructs a fluent builder for the CreateImageBuilder operation.

Source§

impl Client

Source

pub fn create_image_builder_streaming_url( &self, ) -> CreateImageBuilderStreamingURLFluentBuilder

Constructs a fluent builder for the CreateImageBuilderStreamingURL operation.

Source§

impl Client

Source

pub fn create_stack(&self) -> CreateStackFluentBuilder

Constructs a fluent builder for the CreateStack operation.

Source§

impl Client

Source

pub fn create_streaming_url(&self) -> CreateStreamingURLFluentBuilder

Constructs a fluent builder for the CreateStreamingURL operation.

Source§

impl Client

Source

pub fn create_theme_for_stack(&self) -> CreateThemeForStackFluentBuilder

Constructs a fluent builder for the CreateThemeForStack operation.

Source§

impl Client

Source

pub fn create_updated_image(&self) -> CreateUpdatedImageFluentBuilder

Constructs a fluent builder for the CreateUpdatedImage operation.

Source§

impl Client

Source

pub fn create_usage_report_subscription( &self, ) -> CreateUsageReportSubscriptionFluentBuilder

Constructs a fluent builder for the CreateUsageReportSubscription operation.

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

      The Amazon S3 bucket where generated reports are stored.

      If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven’t already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.

    • schedule(Option<UsageReportSchedule>):

      The schedule for generating usage reports.

  • On failure, responds with SdkError<CreateUsageReportSubscriptionError>
Source§

impl Client

Source

pub fn create_user(&self) -> CreateUserFluentBuilder

Constructs a fluent builder for the CreateUser operation.

Source§

impl Client

Source

pub fn delete_app_block(&self) -> DeleteAppBlockFluentBuilder

Constructs a fluent builder for the DeleteAppBlock operation.

Source§

impl Client

Source

pub fn delete_app_block_builder(&self) -> DeleteAppBlockBuilderFluentBuilder

Constructs a fluent builder for the DeleteAppBlockBuilder operation.

Source§

impl Client

Source

pub fn delete_application(&self) -> DeleteApplicationFluentBuilder

Constructs a fluent builder for the DeleteApplication operation.

Source§

impl Client

Source

pub fn delete_directory_config(&self) -> DeleteDirectoryConfigFluentBuilder

Constructs a fluent builder for the DeleteDirectoryConfig operation.

Source§

impl Client

Source

pub fn delete_entitlement(&self) -> DeleteEntitlementFluentBuilder

Constructs a fluent builder for the DeleteEntitlement operation.

Source§

impl Client

Source

pub fn delete_fleet(&self) -> DeleteFleetFluentBuilder

Constructs a fluent builder for the DeleteFleet operation.

Source§

impl Client

Source

pub fn delete_image(&self) -> DeleteImageFluentBuilder

Constructs a fluent builder for the DeleteImage operation.

Source§

impl Client

Source

pub fn delete_image_builder(&self) -> DeleteImageBuilderFluentBuilder

Constructs a fluent builder for the DeleteImageBuilder operation.

Source§

impl Client

Source

pub fn delete_image_permissions(&self) -> DeleteImagePermissionsFluentBuilder

Constructs a fluent builder for the DeleteImagePermissions operation.

Source§

impl Client

Source

pub fn delete_stack(&self) -> DeleteStackFluentBuilder

Constructs a fluent builder for the DeleteStack operation.

Source§

impl Client

Source

pub fn delete_theme_for_stack(&self) -> DeleteThemeForStackFluentBuilder

Constructs a fluent builder for the DeleteThemeForStack operation.

Source§

impl Client

Source

pub fn delete_usage_report_subscription( &self, ) -> DeleteUsageReportSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteUsageReportSubscription operation.

Source§

impl Client

Source

pub fn delete_user(&self) -> DeleteUserFluentBuilder

Constructs a fluent builder for the DeleteUser operation.

Source§

impl Client

Source

pub fn describe_app_block_builder_app_block_associations( &self, ) -> DescribeAppBlockBuilderAppBlockAssociationsFluentBuilder

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

Source§

impl Client

Source

pub fn describe_app_block_builders( &self, ) -> DescribeAppBlockBuildersFluentBuilder

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

Source§

impl Client

Source

pub fn describe_app_blocks(&self) -> DescribeAppBlocksFluentBuilder

Constructs a fluent builder for the DescribeAppBlocks operation.

Source§

impl Client

Source

pub fn describe_application_fleet_associations( &self, ) -> DescribeApplicationFleetAssociationsFluentBuilder

Constructs a fluent builder for the DescribeApplicationFleetAssociations operation.

Source§

impl Client

Source

pub fn describe_applications(&self) -> DescribeApplicationsFluentBuilder

Constructs a fluent builder for the DescribeApplications operation.

Source§

impl Client

Source

pub fn describe_directory_configs( &self, ) -> DescribeDirectoryConfigsFluentBuilder

Constructs a fluent builder for the DescribeDirectoryConfigs operation.

Source§

impl Client

Source

pub fn describe_entitlements(&self) -> DescribeEntitlementsFluentBuilder

Constructs a fluent builder for the DescribeEntitlements operation.

Source§

impl Client

Source

pub fn describe_fleets(&self) -> DescribeFleetsFluentBuilder

Constructs a fluent builder for the DescribeFleets operation.

Source§

impl Client

Source

pub fn describe_image_builders(&self) -> DescribeImageBuildersFluentBuilder

Constructs a fluent builder for the DescribeImageBuilders operation.

Source§

impl Client

Source

pub fn describe_image_permissions( &self, ) -> DescribeImagePermissionsFluentBuilder

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

Source§

impl Client

Source

pub fn describe_images(&self) -> DescribeImagesFluentBuilder

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

Source§

impl Client

Source

pub fn describe_sessions(&self) -> DescribeSessionsFluentBuilder

Constructs a fluent builder for the DescribeSessions operation.

Source§

impl Client

Source

pub fn describe_stacks(&self) -> DescribeStacksFluentBuilder

Constructs a fluent builder for the DescribeStacks operation.

Source§

impl Client

Source

pub fn describe_theme_for_stack(&self) -> DescribeThemeForStackFluentBuilder

Constructs a fluent builder for the DescribeThemeForStack operation.

Source§

impl Client

Source

pub fn describe_usage_report_subscriptions( &self, ) -> DescribeUsageReportSubscriptionsFluentBuilder

Constructs a fluent builder for the DescribeUsageReportSubscriptions operation.

Source§

impl Client

Source

pub fn describe_user_stack_associations( &self, ) -> DescribeUserStackAssociationsFluentBuilder

Constructs a fluent builder for the DescribeUserStackAssociations operation.

Source§

impl Client

Source

pub fn describe_users(&self) -> DescribeUsersFluentBuilder

Constructs a fluent builder for the DescribeUsers operation.

Source§

impl Client

Source

pub fn disable_user(&self) -> DisableUserFluentBuilder

Constructs a fluent builder for the DisableUser operation.

Source§

impl Client

Source

pub fn disassociate_app_block_builder_app_block( &self, ) -> DisassociateAppBlockBuilderAppBlockFluentBuilder

Constructs a fluent builder for the DisassociateAppBlockBuilderAppBlock operation.

Source§

impl Client

Source

pub fn disassociate_application_fleet( &self, ) -> DisassociateApplicationFleetFluentBuilder

Constructs a fluent builder for the DisassociateApplicationFleet operation.

Source§

impl Client

Source

pub fn disassociate_application_from_entitlement( &self, ) -> DisassociateApplicationFromEntitlementFluentBuilder

Constructs a fluent builder for the DisassociateApplicationFromEntitlement operation.

Source§

impl Client

Source

pub fn disassociate_fleet(&self) -> DisassociateFleetFluentBuilder

Constructs a fluent builder for the DisassociateFleet operation.

Source§

impl Client

Source

pub fn enable_user(&self) -> EnableUserFluentBuilder

Constructs a fluent builder for the EnableUser operation.

Source§

impl Client

Source

pub fn expire_session(&self) -> ExpireSessionFluentBuilder

Constructs a fluent builder for the ExpireSession operation.

Source§

impl Client

Source

pub fn list_associated_fleets(&self) -> ListAssociatedFleetsFluentBuilder

Constructs a fluent builder for the ListAssociatedFleets operation.

Source§

impl Client

Source

pub fn list_associated_stacks(&self) -> ListAssociatedStacksFluentBuilder

Constructs a fluent builder for the ListAssociatedStacks operation.

Source§

impl Client

Source

pub fn list_entitled_applications( &self, ) -> ListEntitledApplicationsFluentBuilder

Constructs a fluent builder for the ListEntitledApplications 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 start_app_block_builder(&self) -> StartAppBlockBuilderFluentBuilder

Constructs a fluent builder for the StartAppBlockBuilder operation.

Source§

impl Client

Source

pub fn start_fleet(&self) -> StartFleetFluentBuilder

Constructs a fluent builder for the StartFleet operation.

Source§

impl Client

Source

pub fn start_image_builder(&self) -> StartImageBuilderFluentBuilder

Constructs a fluent builder for the StartImageBuilder operation.

Source§

impl Client

Source

pub fn stop_app_block_builder(&self) -> StopAppBlockBuilderFluentBuilder

Constructs a fluent builder for the StopAppBlockBuilder operation.

Source§

impl Client

Source

pub fn stop_fleet(&self) -> StopFleetFluentBuilder

Constructs a fluent builder for the StopFleet operation.

Source§

impl Client

Source

pub fn stop_image_builder(&self) -> StopImageBuilderFluentBuilder

Constructs a fluent builder for the StopImageBuilder 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_app_block_builder(&self) -> UpdateAppBlockBuilderFluentBuilder

Constructs a fluent builder for the UpdateAppBlockBuilder operation.

Source§

impl Client

Source

pub fn update_application(&self) -> UpdateApplicationFluentBuilder

Constructs a fluent builder for the UpdateApplication operation.

Source§

impl Client

Source

pub fn update_directory_config(&self) -> UpdateDirectoryConfigFluentBuilder

Constructs a fluent builder for the UpdateDirectoryConfig operation.

Source§

impl Client

Source

pub fn update_entitlement(&self) -> UpdateEntitlementFluentBuilder

Constructs a fluent builder for the UpdateEntitlement operation.

Source§

impl Client

Source

pub fn update_fleet(&self) -> UpdateFleetFluentBuilder

Constructs a fluent builder for the UpdateFleet operation.

Source§

impl Client

Source

pub fn update_image_permissions(&self) -> UpdateImagePermissionsFluentBuilder

Constructs a fluent builder for the UpdateImagePermissions operation.

Source§

impl Client

Source

pub fn update_stack(&self) -> UpdateStackFluentBuilder

Constructs a fluent builder for the UpdateStack operation.

Source§

impl Client

Source

pub fn update_theme_for_stack(&self) -> UpdateThemeForStackFluentBuilder

Constructs a fluent builder for the UpdateThemeForStack 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 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.

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

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate 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
Source§

impl Waiters for Client

Auto Trait Implementations§

§

impl Freeze for Client

§

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 T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 T
where 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
Source§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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

impl<T> ErasedDestructor for T
where T: 'static,