worklink/aws.sdk.kotlin.services.worklink

Package-level declarations

Types

Link copied to clipboard
interface WorkLinkClient : SdkClient

Amazon WorkLink is a cloud-based service that provides secure access to internal websites and web apps from iOS and Android phones. In a single step, your users, such as employees, can access internal websites as efficiently as they access any other public website. They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink authenticates the user's access and securely renders authorized internal web content in a secure rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on mobile devices.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun WorkLinkClient.associateDomain(crossinline block: AssociateDomainRequest.Builder.() -> Unit): AssociateDomainResponse

Specifies a domain to be associated to Amazon WorkLink.

Link copied to clipboard
inline suspend fun WorkLinkClient.associateWebsiteAuthorizationProvider(crossinline block: AssociateWebsiteAuthorizationProviderRequest.Builder.() -> Unit): AssociateWebsiteAuthorizationProviderResponse

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

Link copied to clipboard
inline suspend fun WorkLinkClient.associateWebsiteCertificateAuthority(crossinline block: AssociateWebsiteCertificateAuthorityRequest.Builder.() -> Unit): AssociateWebsiteCertificateAuthorityResponse

Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.

Link copied to clipboard
inline suspend fun WorkLinkClient.createFleet(crossinline block: CreateFleetRequest.Builder.() -> Unit): CreateFleetResponse

Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app.

Link copied to clipboard
inline suspend fun WorkLinkClient.deleteFleet(crossinline block: DeleteFleetRequest.Builder.() -> Unit): DeleteFleetResponse

Deletes a fleet. Prevents users from accessing previously associated websites.

Link copied to clipboard
inline suspend fun WorkLinkClient.describeAuditStreamConfiguration(crossinline block: DescribeAuditStreamConfigurationRequest.Builder.() -> Unit): DescribeAuditStreamConfigurationResponse

Describes the configuration for delivering audit streams to the customer account.

Link copied to clipboard
inline suspend fun WorkLinkClient.describeCompanyNetworkConfiguration(crossinline block: DescribeCompanyNetworkConfigurationRequest.Builder.() -> Unit): DescribeCompanyNetworkConfigurationResponse

Describes the networking configuration to access the internal websites associated with the specified fleet.

Link copied to clipboard
inline suspend fun WorkLinkClient.describeDevice(crossinline block: DescribeDeviceRequest.Builder.() -> Unit): DescribeDeviceResponse

Provides information about a user's device.

Link copied to clipboard
inline suspend fun WorkLinkClient.describeDevicePolicyConfiguration(crossinline block: DescribeDevicePolicyConfigurationRequest.Builder.() -> Unit): DescribeDevicePolicyConfigurationResponse

Describes the device policy configuration for the specified fleet.

Link copied to clipboard
inline suspend fun WorkLinkClient.describeDomain(crossinline block: DescribeDomainRequest.Builder.() -> Unit): DescribeDomainResponse

Provides information about the domain.

Link copied to clipboard
inline suspend fun WorkLinkClient.describeFleetMetadata(crossinline block: DescribeFleetMetadataRequest.Builder.() -> Unit): DescribeFleetMetadataResponse

Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.

Link copied to clipboard
inline suspend fun WorkLinkClient.describeIdentityProviderConfiguration(crossinline block: DescribeIdentityProviderConfigurationRequest.Builder.() -> Unit): DescribeIdentityProviderConfigurationResponse

Describes the identity provider configuration of the specified fleet.

Link copied to clipboard
inline suspend fun WorkLinkClient.describeWebsiteCertificateAuthority(crossinline block: DescribeWebsiteCertificateAuthorityRequest.Builder.() -> Unit): DescribeWebsiteCertificateAuthorityResponse

Provides information about the certificate authority.

Link copied to clipboard
inline suspend fun WorkLinkClient.disassociateDomain(crossinline block: DisassociateDomainRequest.Builder.() -> Unit): DisassociateDomainResponse

Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

Link copied to clipboard
inline suspend fun WorkLinkClient.disassociateWebsiteAuthorizationProvider(crossinline block: DisassociateWebsiteAuthorizationProviderRequest.Builder.() -> Unit): DisassociateWebsiteAuthorizationProviderResponse

Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.

Link copied to clipboard
Link copied to clipboard
inline suspend fun WorkLinkClient.listDevices(crossinline block: ListDevicesRequest.Builder.() -> Unit): ListDevicesResponse

Retrieves a list of devices registered with the specified fleet.

Link copied to clipboard
inline suspend fun WorkLinkClient.listDomains(crossinline block: ListDomainsRequest.Builder.() -> Unit): ListDomainsResponse

Retrieves a list of domains associated to a specified fleet.

Link copied to clipboard
inline suspend fun WorkLinkClient.listFleets(crossinline block: ListFleetsRequest.Builder.() -> Unit): ListFleetsResponse

Retrieves a list of fleets for the current account and Region.

Link copied to clipboard
inline suspend fun WorkLinkClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Retrieves a list of tags for the specified resource.

Link copied to clipboard
inline suspend fun WorkLinkClient.listWebsiteAuthorizationProviders(crossinline block: ListWebsiteAuthorizationProvidersRequest.Builder.() -> Unit): ListWebsiteAuthorizationProvidersResponse

Retrieves a list of website authorization providers associated with a specified fleet.

Link copied to clipboard
inline suspend fun WorkLinkClient.listWebsiteCertificateAuthorities(crossinline block: ListWebsiteCertificateAuthoritiesRequest.Builder.() -> Unit): ListWebsiteCertificateAuthoritiesResponse

Retrieves a list of certificate authorities added for the current account and Region.

Link copied to clipboard
inline suspend fun WorkLinkClient.restoreDomainAccess(crossinline block: RestoreDomainAccessRequest.Builder.() -> Unit): RestoreDomainAccessResponse

Moves a domain to ACTIVE status if it was in the INACTIVE status.

Link copied to clipboard
inline suspend fun WorkLinkClient.revokeDomainAccess(crossinline block: RevokeDomainAccessRequest.Builder.() -> Unit): RevokeDomainAccessResponse

Moves a domain to INACTIVE status if it was in the ACTIVE status.

Link copied to clipboard
inline suspend fun WorkLinkClient.signOutUser(crossinline block: SignOutUserRequest.Builder.() -> Unit): SignOutUserResponse

Signs the user out from all of their devices. The user can sign in again if they have valid credentials.

Link copied to clipboard
inline suspend fun WorkLinkClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or overwrites one or more tags for the specified resource, such as a fleet. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

Link copied to clipboard
inline suspend fun WorkLinkClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes one or more tags from the specified resource.

Link copied to clipboard
inline suspend fun WorkLinkClient.updateAuditStreamConfiguration(crossinline block: UpdateAuditStreamConfigurationRequest.Builder.() -> Unit): UpdateAuditStreamConfigurationResponse

Updates the audit stream configuration for the fleet.

Link copied to clipboard
inline suspend fun WorkLinkClient.updateCompanyNetworkConfiguration(crossinline block: UpdateCompanyNetworkConfigurationRequest.Builder.() -> Unit): UpdateCompanyNetworkConfigurationResponse

Updates the company network configuration for the fleet.

Link copied to clipboard
inline suspend fun WorkLinkClient.updateDevicePolicyConfiguration(crossinline block: UpdateDevicePolicyConfigurationRequest.Builder.() -> Unit): UpdateDevicePolicyConfigurationResponse

Updates the device policy configuration for the fleet.

Link copied to clipboard
inline suspend fun WorkLinkClient.updateDomainMetadata(crossinline block: UpdateDomainMetadataRequest.Builder.() -> Unit): UpdateDomainMetadataResponse

Updates domain metadata, such as DisplayName.

Link copied to clipboard
inline suspend fun WorkLinkClient.updateFleetMetadata(crossinline block: UpdateFleetMetadataRequest.Builder.() -> Unit): UpdateFleetMetadataResponse

Updates fleet metadata, such as DisplayName.

Link copied to clipboard
inline suspend fun WorkLinkClient.updateIdentityProviderConfiguration(crossinline block: UpdateIdentityProviderConfigurationRequest.Builder.() -> Unit): UpdateIdentityProviderConfigurationResponse

Updates the identity provider configuration for the fleet.

Link copied to clipboard
fun WorkLinkClient.withConfig(block: WorkLinkClient.Config.Builder.() -> Unit): WorkLinkClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.