Struct Client

pub struct Client { /* private fields */ }

Client for Amazon WorkSpaces Web

Client for invoking operations on Amazon WorkSpaces Web. Each operation on Amazon WorkSpaces Web 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_workspacesweb::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_workspacesweb::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 ExpireSession operation has a Client::expire_session, 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.expire_session()
    .portal_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_browser_settings( &self, ) -> AssociateBrowserSettingsFluentBuilder

Constructs a fluent builder for the AssociateBrowserSettings operation.

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

    The ARN of the web portal.

    
    
  • browser_settings_arn(impl Into<String>) / set_browser_settings_arn(Option<String>):
    required: true
    

    The ARN of the browser settings.

    
    
• On success, responds with AssociateBrowserSettingsOutput with field(s):
  • portal_arn(String):

    The ARN of the web portal.

  • browser_settings_arn(String):

    The ARN of the browser settings.

• On failure, responds with SdkError<AssociateBrowserSettingsError>

impl Client

pub fn associate_data_protection_settings( &self, ) -> AssociateDataProtectionSettingsFluentBuilder

Constructs a fluent builder for the AssociateDataProtectionSettings operation.

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

    The ARN of the web portal.

    
    
  • data_protection_settings_arn(impl Into<String>) / set_data_protection_settings_arn(Option<String>):
    required: true
    

    The ARN of the data protection settings.

    
    
• On success, responds with AssociateDataProtectionSettingsOutput with field(s):
  • portal_arn(String):

    The ARN of the web portal.

  • data_protection_settings_arn(String):

    The ARN of the data protection settings resource.

• On failure, responds with SdkError<AssociateDataProtectionSettingsError>

impl Client

pub fn associate_ip_access_settings( &self, ) -> AssociateIpAccessSettingsFluentBuilder

Constructs a fluent builder for the AssociateIpAccessSettings operation.

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

    The ARN of the web portal.

    
    
  • ip_access_settings_arn(impl Into<String>) / set_ip_access_settings_arn(Option<String>):
    required: true
    

    The ARN of the IP access settings.

    
    
• On success, responds with AssociateIpAccessSettingsOutput with field(s):
  • portal_arn(String):

    The ARN of the web portal.

  • ip_access_settings_arn(String):

    The ARN of the IP access settings resource.

• On failure, responds with SdkError<AssociateIpAccessSettingsError>

impl Client

pub fn associate_network_settings( &self, ) -> AssociateNetworkSettingsFluentBuilder

Constructs a fluent builder for the AssociateNetworkSettings operation.

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

    The ARN of the web portal.

    
    
  • network_settings_arn(impl Into<String>) / set_network_settings_arn(Option<String>):
    required: true
    

    The ARN of the network settings.

    
    
• On success, responds with AssociateNetworkSettingsOutput with field(s):
  • portal_arn(String):

    The ARN of the web portal.

  • network_settings_arn(String):

    The ARN of the network settings.

• On failure, responds with SdkError<AssociateNetworkSettingsError>

impl Client

pub fn associate_trust_store(&self) -> AssociateTrustStoreFluentBuilder

Constructs a fluent builder for the AssociateTrustStore operation.

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

    The ARN of the web portal.

    
    
  • trust_store_arn(impl Into<String>) / set_trust_store_arn(Option<String>):
    required: true
    

    The ARN of the trust store.

    
    
• On success, responds with AssociateTrustStoreOutput with field(s):
  • portal_arn(String):

    The ARN of the web portal.

  • trust_store_arn(String):

    The ARN of the trust store.

• On failure, responds with SdkError<AssociateTrustStoreError>

impl Client

pub fn associate_user_access_logging_settings( &self, ) -> AssociateUserAccessLoggingSettingsFluentBuilder

Constructs a fluent builder for the AssociateUserAccessLoggingSettings operation.

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

    The ARN of the web portal.

    
    
  • user_access_logging_settings_arn(impl Into<String>) / set_user_access_logging_settings_arn(Option<String>):
    required: true
    

    The ARN of the user access logging settings.

    
    
• On success, responds with AssociateUserAccessLoggingSettingsOutput with field(s):
  • portal_arn(String):

    The ARN of the web portal.

  • user_access_logging_settings_arn(String):

    The ARN of the user access logging settings.

• On failure, responds with SdkError<AssociateUserAccessLoggingSettingsError>

impl Client

pub fn associate_user_settings(&self) -> AssociateUserSettingsFluentBuilder

Constructs a fluent builder for the AssociateUserSettings operation.

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

    The ARN of the web portal.

    
    
  • user_settings_arn(impl Into<String>) / set_user_settings_arn(Option<String>):
    required: true
    

    The ARN of the user settings.

    
    
• On success, responds with AssociateUserSettingsOutput with field(s):
  • portal_arn(String):

    The ARN of the web portal.

  • user_settings_arn(String):

    The ARN of the user settings.

• On failure, responds with SdkError<AssociateUserSettingsError>

impl Client

pub fn create_browser_settings(&self) -> CreateBrowserSettingsFluentBuilder

Constructs a fluent builder for the CreateBrowserSettings operation.

• The fluent builder is configurable:
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to add to the browser settings resource. A tag is a key-value pair.

    
    
  • customer_managed_key(impl Into<String>) / set_customer_managed_key(Option<String>):
    required: false
    

    The custom managed key of the browser settings.

    
    
  • additional_encryption_context(impl Into<String>, impl Into<String>) / set_additional_encryption_context(Option<HashMap::<String, String>>):
    required: false
    

    Additional encryption context of the browser settings.

    
    
  • browser_policy(impl Into<String>) / set_browser_policy(Option<String>):
    required: true
    

    A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with CreateBrowserSettingsOutput with field(s):
  • browser_settings_arn(String):

    The ARN of the browser settings.

• On failure, responds with SdkError<CreateBrowserSettingsError>

impl Client

pub fn create_data_protection_settings( &self, ) -> CreateDataProtectionSettingsFluentBuilder

Constructs a fluent builder for the CreateDataProtectionSettings operation.

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

    The display name of the data protection settings.

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

    The description of the data protection settings.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to add to the data protection settings resource. A tag is a key-value pair.

    
    
  • customer_managed_key(impl Into<String>) / set_customer_managed_key(Option<String>):
    required: false
    

    The custom managed key of the data protection settings.

    
    
  • additional_encryption_context(impl Into<String>, impl Into<String>) / set_additional_encryption_context(Option<HashMap::<String, String>>):
    required: false
    

    Additional encryption context of the data protection settings.

    
    
  • inline_redaction_configuration(InlineRedactionConfiguration) / set_inline_redaction_configuration(Option<InlineRedactionConfiguration>):
    required: false
    

    The inline redaction configuration of the data protection settings that will be applied to all sessions.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with CreateDataProtectionSettingsOutput with field(s):
  • data_protection_settings_arn(String):

    The ARN of the data protection settings resource.

• On failure, responds with SdkError<CreateDataProtectionSettingsError>

impl Client

pub fn create_identity_provider(&self) -> CreateIdentityProviderFluentBuilder

Constructs a fluent builder for the CreateIdentityProvider operation.

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

    The ARN of the web portal.

    
    
  • identity_provider_name(impl Into<String>) / set_identity_provider_name(Option<String>):
    required: true
    

    The identity provider name.

    
    
  • identity_provider_type(IdentityProviderType) / set_identity_provider_type(Option<IdentityProviderType>):
    required: true
    

    The identity provider type.

    
    
  • identity_provider_details(impl Into<String>, impl Into<String>) / set_identity_provider_details(Option<HashMap::<String, String>>):
    required: true
    

    The identity provider details. The following list describes the provider detail keys for each identity provider type.

    • For Google and Login with Amazon:

      • client_id

      • client_secret

      • authorize_scopes

    • For Facebook:

      • client_id

      • client_secret

      • authorize_scopes

      • api_version

    • For Sign in with Apple:

      • client_id

      • team_id

      • key_id

      • private_key

      • authorize_scopes

    • For OIDC providers:

      • client_id

      • client_secret

      • attributes_request_method

      • oidc_issuer

      • authorize_scopes

      • authorize_url if not available from discovery URL specified by oidc_issuer key

      • token_url if not available from discovery URL specified by oidc_issuer key

      • attributes_url if not available from discovery URL specified by oidc_issuer key

      • jwks_uri if not available from discovery URL specified by oidc_issuer key

    • For SAML providers:

      • MetadataFile OR MetadataURL

      • IDPSignout (boolean) optional

      • IDPInit (boolean) optional

      • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

      • EncryptedResponses (boolean) optional

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to add to the identity provider resource. A tag is a key-value pair.

    
    
• On success, responds with CreateIdentityProviderOutput with field(s):
  • identity_provider_arn(String):

    The ARN of the identity provider.

• On failure, responds with SdkError<CreateIdentityProviderError>

impl Client

pub fn create_ip_access_settings(&self) -> CreateIpAccessSettingsFluentBuilder

Constructs a fluent builder for the CreateIpAccessSettings operation.

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

    The display name of the IP access settings.

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

    The description of the IP access settings.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to add to the IP access settings resource. A tag is a key-value pair.

    
    
  • customer_managed_key(impl Into<String>) / set_customer_managed_key(Option<String>):
    required: false
    

    The custom managed key of the IP access settings.

    
    
  • additional_encryption_context(impl Into<String>, impl Into<String>) / set_additional_encryption_context(Option<HashMap::<String, String>>):
    required: false
    

    Additional encryption context of the IP access settings.

    
    
  • ip_rules(IpRule) / set_ip_rules(Option<Vec::<IpRule>>):
    required: true
    

    The IP rules of the IP access settings.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with CreateIpAccessSettingsOutput with field(s):
  • ip_access_settings_arn(String):

    The ARN of the IP access settings resource.

• On failure, responds with SdkError<CreateIpAccessSettingsError>

impl Client

pub fn create_network_settings(&self) -> CreateNetworkSettingsFluentBuilder

Constructs a fluent builder for the CreateNetworkSettings operation.

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

    The VPC that streaming instances will connect to.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: true
    

    One or more security groups used to control access from streaming instances to your VPC.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to add to the network settings resource. A tag is a key-value pair.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with CreateNetworkSettingsOutput with field(s):
  • network_settings_arn(String):

    The ARN of the network settings.

• On failure, responds with SdkError<CreateNetworkSettingsError>

impl Client

pub fn create_portal(&self) -> CreatePortalFluentBuilder

Constructs a fluent builder for the CreatePortal operation.

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

    The name of the web portal. This is not visible to users who log into the web portal.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to add to the web portal. A tag is a key-value pair.

    
    
  • customer_managed_key(impl Into<String>) / set_customer_managed_key(Option<String>):
    required: false
    

    The customer managed key of the web portal.

    
    
  • additional_encryption_context(impl Into<String>, impl Into<String>) / set_additional_encryption_context(Option<HashMap::<String, String>>):
    required: false
    

    The additional encryption context of the portal.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

    The type of authentication integration points used when signing into the web portal. Defaults to Standard.

    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

    IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

    
    
  • instance_type(InstanceType) / set_instance_type(Option<InstanceType>):
    required: false
    

    The type and resources of the underlying instance.

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

    The maximum number of concurrent sessions for the portal.

    
    
• On success, responds with CreatePortalOutput with field(s):
  • portal_arn(String):

    The ARN of the web portal.

  • portal_endpoint(String):

    The endpoint URL of the web portal that users access in order to start streaming sessions.

• On failure, responds with SdkError<CreatePortalError>

impl Client

pub fn create_trust_store(&self) -> CreateTrustStoreFluentBuilder

Constructs a fluent builder for the CreateTrustStore operation.

• The fluent builder is configurable:
  • certificate_list(Blob) / set_certificate_list(Option<Vec::<Blob>>):
    required: true
    

    A list of CA certificates to be added to the trust store.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to add to the trust store. A tag is a key-value pair.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with CreateTrustStoreOutput with field(s):
  • trust_store_arn(String):

    The ARN of the trust store.

• On failure, responds with SdkError<CreateTrustStoreError>

impl Client

pub fn create_user_access_logging_settings( &self, ) -> CreateUserAccessLoggingSettingsFluentBuilder

Constructs a fluent builder for the CreateUserAccessLoggingSettings operation.

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

    The ARN of the Kinesis stream.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to add to the user settings resource. A tag is a key-value pair.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with CreateUserAccessLoggingSettingsOutput with field(s):
  • user_access_logging_settings_arn(String):

    The ARN of the user access logging settings.

• On failure, responds with SdkError<CreateUserAccessLoggingSettingsError>

impl Client

pub fn create_user_settings(&self) -> CreateUserSettingsFluentBuilder

Constructs a fluent builder for the CreateUserSettings operation.

• The fluent builder is configurable:
  • copy_allowed(EnabledType) / set_copy_allowed(Option<EnabledType>):
    required: true
    

    Specifies whether the user can copy text from the streaming session to the local device.

    
    
  • paste_allowed(EnabledType) / set_paste_allowed(Option<EnabledType>):
    required: true
    

    Specifies whether the user can paste text from the local device to the streaming session.

    
    
  • download_allowed(EnabledType) / set_download_allowed(Option<EnabledType>):
    required: true
    

    Specifies whether the user can download files from the streaming session to the local device.

    
    
  • upload_allowed(EnabledType) / set_upload_allowed(Option<EnabledType>):
    required: true
    

    Specifies whether the user can upload files from the local device to the streaming session.

    
    
  • print_allowed(EnabledType) / set_print_allowed(Option<EnabledType>):
    required: true
    

    Specifies whether the user can print to the local device.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to add to the user settings resource. A tag is a key-value pair.

    
    
  • disconnect_timeout_in_minutes(i32) / set_disconnect_timeout_in_minutes(Option<i32>):
    required: false
    

    The amount of time that a streaming session remains active after users disconnect.

    
    
  • idle_disconnect_timeout_in_minutes(i32) / set_idle_disconnect_timeout_in_minutes(Option<i32>):
    required: false
    

    The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
  • cookie_synchronization_configuration(CookieSynchronizationConfiguration) / set_cookie_synchronization_configuration(Option<CookieSynchronizationConfiguration>):
    required: false
    

    The configuration that specifies which cookies should be synchronized from the end user’s local browser to the remote browser.

    
    
  • customer_managed_key(impl Into<String>) / set_customer_managed_key(Option<String>):
    required: false
    

    The customer managed key used to encrypt sensitive information in the user settings.

    
    
  • additional_encryption_context(impl Into<String>, impl Into<String>) / set_additional_encryption_context(Option<HashMap::<String, String>>):
    required: false
    

    The additional encryption context of the user settings.

    
    
  • deep_link_allowed(EnabledType) / set_deep_link_allowed(Option<EnabledType>):
    required: false
    

    Specifies whether the user can use deep links that open automatically when connecting to a session.

    
    
• On success, responds with CreateUserSettingsOutput with field(s):
  • user_settings_arn(String):

    The ARN of the user settings.

• On failure, responds with SdkError<CreateUserSettingsError>

impl Client

pub fn delete_browser_settings(&self) -> DeleteBrowserSettingsFluentBuilder

Constructs a fluent builder for the DeleteBrowserSettings operation.

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

    The ARN of the browser settings.

    
    
• On success, responds with DeleteBrowserSettingsOutput
• On failure, responds with SdkError<DeleteBrowserSettingsError>

impl Client

pub fn delete_data_protection_settings( &self, ) -> DeleteDataProtectionSettingsFluentBuilder

Constructs a fluent builder for the DeleteDataProtectionSettings operation.

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

    The ARN of the data protection settings.

    
    
• On success, responds with DeleteDataProtectionSettingsOutput
• On failure, responds with SdkError<DeleteDataProtectionSettingsError>

impl Client

pub fn delete_identity_provider(&self) -> DeleteIdentityProviderFluentBuilder

Constructs a fluent builder for the DeleteIdentityProvider operation.

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

    The ARN of the identity provider.

    
    
• On success, responds with DeleteIdentityProviderOutput
• On failure, responds with SdkError<DeleteIdentityProviderError>

impl Client

pub fn delete_ip_access_settings(&self) -> DeleteIpAccessSettingsFluentBuilder

Constructs a fluent builder for the DeleteIpAccessSettings operation.

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

    The ARN of the IP access settings.

    
    
• On success, responds with DeleteIpAccessSettingsOutput
• On failure, responds with SdkError<DeleteIpAccessSettingsError>

impl Client

pub fn delete_network_settings(&self) -> DeleteNetworkSettingsFluentBuilder

Constructs a fluent builder for the DeleteNetworkSettings operation.

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

    The ARN of the network settings.

    
    
• On success, responds with DeleteNetworkSettingsOutput
• On failure, responds with SdkError<DeleteNetworkSettingsError>

impl Client

pub fn delete_portal(&self) -> DeletePortalFluentBuilder

Constructs a fluent builder for the DeletePortal operation.

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

    The ARN of the web portal.

    
    
• On success, responds with DeletePortalOutput
• On failure, responds with SdkError<DeletePortalError>

impl Client

pub fn delete_trust_store(&self) -> DeleteTrustStoreFluentBuilder

Constructs a fluent builder for the DeleteTrustStore operation.

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

    The ARN of the trust store.

    
    
• On success, responds with DeleteTrustStoreOutput
• On failure, responds with SdkError<DeleteTrustStoreError>

impl Client

pub fn delete_user_access_logging_settings( &self, ) -> DeleteUserAccessLoggingSettingsFluentBuilder

Constructs a fluent builder for the DeleteUserAccessLoggingSettings operation.

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

    The ARN of the user access logging settings.

    
    
• On success, responds with DeleteUserAccessLoggingSettingsOutput
• On failure, responds with SdkError<DeleteUserAccessLoggingSettingsError>

impl Client

pub fn delete_user_settings(&self) -> DeleteUserSettingsFluentBuilder

Constructs a fluent builder for the DeleteUserSettings operation.

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

    The ARN of the user settings.

    
    
• On success, responds with DeleteUserSettingsOutput
• On failure, responds with SdkError<DeleteUserSettingsError>

impl Client

pub fn disassociate_browser_settings( &self, ) -> DisassociateBrowserSettingsFluentBuilder

Constructs a fluent builder for the DisassociateBrowserSettings operation.

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

    The ARN of the web portal.

    
    
• On success, responds with DisassociateBrowserSettingsOutput
• On failure, responds with SdkError<DisassociateBrowserSettingsError>

impl Client

pub fn disassociate_data_protection_settings( &self, ) -> DisassociateDataProtectionSettingsFluentBuilder

Constructs a fluent builder for the DisassociateDataProtectionSettings operation.

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

    The ARN of the web portal.

    
    
• On success, responds with DisassociateDataProtectionSettingsOutput
• On failure, responds with SdkError<DisassociateDataProtectionSettingsError>

impl Client

pub fn disassociate_ip_access_settings( &self, ) -> DisassociateIpAccessSettingsFluentBuilder

Constructs a fluent builder for the DisassociateIpAccessSettings operation.

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

    The ARN of the web portal.

    
    
• On success, responds with DisassociateIpAccessSettingsOutput
• On failure, responds with SdkError<DisassociateIpAccessSettingsError>

impl Client

pub fn disassociate_network_settings( &self, ) -> DisassociateNetworkSettingsFluentBuilder

Constructs a fluent builder for the DisassociateNetworkSettings operation.

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

    The ARN of the web portal.

    
    
• On success, responds with DisassociateNetworkSettingsOutput
• On failure, responds with SdkError<DisassociateNetworkSettingsError>

impl Client

pub fn disassociate_trust_store(&self) -> DisassociateTrustStoreFluentBuilder

Constructs a fluent builder for the DisassociateTrustStore operation.

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

    The ARN of the web portal.

    
    
• On success, responds with DisassociateTrustStoreOutput
• On failure, responds with SdkError<DisassociateTrustStoreError>

impl Client

pub fn disassociate_user_access_logging_settings( &self, ) -> DisassociateUserAccessLoggingSettingsFluentBuilder

Constructs a fluent builder for the DisassociateUserAccessLoggingSettings operation.

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

    The ARN of the web portal.

    
    
• On success, responds with DisassociateUserAccessLoggingSettingsOutput
• On failure, responds with SdkError<DisassociateUserAccessLoggingSettingsError>

impl Client

pub fn disassociate_user_settings( &self, ) -> DisassociateUserSettingsFluentBuilder

Constructs a fluent builder for the DisassociateUserSettings operation.

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

    The ARN of the web portal.

    
    
• On success, responds with DisassociateUserSettingsOutput
• On failure, responds with SdkError<DisassociateUserSettingsError>

impl Client

pub fn expire_session(&self) -> ExpireSessionFluentBuilder

Constructs a fluent builder for the ExpireSession operation.

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

    The ID of the web portal for the session.

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

    The ID of the session to expire.

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

impl Client

pub fn get_browser_settings(&self) -> GetBrowserSettingsFluentBuilder

Constructs a fluent builder for the GetBrowserSettings operation.

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

    The ARN of the browser settings.

    
    
• On success, responds with GetBrowserSettingsOutput with field(s):
  • browser_settings(Option<BrowserSettings>):

    The browser settings.

• On failure, responds with SdkError<GetBrowserSettingsError>

impl Client

pub fn get_data_protection_settings( &self, ) -> GetDataProtectionSettingsFluentBuilder

Constructs a fluent builder for the GetDataProtectionSettings operation.

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

    The ARN of the data protection settings.

    
    
• On success, responds with GetDataProtectionSettingsOutput with field(s):
  • data_protection_settings(Option<DataProtectionSettings>):

    The data protection settings.

• On failure, responds with SdkError<GetDataProtectionSettingsError>

impl Client

pub fn get_identity_provider(&self) -> GetIdentityProviderFluentBuilder

Constructs a fluent builder for the GetIdentityProvider operation.

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

    The ARN of the identity provider.

    
    
• On success, responds with GetIdentityProviderOutput with field(s):
  • identity_provider(Option<IdentityProvider>):

    The identity provider.

• On failure, responds with SdkError<GetIdentityProviderError>

impl Client

pub fn get_ip_access_settings(&self) -> GetIpAccessSettingsFluentBuilder

Constructs a fluent builder for the GetIpAccessSettings operation.

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

    The ARN of the IP access settings.

    
    
• On success, responds with GetIpAccessSettingsOutput with field(s):
  • ip_access_settings(Option<IpAccessSettings>):

    The IP access settings.

• On failure, responds with SdkError<GetIpAccessSettingsError>

impl Client

pub fn get_network_settings(&self) -> GetNetworkSettingsFluentBuilder

Constructs a fluent builder for the GetNetworkSettings operation.

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

    The ARN of the network settings.

    
    
• On success, responds with GetNetworkSettingsOutput with field(s):
  • network_settings(Option<NetworkSettings>):

    The network settings.

• On failure, responds with SdkError<GetNetworkSettingsError>

impl Client

pub fn get_portal(&self) -> GetPortalFluentBuilder

Constructs a fluent builder for the GetPortal operation.

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

    The ARN of the web portal.

    
    
• On success, responds with GetPortalOutput with field(s):
  • portal(Option<Portal>):

    The web portal.

• On failure, responds with SdkError<GetPortalError>

impl Client

pub fn get_portal_service_provider_metadata( &self, ) -> GetPortalServiceProviderMetadataFluentBuilder

Constructs a fluent builder for the GetPortalServiceProviderMetadata operation.

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

    The ARN of the web portal.

    
    
• On success, responds with GetPortalServiceProviderMetadataOutput with field(s):
  • portal_arn(String):

    The ARN of the web portal.

  • service_provider_saml_metadata(Option<String>):

    The service provider SAML metadata.

• On failure, responds with SdkError<GetPortalServiceProviderMetadataError>

impl Client

pub fn get_session(&self) -> GetSessionFluentBuilder

Constructs a fluent builder for the GetSession operation.

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

    The ID of the web portal for the session.

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

    The ID of the session.

    
    
• On success, responds with GetSessionOutput with field(s):
  • session(Option<Session>):

    The sessions in a list.

• On failure, responds with SdkError<GetSessionError>

impl Client

pub fn get_trust_store(&self) -> GetTrustStoreFluentBuilder

Constructs a fluent builder for the GetTrustStore operation.

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

    The ARN of the trust store.

    
    
• On success, responds with GetTrustStoreOutput with field(s):
  • trust_store(Option<TrustStore>):

    The trust store.

• On failure, responds with SdkError<GetTrustStoreError>

impl Client

pub fn get_trust_store_certificate( &self, ) -> GetTrustStoreCertificateFluentBuilder

Constructs a fluent builder for the GetTrustStoreCertificate operation.

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

    The ARN of the trust store certificate.

    
    
  • thumbprint(impl Into<String>) / set_thumbprint(Option<String>):
    required: true
    

    The thumbprint of the trust store certificate.

    
    
• On success, responds with GetTrustStoreCertificateOutput with field(s):
  • trust_store_arn(String):

    The ARN of the trust store certificate.

  • certificate(Option<Certificate>):

    The certificate of the trust store certificate.

• On failure, responds with SdkError<GetTrustStoreCertificateError>

impl Client

pub fn get_user_access_logging_settings( &self, ) -> GetUserAccessLoggingSettingsFluentBuilder

Constructs a fluent builder for the GetUserAccessLoggingSettings operation.

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

    The ARN of the user access logging settings.

    
    
• On success, responds with GetUserAccessLoggingSettingsOutput with field(s):
  • user_access_logging_settings(Option<UserAccessLoggingSettings>):

    The user access logging settings.

• On failure, responds with SdkError<GetUserAccessLoggingSettingsError>

impl Client

pub fn get_user_settings(&self) -> GetUserSettingsFluentBuilder

Constructs a fluent builder for the GetUserSettings operation.

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

    The ARN of the user settings.

    
    
• On success, responds with GetUserSettingsOutput with field(s):
  • user_settings(Option<UserSettings>):

    The user settings.

• On failure, responds with SdkError<GetUserSettingsError>

impl Client

pub fn list_browser_settings(&self) -> ListBrowserSettingsFluentBuilder

Constructs a fluent builder for the ListBrowserSettings 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 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 number of results to be included in the next page.

    
    
• On success, responds with ListBrowserSettingsOutput with field(s):
  • browser_settings(Option<Vec::<BrowserSettingsSummary>>):

    The browser settings.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListBrowserSettingsError>

impl Client

pub fn list_data_protection_settings( &self, ) -> ListDataProtectionSettingsFluentBuilder

Constructs a fluent builder for the ListDataProtectionSettings 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 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 number of results to be included in the next page.

    
    
• On success, responds with ListDataProtectionSettingsOutput with field(s):
  • data_protection_settings(Option<Vec::<DataProtectionSettingsSummary>>):

    The data protection settings.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListDataProtectionSettingsError>

impl Client

pub fn list_identity_providers(&self) -> ListIdentityProvidersFluentBuilder

Constructs a fluent builder for the ListIdentityProviders 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 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 number of results to be included in the next page.

    
    
  • portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
    required: true
    

    The ARN of the web portal.

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

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

  • identity_providers(Option<Vec::<IdentityProviderSummary>>):

    The identity providers.

• On failure, responds with SdkError<ListIdentityProvidersError>

impl Client

pub fn list_ip_access_settings(&self) -> ListIpAccessSettingsFluentBuilder

Constructs a fluent builder for the ListIpAccessSettings 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 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 number of results to be included in the next page.

    
    
• On success, responds with ListIpAccessSettingsOutput with field(s):
  • ip_access_settings(Option<Vec::<IpAccessSettingsSummary>>):

    The IP access settings.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListIpAccessSettingsError>

impl Client

pub fn list_network_settings(&self) -> ListNetworkSettingsFluentBuilder

Constructs a fluent builder for the ListNetworkSettings 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 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 number of results to be included in the next page.

    
    
• On success, responds with ListNetworkSettingsOutput with field(s):
  • network_settings(Option<Vec::<NetworkSettingsSummary>>):

    The network settings.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListNetworkSettingsError>

impl Client

pub fn list_portals(&self) -> ListPortalsFluentBuilder

Constructs a fluent builder for the ListPortals 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 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 number of results to be included in the next page.

    
    
• On success, responds with ListPortalsOutput with field(s):
  • portals(Option<Vec::<PortalSummary>>):

    The portals 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<ListPortalsError>

impl Client

pub fn list_sessions(&self) -> ListSessionsFluentBuilder

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

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

    The ID of the web portal for the sessions.

    
    
  • username(impl Into<String>) / set_username(Option<String>):
    required: false
    

    The username of the session.

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

    The ID of the session.

    
    
  • sort_by(SessionSortBy) / set_sort_by(Option<SessionSortBy>):
    required: false
    

    The method in which the returned sessions should be sorted.

    
    
  • status(SessionStatus) / set_status(Option<SessionStatus>):
    required: false
    

    The status of the session.

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

    The maximum number of results to be included in the next page.

    
    
  • 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 ListSessionsOutput with field(s):
  • sessions(Vec::<SessionSummary>):

    The sessions in a list.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListSessionsError>

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 ARN of the resource.

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

    The tags of the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_trust_store_certificates( &self, ) -> ListTrustStoreCertificatesFluentBuilder

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

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

    The ARN of the trust store

    
    
  • 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 number of results to be included in the next page.

    
    
• On success, responds with ListTrustStoreCertificatesOutput with field(s):
  • certificate_list(Option<Vec::<CertificateSummary>>):

    The certificate list.

  • trust_store_arn(String):

    The ARN of the trust store.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListTrustStoreCertificatesError>

impl Client

pub fn list_trust_stores(&self) -> ListTrustStoresFluentBuilder

Constructs a fluent builder for the ListTrustStores 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 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 number of results to be included in the next page.

    
    
• On success, responds with ListTrustStoresOutput with field(s):
  • trust_stores(Option<Vec::<TrustStoreSummary>>):

    The trust stores.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListTrustStoresError>

impl Client

pub fn list_user_access_logging_settings( &self, ) -> ListUserAccessLoggingSettingsFluentBuilder

Constructs a fluent builder for the ListUserAccessLoggingSettings 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 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 number of results to be included in the next page.

    
    
• On success, responds with ListUserAccessLoggingSettingsOutput with field(s):
  • user_access_logging_settings(Option<Vec::<UserAccessLoggingSettingsSummary>>):

    The user access logging settings.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListUserAccessLoggingSettingsError>

impl Client

pub fn list_user_settings(&self) -> ListUserSettingsFluentBuilder

Constructs a fluent builder for the ListUserSettings 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 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 number of results to be included in the next page.

    
    
• On success, responds with ListUserSettingsOutput with field(s):
  • user_settings(Option<Vec::<UserSettingsSummary>>):

    The user settings.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListUserSettingsError>

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 ARN of the resource.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tags of the resource.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• 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 ARN of the resource.

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

    The list of tag keys to remove from the resource.

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

impl Client

pub fn update_browser_settings(&self) -> UpdateBrowserSettingsFluentBuilder

Constructs a fluent builder for the UpdateBrowserSettings operation.

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

    The ARN of the browser settings.

    
    
  • browser_policy(impl Into<String>) / set_browser_policy(Option<String>):
    required: false
    

    A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with UpdateBrowserSettingsOutput with field(s):
  • browser_settings(Option<BrowserSettings>):

    The browser settings.

• On failure, responds with SdkError<UpdateBrowserSettingsError>

impl Client

pub fn update_data_protection_settings( &self, ) -> UpdateDataProtectionSettingsFluentBuilder

Constructs a fluent builder for the UpdateDataProtectionSettings operation.

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

    The ARN of the data protection settings.

    
    
  • inline_redaction_configuration(InlineRedactionConfiguration) / set_inline_redaction_configuration(Option<InlineRedactionConfiguration>):
    required: false
    

    The inline redaction configuration of the data protection settings that will be applied to all sessions.

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

    The display name of the data protection settings.

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

    The description of the data protection settings.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with UpdateDataProtectionSettingsOutput with field(s):
  • data_protection_settings(Option<DataProtectionSettings>):

    The data protection settings.

• On failure, responds with SdkError<UpdateDataProtectionSettingsError>

impl Client

pub fn update_identity_provider(&self) -> UpdateIdentityProviderFluentBuilder

Constructs a fluent builder for the UpdateIdentityProvider operation.

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

    The ARN of the identity provider.

    
    
  • identity_provider_name(impl Into<String>) / set_identity_provider_name(Option<String>):
    required: false
    

    The name of the identity provider.

    
    
  • identity_provider_type(IdentityProviderType) / set_identity_provider_type(Option<IdentityProviderType>):
    required: false
    

    The type of the identity provider.

    
    
  • identity_provider_details(impl Into<String>, impl Into<String>) / set_identity_provider_details(Option<HashMap::<String, String>>):
    required: false
    

    The details of the identity provider. The following list describes the provider detail keys for each identity provider type.

    • For Google and Login with Amazon:

      • client_id

      • client_secret

      • authorize_scopes

    • For Facebook:

      • client_id

      • client_secret

      • authorize_scopes

      • api_version

    • For Sign in with Apple:

      • client_id

      • team_id

      • key_id

      • private_key

      • authorize_scopes

    • For OIDC providers:

      • client_id

      • client_secret

      • attributes_request_method

      • oidc_issuer

      • authorize_scopes

      • authorize_url if not available from discovery URL specified by oidc_issuer key

      • token_url if not available from discovery URL specified by oidc_issuer key

      • attributes_url if not available from discovery URL specified by oidc_issuer key

      • jwks_uri if not available from discovery URL specified by oidc_issuer key

    • For SAML providers:

      • MetadataFile OR MetadataURL

      • IDPSignout (boolean) optional

      • IDPInit (boolean) optional

      • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

      • EncryptedResponses (boolean) optional

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with UpdateIdentityProviderOutput with field(s):
  • identity_provider(Option<IdentityProvider>):

    The identity provider.

• On failure, responds with SdkError<UpdateIdentityProviderError>

impl Client

pub fn update_ip_access_settings(&self) -> UpdateIpAccessSettingsFluentBuilder

Constructs a fluent builder for the UpdateIpAccessSettings operation.

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

    The ARN of the IP access settings.

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

    The display name of the IP access settings.

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

    The description of the IP access settings.

    
    
  • ip_rules(IpRule) / set_ip_rules(Option<Vec::<IpRule>>):
    required: false
    

    The updated IP rules of the IP access settings.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with UpdateIpAccessSettingsOutput with field(s):
  • ip_access_settings(Option<IpAccessSettings>):

    The IP access settings.

• On failure, responds with SdkError<UpdateIpAccessSettingsError>

impl Client

pub fn update_network_settings(&self) -> UpdateNetworkSettingsFluentBuilder

Constructs a fluent builder for the UpdateNetworkSettings operation.

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

    The ARN of the network settings.

    
    
  • vpc_id(impl Into<String>) / set_vpc_id(Option<String>):
    required: false
    

    The VPC that streaming instances will connect to.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: false
    

    The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    One or more security groups used to control access from streaming instances to your VPC.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with UpdateNetworkSettingsOutput with field(s):
  • network_settings(Option<NetworkSettings>):

    The network settings.

• On failure, responds with SdkError<UpdateNetworkSettingsError>

impl Client

pub fn update_portal(&self) -> UpdatePortalFluentBuilder

Constructs a fluent builder for the UpdatePortal operation.

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

    The ARN of the web portal.

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

    The name of the web portal. This is not visible to users who log into the web portal.

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

    The type of authentication integration points used when signing into the web portal. Defaults to Standard.

    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

    IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

    
    
  • instance_type(InstanceType) / set_instance_type(Option<InstanceType>):
    required: false
    

    The type and resources of the underlying instance.

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

    The maximum number of concurrent sessions for the portal.

    
    
• On success, responds with UpdatePortalOutput with field(s):
  • portal(Option<Portal>):

    The web portal.

• On failure, responds with SdkError<UpdatePortalError>

impl Client

pub fn update_trust_store(&self) -> UpdateTrustStoreFluentBuilder

Constructs a fluent builder for the UpdateTrustStore operation.

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

    The ARN of the trust store.

    
    
  • certificates_to_add(Blob) / set_certificates_to_add(Option<Vec::<Blob>>):
    required: false
    

    A list of CA certificates to add to the trust store.

    
    
  • certificates_to_delete(impl Into<String>) / set_certificates_to_delete(Option<Vec::<String>>):
    required: false
    

    A list of CA certificates to delete from a trust store.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with UpdateTrustStoreOutput with field(s):
  • trust_store_arn(String):

    The ARN of the trust store.

• On failure, responds with SdkError<UpdateTrustStoreError>

impl Client

pub fn update_user_access_logging_settings( &self, ) -> UpdateUserAccessLoggingSettingsFluentBuilder

Constructs a fluent builder for the UpdateUserAccessLoggingSettings operation.

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

    The ARN of the user access logging settings.

    
    
  • kinesis_stream_arn(impl Into<String>) / set_kinesis_stream_arn(Option<String>):
    required: false
    

    The ARN of the Kinesis stream.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with UpdateUserAccessLoggingSettingsOutput with field(s):
  • user_access_logging_settings(Option<UserAccessLoggingSettings>):

    The user access logging settings.

• On failure, responds with SdkError<UpdateUserAccessLoggingSettingsError>

impl Client

pub fn update_user_settings(&self) -> UpdateUserSettingsFluentBuilder

Constructs a fluent builder for the UpdateUserSettings operation.

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

    The ARN of the user settings.

    
    
  • copy_allowed(EnabledType) / set_copy_allowed(Option<EnabledType>):
    required: false
    

    Specifies whether the user can copy text from the streaming session to the local device.

    
    
  • paste_allowed(EnabledType) / set_paste_allowed(Option<EnabledType>):
    required: false
    

    Specifies whether the user can paste text from the local device to the streaming session.

    
    
  • download_allowed(EnabledType) / set_download_allowed(Option<EnabledType>):
    required: false
    

    Specifies whether the user can download files from the streaming session to the local device.

    
    
  • upload_allowed(EnabledType) / set_upload_allowed(Option<EnabledType>):
    required: false
    

    Specifies whether the user can upload files from the local device to the streaming session.

    
    
  • print_allowed(EnabledType) / set_print_allowed(Option<EnabledType>):
    required: false
    

    Specifies whether the user can print to the local device.

    
    
  • disconnect_timeout_in_minutes(i32) / set_disconnect_timeout_in_minutes(Option<i32>):
    required: false
    

    The amount of time that a streaming session remains active after users disconnect.

    
    
  • idle_disconnect_timeout_in_minutes(i32) / set_idle_disconnect_timeout_in_minutes(Option<i32>):
    required: false
    

    The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
  • cookie_synchronization_configuration(CookieSynchronizationConfiguration) / set_cookie_synchronization_configuration(Option<CookieSynchronizationConfiguration>):
    required: false
    

    The configuration that specifies which cookies should be synchronized from the end user’s local browser to the remote browser.

    If the allowlist and blocklist are empty, the configuration becomes null.

    
    
  • deep_link_allowed(EnabledType) / set_deep_link_allowed(Option<EnabledType>):
    required: false
    

    Specifies whether the user can use deep links that open automatically when connecting to a session.

    
    
• On success, responds with UpdateUserSettingsOutput with field(s):
  • user_settings(Option<UserSettings>):

    The user settings.

• On failure, responds with SdkError<UpdateUserSettingsError>

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.