Struct aws_sdk_nimble::client::Client

pub struct Client { /* private fields */ }

Client for AmazonNimbleStudio

Client for invoking operations on AmazonNimbleStudio. Each operation on AmazonNimbleStudio 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_nimble::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_nimble::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 ListTagsForResource operation has a Client::list_tags_for_resource, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.list_tags_for_resource()
    .resource_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 accept_eulas(&self) -> AcceptEulasFluentBuilder

Constructs a fluent builder for the AcceptEulas operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • eula_ids(impl Into<String>) / set_eula_ids(Option<Vec::<String>>):
    required: false
    

    The EULA ID.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with AcceptEulasOutput with field(s):
  • eula_acceptances(Option<Vec::<EulaAcceptance>>):

    A collection of EULA acceptances.

• On failure, responds with SdkError<AcceptEulasError>

impl Client

pub fn create_launch_profile(&self) -> CreateLaunchProfileFluentBuilder

Constructs a fluent builder for the CreateLaunchProfile operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

    The description.

    
    
  • ec2_subnet_ids(impl Into<String>) / set_ec2_subnet_ids(Option<Vec::<String>>):
    required: true
    

    Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.

    
    
  • launch_profile_protocol_versions(impl Into<String>) / set_launch_profile_protocol_versions(Option<Vec::<String>>):
    required: true
    

    The version number of the protocol that is used by the launch profile. The only valid version is “2021-03-31”.

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

    The name for the launch profile.

    
    
  • stream_configuration(StreamConfigurationCreate) / set_stream_configuration(Option<StreamConfigurationCreate>):
    required: true
    

    A configuration for a streaming session.

    
    
  • studio_component_ids(impl Into<String>) / set_studio_component_ids(Option<Vec::<String>>):
    required: true
    

    Unique identifiers for a collection of studio components that can be used with this launch profile.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

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

    A collection of labels, in the form of key-value pairs, that apply to this resource.

    
    
• On success, responds with CreateLaunchProfileOutput with field(s):
  • launch_profile(Option<LaunchProfile>):

    The launch profile.

• On failure, responds with SdkError<CreateLaunchProfileError>

impl Client

pub fn create_streaming_image(&self) -> CreateStreamingImageFluentBuilder

Constructs a fluent builder for the CreateStreamingImage operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

    A human-readable description of the streaming image.

    
    
  • ec2_image_id(impl Into<String>) / set_ec2_image_id(Option<String>):
    required: true
    

    The ID of an EC2 machine image with which to create this streaming image.

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

    A friendly name for a streaming image resource.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

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

    A collection of labels, in the form of key-value pairs, that apply to this resource.

    
    
• On success, responds with CreateStreamingImageOutput with field(s):
  • streaming_image(Option<StreamingImage>):

    The streaming image.

• On failure, responds with SdkError<CreateStreamingImageError>

impl Client

pub fn create_streaming_session(&self) -> CreateStreamingSessionFluentBuilder

Constructs a fluent builder for the CreateStreamingSession operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • ec2_instance_type(StreamingInstanceType) / set_ec2_instance_type(Option<StreamingInstanceType>):
    required: false
    

    The EC2 Instance type used for the streaming session.

    
    
  • launch_profile_id(impl Into<String>) / set_launch_profile_id(Option<String>):
    required: true
    

    The ID of the launch profile used to control access from the streaming session.

    
    
  • owned_by(impl Into<String>) / set_owned_by(Option<String>):
    required: false
    

    The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

    
    
  • streaming_image_id(impl Into<String>) / set_streaming_image_id(Option<String>):
    required: false
    

    The ID of the streaming image.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

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

    A collection of labels, in the form of key-value pairs, that apply to this resource.

    
    
• On success, responds with CreateStreamingSessionOutput with field(s):
  • session(Option<StreamingSession>):

    The session.

• On failure, responds with SdkError<CreateStreamingSessionError>

impl Client

pub fn create_streaming_session_stream( &self ) -> CreateStreamingSessionStreamFluentBuilder

Constructs a fluent builder for the CreateStreamingSessionStream operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • expiration_in_seconds(i32) / set_expiration_in_seconds(Option<i32>):
    required: false
    

    The expiration time in seconds.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The streaming session ID.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with CreateStreamingSessionStreamOutput with field(s):
  • stream(Option<StreamingSessionStream>):

    The stream.

• On failure, responds with SdkError<CreateStreamingSessionStreamError>

impl Client

pub fn create_studio(&self) -> CreateStudioFluentBuilder

Constructs a fluent builder for the CreateStudio operation.

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

    The IAM role that studio admins will assume when logging in to the Nimble Studio portal.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

    A friendly name for the studio.

    
    
  • studio_encryption_configuration(StudioEncryptionConfiguration) / set_studio_encryption_configuration(Option<StudioEncryptionConfiguration>):
    required: false
    

    The studio encryption configuration.

    
    
  • studio_name(impl Into<String>) / set_studio_name(Option<String>):
    required: true
    

    The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

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

    A collection of labels, in the form of key-value pairs, that apply to this resource.

    
    
  • user_role_arn(impl Into<String>) / set_user_role_arn(Option<String>):
    required: true
    

    The IAM role that studio users will assume when logging in to the Nimble Studio portal.

    
    
• On success, responds with CreateStudioOutput with field(s):
  • studio(Option<Studio>):

    Information about a studio.

• On failure, responds with SdkError<CreateStudioError>

impl Client

pub fn create_studio_component(&self) -> CreateStudioComponentFluentBuilder

Constructs a fluent builder for the CreateStudioComponent operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • configuration(StudioComponentConfiguration) / set_configuration(Option<StudioComponentConfiguration>):
    required: false
    

    The configuration of the studio component, based on component type.

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

    The description.

    
    
  • ec2_security_group_ids(impl Into<String>) / set_ec2_security_group_ids(Option<Vec::<String>>):
    required: false
    

    The EC2 security groups that control access to the studio component.

    
    
  • initialization_scripts(StudioComponentInitializationScript) / set_initialization_scripts(Option<Vec::<StudioComponentInitializationScript>>):
    required: false
    

    Initialization scripts for studio components.

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

    The name for the studio component.

    
    
  • script_parameters(ScriptParameterKeyValue) / set_script_parameters(Option<Vec::<ScriptParameterKeyValue>>):
    required: false
    

    Parameters for the studio component scripts.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
  • subtype(StudioComponentSubtype) / set_subtype(Option<StudioComponentSubtype>):
    required: false
    

    The specific subtype of a studio component.

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

    A collection of labels, in the form of key-value pairs, that apply to this resource.

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

    The type of the studio component.

    
    
  • secure_initialization_role_arn(impl Into<String>) / set_secure_initialization_role_arn(Option<String>):
    required: false
    

    An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

    
    
  • runtime_role_arn(impl Into<String>) / set_runtime_role_arn(Option<String>):
    required: false
    

    An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

    
    
• On success, responds with CreateStudioComponentOutput with field(s):
  • studio_component(Option<StudioComponent>):

    Information about the studio component.

• On failure, responds with SdkError<CreateStudioComponentError>

impl Client

pub fn delete_launch_profile(&self) -> DeleteLaunchProfileFluentBuilder

Constructs a fluent builder for the DeleteLaunchProfile operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • launch_profile_id(impl Into<String>) / set_launch_profile_id(Option<String>):
    required: true
    

    The ID of the launch profile used to control access from the streaming session.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with DeleteLaunchProfileOutput with field(s):
  • launch_profile(Option<LaunchProfile>):

    The launch profile.

• On failure, responds with SdkError<DeleteLaunchProfileError>

impl Client

pub fn delete_launch_profile_member( &self ) -> DeleteLaunchProfileMemberFluentBuilder

Constructs a fluent builder for the DeleteLaunchProfileMember operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • launch_profile_id(impl Into<String>) / set_launch_profile_id(Option<String>):
    required: true
    

    The ID of the launch profile used to control access from the streaming session.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    The principal ID. This currently supports a IAM Identity Center UserId.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with DeleteLaunchProfileMemberOutput
• On failure, responds with SdkError<DeleteLaunchProfileMemberError>

impl Client

pub fn delete_streaming_image(&self) -> DeleteStreamingImageFluentBuilder

Constructs a fluent builder for the DeleteStreamingImage operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • streaming_image_id(impl Into<String>) / set_streaming_image_id(Option<String>):
    required: true
    

    The streaming image ID.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with DeleteStreamingImageOutput with field(s):
  • streaming_image(Option<StreamingImage>):

    The streaming image.

• On failure, responds with SdkError<DeleteStreamingImageError>

impl Client

pub fn delete_streaming_session(&self) -> DeleteStreamingSessionFluentBuilder

Constructs a fluent builder for the DeleteStreamingSession operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The streaming session ID.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with DeleteStreamingSessionOutput with field(s):
  • session(Option<StreamingSession>):

    The session.

• On failure, responds with SdkError<DeleteStreamingSessionError>

impl Client

pub fn delete_studio(&self) -> DeleteStudioFluentBuilder

Constructs a fluent builder for the DeleteStudio operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with DeleteStudioOutput with field(s):
  • studio(Option<Studio>):

    Information about a studio.

• On failure, responds with SdkError<DeleteStudioError>

impl Client

pub fn delete_studio_component(&self) -> DeleteStudioComponentFluentBuilder

Constructs a fluent builder for the DeleteStudioComponent operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • studio_component_id(impl Into<String>) / set_studio_component_id(Option<String>):
    required: true
    

    The studio component ID.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with DeleteStudioComponentOutput with field(s):
  • studio_component(Option<StudioComponent>):

    Information about the studio component.

• On failure, responds with SdkError<DeleteStudioComponentError>

impl Client

pub fn delete_studio_member(&self) -> DeleteStudioMemberFluentBuilder

Constructs a fluent builder for the DeleteStudioMember operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    The principal ID. This currently supports a IAM Identity Center UserId.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with DeleteStudioMemberOutput
• On failure, responds with SdkError<DeleteStudioMemberError>

impl Client

pub fn get_eula(&self) -> GetEulaFluentBuilder

Constructs a fluent builder for the GetEula operation.

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

    The EULA ID.

    
    
• On success, responds with GetEulaOutput with field(s):
  • eula(Option<Eula>):

    The EULA.

• On failure, responds with SdkError<GetEulaError>

impl Client

pub fn get_launch_profile(&self) -> GetLaunchProfileFluentBuilder

Constructs a fluent builder for the GetLaunchProfile operation.

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

    The ID of the launch profile used to control access from the streaming session.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with GetLaunchProfileOutput with field(s):
  • launch_profile(Option<LaunchProfile>):

    The launch profile.

• On failure, responds with SdkError<GetLaunchProfileError>

impl Client

pub fn get_launch_profile_details(&self) -> GetLaunchProfileDetailsFluentBuilder

Constructs a fluent builder for the GetLaunchProfileDetails operation.

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

    The ID of the launch profile used to control access from the streaming session.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with GetLaunchProfileDetailsOutput with field(s):
  • launch_profile(Option<LaunchProfile>):

    The launch profile.

  • streaming_images(Option<Vec::<StreamingImage>>):

    A collection of streaming images.

  • studio_component_summaries(Option<Vec::<StudioComponentSummary>>):

    A collection of studio component summaries.

• On failure, responds with SdkError<GetLaunchProfileDetailsError>

impl Client

pub fn get_launch_profile_initialization( &self ) -> GetLaunchProfileInitializationFluentBuilder

Constructs a fluent builder for the GetLaunchProfileInitialization operation.

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

    The ID of the launch profile used to control access from the streaming session.

    
    
  • launch_profile_protocol_versions(impl Into<String>) / set_launch_profile_protocol_versions(Option<Vec::<String>>):
    required: true
    

    The launch profile protocol versions supported by the client.

    
    
  • launch_purpose(impl Into<String>) / set_launch_purpose(Option<String>):
    required: true
    

    The launch purpose.

    
    
  • platform(impl Into<String>) / set_platform(Option<String>):
    required: true
    

    The platform where this Launch Profile will be used, either Windows or Linux.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with GetLaunchProfileInitializationOutput with field(s):
  • launch_profile_initialization(Option<LaunchProfileInitialization>):

    The launch profile initialization.

• On failure, responds with SdkError<GetLaunchProfileInitializationError>

impl Client

pub fn get_launch_profile_member(&self) -> GetLaunchProfileMemberFluentBuilder

Constructs a fluent builder for the GetLaunchProfileMember operation.

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

    The ID of the launch profile used to control access from the streaming session.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    The principal ID. This currently supports a IAM Identity Center UserId.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with GetLaunchProfileMemberOutput with field(s):
  • member(Option<LaunchProfileMembership>):

    The member.

• On failure, responds with SdkError<GetLaunchProfileMemberError>

impl Client

pub fn get_streaming_image(&self) -> GetStreamingImageFluentBuilder

Constructs a fluent builder for the GetStreamingImage operation.

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

    The streaming image ID.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with GetStreamingImageOutput with field(s):
  • streaming_image(Option<StreamingImage>):

    The streaming image.

• On failure, responds with SdkError<GetStreamingImageError>

impl Client

pub fn get_streaming_session(&self) -> GetStreamingSessionFluentBuilder

Constructs a fluent builder for the GetStreamingSession operation.

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

    The streaming session ID.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with GetStreamingSessionOutput with field(s):
  • session(Option<StreamingSession>):

    The session.

• On failure, responds with SdkError<GetStreamingSessionError>

impl Client

pub fn get_streaming_session_backup( &self ) -> GetStreamingSessionBackupFluentBuilder

Constructs a fluent builder for the GetStreamingSessionBackup operation.

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

    The ID of the backup.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with GetStreamingSessionBackupOutput with field(s):
  • streaming_session_backup(Option<StreamingSessionBackup>):

    Information about the streaming session backup.

• On failure, responds with SdkError<GetStreamingSessionBackupError>

impl Client

pub fn get_streaming_session_stream( &self ) -> GetStreamingSessionStreamFluentBuilder

Constructs a fluent builder for the GetStreamingSessionStream operation.

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

    The streaming session ID.

    
    
  • stream_id(impl Into<String>) / set_stream_id(Option<String>):
    required: true
    

    The streaming session stream ID.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with GetStreamingSessionStreamOutput with field(s):
  • stream(Option<StreamingSessionStream>):

    The stream.

• On failure, responds with SdkError<GetStreamingSessionStreamError>

impl Client

pub fn get_studio(&self) -> GetStudioFluentBuilder

Constructs a fluent builder for the GetStudio operation.

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

    The studio ID.

    
    
• On success, responds with GetStudioOutput with field(s):
  • studio(Option<Studio>):

    Information about a studio.

• On failure, responds with SdkError<GetStudioError>

impl Client

pub fn get_studio_component(&self) -> GetStudioComponentFluentBuilder

Constructs a fluent builder for the GetStudioComponent operation.

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

    The studio component ID.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with GetStudioComponentOutput with field(s):
  • studio_component(Option<StudioComponent>):

    Information about the studio component.

• On failure, responds with SdkError<GetStudioComponentError>

impl Client

pub fn get_studio_member(&self) -> GetStudioMemberFluentBuilder

Constructs a fluent builder for the GetStudioMember operation.

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

    The principal ID. This currently supports a IAM Identity Center UserId.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with GetStudioMemberOutput with field(s):
  • member(Option<StudioMembership>):

    The member.

• On failure, responds with SdkError<GetStudioMemberError>

impl Client

pub fn list_eula_acceptances(&self) -> ListEulaAcceptancesFluentBuilder

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

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

    The list of EULA IDs that have been previously accepted.

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

    The token for the next set of results, or null if there are no more results.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with ListEulaAcceptancesOutput with field(s):
  • eula_acceptances(Option<Vec::<EulaAcceptance>>):

    A collection of EULA acceptances.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListEulaAcceptancesError>

impl Client

pub fn list_eulas(&self) -> ListEulasFluentBuilder

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

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

    The list of EULA IDs that should be returned

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

    The token for the next set of results, or null if there are no more results.

    
    
• On success, responds with ListEulasOutput with field(s):
  • eulas(Option<Vec::<Eula>>):

    A collection of EULA resources.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListEulasError>

impl Client

pub fn list_launch_profile_members( &self ) -> ListLaunchProfileMembersFluentBuilder

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

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

    The ID of the launch profile used to control access from the streaming session.

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

    The max number of results to return in the response.

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

    The token for the next set of results, or null if there are no more results.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with ListLaunchProfileMembersOutput with field(s):
  • members(Option<Vec::<LaunchProfileMembership>>):

    A list of members.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListLaunchProfileMembersError>

impl Client

pub fn list_launch_profiles(&self) -> ListLaunchProfilesFluentBuilder

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

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

    The max number of results to return in the response.

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

    The token for the next set of results, or null if there are no more results.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: false
    

    The principal ID. This currently supports a IAM Identity Center UserId.

    
    
  • states(LaunchProfileState) / set_states(Option<Vec::<LaunchProfileState>>):
    required: false
    

    Filter this request to launch profiles in any of the given states.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with ListLaunchProfilesOutput with field(s):
  • launch_profiles(Option<Vec::<LaunchProfile>>):

    A collection of launch profiles.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListLaunchProfilesError>

impl Client

pub fn list_streaming_images(&self) -> ListStreamingImagesFluentBuilder

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

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

    The token for the next set of results, or null if there are no more results.

    
    
  • owner(impl Into<String>) / set_owner(Option<String>):
    required: false
    

    Filter this request to streaming images with the given owner

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with ListStreamingImagesOutput with field(s):
  • next_token(Option<String>):

    The token for the next set of results, or null if there are no more results.

  • streaming_images(Option<Vec::<StreamingImage>>):

    A collection of streaming images.

• On failure, responds with SdkError<ListStreamingImagesError>

impl Client

pub fn list_streaming_session_backups( &self ) -> ListStreamingSessionBackupsFluentBuilder

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

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

    The token for the next set of results, or null if there are no more results.

    
    
  • owned_by(impl Into<String>) / set_owned_by(Option<String>):
    required: false
    

    The user ID of the user that owns the streaming session.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with ListStreamingSessionBackupsOutput with field(s):
  • next_token(Option<String>):

    The token for the next set of results, or null if there are no more results.

  • streaming_session_backups(Option<Vec::<StreamingSessionBackup>>):

    Information about the streaming session backups.

• On failure, responds with SdkError<ListStreamingSessionBackupsError>

impl Client

pub fn list_streaming_sessions(&self) -> ListStreamingSessionsFluentBuilder

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

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

    Filters the request to streaming sessions created by the given user.

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

    The token for the next set of results, or null if there are no more results.

    
    
  • owned_by(impl Into<String>) / set_owned_by(Option<String>):
    required: false
    

    Filters the request to streaming session owned by the given user

    
    
  • session_ids(impl Into<String>) / set_session_ids(Option<String>):
    required: false
    

    Filters the request to only the provided session IDs.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with ListStreamingSessionsOutput with field(s):
  • next_token(Option<String>):

    The token for the next set of results, or null if there are no more results.

  • sessions(Option<Vec::<StreamingSession>>):

    A collection of streaming sessions.

• On failure, responds with SdkError<ListStreamingSessionsError>

impl Client

pub fn list_studio_components(&self) -> ListStudioComponentsFluentBuilder

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

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

    The max number of results to return in the response.

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

    The token for the next set of results, or null if there are no more results.

    
    
  • states(StudioComponentState) / set_states(Option<Vec::<StudioComponentState>>):
    required: false
    

    Filters the request to studio components that are in one of the given states.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
  • types(StudioComponentType) / set_types(Option<Vec::<StudioComponentType>>):
    required: false
    

    Filters the request to studio components that are of one of the given types.

    
    
• On success, responds with ListStudioComponentsOutput with field(s):
  • next_token(Option<String>):

    The token for the next set of results, or null if there are no more results.

  • studio_components(Option<Vec::<StudioComponent>>):

    A collection of studio components.

• On failure, responds with SdkError<ListStudioComponentsError>

impl Client

pub fn list_studio_members(&self) -> ListStudioMembersFluentBuilder

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

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

    The max number of results to return in the response.

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

    The token for the next set of results, or null if there are no more results.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with ListStudioMembersOutput with field(s):
  • members(Option<Vec::<StudioMembership>>):

    A list of admin members.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListStudioMembersError>

impl Client

pub fn list_studios(&self) -> ListStudiosFluentBuilder

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

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

    The token for the next set of results, or null if there are no more results.

    
    
• On success, responds with ListStudiosOutput with field(s):
  • next_token(Option<String>):

    The token for the next set of results, or null if there are no more results.

  • studios(Vec::<Studio>):

    A collection of studios.

• On failure, responds with SdkError<ListStudiosError>

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 for which you want to list tags.

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

    A collection of labels, in the form of key-value pairs, that apply to this resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_launch_profile_members(&self) -> PutLaunchProfileMembersFluentBuilder

Constructs a fluent builder for the PutLaunchProfileMembers operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • identity_store_id(impl Into<String>) / set_identity_store_id(Option<String>):
    required: true
    

    The ID of the identity store.

    
    
  • launch_profile_id(impl Into<String>) / set_launch_profile_id(Option<String>):
    required: true
    

    The ID of the launch profile used to control access from the streaming session.

    
    
  • members(NewLaunchProfileMember) / set_members(Option<Vec::<NewLaunchProfileMember>>):
    required: true
    

    A list of members.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with PutLaunchProfileMembersOutput
• On failure, responds with SdkError<PutLaunchProfileMembersError>

impl Client

pub fn put_studio_members(&self) -> PutStudioMembersFluentBuilder

Constructs a fluent builder for the PutStudioMembers operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • identity_store_id(impl Into<String>) / set_identity_store_id(Option<String>):
    required: true
    

    The ID of the identity store.

    
    
  • members(NewStudioMember) / set_members(Option<Vec::<NewStudioMember>>):
    required: true
    

    A list of members.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with PutStudioMembersOutput
• On failure, responds with SdkError<PutStudioMembersError>

impl Client

pub fn start_streaming_session(&self) -> StartStreamingSessionFluentBuilder

Constructs a fluent builder for the StartStreamingSession operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The streaming session ID for the StartStreamingSessionRequest.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID for the StartStreamingSessionRequest.

    
    
  • backup_id(impl Into<String>) / set_backup_id(Option<String>):
    required: false
    

    The ID of the backup.

    
    
• On success, responds with StartStreamingSessionOutput with field(s):
  • session(Option<StreamingSession>):

    A streaming session is a virtual workstation created using a particular launch profile.

• On failure, responds with SdkError<StartStreamingSessionError>

impl Client

pub fn start_studio_sso_configuration_repair( &self ) -> StartStudioSSOConfigurationRepairFluentBuilder

Constructs a fluent builder for the StartStudioSSOConfigurationRepair operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with StartStudioSsoConfigurationRepairOutput with field(s):
  • studio(Option<Studio>):

    Information about a studio.

• On failure, responds with SdkError<StartStudioSSOConfigurationRepairError>

impl Client

pub fn stop_streaming_session(&self) -> StopStreamingSessionFluentBuilder

Constructs a fluent builder for the StopStreamingSession operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The streaming session ID for the StopStreamingSessionRequest.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studioId for the StopStreamingSessionRequest.

    
    
  • volume_retention_mode(VolumeRetentionMode) / set_volume_retention_mode(Option<VolumeRetentionMode>):
    required: false
    

    Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.

    
    
• On success, responds with StopStreamingSessionOutput with field(s):
  • session(Option<StreamingSession>):

    A streaming session is a virtual workstation created using a particular launch profile.

• On failure, responds with SdkError<StopStreamingSessionError>

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 you want to add tags to.

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

    A collection of labels, in the form of key-value pairs, that apply to this resource.

    
    
• 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
    

    Identifies the Amazon Resource Name(ARN) key from which you are removing tags.

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

    One or more tag keys. Specify only the tag keys, not the tag values.

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

impl Client

pub fn update_launch_profile(&self) -> UpdateLaunchProfileFluentBuilder

Constructs a fluent builder for the UpdateLaunchProfile operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

    The description.

    
    
  • launch_profile_id(impl Into<String>) / set_launch_profile_id(Option<String>):
    required: true
    

    The ID of the launch profile used to control access from the streaming session.

    
    
  • launch_profile_protocol_versions(impl Into<String>) / set_launch_profile_protocol_versions(Option<Vec::<String>>):
    required: false
    

    The version number of the protocol that is used by the launch profile. The only valid version is “2021-03-31”.

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

    The name for the launch profile.

    
    
  • stream_configuration(StreamConfigurationCreate) / set_stream_configuration(Option<StreamConfigurationCreate>):
    required: false
    

    A configuration for a streaming session.

    
    
  • studio_component_ids(impl Into<String>) / set_studio_component_ids(Option<Vec::<String>>):
    required: false
    

    Unique identifiers for a collection of studio components that can be used with this launch profile.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with UpdateLaunchProfileOutput with field(s):
  • launch_profile(Option<LaunchProfile>):

    The launch profile.

• On failure, responds with SdkError<UpdateLaunchProfileError>

impl Client

pub fn update_launch_profile_member( &self ) -> UpdateLaunchProfileMemberFluentBuilder

Constructs a fluent builder for the UpdateLaunchProfileMember operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • launch_profile_id(impl Into<String>) / set_launch_profile_id(Option<String>):
    required: true
    

    The ID of the launch profile used to control access from the streaming session.

    
    
  • persona(LaunchProfilePersona) / set_persona(Option<LaunchProfilePersona>):
    required: true
    

    The persona.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    The principal ID. This currently supports a IAM Identity Center UserId.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with UpdateLaunchProfileMemberOutput with field(s):
  • member(Option<LaunchProfileMembership>):

    The updated member.

• On failure, responds with SdkError<UpdateLaunchProfileMemberError>

impl Client

pub fn update_streaming_image(&self) -> UpdateStreamingImageFluentBuilder

Constructs a fluent builder for the UpdateStreamingImage operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

    The description.

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

    The name for the streaming image.

    
    
  • streaming_image_id(impl Into<String>) / set_streaming_image_id(Option<String>):
    required: true
    

    The streaming image ID.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
• On success, responds with UpdateStreamingImageOutput with field(s):
  • streaming_image(Option<StreamingImage>):

    Represents a streaming image resource.

    Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.

    Amazon provides a number of streaming images that include popular 3rd-party software.

    You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.

• On failure, responds with SdkError<UpdateStreamingImageError>

impl Client

pub fn update_studio(&self) -> UpdateStudioFluentBuilder

Constructs a fluent builder for the UpdateStudio operation.

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

    The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

    A friendly name for the studio.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
  • user_role_arn(impl Into<String>) / set_user_role_arn(Option<String>):
    required: false
    

    The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

    
    
• On success, responds with UpdateStudioOutput with field(s):
  • studio(Option<Studio>):

    Information about a studio.

• On failure, responds with SdkError<UpdateStudioError>

impl Client

pub fn update_studio_component(&self) -> UpdateStudioComponentFluentBuilder

Constructs a fluent builder for the UpdateStudioComponent operation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    
    
  • configuration(StudioComponentConfiguration) / set_configuration(Option<StudioComponentConfiguration>):
    required: false
    

    The configuration of the studio component, based on component type.

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

    The description.

    
    
  • ec2_security_group_ids(impl Into<String>) / set_ec2_security_group_ids(Option<Vec::<String>>):
    required: false
    

    The EC2 security groups that control access to the studio component.

    
    
  • initialization_scripts(StudioComponentInitializationScript) / set_initialization_scripts(Option<Vec::<StudioComponentInitializationScript>>):
    required: false
    

    Initialization scripts for studio components.

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

    The name for the studio component.

    
    
  • script_parameters(ScriptParameterKeyValue) / set_script_parameters(Option<Vec::<ScriptParameterKeyValue>>):
    required: false
    

    Parameters for the studio component scripts.

    
    
  • studio_component_id(impl Into<String>) / set_studio_component_id(Option<String>):
    required: true
    

    The studio component ID.

    
    
  • studio_id(impl Into<String>) / set_studio_id(Option<String>):
    required: true
    

    The studio ID.

    
    
  • subtype(StudioComponentSubtype) / set_subtype(Option<StudioComponentSubtype>):
    required: false
    

    The specific subtype of a studio component.

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

    The type of the studio component.

    
    
  • secure_initialization_role_arn(impl Into<String>) / set_secure_initialization_role_arn(Option<String>):
    required: false
    

    An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

    
    
  • runtime_role_arn(impl Into<String>) / set_runtime_role_arn(Option<String>):
    required: false
    

    An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

    
    
• On success, responds with UpdateStudioComponentOutput with field(s):
  • studio_component(Option<StudioComponent>):

    Information about the studio component.

• On failure, responds with SdkError<UpdateStudioComponentError>

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_launch_profile_ready(&self) -> LaunchProfileReadyFluentBuilder

Wait until a LaunchProfile is Ready. Use this after invoking CreateLaunchProfile or UpdateLaunchProfile

fn wait_until_launch_profile_deleted(&self) -> LaunchProfileDeletedFluentBuilder

Wait until a LaunchProfile is Deleted. Use this after invoking DeleteLaunchProfile

fn wait_until_streaming_image_ready(&self) -> StreamingImageReadyFluentBuilder

Wait until a StreamingImage is Ready. Use this after invoking CreateStreamingImage or UpdateStreamingImage

fn wait_until_streaming_image_deleted( &self ) -> StreamingImageDeletedFluentBuilder

Wait until a StreamingImage Deleted. Use this after invoking DeleteStreamingImage

fn wait_until_streaming_session_ready( &self ) -> StreamingSessionReadyFluentBuilder

Wait until a StreamingSession is ready. Use this after invoking CreateStreamingSession, StartStreamingSession

fn wait_until_streaming_session_stopped( &self ) -> StreamingSessionStoppedFluentBuilder

Wait until a StreamingSessionStopped. Use this after invoking StopStreamingSession

fn wait_until_streaming_session_deleted( &self ) -> StreamingSessionDeletedFluentBuilder

Wait until a StreamingSessionDeleted. Use this after invoking DeleteStreamingSession

fn wait_until_streaming_session_stream_ready( &self ) -> StreamingSessionStreamReadyFluentBuilder

Wait until a StreamingSessionStream is ready. Use this after invoking CreateStreamingSessionStream

fn wait_until_studio_ready(&self) -> StudioReadyFluentBuilder

Wait until a Studio is Ready. Use this after invoking CreateStudio, UpdateStudio, or StartStudioSSOConfigurationRepair

fn wait_until_studio_deleted(&self) -> StudioDeletedFluentBuilder

Wait until a Studio is Deleted. Use this after invoking DeleteStudio.

fn wait_until_studio_component_ready(&self) -> StudioComponentReadyFluentBuilder

Wait until a StudioComponent is Ready. Use this after invoking CreateStudioComponent or UpdateStudioComponent

fn wait_until_studio_component_deleted( &self ) -> StudioComponentDeletedFluentBuilder

Wait until a StudioComponent Deleted. Use this after invoking DeleteStudioComponent