Struct aws_sdk_appstream::Client

pub struct Client { /* private fields */ }

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

impl Client

pub fn associate_app_block_builder_app_block( &self ) -> AssociateAppBlockBuilderAppBlockFluentBuilder

Constructs a fluent builder for the AssociateAppBlockBuilderAppBlock operation.

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

    The ARN of the app block.

    
    
  • app_block_builder_name(impl Into<String>) / set_app_block_builder_name(Option<String>):
    required: true
    

    The name of the app block builder.

    
    
• On success, responds with AssociateAppBlockBuilderAppBlockOutput with field(s):
  • app_block_builder_app_block_association(Option<AppBlockBuilderAppBlockAssociation>):

    The list of app block builders associated with app blocks.

• On failure, responds with SdkError<AssociateAppBlockBuilderAppBlockError>

impl Client

pub fn associate_application_fleet( &self ) -> AssociateApplicationFleetFluentBuilder

Constructs a fluent builder for the AssociateApplicationFleet operation.

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

    The name of the fleet.

    
    
  • application_arn(impl Into<String>) / set_application_arn(Option<String>):
    required: true
    

    The ARN of the application.

    
    
• On success, responds with AssociateApplicationFleetOutput with field(s):
  • application_fleet_association(Option<ApplicationFleetAssociation>):

    If fleet name is specified, this returns the list of applications that are associated to it. If application ARN is specified, this returns the list of fleets to which it is associated.

• On failure, responds with SdkError<AssociateApplicationFleetError>

impl Client

pub fn associate_application_to_entitlement( &self ) -> AssociateApplicationToEntitlementFluentBuilder

Constructs a fluent builder for the AssociateApplicationToEntitlement operation.

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

    The name of the stack.

    
    
  • entitlement_name(impl Into<String>) / set_entitlement_name(Option<String>):
    required: true
    

    The name of the entitlement.

    
    
  • application_identifier(impl Into<String>) / set_application_identifier(Option<String>):
    required: true
    

    The identifier of the application.

    
    
• On success, responds with AssociateApplicationToEntitlementOutput
• On failure, responds with SdkError<AssociateApplicationToEntitlementError>

impl Client

pub fn associate_fleet(&self) -> AssociateFleetFluentBuilder

Constructs a fluent builder for the AssociateFleet operation.

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

    The name of the fleet.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name of the stack.

    
    
• On success, responds with AssociateFleetOutput
• On failure, responds with SdkError<AssociateFleetError>

impl Client

pub fn batch_associate_user_stack(&self) -> BatchAssociateUserStackFluentBuilder

Constructs a fluent builder for the BatchAssociateUserStack operation.

• The fluent builder is configurable:
  • user_stack_associations(UserStackAssociation) / set_user_stack_associations(Option<Vec::<UserStackAssociation>>):
    required: true
    

    The list of UserStackAssociation objects.

    
    
• On success, responds with BatchAssociateUserStackOutput with field(s):
  • errors(Option<Vec::<UserStackAssociationError>>):

    The list of UserStackAssociationError objects.

• On failure, responds with SdkError<BatchAssociateUserStackError>

impl Client

pub fn batch_disassociate_user_stack( &self ) -> BatchDisassociateUserStackFluentBuilder

Constructs a fluent builder for the BatchDisassociateUserStack operation.

• The fluent builder is configurable:
  • user_stack_associations(UserStackAssociation) / set_user_stack_associations(Option<Vec::<UserStackAssociation>>):
    required: true
    

    The list of UserStackAssociation objects.

    
    
• On success, responds with BatchDisassociateUserStackOutput with field(s):
  • errors(Option<Vec::<UserStackAssociationError>>):

    The list of UserStackAssociationError objects.

• On failure, responds with SdkError<BatchDisassociateUserStackError>

impl Client

pub fn copy_image(&self) -> CopyImageFluentBuilder

Constructs a fluent builder for the CopyImage operation.

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

    The name of the image to copy.

    
    
  • destination_image_name(impl Into<String>) / set_destination_image_name(Option<String>):
    required: true
    

    The name that the image will have when it is copied to the destination.

    
    
  • destination_region(impl Into<String>) / set_destination_region(Option<String>):
    required: true
    

    The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.

    
    
  • destination_image_description(impl Into<String>) / set_destination_image_description(Option<String>):
    required: false
    

    The description that the image will have when it is copied to the destination.

    
    
• On success, responds with CopyImageOutput with field(s):
  • destination_image_name(Option<String>):

    The name of the destination image.

• On failure, responds with SdkError<CopyImageError>

impl Client

pub fn create_app_block(&self) -> CreateAppBlockFluentBuilder

Constructs a fluent builder for the CreateAppBlock operation.

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

    The name of the app block.

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

    The description of the app block.

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

    The display name of the app block. This is not displayed to the user.

    
    
  • source_s3_location(S3Location) / set_source_s3_location(Option<S3Location>):
    required: true
    

    The source S3 location of the app block.

    
    
  • setup_script_details(ScriptDetails) / set_setup_script_details(Option<ScriptDetails>):
    required: false
    

    The setup script details of the app block. This must be provided for the CUSTOM PackagingType.

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

    The tags assigned to the app block.

    
    
  • post_setup_script_details(ScriptDetails) / set_post_setup_script_details(Option<ScriptDetails>):
    required: false
    

    The post setup script details of the app block. This can only be provided for the APPSTREAM2 PackagingType.

    
    
  • packaging_type(PackagingType) / set_packaging_type(Option<PackagingType>):
    required: false
    

    The packaging type of the app block.

    
    
• On success, responds with CreateAppBlockOutput with field(s):
  • app_block(Option<AppBlock>):

    The app block.

• On failure, responds with SdkError<CreateAppBlockError>

impl Client

pub fn create_app_block_builder(&self) -> CreateAppBlockBuilderFluentBuilder

Constructs a fluent builder for the CreateAppBlockBuilder operation.

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

    The unique name for the app block builder.

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

    The description of the app block builder.

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

    The display name of the app block builder.

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

    The tags to associate with the app block builder. 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.

    
    
  • platform(AppBlockBuilderPlatformType) / set_platform(Option<AppBlockBuilderPlatformType>):
    required: true
    

    The platform of the app block builder.

    WINDOWS_SERVER_2019 is the only valid value.

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

    The instance type to use when launching the app block builder. The following instance types are available:

    • stream.standard.small

    • stream.standard.medium

    • stream.standard.large

    • stream.standard.xlarge

    • stream.standard.2xlarge

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

    The VPC configuration for the app block builder.

    App block builders require that you specify at least two subnets in different availability zones.

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

    Enables or disables default internet access for the app block builder.

    
    
  • 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 app block builder. To assume a role, the app block builder 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.

    
    
  • access_endpoints(AccessEndpoint) / set_access_endpoints(Option<Vec::<AccessEndpoint>>):
    required: false
    

    The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.

    
    
• On success, responds with CreateAppBlockBuilderOutput with field(s):
  • app_block_builder(Option<AppBlockBuilder>):

    Describes an app block builder.

• On failure, responds with SdkError<CreateAppBlockBuilderError>

impl Client

pub fn create_app_block_builder_streaming_url( &self ) -> CreateAppBlockBuilderStreamingURLFluentBuilder

Constructs a fluent builder for the CreateAppBlockBuilderStreamingURL operation.

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

    The name of the app block builder.

    
    
  • validity(i64) / set_validity(Option<i64>):
    required: false
    

    The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

    
    
• On success, responds with CreateAppBlockBuilderStreamingUrlOutput with field(s):
  • streaming_url(Option<String>):

    The URL to start the streaming session.

  • expires(Option<DateTime>):

    The elapsed time, in seconds after the Unix epoch, when this URL expires.

• On failure, responds with SdkError<CreateAppBlockBuilderStreamingURLError>

impl Client

pub fn create_application(&self) -> CreateApplicationFluentBuilder

Constructs a fluent builder for the CreateApplication operation.

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

    The name of the application. This name is visible to users when display name is not specified.

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

    The display name of the application. This name is visible to users in the application catalog.

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

    The description of the application.

    
    
  • icon_s3_location(S3Location) / set_icon_s3_location(Option<S3Location>):
    required: true
    

    The location in S3 of the application icon.

    
    
  • launch_path(impl Into<String>) / set_launch_path(Option<String>):
    required: true
    

    The launch path of the application.

    
    
  • working_directory(impl Into<String>) / set_working_directory(Option<String>):
    required: false
    

    The working directory of the application.

    
    
  • launch_parameters(impl Into<String>) / set_launch_parameters(Option<String>):
    required: false
    

    The launch parameters of the application.

    
    
  • platforms(PlatformType) / set_platforms(Option<Vec::<PlatformType>>):
    required: true
    

    The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

    
    
  • instance_families(impl Into<String>) / set_instance_families(Option<Vec::<String>>):
    required: true
    

    The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.

    
    
  • app_block_arn(impl Into<String>) / set_app_block_arn(Option<String>):
    required: true
    

    The app block ARN to which the application should be associated

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

    The tags assigned to the application.

    
    
• On success, responds with CreateApplicationOutput with field(s):
  • application(Option<Application>):

    Describes an application in the application catalog.

• On failure, responds with SdkError<CreateApplicationError>

impl Client

pub fn create_directory_config(&self) -> CreateDirectoryConfigFluentBuilder

Constructs a fluent builder for the CreateDirectoryConfig operation.

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

    The fully qualified name of the directory (for example, corp.example.com).

    
    
  • organizational_unit_distinguished_names(impl Into<String>) / set_organizational_unit_distinguished_names(Option<Vec::<String>>):
    required: true
    

    The distinguished names of the organizational units for computer accounts.

    
    
  • service_account_credentials(ServiceAccountCredentials) / set_service_account_credentials(Option<ServiceAccountCredentials>):
    required: false
    

    The credentials for the service account used by the fleet or image builder to connect to the directory.

    
    
  • certificate_based_auth_properties(CertificateBasedAuthProperties) / set_certificate_based_auth_properties(Option<CertificateBasedAuthProperties>):
    required: false
    

    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

    
    
• On success, responds with CreateDirectoryConfigOutput with field(s):
  • directory_config(Option<DirectoryConfig>):

    Information about the directory configuration.

• On failure, responds with SdkError<CreateDirectoryConfigError>

impl Client

pub fn create_entitlement(&self) -> CreateEntitlementFluentBuilder

Constructs a fluent builder for the CreateEntitlement operation.

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

    The name of the entitlement.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name of the stack with which the entitlement is associated.

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

    The description of the entitlement.

    
    
  • app_visibility(AppVisibility) / set_app_visibility(Option<AppVisibility>):
    required: true
    

    Specifies whether all or selected apps are entitled.

    
    
  • attributes(EntitlementAttribute) / set_attributes(Option<Vec::<EntitlementAttribute>>):
    required: true
    

    The attributes of the entitlement.

    
    
• On success, responds with CreateEntitlementOutput with field(s):
  • entitlement(Option<Entitlement>):

    The entitlement.

• On failure, responds with SdkError<CreateEntitlementError>

impl Client

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-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 360000.

    
    
  • 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 3600. 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):
  • fleet(Option<Fleet>):

    Information about the fleet.

• On failure, responds with SdkError<CreateFleetError>

impl Client

pub fn create_image_builder(&self) -> CreateImageBuilderFluentBuilder

Constructs a fluent builder for the CreateImageBuilder operation.

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

    A unique name for the image builder.

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

    The name of the image used to create the image builder.

    
    
  • 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 the image builder. The following instance types are available:

    • stream.standard.small

    • stream.standard.medium

    • stream.standard.large

    • 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-pro.4xlarge

    • stream.graphics-pro.8xlarge

    • stream.graphics-pro.16xlarge

    
    
  • 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 image builder name to display.

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

    The VPC configuration for the image builder. You can specify only one subnet.

    
    
  • 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 image builder. To assume a role, the image builder 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.

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

    Enables or disables default internet access for the image builder.

    
    
  • 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 image builder to a Microsoft Active Directory domain.

    
    
  • appstream_agent_version(impl Into<String>) / set_appstream_agent_version(Option<String>):
    required: false
    

    The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

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

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

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

    _ . : / = + \ - @

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

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

    
    
  • access_endpoints(AccessEndpoint) / set_access_endpoints(Option<Vec::<AccessEndpoint>>):
    required: false
    

    The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

    
    
• On success, responds with CreateImageBuilderOutput with field(s):
  • image_builder(Option<ImageBuilder>):

    Information about the image builder.

• On failure, responds with SdkError<CreateImageBuilderError>

impl Client

pub fn create_image_builder_streaming_url( &self ) -> CreateImageBuilderStreamingURLFluentBuilder

Constructs a fluent builder for the CreateImageBuilderStreamingURL operation.

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

    The name of the image builder.

    
    
  • validity(i64) / set_validity(Option<i64>):
    required: false
    

    The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

    
    
• On success, responds with CreateImageBuilderStreamingUrlOutput with field(s):
  • streaming_url(Option<String>):

    The URL to start the AppStream 2.0 streaming session.

  • expires(Option<DateTime>):

    The elapsed time, in seconds after the Unix epoch, when this URL expires.

• On failure, responds with SdkError<CreateImageBuilderStreamingURLError>

impl Client

pub fn create_stack(&self) -> CreateStackFluentBuilder

Constructs a fluent builder for the CreateStack operation.

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

    The name of the stack.

    
    
  • 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 stack name to display.

    
    
  • storage_connectors(StorageConnector) / set_storage_connectors(Option<Vec::<StorageConnector>>):
    required: false
    

    The storage connectors to enable.

    
    
  • redirect_url(impl Into<String>) / set_redirect_url(Option<String>):
    required: false
    

    The URL that users are redirected to after their streaming session ends.

    
    
  • feedback_url(impl Into<String>) / set_feedback_url(Option<String>):
    required: false
    

    The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

    
    
  • user_settings(UserSetting) / set_user_settings(Option<Vec::<UserSetting>>):
    required: false
    

    The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

    
    
  • application_settings(ApplicationSettings) / set_application_settings(Option<ApplicationSettings>):
    required: false
    

    The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

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

    The tags to associate with the stack. 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 about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

    
    
  • access_endpoints(AccessEndpoint) / set_access_endpoints(Option<Vec::<AccessEndpoint>>):
    required: false
    

    The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

    
    
  • embed_host_domains(impl Into<String>) / set_embed_host_domains(Option<Vec::<String>>):
    required: false
    

    The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

    
    
  • streaming_experience_settings(StreamingExperienceSettings) / set_streaming_experience_settings(Option<StreamingExperienceSettings>):
    required: false
    

    The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

    
    
• On success, responds with CreateStackOutput with field(s):
  • stack(Option<Stack>):

    Information about the stack.

• On failure, responds with SdkError<CreateStackError>

impl Client

pub fn create_streaming_url(&self) -> CreateStreamingURLFluentBuilder

Constructs a fluent builder for the CreateStreamingURL operation.

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

    The name of the stack.

    
    
  • fleet_name(impl Into<String>) / set_fleet_name(Option<String>):
    required: true
    

    The name of the fleet.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user.

    
    
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: false
    

    The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant. If your fleet is enabled for the Desktop stream view, you can also choose to launch directly to the operating system desktop. To do so, specify Desktop.

    
    
  • validity(i64) / set_validity(Option<i64>):
    required: false
    

    The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.

    
    
  • session_context(impl Into<String>) / set_session_context(Option<String>):
    required: false
    

    The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.

    
    
• On success, responds with CreateStreamingUrlOutput with field(s):
  • streaming_url(Option<String>):

    The URL to start the AppStream 2.0 streaming session.

  • expires(Option<DateTime>):

    The elapsed time, in seconds after the Unix epoch, when this URL expires.

• On failure, responds with SdkError<CreateStreamingURLError>

impl Client

pub fn create_updated_image(&self) -> CreateUpdatedImageFluentBuilder

Constructs a fluent builder for the CreateUpdatedImage operation.

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

    The name of the image to update.

    
    
  • new_image_name(impl Into<String>) / set_new_image_name(Option<String>):
    required: true
    

    The name of the new image. The name must be unique within the AWS account and Region.

    
    
  • new_image_description(impl Into<String>) / set_new_image_description(Option<String>):
    required: false
    

    The description to display for the new image.

    
    
  • new_image_display_name(impl Into<String>) / set_new_image_display_name(Option<String>):
    required: false
    

    The name to display for the new image.

    
    
  • new_image_tags(impl Into<String>, impl Into<String>) / set_new_image_tags(Option<HashMap::<String, String>>):
    required: false
    

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

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

    _ . : / = + \ - @

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

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

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

    Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true, AppStream 2.0 displays whether image updates are available. If this value is set to false, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.

    
    
• On success, responds with CreateUpdatedImageOutput with field(s):
  • image(Option<Image>):

    Describes an image.

  • can_update_image(Option<bool>):

    Indicates whether a new image can be created.

• On failure, responds with SdkError<CreateUpdatedImageError>

impl Client

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>

impl Client

pub fn create_user(&self) -> CreateUserFluentBuilder

Constructs a fluent builder for the CreateUser operation.

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

    The email address of the user.

    Users’ email addresses are case-sensitive. During login, if they specify an email address that doesn’t use the same capitalization as the email address specified when their user pool account was created, a “user does not exist” error message displays.

    
    
  • message_action(MessageAction) / set_message_action(Option<MessageAction>):
    required: false
    

    The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.

    The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.

    
    
  • first_name(impl Into<String>) / set_first_name(Option<String>):
    required: false
    

    The first name, or given name, of the user.

    
    
  • last_name(impl Into<String>) / set_last_name(Option<String>):
    required: false
    

    The last name, or surname, of the user.

    
    
  • authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):
    required: true
    

    The authentication type for the user. You must specify USERPOOL.

    
    
• On success, responds with CreateUserOutput
• On failure, responds with SdkError<CreateUserError>

impl Client

pub fn delete_app_block(&self) -> DeleteAppBlockFluentBuilder

Constructs a fluent builder for the DeleteAppBlock operation.

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

    The name of the app block.

    
    
• On success, responds with DeleteAppBlockOutput
• On failure, responds with SdkError<DeleteAppBlockError>

impl Client

pub fn delete_app_block_builder(&self) -> DeleteAppBlockBuilderFluentBuilder

Constructs a fluent builder for the DeleteAppBlockBuilder operation.

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

    The name of the app block builder.

    
    
• On success, responds with DeleteAppBlockBuilderOutput
• On failure, responds with SdkError<DeleteAppBlockBuilderError>

impl Client

pub fn delete_application(&self) -> DeleteApplicationFluentBuilder

Constructs a fluent builder for the DeleteApplication operation.

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

    The name of the application.

    
    
• On success, responds with DeleteApplicationOutput
• On failure, responds with SdkError<DeleteApplicationError>

impl Client

pub fn delete_directory_config(&self) -> DeleteDirectoryConfigFluentBuilder

Constructs a fluent builder for the DeleteDirectoryConfig operation.

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

    The name of the directory configuration.

    
    
• On success, responds with DeleteDirectoryConfigOutput
• On failure, responds with SdkError<DeleteDirectoryConfigError>

impl Client

pub fn delete_entitlement(&self) -> DeleteEntitlementFluentBuilder

Constructs a fluent builder for the DeleteEntitlement operation.

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

    The name of the entitlement.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name of the stack with which the entitlement is associated.

    
    
• On success, responds with DeleteEntitlementOutput
• On failure, responds with SdkError<DeleteEntitlementError>

impl Client

pub fn delete_fleet(&self) -> DeleteFleetFluentBuilder

Constructs a fluent builder for the DeleteFleet operation.

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

    The name of the fleet.

    
    
• On success, responds with DeleteFleetOutput
• On failure, responds with SdkError<DeleteFleetError>

impl Client

pub fn delete_image(&self) -> DeleteImageFluentBuilder

Constructs a fluent builder for the DeleteImage operation.

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

    The name of the image.

    
    
• On success, responds with DeleteImageOutput with field(s):
  • image(Option<Image>):

    Information about the image.

• On failure, responds with SdkError<DeleteImageError>

impl Client

pub fn delete_image_builder(&self) -> DeleteImageBuilderFluentBuilder

Constructs a fluent builder for the DeleteImageBuilder operation.

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

    The name of the image builder.

    
    
• On success, responds with DeleteImageBuilderOutput with field(s):
  • image_builder(Option<ImageBuilder>):

    Information about the image builder.

• On failure, responds with SdkError<DeleteImageBuilderError>

impl Client

pub fn delete_image_permissions(&self) -> DeleteImagePermissionsFluentBuilder

Constructs a fluent builder for the DeleteImagePermissions operation.

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

    The name of the private image.

    
    
  • shared_account_id(impl Into<String>) / set_shared_account_id(Option<String>):
    required: true
    

    The 12-digit identifier of the AWS account for which to delete image permissions.

    
    
• On success, responds with DeleteImagePermissionsOutput
• On failure, responds with SdkError<DeleteImagePermissionsError>

impl Client

pub fn delete_stack(&self) -> DeleteStackFluentBuilder

Constructs a fluent builder for the DeleteStack operation.

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

    The name of the stack.

    
    
• On success, responds with DeleteStackOutput
• On failure, responds with SdkError<DeleteStackError>

impl Client

pub fn delete_usage_report_subscription( &self ) -> DeleteUsageReportSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteUsageReportSubscription operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteUsageReportSubscriptionOutput
• On failure, responds with SdkError<DeleteUsageReportSubscriptionError>

impl Client

pub fn delete_user(&self) -> DeleteUserFluentBuilder

Constructs a fluent builder for the DeleteUser operation.

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

    The email address of the user.

    Users’ email addresses are case-sensitive.

    
    
  • authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):
    required: true
    

    The authentication type for the user. You must specify USERPOOL.

    
    
• On success, responds with DeleteUserOutput
• On failure, responds with SdkError<DeleteUserError>

impl Client

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().

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

    The ARN of the app block.

    
    
  • app_block_builder_name(impl Into<String>) / set_app_block_builder_name(Option<String>):
    required: false
    

    The name of the app block builder.

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

    The maximum size of each page of results.

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

    The pagination token used to retrieve the next page of results for this operation.

    
    
• On success, responds with DescribeAppBlockBuilderAppBlockAssociationsOutput with field(s):
  • app_block_builder_app_block_associations(Option<Vec::<AppBlockBuilderAppBlockAssociation>>):

    This list of app block builders associated with app blocks.

  • next_token(Option<String>):

    The pagination token used to retrieve the next page of results for this operation.

• On failure, responds with SdkError<DescribeAppBlockBuilderAppBlockAssociationsError>

impl Client

pub fn describe_app_block_builders( &self ) -> DescribeAppBlockBuildersFluentBuilder

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

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

    The names of the app block builders.

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

    The pagination token used to retrieve the next page of results for this operation.

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

    The maximum size of each page of results. The maximum value is 25.

    
    
• On success, responds with DescribeAppBlockBuildersOutput with field(s):
  • app_block_builders(Option<Vec::<AppBlockBuilder>>):

    The list that describes one or more app block builders.

  • next_token(Option<String>):

    The pagination token used to retrieve the next page of results for this operation.

• On failure, responds with SdkError<DescribeAppBlockBuildersError>

impl Client

pub fn describe_app_blocks(&self) -> DescribeAppBlocksFluentBuilder

Constructs a fluent builder for the DescribeAppBlocks operation.

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

    The ARNs of the app blocks.

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

    The pagination token used to retrieve the next page of results for this operation.

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

    The maximum size of each page of results.

    
    
• On success, responds with DescribeAppBlocksOutput with field(s):
  • app_blocks(Option<Vec::<AppBlock>>):

    The app blocks in the list.

  • next_token(Option<String>):

    The pagination token used to retrieve the next page of results for this operation.

• On failure, responds with SdkError<DescribeAppBlocksError>

impl Client

pub fn describe_application_fleet_associations( &self ) -> DescribeApplicationFleetAssociationsFluentBuilder

Constructs a fluent builder for the DescribeApplicationFleetAssociations operation.

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

    The name of the fleet.

    
    
  • application_arn(impl Into<String>) / set_application_arn(Option<String>):
    required: false
    

    The ARN of the application.

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

    The maximum size of each page of results.

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

    The pagination token used to retrieve the next page of results for this operation.

    
    
• On success, responds with DescribeApplicationFleetAssociationsOutput with field(s):
  • application_fleet_associations(Option<Vec::<ApplicationFleetAssociation>>):

    The application fleet associations in the list.

  • next_token(Option<String>):

    The pagination token used to retrieve the next page of results for this operation.

• On failure, responds with SdkError<DescribeApplicationFleetAssociationsError>

impl Client

pub fn describe_applications(&self) -> DescribeApplicationsFluentBuilder

Constructs a fluent builder for the DescribeApplications operation.

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

    The ARNs for the applications.

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

    The pagination token used to retrieve the next page of results for this operation.

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

    The maximum size of each page of results.

    
    
• On success, responds with DescribeApplicationsOutput with field(s):
  • applications(Option<Vec::<Application>>):

    The applications in the list.

  • next_token(Option<String>):

    The pagination token used to retrieve the next page of results for this operation.

• On failure, responds with SdkError<DescribeApplicationsError>

impl Client

pub fn describe_directory_configs( &self ) -> DescribeDirectoryConfigsFluentBuilder

Constructs a fluent builder for the DescribeDirectoryConfigs operation.

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

    The directory names.

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

    The maximum size of each page of results.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    
    
• On success, responds with DescribeDirectoryConfigsOutput with field(s):
  • directory_configs(Option<Vec::<DirectoryConfig>>):

    Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<DescribeDirectoryConfigsError>

impl Client

pub fn describe_entitlements(&self) -> DescribeEntitlementsFluentBuilder

Constructs a fluent builder for the DescribeEntitlements operation.

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

    The name of the entitlement.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name of the stack with which the entitlement is associated.

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

    The pagination token used to retrieve the next page of results for this operation.

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

    The maximum size of each page of results.

    
    
• On success, responds with DescribeEntitlementsOutput with field(s):
  • entitlements(Option<Vec::<Entitlement>>):

    The entitlements.

  • next_token(Option<String>):

    The pagination token used to retrieve the next page of results for this operation.

• On failure, responds with SdkError<DescribeEntitlementsError>

impl Client

pub fn describe_fleets(&self) -> DescribeFleetsFluentBuilder

Constructs a fluent builder for the DescribeFleets operation.

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

    The names of the fleets to describe.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    
    
• On success, responds with DescribeFleetsOutput with field(s):
  • fleets(Option<Vec::<Fleet>>):

    Information about the fleets.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<DescribeFleetsError>

impl Client

pub fn describe_image_builders(&self) -> DescribeImageBuildersFluentBuilder

Constructs a fluent builder for the DescribeImageBuilders operation.

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

    The names of the image builders to describe.

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

    The maximum size of each page of results.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    
    
• On success, responds with DescribeImageBuildersOutput with field(s):
  • image_builders(Option<Vec::<ImageBuilder>>):

    Information about the image builders.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<DescribeImageBuildersError>

impl Client

pub fn describe_image_permissions( &self ) -> DescribeImagePermissionsFluentBuilder

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

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

    The name of the private image for which to describe permissions. The image must be one that you own.

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

    The maximum size of each page of results.

    
    
  • shared_aws_account_ids(impl Into<String>) / set_shared_aws_account_ids(Option<Vec::<String>>):
    required: false
    

    The 12-digit identifier of one or more AWS accounts with which the image is shared.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    
    
• On success, responds with DescribeImagePermissionsOutput with field(s):
  • name(Option<String>):

    The name of the private image.

  • shared_image_permissions_list(Option<Vec::<SharedImagePermissions>>):

    The permissions for a private image that you own.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<DescribeImagePermissionsError>

impl Client

pub fn describe_images(&self) -> DescribeImagesFluentBuilder

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

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

    The names of the public or private images to describe.

    
    
  • arns(impl Into<String>) / set_arns(Option<Vec::<String>>):
    required: false
    

    The ARNs of the public, private, and shared images to describe.

    
    
  • r#type(VisibilityType) / set_type(Option<VisibilityType>):
    required: false
    

    The type of image (public, private, or shared) to describe.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

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

    The maximum size of each page of results.

    
    
• On success, responds with DescribeImagesOutput with field(s):
  • images(Option<Vec::<Image>>):

    Information about the images.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<DescribeImagesError>

impl Client

pub fn describe_sessions(&self) -> DescribeSessionsFluentBuilder

Constructs a fluent builder for the DescribeSessions operation.

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

    The name of the stack. This value is case-sensitive.

    
    
  • fleet_name(impl Into<String>) / set_fleet_name(Option<String>):
    required: true
    

    The name of the fleet. This value is case-sensitive.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The size of each page of results. The default value is 20 and the maximum value is 50.

    
    
  • authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):
    required: false
    

    The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

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

    The identifier for the instance hosting the session.

    
    
• On success, responds with DescribeSessionsOutput with field(s):
  • sessions(Option<Vec::<Session>>):

    Information about the streaming sessions.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<DescribeSessionsError>

impl Client

pub fn describe_stacks(&self) -> DescribeStacksFluentBuilder

Constructs a fluent builder for the DescribeStacks operation.

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

    The names of the stacks to describe.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    
    
• On success, responds with DescribeStacksOutput with field(s):
  • stacks(Option<Vec::<Stack>>):

    Information about the stacks.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<DescribeStacksError>

impl Client

pub fn describe_usage_report_subscriptions( &self ) -> DescribeUsageReportSubscriptionsFluentBuilder

Constructs a fluent builder for the DescribeUsageReportSubscriptions operation.

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

    The maximum size of each page of results.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    
    
• On success, responds with DescribeUsageReportSubscriptionsOutput with field(s):
  • usage_report_subscriptions(Option<Vec::<UsageReportSubscription>>):

    Information about the usage report subscription.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<DescribeUsageReportSubscriptionsError>

impl Client

pub fn describe_user_stack_associations( &self ) -> DescribeUserStackAssociationsFluentBuilder

Constructs a fluent builder for the DescribeUserStackAssociations operation.

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

    The name of the stack that is associated with the user.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: false
    

    The email address of the user who is associated with the stack.

    Users’ email addresses are case-sensitive.

    
    
  • authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):
    required: false
    

    The authentication type for the user who is associated with the stack. You must specify USERPOOL.

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

    The maximum size of each page of results.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    
    
• On success, responds with DescribeUserStackAssociationsOutput with field(s):
  • user_stack_associations(Option<Vec::<UserStackAssociation>>):

    The UserStackAssociation objects.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<DescribeUserStackAssociationsError>

impl Client

pub fn describe_users(&self) -> DescribeUsersFluentBuilder

Constructs a fluent builder for the DescribeUsers operation.

• The fluent builder is configurable:
  • authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):
    required: true
    

    The authentication type for the users in the user pool to describe. You must specify USERPOOL.

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

    The maximum size of each page of results.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    
    
• On success, responds with DescribeUsersOutput with field(s):
  • users(Option<Vec::<User>>):

    Information about users in the user pool.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<DescribeUsersError>

impl Client

pub fn disable_user(&self) -> DisableUserFluentBuilder

Constructs a fluent builder for the DisableUser operation.

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

    The email address of the user.

    Users’ email addresses are case-sensitive.

    
    
  • authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):
    required: true
    

    The authentication type for the user. You must specify USERPOOL.

    
    
• On success, responds with DisableUserOutput
• On failure, responds with SdkError<DisableUserError>

impl Client

pub fn disassociate_app_block_builder_app_block( &self ) -> DisassociateAppBlockBuilderAppBlockFluentBuilder

Constructs a fluent builder for the DisassociateAppBlockBuilderAppBlock operation.

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

    The ARN of the app block.

    
    
  • app_block_builder_name(impl Into<String>) / set_app_block_builder_name(Option<String>):
    required: true
    

    The name of the app block builder.

    
    
• On success, responds with DisassociateAppBlockBuilderAppBlockOutput
• On failure, responds with SdkError<DisassociateAppBlockBuilderAppBlockError>

impl Client

pub fn disassociate_application_fleet( &self ) -> DisassociateApplicationFleetFluentBuilder

Constructs a fluent builder for the DisassociateApplicationFleet operation.

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

    The name of the fleet.

    
    
  • application_arn(impl Into<String>) / set_application_arn(Option<String>):
    required: true
    

    The ARN of the application.

    
    
• On success, responds with DisassociateApplicationFleetOutput
• On failure, responds with SdkError<DisassociateApplicationFleetError>

impl Client

pub fn disassociate_application_from_entitlement( &self ) -> DisassociateApplicationFromEntitlementFluentBuilder

Constructs a fluent builder for the DisassociateApplicationFromEntitlement operation.

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

    The name of the stack with which the entitlement is associated.

    
    
  • entitlement_name(impl Into<String>) / set_entitlement_name(Option<String>):
    required: true
    

    The name of the entitlement.

    
    
  • application_identifier(impl Into<String>) / set_application_identifier(Option<String>):
    required: true
    

    The identifier of the application to remove from the entitlement.

    
    
• On success, responds with DisassociateApplicationFromEntitlementOutput
• On failure, responds with SdkError<DisassociateApplicationFromEntitlementError>

impl Client

pub fn disassociate_fleet(&self) -> DisassociateFleetFluentBuilder

Constructs a fluent builder for the DisassociateFleet operation.

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

    The name of the fleet.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name of the stack.

    
    
• On success, responds with DisassociateFleetOutput
• On failure, responds with SdkError<DisassociateFleetError>

impl Client

pub fn enable_user(&self) -> EnableUserFluentBuilder

Constructs a fluent builder for the EnableUser operation.

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

    The email address of the user.

    Users’ email addresses are case-sensitive. During login, if they specify an email address that doesn’t use the same capitalization as the email address specified when their user pool account was created, a “user does not exist” error message displays.

    
    
  • authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):
    required: true
    

    The authentication type for the user. You must specify USERPOOL.

    
    
• On success, responds with EnableUserOutput
• On failure, responds with SdkError<EnableUserError>

impl Client

pub fn expire_session(&self) -> ExpireSessionFluentBuilder

Constructs a fluent builder for the ExpireSession operation.

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

    The identifier of the streaming session.

    
    
• On success, responds with ExpireSessionOutput
• On failure, responds with SdkError<ExpireSessionError>

impl Client

pub fn list_associated_fleets(&self) -> ListAssociatedFleetsFluentBuilder

Constructs a fluent builder for the ListAssociatedFleets operation.

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

    The name of the stack.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    
    
• On success, responds with ListAssociatedFleetsOutput with field(s):
  • names(Option<Vec::<String>>):

    The name of the fleet.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<ListAssociatedFleetsError>

impl Client

pub fn list_associated_stacks(&self) -> ListAssociatedStacksFluentBuilder

Constructs a fluent builder for the ListAssociatedStacks operation.

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

    The name of the fleet.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    
    
• On success, responds with ListAssociatedStacksOutput with field(s):
  • names(Option<Vec::<String>>):

    The name of the stack.

  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

• On failure, responds with SdkError<ListAssociatedStacksError>

impl Client

pub fn list_entitled_applications( &self ) -> ListEntitledApplicationsFluentBuilder

Constructs a fluent builder for the ListEntitledApplications operation.

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

    The name of the stack with which the entitlement is associated.

    
    
  • entitlement_name(impl Into<String>) / set_entitlement_name(Option<String>):
    required: true
    

    The name of the entitlement.

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

    The pagination token used to retrieve the next page of results for this operation.

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

    The maximum size of each page of results.

    
    
• On success, responds with ListEntitledApplicationsOutput with field(s):
  • entitled_applications(Option<Vec::<EntitledApplication>>):

    The entitled applications.

  • next_token(Option<String>):

    The pagination token used to retrieve the next page of results for this operation.

• On failure, responds with SdkError<ListEntitledApplicationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

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

    The information about the tags.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn start_app_block_builder(&self) -> StartAppBlockBuilderFluentBuilder

Constructs a fluent builder for the StartAppBlockBuilder operation.

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

    The name of the app block builder.

    
    
• On success, responds with StartAppBlockBuilderOutput with field(s):
  • app_block_builder(Option<AppBlockBuilder>):

    Describes an app block builder.

• On failure, responds with SdkError<StartAppBlockBuilderError>

impl Client

pub fn start_fleet(&self) -> StartFleetFluentBuilder

Constructs a fluent builder for the StartFleet operation.

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

    The name of the fleet.

    
    
• On success, responds with StartFleetOutput
• On failure, responds with SdkError<StartFleetError>

impl Client

pub fn start_image_builder(&self) -> StartImageBuilderFluentBuilder

Constructs a fluent builder for the StartImageBuilder operation.

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

    The name of the image builder.

    
    
  • appstream_agent_version(impl Into<String>) / set_appstream_agent_version(Option<String>):
    required: false
    

    The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

    
    
• On success, responds with StartImageBuilderOutput with field(s):
  • image_builder(Option<ImageBuilder>):

    Information about the image builder.

• On failure, responds with SdkError<StartImageBuilderError>

impl Client

pub fn stop_app_block_builder(&self) -> StopAppBlockBuilderFluentBuilder

Constructs a fluent builder for the StopAppBlockBuilder operation.

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

    The name of the app block builder.

    
    
• On success, responds with StopAppBlockBuilderOutput with field(s):
  • app_block_builder(Option<AppBlockBuilder>):

    Describes an app block builder.

• On failure, responds with SdkError<StopAppBlockBuilderError>

impl Client

pub fn stop_fleet(&self) -> StopFleetFluentBuilder

Constructs a fluent builder for the StopFleet operation.

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

    The name of the fleet.

    
    
• On success, responds with StopFleetOutput
• On failure, responds with SdkError<StopFleetError>

impl Client

pub fn stop_image_builder(&self) -> StopImageBuilderFluentBuilder

Constructs a fluent builder for the StopImageBuilder operation.

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

    The name of the image builder.

    
    
• On success, responds with StopImageBuilderOutput with field(s):
  • image_builder(Option<ImageBuilder>):

    Information about the image builder.

• On failure, responds with SdkError<StopImageBuilderError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

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

    The tags to associate. 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:

    _ . : / = + \ - @

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

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

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

    The tag keys for the tags to disassociate.

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

impl Client

pub fn update_app_block_builder(&self) -> UpdateAppBlockBuilderFluentBuilder

Constructs a fluent builder for the UpdateAppBlockBuilder operation.

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

    The unique name for the app block builder.

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

    The description of the app block builder.

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

    The display name of the app block builder.

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

    The platform of the app block builder.

    WINDOWS_SERVER_2019 is the only valid value.

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

    The instance type to use when launching the app block builder. The following instance types are available:

    • stream.standard.small

    • stream.standard.medium

    • stream.standard.large

    • stream.standard.xlarge

    • stream.standard.2xlarge

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

    The VPC configuration for the app block builder.

    App block builders require that you specify at least two subnets in different availability zones.

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

    Enables or disables default internet access for the app block builder.

    
    
  • 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 app block builder. To assume a role, the app block builder 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.

    
    
  • access_endpoints(AccessEndpoint) / set_access_endpoints(Option<Vec::<AccessEndpoint>>):
    required: false
    

    The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.

    
    
  • attributes_to_delete(AppBlockBuilderAttribute) / set_attributes_to_delete(Option<Vec::<AppBlockBuilderAttribute>>):
    required: false
    

    The attributes to delete from the app block builder.

    
    
• On success, responds with UpdateAppBlockBuilderOutput with field(s):
  • app_block_builder(Option<AppBlockBuilder>):

    Describes an app block builder.

• On failure, responds with SdkError<UpdateAppBlockBuilderError>

impl Client

pub fn update_application(&self) -> UpdateApplicationFluentBuilder

Constructs a fluent builder for the UpdateApplication operation.

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

    The name of the application. This name is visible to users when display name is not specified.

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

    The display name of the application. This name is visible to users in the application catalog.

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

    The description of the application.

    
    
  • icon_s3_location(S3Location) / set_icon_s3_location(Option<S3Location>):
    required: false
    

    The icon S3 location of the application.

    
    
  • launch_path(impl Into<String>) / set_launch_path(Option<String>):
    required: false
    

    The launch path of the application.

    
    
  • working_directory(impl Into<String>) / set_working_directory(Option<String>):
    required: false
    

    The working directory of the application.

    
    
  • launch_parameters(impl Into<String>) / set_launch_parameters(Option<String>):
    required: false
    

    The launch parameters of the application.

    
    
  • app_block_arn(impl Into<String>) / set_app_block_arn(Option<String>):
    required: false
    

    The ARN of the app block.

    
    
  • attributes_to_delete(ApplicationAttribute) / set_attributes_to_delete(Option<Vec::<ApplicationAttribute>>):
    required: false
    

    The attributes to delete for an application.

    
    
• On success, responds with UpdateApplicationOutput with field(s):
  • application(Option<Application>):

    Describes an application in the application catalog.

• On failure, responds with SdkError<UpdateApplicationError>

impl Client

pub fn update_directory_config(&self) -> UpdateDirectoryConfigFluentBuilder

Constructs a fluent builder for the UpdateDirectoryConfig operation.

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

    The name of the Directory Config object.

    
    
  • organizational_unit_distinguished_names(impl Into<String>) / set_organizational_unit_distinguished_names(Option<Vec::<String>>):
    required: false
    

    The distinguished names of the organizational units for computer accounts.

    
    
  • service_account_credentials(ServiceAccountCredentials) / set_service_account_credentials(Option<ServiceAccountCredentials>):
    required: false
    

    The credentials for the service account used by the fleet or image builder to connect to the directory.

    
    
  • certificate_based_auth_properties(CertificateBasedAuthProperties) / set_certificate_based_auth_properties(Option<CertificateBasedAuthProperties>):
    required: false
    

    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

    
    
• On success, responds with UpdateDirectoryConfigOutput with field(s):
  • directory_config(Option<DirectoryConfig>):

    Information about the Directory Config object.

• On failure, responds with SdkError<UpdateDirectoryConfigError>

impl Client

pub fn update_entitlement(&self) -> UpdateEntitlementFluentBuilder

Constructs a fluent builder for the UpdateEntitlement operation.

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

    The name of the entitlement.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name of the stack with which the entitlement is associated.

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

    The description of the entitlement.

    
    
  • app_visibility(AppVisibility) / set_app_visibility(Option<AppVisibility>):
    required: false
    

    Specifies whether all or only selected apps are entitled.

    
    
  • attributes(EntitlementAttribute) / set_attributes(Option<Vec::<EntitlementAttribute>>):
    required: false
    

    The attributes of the entitlement.

    
    
• On success, responds with UpdateEntitlementOutput with field(s):
  • entitlement(Option<Entitlement>):

    The entitlement.

• On failure, responds with SdkError<UpdateEntitlementError>

impl Client

pub fn update_fleet(&self) -> UpdateFleetFluentBuilder

Constructs a fluent builder for the UpdateFleet operation.

• The fluent builder is configurable:
  • 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.

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

    A unique name for the fleet.

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

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

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

    The desired capacity for the fleet. This is not allowed for Elastic fleets.

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

    
    
  • delete_vpc_config(bool) / set_delete_vpc_config(Option<bool>):
    required: false
    

    Deletes the VPC association for the specified fleet.

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

    
    
  • 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 users 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 3600. 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.

    
    
  • attributes_to_delete(FleetAttribute) / set_attributes_to_delete(Option<Vec::<FleetAttribute>>):
    required: false
    

    The fleet attributes to delete.

    
    
  • 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 platform of the fleet. 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 number of concurrent sessions for a fleet.

    
    
  • 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 UpdateFleetOutput with field(s):
  • fleet(Option<Fleet>):

    Information about the fleet.

• On failure, responds with SdkError<UpdateFleetError>

impl Client

pub fn update_image_permissions(&self) -> UpdateImagePermissionsFluentBuilder

Constructs a fluent builder for the UpdateImagePermissions operation.

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

    The name of the private image.

    
    
  • shared_account_id(impl Into<String>) / set_shared_account_id(Option<String>):
    required: true
    

    The 12-digit identifier of the AWS account for which you want add or update image permissions.

    
    
  • image_permissions(ImagePermissions) / set_image_permissions(Option<ImagePermissions>):
    required: true
    

    The permissions for the image.

    
    
• On success, responds with UpdateImagePermissionsOutput
• On failure, responds with SdkError<UpdateImagePermissionsError>

impl Client

pub fn update_stack(&self) -> UpdateStackFluentBuilder

Constructs a fluent builder for the UpdateStack operation.

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

    The stack name to display.

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

    The description to display.

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

    The name of the stack.

    
    
  • storage_connectors(StorageConnector) / set_storage_connectors(Option<Vec::<StorageConnector>>):
    required: false
    

    The storage connectors to enable.

    
    
  • delete_storage_connectors(bool) / set_delete_storage_connectors(Option<bool>):
    required: false
    

    Deletes the storage connectors currently enabled for the stack.

    
    
  • redirect_url(impl Into<String>) / set_redirect_url(Option<String>):
    required: false
    

    The URL that users are redirected to after their streaming session ends.

    
    
  • feedback_url(impl Into<String>) / set_feedback_url(Option<String>):
    required: false
    

    The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

    
    
  • attributes_to_delete(StackAttribute) / set_attributes_to_delete(Option<Vec::<StackAttribute>>):
    required: false
    

    The stack attributes to delete.

    
    
  • user_settings(UserSetting) / set_user_settings(Option<Vec::<UserSetting>>):
    required: false
    

    The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

    
    
  • application_settings(ApplicationSettings) / set_application_settings(Option<ApplicationSettings>):
    required: false
    

    The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

    
    
  • access_endpoints(AccessEndpoint) / set_access_endpoints(Option<Vec::<AccessEndpoint>>):
    required: false
    

    The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

    
    
  • embed_host_domains(impl Into<String>) / set_embed_host_domains(Option<Vec::<String>>):
    required: false
    

    The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

    
    
  • streaming_experience_settings(StreamingExperienceSettings) / set_streaming_experience_settings(Option<StreamingExperienceSettings>):
    required: false
    

    The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

    
    
• On success, responds with UpdateStackOutput with field(s):
  • stack(Option<Stack>):

    Information about the stack.

• On failure, responds with SdkError<UpdateStackError>

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.

impl Waiters for Client

fn wait_until_fleet_started(&self) -> FleetStartedFluentBuilder

Wait for fleet_started

fn wait_until_fleet_stopped(&self) -> FleetStoppedFluentBuilder

Wait for fleet_stopped