WorkLink class

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.

Constructors

WorkLink.new({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

associateDomain({required String acmCertificateArn, required String domainName, required String fleetArn, String? displayName}) → Future<void>

Specifies a domain to be associated to Amazon WorkLink.

associateWebsiteAuthorizationProvider({required AuthorizationProviderType authorizationProviderType, required String fleetArn, String? domainName}) → Future<AssociateWebsiteAuthorizationProviderResponse>

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

associateWebsiteCertificateAuthority({required String certificate, required String fleetArn, String? displayName}) → Future<AssociateWebsiteCertificateAuthorityResponse>

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

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createFleet({required String fleetName, String? displayName, bool? optimizeForEndUserLocation, Map<String, String>? tags}) → Future<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.

deleteFleet({required String fleetArn}) → Future<void>

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

describeAuditStreamConfiguration({required String fleetArn}) → Future<DescribeAuditStreamConfigurationResponse>

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

describeCompanyNetworkConfiguration({required String fleetArn}) → Future<DescribeCompanyNetworkConfigurationResponse>

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

describeDevice({required String deviceId, required String fleetArn}) → Future<DescribeDeviceResponse>

Provides information about a user's device.

describeDevicePolicyConfiguration({required String fleetArn}) → Future<DescribeDevicePolicyConfigurationResponse>

Describes the device policy configuration for the specified fleet.

describeDomain({required String domainName, required String fleetArn}) → Future<DescribeDomainResponse>

Provides information about the domain.

describeFleetMetadata({required String fleetArn}) → Future<DescribeFleetMetadataResponse>

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

describeIdentityProviderConfiguration({required String fleetArn}) → Future<DescribeIdentityProviderConfigurationResponse>

Describes the identity provider configuration of the specified fleet.

describeWebsiteCertificateAuthority({required String fleetArn, required String websiteCaId}) → Future<DescribeWebsiteCertificateAuthorityResponse>

Provides information about the certificate authority.

disassociateDomain({required String domainName, required String fleetArn}) → Future<void>

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

disassociateWebsiteAuthorizationProvider({required String authorizationProviderId, required String fleetArn}) → Future<void>

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

disassociateWebsiteCertificateAuthority({required String fleetArn, required String websiteCaId}) → Future<void>

Removes a certificate authority (CA).

listDevices({required String fleetArn, int? maxResults, String? nextToken}) → Future<ListDevicesResponse>

Retrieves a list of devices registered with the specified fleet.

listDomains({required String fleetArn, int? maxResults, String? nextToken}) → Future<ListDomainsResponse>

Retrieves a list of domains associated to a specified fleet.

listFleets({int? maxResults, String? nextToken}) → Future<ListFleetsResponse>

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

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>

Retrieves a list of tags for the specified resource.

listWebsiteAuthorizationProviders({required String fleetArn, int? maxResults, String? nextToken}) → Future<ListWebsiteAuthorizationProvidersResponse>

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

listWebsiteCertificateAuthorities({required String fleetArn, int? maxResults, String? nextToken}) → Future<ListWebsiteCertificateAuthoritiesResponse>

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

restoreDomainAccess({required String domainName, required String fleetArn}) → Future<void>

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

revokeDomainAccess({required String domainName, required String fleetArn}) → Future<void>

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

signOutUser({required String fleetArn, required String username}) → Future<void>

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

tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>

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.

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

Removes one or more tags from the specified resource.

updateAuditStreamConfiguration({required String fleetArn, String? auditStreamArn}) → Future<void>

Updates the audit stream configuration for the fleet.

updateCompanyNetworkConfiguration({required String fleetArn, required List<String> securityGroupIds, required List<String> subnetIds, required String vpcId}) → Future<void>

Updates the company network configuration for the fleet.

updateDevicePolicyConfiguration({required String fleetArn, String? deviceCaCertificate}) → Future<void>

Updates the device policy configuration for the fleet.

updateDomainMetadata({required String domainName, required String fleetArn, String? displayName}) → Future<void>

Updates domain metadata, such as DisplayName.

updateFleetMetadata({required String fleetArn, String? displayName, bool? optimizeForEndUserLocation}) → Future<void>

Updates fleet metadata, such as DisplayName.

updateIdentityProviderConfiguration({required String fleetArn, required IdentityProviderType identityProviderType, String? identityProviderSamlMetadata}) → Future<void>

Updates the identity provider configuration for the fleet.

Operators

operator ==(Object other) → bool

The equality operator.

inherited