WorkLink

public struct WorkLink

Client object for interacting with AWS WorkLink service.

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.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the WorkLink client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls


                    
                    
                    associateDomain(_:)

Specifies a domain to be associated to Amazon WorkLink.

Declaration

Swift

public func associateDomain(_ input: AssociateDomainRequest) -> EventLoopFuture<AssociateDomainResponse>

associateWebsiteAuthorizationProvider(_:)
Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.
Declaration
Swift

public func associateWebsiteAuthorizationProvider(_ input: AssociateWebsiteAuthorizationProviderRequest) -> EventLoopFuture<AssociateWebsiteAuthorizationProviderResponse>
associateWebsiteCertificateAuthority(_:)
Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.
Declaration
Swift

public func associateWebsiteCertificateAuthority(_ input: AssociateWebsiteCertificateAuthorityRequest) -> EventLoopFuture<AssociateWebsiteCertificateAuthorityResponse>
createFleet(_:)
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.
Declaration
Swift

public func createFleet(_ input: CreateFleetRequest) -> EventLoopFuture<CreateFleetResponse>
deleteFleet(_:)
Deletes a fleet. Prevents users from accessing previously associated websites.
Declaration
Swift

public func deleteFleet(_ input: DeleteFleetRequest) -> EventLoopFuture<DeleteFleetResponse>


                    
                    
                    describeAuditStreamConfiguration(_:)

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

Declaration

Swift

public func describeAuditStreamConfiguration(_ input: DescribeAuditStreamConfigurationRequest) -> EventLoopFuture<DescribeAuditStreamConfigurationResponse>


                    
                    
                    describeCompanyNetworkConfiguration(_:)

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

Declaration

Swift

public func describeCompanyNetworkConfiguration(_ input: DescribeCompanyNetworkConfigurationRequest) -> EventLoopFuture<DescribeCompanyNetworkConfigurationResponse>


                    
                    
                    describeDevice(_:)

Provides information about a user’s device.

Declaration

Swift

public func describeDevice(_ input: DescribeDeviceRequest) -> EventLoopFuture<DescribeDeviceResponse>


                    
                    
                    describeDevicePolicyConfiguration(_:)

Describes the device policy configuration for the specified fleet.

Declaration

Swift

public func describeDevicePolicyConfiguration(_ input: DescribeDevicePolicyConfigurationRequest) -> EventLoopFuture<DescribeDevicePolicyConfigurationResponse>


                    
                    
                    describeDomain(_:)

Provides information about the domain.

Declaration

Swift

public func describeDomain(_ input: DescribeDomainRequest) -> EventLoopFuture<DescribeDomainResponse>

describeFleetMetadata(_:)
Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
Declaration
Swift

public func describeFleetMetadata(_ input: DescribeFleetMetadataRequest) -> EventLoopFuture<DescribeFleetMetadataResponse>


                    
                    
                    describeIdentityProviderConfiguration(_:)

Describes the identity provider configuration of the specified fleet.

Declaration

Swift

public func describeIdentityProviderConfiguration(_ input: DescribeIdentityProviderConfigurationRequest) -> EventLoopFuture<DescribeIdentityProviderConfigurationResponse>


                    
                    
                    describeWebsiteCertificateAuthority(_:)

Provides information about the certificate authority.

Declaration

Swift

public func describeWebsiteCertificateAuthority(_ input: DescribeWebsiteCertificateAuthorityRequest) -> EventLoopFuture<DescribeWebsiteCertificateAuthorityResponse>

disassociateDomain(_:)
Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.
Declaration
Swift

public func disassociateDomain(_ input: DisassociateDomainRequest) -> EventLoopFuture<DisassociateDomainResponse>
disassociateWebsiteAuthorizationProvider(_:)
Disassociates a website authorization provider from a specified fleet. After the disassociation, users can’t load any associated websites that require this authorization provider.
Declaration
Swift

public func disassociateWebsiteAuthorizationProvider(_ input: DisassociateWebsiteAuthorizationProviderRequest) -> EventLoopFuture<DisassociateWebsiteAuthorizationProviderResponse>


                    
                    
                    disassociateWebsiteCertificateAuthority(_:)

Removes a certificate authority (CA).

Declaration

Swift

public func disassociateWebsiteCertificateAuthority(_ input: DisassociateWebsiteCertificateAuthorityRequest) -> EventLoopFuture<DisassociateWebsiteCertificateAuthorityResponse>


                    
                    
                    listDevices(_:)

Retrieves a list of devices registered with the specified fleet.

Declaration

Swift

public func listDevices(_ input: ListDevicesRequest) -> EventLoopFuture<ListDevicesResponse>


                    
                    
                    listDomains(_:)

Retrieves a list of domains associated to a specified fleet.

Declaration

Swift

public func listDomains(_ input: ListDomainsRequest) -> EventLoopFuture<ListDomainsResponse>


                    
                    
                    listFleets(_:)

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

Declaration

Swift

public func listFleets(_ input: ListFleetsRequest) -> EventLoopFuture<ListFleetsResponse>


                    
                    
                    listTagsForResource(_:)

Retrieves a list of tags for the specified resource.

Declaration

Swift

public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>


                    
                    
                    listWebsiteAuthorizationProviders(_:)

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

Declaration

Swift

public func listWebsiteAuthorizationProviders(_ input: ListWebsiteAuthorizationProvidersRequest) -> EventLoopFuture<ListWebsiteAuthorizationProvidersResponse>


                    
                    
                    listWebsiteCertificateAuthorities(_:)

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

Declaration

Swift

public func listWebsiteCertificateAuthorities(_ input: ListWebsiteCertificateAuthoritiesRequest) -> EventLoopFuture<ListWebsiteCertificateAuthoritiesResponse>


                    
                    
                    restoreDomainAccess(_:)

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

Declaration

Swift

public func restoreDomainAccess(_ input: RestoreDomainAccessRequest) -> EventLoopFuture<RestoreDomainAccessResponse>


                    
                    
                    revokeDomainAccess(_:)

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

Declaration

Swift

public func revokeDomainAccess(_ input: RevokeDomainAccessRequest) -> EventLoopFuture<RevokeDomainAccessResponse>

signOutUser(_:)
Signs the user out from all of their devices. The user can sign in again if they have valid credentials.
Declaration
Swift

public func signOutUser(_ input: SignOutUserRequest) -> EventLoopFuture<SignOutUserResponse>
tagResource(_:)
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.
Declaration
Swift

public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>


                    
                    
                    untagResource(_:)

Removes one or more tags from the specified resource.

Declaration

Swift

public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>


                    
                    
                    updateAuditStreamConfiguration(_:)

Updates the audit stream configuration for the fleet.

Declaration

Swift

public func updateAuditStreamConfiguration(_ input: UpdateAuditStreamConfigurationRequest) -> EventLoopFuture<UpdateAuditStreamConfigurationResponse>


                    
                    
                    updateCompanyNetworkConfiguration(_:)

Updates the company network configuration for the fleet.

Declaration

Swift

public func updateCompanyNetworkConfiguration(_ input: UpdateCompanyNetworkConfigurationRequest) -> EventLoopFuture<UpdateCompanyNetworkConfigurationResponse>


                    
                    
                    updateDevicePolicyConfiguration(_:)

Updates the device policy configuration for the fleet.

Declaration

Swift

public func updateDevicePolicyConfiguration(_ input: UpdateDevicePolicyConfigurationRequest) -> EventLoopFuture<UpdateDevicePolicyConfigurationResponse>


                    
                    
                    updateDomainMetadata(_:)

Updates domain metadata, such as DisplayName.

Declaration

Swift

public func updateDomainMetadata(_ input: UpdateDomainMetadataRequest) -> EventLoopFuture<UpdateDomainMetadataResponse>


                    
                    
                    updateFleetMetadata(_:)

Updates fleet metadata, such as DisplayName.

Declaration

Swift

public func updateFleetMetadata(_ input: UpdateFleetMetadataRequest) -> EventLoopFuture<UpdateFleetMetadataResponse>


                    
                    
                    updateIdentityProviderConfiguration(_:)

Updates the identity provider configuration for the fleet.

Declaration

Swift

public func updateIdentityProviderConfiguration(_ input: UpdateIdentityProviderConfigurationRequest) -> EventLoopFuture<UpdateIdentityProviderConfigurationResponse>

Paginators


                    
                    
                    listDevicesPaginator(_:onPage:)

Retrieves a list of devices registered with the specified fleet.

Declaration

Swift

public func listDevicesPaginator(_ input: ListDevicesRequest, onPage: @escaping (ListDevicesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listDomainsPaginator(_:onPage:)

Retrieves a list of domains associated to a specified fleet.

Declaration

Swift

public func listDomainsPaginator(_ input: ListDomainsRequest, onPage: @escaping (ListDomainsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listFleetsPaginator(_:onPage:)

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

Declaration

Swift

public func listFleetsPaginator(_ input: ListFleetsRequest, onPage: @escaping (ListFleetsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listWebsiteAuthorizationProvidersPaginator(_:onPage:)

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

Declaration

Swift

public func listWebsiteAuthorizationProvidersPaginator(_ input: ListWebsiteAuthorizationProvidersRequest, onPage: @escaping (ListWebsiteAuthorizationProvidersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listWebsiteCertificateAuthoritiesPaginator(_:onPage:)

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

Declaration

Swift

public func listWebsiteCertificateAuthoritiesPaginator(_ input: ListWebsiteCertificateAuthoritiesRequest, onPage: @escaping (ListWebsiteCertificateAuthoritiesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListDevicesRequest

Undocumented

Declaration

Swift

public struct ListDevicesRequest : AWSShape

extension WorkLink.ListDevicesRequest: AWSPaginateStringToken


                    
                    
                    ListDomainsRequest

Undocumented

Declaration

Swift

public struct ListDomainsRequest : AWSShape

extension WorkLink.ListDomainsRequest: AWSPaginateStringToken


                    
                    
                    ListFleetsRequest

Undocumented

Declaration

Swift

public struct ListFleetsRequest : AWSShape

extension WorkLink.ListFleetsRequest: AWSPaginateStringToken


                    
                    
                    ListWebsiteAuthorizationProvidersRequest

Undocumented

Declaration

Swift

public struct ListWebsiteAuthorizationProvidersRequest : AWSShape

extension WorkLink.ListWebsiteAuthorizationProvidersRequest: AWSPaginateStringToken


                    
                    
                    ListWebsiteCertificateAuthoritiesRequest

Undocumented

Declaration

Swift

public struct ListWebsiteCertificateAuthoritiesRequest : AWSShape

extension WorkLink.ListWebsiteCertificateAuthoritiesRequest: AWSPaginateStringToken

AssociateDomainRequest
Undocumented
See more
Declaration
Swift

public struct AssociateDomainRequest : AWSShape
AssociateDomainResponse
Undocumented
See more
Declaration
Swift

public struct AssociateDomainResponse : AWSShape
AssociateWebsiteAuthorizationProviderRequest
Undocumented
See more
Declaration
Swift

public struct AssociateWebsiteAuthorizationProviderRequest : AWSShape
AssociateWebsiteAuthorizationProviderResponse
Undocumented
See more
Declaration
Swift

public struct AssociateWebsiteAuthorizationProviderResponse : AWSShape
AssociateWebsiteCertificateAuthorityRequest
Undocumented
See more
Declaration
Swift

public struct AssociateWebsiteCertificateAuthorityRequest : AWSShape
AssociateWebsiteCertificateAuthorityResponse
Undocumented
See more
Declaration
Swift

public struct AssociateWebsiteCertificateAuthorityResponse : AWSShape
CreateFleetRequest
Undocumented
See more
Declaration
Swift

public struct CreateFleetRequest : AWSShape
CreateFleetResponse
Undocumented
See more
Declaration
Swift

public struct CreateFleetResponse : AWSShape
DeleteFleetRequest
Undocumented
See more
Declaration
Swift

public struct DeleteFleetRequest : AWSShape
DeleteFleetResponse
Undocumented
See more
Declaration
Swift

public struct DeleteFleetResponse : AWSShape
DescribeAuditStreamConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct DescribeAuditStreamConfigurationRequest : AWSShape
DescribeAuditStreamConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct DescribeAuditStreamConfigurationResponse : AWSShape
DescribeCompanyNetworkConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct DescribeCompanyNetworkConfigurationRequest : AWSShape
DescribeCompanyNetworkConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct DescribeCompanyNetworkConfigurationResponse : AWSShape
DescribeDevicePolicyConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct DescribeDevicePolicyConfigurationRequest : AWSShape
DescribeDevicePolicyConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct DescribeDevicePolicyConfigurationResponse : AWSShape
DescribeDeviceRequest
Undocumented
See more
Declaration
Swift

public struct DescribeDeviceRequest : AWSShape
DescribeDeviceResponse
Undocumented
See more
Declaration
Swift

public struct DescribeDeviceResponse : AWSShape
DescribeDomainRequest
Undocumented
See more
Declaration
Swift

public struct DescribeDomainRequest : AWSShape
DescribeDomainResponse
Undocumented
See more
Declaration
Swift

public struct DescribeDomainResponse : AWSShape
DescribeFleetMetadataRequest
Undocumented
See more
Declaration
Swift

public struct DescribeFleetMetadataRequest : AWSShape
DescribeFleetMetadataResponse
Undocumented
See more
Declaration
Swift

public struct DescribeFleetMetadataResponse : AWSShape
DescribeIdentityProviderConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct DescribeIdentityProviderConfigurationRequest : AWSShape
DescribeIdentityProviderConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct DescribeIdentityProviderConfigurationResponse : AWSShape
DescribeWebsiteCertificateAuthorityRequest
Undocumented
See more
Declaration
Swift

public struct DescribeWebsiteCertificateAuthorityRequest : AWSShape
DescribeWebsiteCertificateAuthorityResponse
Undocumented
See more
Declaration
Swift

public struct DescribeWebsiteCertificateAuthorityResponse : AWSShape
DeviceSummary
Undocumented
See more
Declaration
Swift

public struct DeviceSummary : AWSShape
DisassociateDomainRequest
Undocumented
See more
Declaration
Swift

public struct DisassociateDomainRequest : AWSShape
DisassociateDomainResponse
Undocumented
See more
Declaration
Swift

public struct DisassociateDomainResponse : AWSShape
DisassociateWebsiteAuthorizationProviderRequest
Undocumented
See more
Declaration
Swift

public struct DisassociateWebsiteAuthorizationProviderRequest : AWSShape
DisassociateWebsiteAuthorizationProviderResponse
Undocumented
See more
Declaration
Swift

public struct DisassociateWebsiteAuthorizationProviderResponse : AWSShape
DisassociateWebsiteCertificateAuthorityRequest
Undocumented
See more
Declaration
Swift

public struct DisassociateWebsiteCertificateAuthorityRequest : AWSShape
DisassociateWebsiteCertificateAuthorityResponse
Undocumented
See more
Declaration
Swift

public struct DisassociateWebsiteCertificateAuthorityResponse : AWSShape
DomainSummary
Undocumented
See more
Declaration
Swift

public struct DomainSummary : AWSShape
FleetSummary
Undocumented
See more
Declaration
Swift

public struct FleetSummary : AWSShape
ListDevicesResponse
Undocumented
See more
Declaration
Swift

public struct ListDevicesResponse : AWSShape
ListDomainsResponse
Undocumented
See more
Declaration
Swift

public struct ListDomainsResponse : AWSShape
ListFleetsResponse
Undocumented
See more
Declaration
Swift

public struct ListFleetsResponse : AWSShape
ListTagsForResourceRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceRequest : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
ListWebsiteAuthorizationProvidersResponse
Undocumented
See more
Declaration
Swift

public struct ListWebsiteAuthorizationProvidersResponse : AWSShape
ListWebsiteCertificateAuthoritiesResponse
Undocumented
See more
Declaration
Swift

public struct ListWebsiteCertificateAuthoritiesResponse : AWSShape
RestoreDomainAccessRequest
Undocumented
See more
Declaration
Swift

public struct RestoreDomainAccessRequest : AWSShape
RestoreDomainAccessResponse
Undocumented
See more
Declaration
Swift

public struct RestoreDomainAccessResponse : AWSShape
RevokeDomainAccessRequest
Undocumented
See more
Declaration
Swift

public struct RevokeDomainAccessRequest : AWSShape
RevokeDomainAccessResponse
Undocumented
See more
Declaration
Swift

public struct RevokeDomainAccessResponse : AWSShape
SignOutUserRequest
Undocumented
See more
Declaration
Swift

public struct SignOutUserRequest : AWSShape
SignOutUserResponse
Undocumented
See more
Declaration
Swift

public struct SignOutUserResponse : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
TagResourceResponse
Undocumented
See more
Declaration
Swift

public struct TagResourceResponse : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UntagResourceResponse
Undocumented
See more
Declaration
Swift

public struct UntagResourceResponse : AWSShape
UpdateAuditStreamConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct UpdateAuditStreamConfigurationRequest : AWSShape
UpdateAuditStreamConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct UpdateAuditStreamConfigurationResponse : AWSShape
UpdateCompanyNetworkConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct UpdateCompanyNetworkConfigurationRequest : AWSShape
UpdateCompanyNetworkConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct UpdateCompanyNetworkConfigurationResponse : AWSShape
UpdateDevicePolicyConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct UpdateDevicePolicyConfigurationRequest : AWSShape
UpdateDevicePolicyConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct UpdateDevicePolicyConfigurationResponse : AWSShape
UpdateDomainMetadataRequest
Undocumented
See more
Declaration
Swift

public struct UpdateDomainMetadataRequest : AWSShape
UpdateDomainMetadataResponse
Undocumented
See more
Declaration
Swift

public struct UpdateDomainMetadataResponse : AWSShape
UpdateFleetMetadataRequest
Undocumented
See more
Declaration
Swift

public struct UpdateFleetMetadataRequest : AWSShape
UpdateFleetMetadataResponse
Undocumented
See more
Declaration
Swift

public struct UpdateFleetMetadataResponse : AWSShape
UpdateIdentityProviderConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct UpdateIdentityProviderConfigurationRequest : AWSShape
UpdateIdentityProviderConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct UpdateIdentityProviderConfigurationResponse : AWSShape
WebsiteAuthorizationProviderSummary
Undocumented
See more
Declaration
Swift

public struct WebsiteAuthorizationProviderSummary : AWSShape
WebsiteCaSummary
Undocumented
See more
Declaration
Swift

public struct WebsiteCaSummary : AWSShape

Enums


                    
                    
                    AuthorizationProviderType

Undocumented

Declaration

Swift

public enum AuthorizationProviderType : String, CustomStringConvertible, Codable


                    
                    
                    DeviceStatus

Undocumented

Declaration

Swift

public enum DeviceStatus : String, CustomStringConvertible, Codable


                    
                    
                    DomainStatus

Undocumented

Declaration

Swift

public enum DomainStatus : String, CustomStringConvertible, Codable


                    
                    
                    FleetStatus

Undocumented

Declaration

Swift

public enum FleetStatus : String, CustomStringConvertible, Codable


                    
                    
                    IdentityProviderType

Undocumented

Declaration

Swift

public enum IdentityProviderType : String, CustomStringConvertible, Codable