Struct aws_sdk_worklink::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon WorkLink
Client for invoking operations on Amazon WorkLink. Each operation on Amazon WorkLink 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_worklink::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_worklink::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 AssociateDomain
operation has
a Client::associate_domain
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.associate_domain()
.fleet_arn("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn associate_domain(&self) -> AssociateDomainFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn associate_domain(&self) -> AssociateDomainFluentBuilder
Constructs a fluent builder for the AssociateDomain
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the fleet.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe fully qualified domain name (FQDN).
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseThe name to display.
acm_certificate_arn(impl Into<String>)
/set_acm_certificate_arn(Option<String>)
:
required: trueThe ARN of an issued ACM certificate that is valid for the domain being associated.
- On success, responds with
AssociateDomainOutput
- On failure, responds with
SdkError<AssociateDomainError>
source§impl Client
impl Client
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
Constructs a fluent builder for the AssociateWebsiteAuthorizationProvider
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
authorization_provider_type(AuthorizationProviderType)
/set_authorization_provider_type(Option<AuthorizationProviderType>)
:
required: trueThe authorization provider type.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: falseThe domain name of the authorization provider. This applies only to SAML-based authorization providers.
- On success, responds with
AssociateWebsiteAuthorizationProviderOutput
with field(s):authorization_provider_id(Option<String>)
:A unique identifier for the authorization provider.
- On failure, responds with
SdkError<AssociateWebsiteAuthorizationProviderError>
source§impl Client
impl Client
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
Constructs a fluent builder for the AssociateWebsiteCertificateAuthority
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
certificate(impl Into<String>)
/set_certificate(Option<String>)
:
required: trueThe root certificate of the CA.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseThe certificate name to display.
- On success, responds with
AssociateWebsiteCertificateAuthorityOutput
with field(s):website_ca_id(Option<String>)
:A unique identifier for the CA.
- On failure, responds with
SdkError<AssociateWebsiteCertificateAuthorityError>
source§impl Client
impl Client
sourcepub fn create_fleet(&self) -> CreateFleetFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn create_fleet(&self) -> CreateFleetFluentBuilder
Constructs a fluent builder for the CreateFleet
operation.
- The fluent builder is configurable:
fleet_name(impl Into<String>)
/set_fleet_name(Option<String>)
:
required: trueA unique name for the fleet.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseThe fleet name to display.
optimize_for_end_user_location(bool)
/set_optimize_for_end_user_location(Option<bool>)
:
required: falseThe option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to add to the resource. A tag is a key-value pair.
- On success, responds with
CreateFleetOutput
with field(s):fleet_arn(Option<String>)
:The Amazon Resource Name (ARN) of the fleet.
- On failure, responds with
SdkError<CreateFleetError>
source§impl Client
impl Client
sourcepub fn delete_fleet(&self) -> DeleteFleetFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn delete_fleet(&self) -> DeleteFleetFluentBuilder
Constructs a fluent builder for the DeleteFleet
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
- On success, responds with
DeleteFleetOutput
- On failure, responds with
SdkError<DeleteFleetError>
source§impl Client
impl Client
sourcepub fn describe_audit_stream_configuration(
&self
) -> DescribeAuditStreamConfigurationFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn describe_audit_stream_configuration( &self ) -> DescribeAuditStreamConfigurationFluentBuilder
Constructs a fluent builder for the DescribeAuditStreamConfiguration
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
- On success, responds with
DescribeAuditStreamConfigurationOutput
with field(s):audit_stream_arn(Option<String>)
:The ARN of the Amazon Kinesis data stream that will receive the audit events.
- On failure, responds with
SdkError<DescribeAuditStreamConfigurationError>
source§impl Client
impl Client
sourcepub fn describe_company_network_configuration(
&self
) -> DescribeCompanyNetworkConfigurationFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn describe_company_network_configuration( &self ) -> DescribeCompanyNetworkConfigurationFluentBuilder
Constructs a fluent builder for the DescribeCompanyNetworkConfiguration
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
- On success, responds with
DescribeCompanyNetworkConfigurationOutput
with field(s):vpc_id(Option<String>)
:The VPC with connectivity to associated websites.
subnet_ids(Option<Vec::<String>>)
:The subnets used for X-ENI connections from Amazon WorkLink rendering containers.
security_group_ids(Option<Vec::<String>>)
:The security groups associated with access to the provided subnets.
- On failure, responds with
SdkError<DescribeCompanyNetworkConfigurationError>
source§impl Client
impl Client
sourcepub fn describe_device(&self) -> DescribeDeviceFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn describe_device(&self) -> DescribeDeviceFluentBuilder
Constructs a fluent builder for the DescribeDevice
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
device_id(impl Into<String>)
/set_device_id(Option<String>)
:
required: trueA unique identifier for a registered user’s device.
- On success, responds with
DescribeDeviceOutput
with field(s):status(Option<DeviceStatus>)
:The current state of the device.
model(Option<String>)
:The model of the device.
manufacturer(Option<String>)
:The manufacturer of the device.
operating_system(Option<String>)
:The operating system of the device.
operating_system_version(Option<String>)
:The operating system version of the device.
patch_level(Option<String>)
:The operating system patch level of the device.
first_accessed_time(Option<DateTime>)
:The date that the device first signed in to Amazon WorkLink.
last_accessed_time(Option<DateTime>)
:The date that the device last accessed Amazon WorkLink.
username(Option<String>)
:The user name associated with the device.
- On failure, responds with
SdkError<DescribeDeviceError>
source§impl Client
impl Client
sourcepub fn describe_device_policy_configuration(
&self
) -> DescribeDevicePolicyConfigurationFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn describe_device_policy_configuration( &self ) -> DescribeDevicePolicyConfigurationFluentBuilder
Constructs a fluent builder for the DescribeDevicePolicyConfiguration
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
- On success, responds with
DescribeDevicePolicyConfigurationOutput
with field(s):device_ca_certificate(Option<String>)
:The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
- On failure, responds with
SdkError<DescribeDevicePolicyConfigurationError>
source§impl Client
impl Client
sourcepub fn describe_domain(&self) -> DescribeDomainFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn describe_domain(&self) -> DescribeDomainFluentBuilder
Constructs a fluent builder for the DescribeDomain
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe name of the domain.
- On success, responds with
DescribeDomainOutput
with field(s):domain_name(Option<String>)
:The name of the domain.
display_name(Option<String>)
:The name to display.
created_time(Option<DateTime>)
:The time that the domain was added.
domain_status(Option<DomainStatus>)
:The current state for the domain.
acm_certificate_arn(Option<String>)
:The ARN of an issued ACM certificate that is valid for the domain being associated.
- On failure, responds with
SdkError<DescribeDomainError>
source§impl Client
impl Client
sourcepub fn describe_fleet_metadata(&self) -> DescribeFleetMetadataFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn describe_fleet_metadata(&self) -> DescribeFleetMetadataFluentBuilder
Constructs a fluent builder for the DescribeFleetMetadata
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the fleet.
- On success, responds with
DescribeFleetMetadataOutput
with field(s):created_time(Option<DateTime>)
:The time that the fleet was created.
last_updated_time(Option<DateTime>)
:The time that the fleet was last updated.
fleet_name(Option<String>)
:The name of the fleet.
display_name(Option<String>)
:The name to display.
optimize_for_end_user_location(Option<bool>)
:The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.
company_code(Option<String>)
:The identifier used by users to sign in to the Amazon WorkLink app.
fleet_status(Option<FleetStatus>)
:The current state of the fleet.
tags(Option<HashMap::<String, String>>)
:The tags attached to the resource. A tag is a key-value pair.
- On failure, responds with
SdkError<DescribeFleetMetadataError>
source§impl Client
impl Client
sourcepub fn describe_identity_provider_configuration(
&self
) -> DescribeIdentityProviderConfigurationFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn describe_identity_provider_configuration( &self ) -> DescribeIdentityProviderConfigurationFluentBuilder
Constructs a fluent builder for the DescribeIdentityProviderConfiguration
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
- On success, responds with
DescribeIdentityProviderConfigurationOutput
with field(s):identity_provider_type(Option<IdentityProviderType>)
:The type of identity provider.
service_provider_saml_metadata(Option<String>)
:The SAML metadata document uploaded to the user’s identity provider.
identity_provider_saml_metadata(Option<String>)
:The SAML metadata document provided by the user’s identity provider.
- On failure, responds with
SdkError<DescribeIdentityProviderConfigurationError>
source§impl Client
impl Client
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
Constructs a fluent builder for the DescribeWebsiteCertificateAuthority
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
website_ca_id(impl Into<String>)
/set_website_ca_id(Option<String>)
:
required: trueA unique identifier for the certificate authority.
- On success, responds with
DescribeWebsiteCertificateAuthorityOutput
with field(s):certificate(Option<String>)
:The root certificate of the certificate authority.
created_time(Option<DateTime>)
:The time that the certificate authority was added.
display_name(Option<String>)
:The certificate name to display.
- On failure, responds with
SdkError<DescribeWebsiteCertificateAuthorityError>
source§impl Client
impl Client
sourcepub fn disassociate_domain(&self) -> DisassociateDomainFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn disassociate_domain(&self) -> DisassociateDomainFluentBuilder
Constructs a fluent builder for the DisassociateDomain
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe name of the domain.
- On success, responds with
DisassociateDomainOutput
- On failure, responds with
SdkError<DisassociateDomainError>
source§impl Client
impl Client
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
Constructs a fluent builder for the DisassociateWebsiteAuthorizationProvider
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
authorization_provider_id(impl Into<String>)
/set_authorization_provider_id(Option<String>)
:
required: trueA unique identifier for the authorization provider.
- On success, responds with
DisassociateWebsiteAuthorizationProviderOutput
- On failure, responds with
SdkError<DisassociateWebsiteAuthorizationProviderError>
source§impl Client
impl Client
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
Constructs a fluent builder for the DisassociateWebsiteCertificateAuthority
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
website_ca_id(impl Into<String>)
/set_website_ca_id(Option<String>)
:
required: trueA unique identifier for the CA.
- On success, responds with
DisassociateWebsiteCertificateAuthorityOutput
- On failure, responds with
SdkError<DisassociateWebsiteCertificateAuthorityError>
source§impl Client
impl Client
sourcepub fn list_devices(&self) -> ListDevicesFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn list_devices(&self) -> ListDevicesFluentBuilder
Constructs a fluent builder for the ListDevices
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be included in the next page.
- On success, responds with
ListDevicesOutput
with field(s):devices(Option<Vec::<DeviceSummary>>)
:Information about the devices.
next_token(Option<String>)
:The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- On failure, responds with
SdkError<ListDevicesError>
source§impl Client
impl Client
sourcepub fn list_domains(&self) -> ListDomainsFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn list_domains(&self) -> ListDomainsFluentBuilder
Constructs a fluent builder for the ListDomains
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be included in the next page.
- On success, responds with
ListDomainsOutput
with field(s):domains(Option<Vec::<DomainSummary>>)
:Information about the domains.
next_token(Option<String>)
:The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- On failure, responds with
SdkError<ListDomainsError>
source§impl Client
impl Client
sourcepub fn list_fleets(&self) -> ListFleetsFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn list_fleets(&self) -> ListFleetsFluentBuilder
Constructs a fluent builder for the ListFleets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be included in the next page.
- On success, responds with
ListFleetsOutput
with field(s):fleet_summary_list(Option<Vec::<FleetSummary>>)
:The summary list of the fleets.
next_token(Option<String>)
:The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- On failure, responds with
SdkError<ListFleetsError>
source§impl Client
impl Client
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the fleet.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:The tags attached to the resource. A tag is a key-value pair.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
Constructs a fluent builder for the ListWebsiteAuthorizationProviders
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be included in the next page.
- On success, responds with
ListWebsiteAuthorizationProvidersOutput
with field(s):website_authorization_providers(Option<Vec::<WebsiteAuthorizationProviderSummary>>)
:The website authorization providers.
next_token(Option<String>)
:The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- On failure, responds with
SdkError<ListWebsiteAuthorizationProvidersError>
source§impl Client
impl Client
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
Constructs a fluent builder for the ListWebsiteCertificateAuthorities
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be included in the next page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- On success, responds with
ListWebsiteCertificateAuthoritiesOutput
with field(s):website_certificate_authorities(Option<Vec::<WebsiteCaSummary>>)
:Information about the certificates.
next_token(Option<String>)
:The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- On failure, responds with
SdkError<ListWebsiteCertificateAuthoritiesError>
source§impl Client
impl Client
sourcepub fn restore_domain_access(&self) -> RestoreDomainAccessFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn restore_domain_access(&self) -> RestoreDomainAccessFluentBuilder
Constructs a fluent builder for the RestoreDomainAccess
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe name of the domain.
- On success, responds with
RestoreDomainAccessOutput
- On failure, responds with
SdkError<RestoreDomainAccessError>
source§impl Client
impl Client
sourcepub fn revoke_domain_access(&self) -> RevokeDomainAccessFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn revoke_domain_access(&self) -> RevokeDomainAccessFluentBuilder
Constructs a fluent builder for the RevokeDomainAccess
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe name of the domain.
- On success, responds with
RevokeDomainAccessOutput
- On failure, responds with
SdkError<RevokeDomainAccessError>
source§impl Client
impl Client
sourcepub fn sign_out_user(&self) -> SignOutUserFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn sign_out_user(&self) -> SignOutUserFluentBuilder
Constructs a fluent builder for the SignOutUser
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
username(impl Into<String>)
/set_username(Option<String>)
:
required: trueThe name of the user.
- On success, responds with
SignOutUserOutput
- On failure, responds with
SdkError<SignOutUserError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
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: trueThe Amazon Resource Name (ARN) of the fleet.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueThe tags to add to the resource. A tag is a key-value pair.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
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: trueThe Amazon Resource Name (ARN) of the fleet.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe list of tag keys to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_audit_stream_configuration(
&self
) -> UpdateAuditStreamConfigurationFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn update_audit_stream_configuration( &self ) -> UpdateAuditStreamConfigurationFluentBuilder
Constructs a fluent builder for the UpdateAuditStreamConfiguration
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
audit_stream_arn(impl Into<String>)
/set_audit_stream_arn(Option<String>)
:
required: falseThe ARN of the Amazon Kinesis data stream that receives the audit events.
- On success, responds with
UpdateAuditStreamConfigurationOutput
- On failure, responds with
SdkError<UpdateAuditStreamConfigurationError>
source§impl Client
impl Client
sourcepub fn update_company_network_configuration(
&self
) -> UpdateCompanyNetworkConfigurationFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn update_company_network_configuration( &self ) -> UpdateCompanyNetworkConfigurationFluentBuilder
Constructs a fluent builder for the UpdateCompanyNetworkConfiguration
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
vpc_id(impl Into<String>)
/set_vpc_id(Option<String>)
:
required: trueThe VPC with connectivity to associated websites.
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: trueThe subnets used for X-ENI connections from Amazon WorkLink rendering containers.
security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: trueThe security groups associated with access to the provided subnets.
- On success, responds with
UpdateCompanyNetworkConfigurationOutput
- On failure, responds with
SdkError<UpdateCompanyNetworkConfigurationError>
source§impl Client
impl Client
sourcepub fn update_device_policy_configuration(
&self
) -> UpdateDevicePolicyConfigurationFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn update_device_policy_configuration( &self ) -> UpdateDevicePolicyConfigurationFluentBuilder
Constructs a fluent builder for the UpdateDevicePolicyConfiguration
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
device_ca_certificate(impl Into<String>)
/set_device_ca_certificate(Option<String>)
:
required: falseThe certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
- On success, responds with
UpdateDevicePolicyConfigurationOutput
- On failure, responds with
SdkError<UpdateDevicePolicyConfigurationError>
source§impl Client
impl Client
sourcepub fn update_domain_metadata(&self) -> UpdateDomainMetadataFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn update_domain_metadata(&self) -> UpdateDomainMetadataFluentBuilder
Constructs a fluent builder for the UpdateDomainMetadata
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe name of the domain.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseThe name to display.
- On success, responds with
UpdateDomainMetadataOutput
- On failure, responds with
SdkError<UpdateDomainMetadataError>
source§impl Client
impl Client
sourcepub fn update_fleet_metadata(&self) -> UpdateFleetMetadataFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn update_fleet_metadata(&self) -> UpdateFleetMetadataFluentBuilder
Constructs a fluent builder for the UpdateFleetMetadata
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseThe fleet name to display. The existing DisplayName is unset if null is passed.
optimize_for_end_user_location(bool)
/set_optimize_for_end_user_location(Option<bool>)
:
required: falseThe option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.
- On success, responds with
UpdateFleetMetadataOutput
- On failure, responds with
SdkError<UpdateFleetMetadataError>
source§impl Client
impl Client
sourcepub fn update_identity_provider_configuration(
&self
) -> UpdateIdentityProviderConfigurationFluentBuilder
👎Deprecated: Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK.
pub fn update_identity_provider_configuration( &self ) -> UpdateIdentityProviderConfigurationFluentBuilder
Constructs a fluent builder for the UpdateIdentityProviderConfiguration
operation.
- The fluent builder is configurable:
fleet_arn(impl Into<String>)
/set_fleet_arn(Option<String>)
:
required: trueThe ARN of the fleet.
identity_provider_type(IdentityProviderType)
/set_identity_provider_type(Option<IdentityProviderType>)
:
required: trueThe type of identity provider.
identity_provider_saml_metadata(impl Into<String>)
/set_identity_provider_saml_metadata(Option<String>)
:
required: falseThe SAML metadata document provided by the customer’s identity provider. The existing IdentityProviderSamlMetadata is unset if null is passed.
- On success, responds with
UpdateIdentityProviderConfigurationOutput
- On failure, responds with
SdkError<UpdateIdentityProviderConfigurationError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
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
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_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, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more