Struct aws_sdk_workspacesweb::Client

source ·

pub struct Client { /* private fields */ }

Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_workspacesweb::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_workspacesweb::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_workspacesweb::Client::from_conf(config);

Implementations§

source §

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source §

impl Client

source

pub fn associate_browser_settings(&self) -> AssociateBrowserSettings

Constructs a fluent builder for the AssociateBrowserSettings operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
- browser_settings_arn(impl Into<String>) / set_browser_settings_arn(Option<String>):
 The ARN of the browser settings.
On success, responds with AssociateBrowserSettingsOutput with field(s):
- portal_arn(Option<String>):
 The ARN of the web portal.
- browser_settings_arn(Option<String>):
 The ARN of the browser settings.
On failure, responds with SdkError<AssociateBrowserSettingsError>

source

pub fn associate_network_settings(&self) -> AssociateNetworkSettings

Constructs a fluent builder for the AssociateNetworkSettings operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
- network_settings_arn(impl Into<String>) / set_network_settings_arn(Option<String>):
 The ARN of the network settings.
On success, responds with AssociateNetworkSettingsOutput with field(s):
- portal_arn(Option<String>):
 The ARN of the web portal.
- network_settings_arn(Option<String>):
 The ARN of the network settings.
On failure, responds with SdkError<AssociateNetworkSettingsError>

source

pub fn associate_trust_store(&self) -> AssociateTrustStore

Constructs a fluent builder for the AssociateTrustStore operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
- trust_store_arn(impl Into<String>) / set_trust_store_arn(Option<String>):
 The ARN of the trust store.
On success, responds with AssociateTrustStoreOutput with field(s):
- portal_arn(Option<String>):
 The ARN of the web portal.
- trust_store_arn(Option<String>):
 The ARN of the trust store.
On failure, responds with SdkError<AssociateTrustStoreError>

source

pub fn associate_user_access_logging_settings(
&self
) -> AssociateUserAccessLoggingSettings

Constructs a fluent builder for the AssociateUserAccessLoggingSettings operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
- user_access_logging_settings_arn(impl Into<String>) / set_user_access_logging_settings_arn(Option<String>):
 The ARN of the user access logging settings.
On success, responds with AssociateUserAccessLoggingSettingsOutput with field(s):
- portal_arn(Option<String>):
 The ARN of the web portal.
- user_access_logging_settings_arn(Option<String>):
 The ARN of the user access logging settings.
On failure, responds with SdkError<AssociateUserAccessLoggingSettingsError>

source

pub fn associate_user_settings(&self) -> AssociateUserSettings

Constructs a fluent builder for the AssociateUserSettings operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
- user_settings_arn(impl Into<String>) / set_user_settings_arn(Option<String>):
 The ARN of the user settings.
On success, responds with AssociateUserSettingsOutput with field(s):
- portal_arn(Option<String>):
 The ARN of the web portal.
- user_settings_arn(Option<String>):
 The ARN of the user settings.
On failure, responds with SdkError<AssociateUserSettingsError>

source

pub fn create_browser_settings(&self) -> CreateBrowserSettings

Constructs a fluent builder for the CreateBrowserSettings operation.

The fluent builder is configurable:
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 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>):
 The custom managed key of the browser settings.
- additional_encryption_context(HashMap<String, String>) / set_additional_encryption_context(Option<HashMap<String, String>>):
 Additional encryption context of the browser settings.
- browser_policy(impl Into<String>) / set_browser_policy(Option<String>):
 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>):
 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 AWS SDK.
On success, responds with CreateBrowserSettingsOutput with field(s):
- browser_settings_arn(Option<String>):
 The ARN of the browser settings.
On failure, responds with SdkError<CreateBrowserSettingsError>

source

pub fn create_identity_provider(&self) -> CreateIdentityProvider

Constructs a fluent builder for the CreateIdentityProvider operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
- identity_provider_name(impl Into<String>) / set_identity_provider_name(Option<String>):
 The identity provider name.
- identity_provider_type(IdentityProviderType) / set_identity_provider_type(Option<IdentityProviderType>):
 The identity provider type.
- identity_provider_details(HashMap<String, String>) / set_identity_provider_details(Option<HashMap<String, String>>):
 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
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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 AWS SDK.
On success, responds with CreateIdentityProviderOutput with field(s):
- identity_provider_arn(Option<String>):
 The ARN of the identity provider.
On failure, responds with SdkError<CreateIdentityProviderError>

source

pub fn create_network_settings(&self) -> CreateNetworkSettings

Constructs a fluent builder for the CreateNetworkSettings operation.

The fluent builder is configurable:
- vpc_id(impl Into<String>) / set_vpc_id(Option<String>):
 The VPC that streaming instances will connect to.
- subnet_ids(Vec<String>) / set_subnet_ids(Option<Vec<String>>):
 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(Vec<String>) / set_security_group_ids(Option<Vec<String>>):
 One or more security groups used to control access from streaming instances to your VPC.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 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>):
 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 AWS SDK.
On success, responds with CreateNetworkSettingsOutput with field(s):
- network_settings_arn(Option<String>):
 The ARN of the network settings.
On failure, responds with SdkError<CreateNetworkSettingsError>

source

pub fn create_portal(&self) -> CreatePortal

Constructs a fluent builder for the CreatePortal operation.

The fluent builder is configurable:
- display_name(impl Into<String>) / set_display_name(Option<String>):
 The name of the web portal. This is not visible to users who log into the web portal.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 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>):
 The customer managed key of the web portal.
- additional_encryption_context(HashMap<String, String>) / set_additional_encryption_context(Option<HashMap<String, String>>):
 The additional encryption context of the portal.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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 AWS SDK.
- authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):
 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 AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
On success, responds with CreatePortalOutput with field(s):
- portal_arn(Option<String>):
 The ARN of the web portal.
- portal_endpoint(Option<String>):
 The endpoint URL of the web portal that users access in order to start streaming sessions.
On failure, responds with SdkError<CreatePortalError>

source

pub fn create_trust_store(&self) -> CreateTrustStore

Constructs a fluent builder for the CreateTrustStore operation.

The fluent builder is configurable:
- certificate_list(Vec<Blob>) / set_certificate_list(Option<Vec<Blob>>):
 A list of CA certificates to be added to the trust store.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 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>):
 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 AWS SDK.
On success, responds with CreateTrustStoreOutput with field(s):
- trust_store_arn(Option<String>):
 The ARN of the trust store.
On failure, responds with SdkError<CreateTrustStoreError>

source

pub fn create_user_access_logging_settings(
&self
) -> CreateUserAccessLoggingSettings

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>):
 The ARN of the Kinesis stream.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 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>):
 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 AWS SDK.
On success, responds with CreateUserAccessLoggingSettingsOutput with field(s):
- user_access_logging_settings_arn(Option<String>):
 The ARN of the user access logging settings.
On failure, responds with SdkError<CreateUserAccessLoggingSettingsError>

source

pub fn create_user_settings(&self) -> CreateUserSettings

Constructs a fluent builder for the CreateUserSettings operation.

The fluent builder is configurable:
- copy_allowed(EnabledType) / set_copy_allowed(Option<EnabledType>):
 Specifies whether the user can copy text from the streaming session to the local device.
- paste_allowed(EnabledType) / set_paste_allowed(Option<EnabledType>):
 Specifies whether the user can paste text from the local device to the streaming session.
- download_allowed(EnabledType) / set_download_allowed(Option<EnabledType>):
 Specifies whether the user can download files from the streaming session to the local device.
- upload_allowed(EnabledType) / set_upload_allowed(Option<EnabledType>):
 Specifies whether the user can upload files from the local device to the streaming session.
- print_allowed(EnabledType) / set_print_allowed(Option<EnabledType>):
 Specifies whether the user can print to the local device.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 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>):
 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>):
 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>):
 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 AWS SDK.
On success, responds with CreateUserSettingsOutput with field(s):
- user_settings_arn(Option<String>):
 The ARN of the user settings.
On failure, responds with SdkError<CreateUserSettingsError>

source

pub fn delete_browser_settings(&self) -> DeleteBrowserSettings

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>):
 The ARN of the browser settings.
On success, responds with DeleteBrowserSettingsOutput
On failure, responds with SdkError<DeleteBrowserSettingsError>

source

pub fn delete_identity_provider(&self) -> DeleteIdentityProvider

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>):
 The ARN of the identity provider.
On success, responds with DeleteIdentityProviderOutput
On failure, responds with SdkError<DeleteIdentityProviderError>

source

pub fn delete_network_settings(&self) -> DeleteNetworkSettings

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>):
 The ARN of the network settings.
On success, responds with DeleteNetworkSettingsOutput
On failure, responds with SdkError<DeleteNetworkSettingsError>

source

pub fn delete_portal(&self) -> DeletePortal

Constructs a fluent builder for the DeletePortal operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
On success, responds with DeletePortalOutput
On failure, responds with SdkError<DeletePortalError>

source

pub fn delete_trust_store(&self) -> DeleteTrustStore

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>):
 The ARN of the trust store.
On success, responds with DeleteTrustStoreOutput
On failure, responds with SdkError<DeleteTrustStoreError>

source

pub fn delete_user_access_logging_settings(
&self
) -> DeleteUserAccessLoggingSettings

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>):
 The ARN of the user access logging settings.
On success, responds with DeleteUserAccessLoggingSettingsOutput
On failure, responds with SdkError<DeleteUserAccessLoggingSettingsError>

source

pub fn delete_user_settings(&self) -> DeleteUserSettings

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>):
 The ARN of the user settings.
On success, responds with DeleteUserSettingsOutput
On failure, responds with SdkError<DeleteUserSettingsError>

source

pub fn disassociate_browser_settings(&self) -> DisassociateBrowserSettings

Constructs a fluent builder for the DisassociateBrowserSettings operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
On success, responds with DisassociateBrowserSettingsOutput
On failure, responds with SdkError<DisassociateBrowserSettingsError>

source

pub fn disassociate_network_settings(&self) -> DisassociateNetworkSettings

Constructs a fluent builder for the DisassociateNetworkSettings operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
On success, responds with DisassociateNetworkSettingsOutput
On failure, responds with SdkError<DisassociateNetworkSettingsError>

source

pub fn disassociate_trust_store(&self) -> DisassociateTrustStore

Constructs a fluent builder for the DisassociateTrustStore operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
On success, responds with DisassociateTrustStoreOutput
On failure, responds with SdkError<DisassociateTrustStoreError>

source

pub fn disassociate_user_access_logging_settings(
&self
) -> DisassociateUserAccessLoggingSettings

Constructs a fluent builder for the DisassociateUserAccessLoggingSettings operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
On success, responds with DisassociateUserAccessLoggingSettingsOutput
On failure, responds with SdkError<DisassociateUserAccessLoggingSettingsError>

source

pub fn disassociate_user_settings(&self) -> DisassociateUserSettings

Constructs a fluent builder for the DisassociateUserSettings operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
On success, responds with DisassociateUserSettingsOutput
On failure, responds with SdkError<DisassociateUserSettingsError>

source

pub fn get_browser_settings(&self) -> GetBrowserSettings

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

source

pub fn get_identity_provider(&self) -> GetIdentityProvider

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

source

pub fn get_network_settings(&self) -> GetNetworkSettings

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

source

pub fn get_portal(&self) -> GetPortal

Constructs a fluent builder for the GetPortal operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 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>

source

pub fn get_portal_service_provider_metadata(
&self
) -> GetPortalServiceProviderMetadata

Constructs a fluent builder for the GetPortalServiceProviderMetadata operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
On success, responds with GetPortalServiceProviderMetadataOutput with field(s):
- portal_arn(Option<String>):
 The ARN of the web portal.
- service_provider_saml_metadata(Option<String>):
 The service provider SAML metadata.
On failure, responds with SdkError<GetPortalServiceProviderMetadataError>

source

pub fn get_trust_store(&self) -> GetTrustStore

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

source

pub fn get_trust_store_certificate(&self) -> GetTrustStoreCertificate

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>):
 The ARN of the trust store certificate.
- thumbprint(impl Into<String>) / set_thumbprint(Option<String>):
 The thumbprint of the trust store certificate.
On success, responds with GetTrustStoreCertificateOutput with field(s):
- trust_store_arn(Option<String>):
 The ARN of the trust store certificate.
- certificate(Option<Certificate>):
 The certificate of the trust store certificate.
On failure, responds with SdkError<GetTrustStoreCertificateError>

source

pub fn get_user_access_logging_settings(&self) -> GetUserAccessLoggingSettings

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

source

pub fn get_user_settings(&self) -> GetUserSettings

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

source

pub fn list_browser_settings(&self) -> ListBrowserSettings

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>):
 The pagination token used to retrieve the next page of results for this operation.
- max_results(i32) / set_max_results(Option<i32>):
 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>

source

pub fn list_identity_providers(&self) -> ListIdentityProviders

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>):
 The pagination token used to retrieve the next page of results for this operation.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to be included in the next page.
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 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>

source

pub fn list_network_settings(&self) -> ListNetworkSettings

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>):
 The pagination token used to retrieve the next page of results for this operation.
- max_results(i32) / set_max_results(Option<i32>):
 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>

source

pub fn list_portals(&self) -> ListPortals

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>):
 The pagination token used to retrieve the next page of results for this operation.
- max_results(i32) / set_max_results(Option<i32>):
 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>

source

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 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>

source

pub fn list_trust_store_certificates(&self) -> ListTrustStoreCertificates

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>):
 The ARN of the trust store
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The pagination token used to retrieve the next page of results for this operation.
- max_results(i32) / set_max_results(Option<i32>):
 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(Option<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>

source

pub fn list_trust_stores(&self) -> ListTrustStores

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>):
 The pagination token used to retrieve the next page of results for this operation.
- max_results(i32) / set_max_results(Option<i32>):
 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>

source

pub fn list_user_access_logging_settings(&self) -> ListUserAccessLoggingSettings

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>):
 The pagination token used to retrieve the next page of results for this operation.
- max_results(i32) / set_max_results(Option<i32>):
 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>

source

pub fn list_user_settings(&self) -> ListUserSettings

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>):
 The pagination token used to retrieve the next page of results for this operation.
- max_results(i32) / set_max_results(Option<i32>):
 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>

source

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The ARN of the resource.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 The tags of the resource.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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 AWS SDK.
On success, responds with TagResourceOutput
On failure, responds with SdkError<TagResourceError>

source

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The ARN of the resource.
- tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):
 The list of tag keys to remove from the resource.
On success, responds with UntagResourceOutput
On failure, responds with SdkError<UntagResourceError>

source

pub fn update_browser_settings(&self) -> UpdateBrowserSettings

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>):
 The ARN of the browser settings.
- browser_policy(impl Into<String>) / set_browser_policy(Option<String>):
 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>):
 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 AWS SDK.
On success, responds with UpdateBrowserSettingsOutput with field(s):
- browser_settings(Option<BrowserSettings>):
 The browser settings.
On failure, responds with SdkError<UpdateBrowserSettingsError>

source

pub fn update_identity_provider(&self) -> UpdateIdentityProvider

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>):
 The ARN of the identity provider.
- identity_provider_name(impl Into<String>) / set_identity_provider_name(Option<String>):
 The name of the identity provider.
- identity_provider_type(IdentityProviderType) / set_identity_provider_type(Option<IdentityProviderType>):
 The type of the identity provider.
- identity_provider_details(HashMap<String, String>) / set_identity_provider_details(Option<HashMap<String, String>>):
 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
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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 AWS SDK.
On success, responds with UpdateIdentityProviderOutput with field(s):
- identity_provider(Option<IdentityProvider>):
 The identity provider.
On failure, responds with SdkError<UpdateIdentityProviderError>

source

pub fn update_network_settings(&self) -> UpdateNetworkSettings

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>):
 The ARN of the network settings.
- vpc_id(impl Into<String>) / set_vpc_id(Option<String>):
 The VPC that streaming instances will connect to.
- subnet_ids(Vec<String>) / set_subnet_ids(Option<Vec<String>>):
 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(Vec<String>) / set_security_group_ids(Option<Vec<String>>):
 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>):
 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 AWS SDK.
On success, responds with UpdateNetworkSettingsOutput with field(s):
- network_settings(Option<NetworkSettings>):
 The network settings.
On failure, responds with SdkError<UpdateNetworkSettingsError>

source

pub fn update_portal(&self) -> UpdatePortal

Constructs a fluent builder for the UpdatePortal operation.

The fluent builder is configurable:
- portal_arn(impl Into<String>) / set_portal_arn(Option<String>):
 The ARN of the web portal.
- display_name(impl Into<String>) / set_display_name(Option<String>):
 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>):
 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 AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
On success, responds with UpdatePortalOutput with field(s):
- portal(Option<Portal>):
 The web portal.
On failure, responds with SdkError<UpdatePortalError>

source

pub fn update_trust_store(&self) -> UpdateTrustStore

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>):
 The ARN of the trust store.
- certificates_to_add(Vec<Blob>) / set_certificates_to_add(Option<Vec<Blob>>):
 A list of CA certificates to add to the trust store.
- certificates_to_delete(Vec<String>) / set_certificates_to_delete(Option<Vec<String>>):
 A list of CA certificates to delete from a trust store.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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 AWS SDK.
On success, responds with UpdateTrustStoreOutput with field(s):
- trust_store_arn(Option<String>):
 The ARN of the trust store.
On failure, responds with SdkError<UpdateTrustStoreError>

source

pub fn update_user_access_logging_settings(
&self
) -> UpdateUserAccessLoggingSettings

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>):
 The ARN of the user access logging settings.
- kinesis_stream_arn(impl Into<String>) / set_kinesis_stream_arn(Option<String>):
 The ARN of the Kinesis stream.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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 AWS 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>

source

pub fn update_user_settings(&self) -> UpdateUserSettings

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>):
 The ARN of the user settings.
- copy_allowed(EnabledType) / set_copy_allowed(Option<EnabledType>):
 Specifies whether the user can copy text from the streaming session to the local device.
- paste_allowed(EnabledType) / set_paste_allowed(Option<EnabledType>):
 Specifies whether the user can paste text from the local device to the streaming session.
- download_allowed(EnabledType) / set_download_allowed(Option<EnabledType>):
 Specifies whether the user can download files from the streaming session to the local device.
- upload_allowed(EnabledType) / set_upload_allowed(Option<EnabledType>):
 Specifies whether the user can upload files from the local device to the streaming session.
- print_allowed(EnabledType) / set_print_allowed(Option<EnabledType>):
 Specifies whether the user can print to the local device.
- disconnect_timeout_in_minutes(i32) / set_disconnect_timeout_in_minutes(Option<i32>):
 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>):
 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>):
 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 AWS SDK.
On success, responds with UpdateUserSettingsOutput with field(s):
- user_settings(Option<UserSettings>):
 The user settings.
On failure, responds with SdkError<UpdateUserSettingsError>

source §

impl Client

source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.