canonical: https://jentic.com/apis/amazonaws.com/worklink

# AWS Amazon WorkLink

Jentic publishes the only available OpenAPI specification for Amazon WorkLink, keeping it validated and agent-ready. Amazon WorkLink was a managed service that provided secure access to internal websites and web apps from iOS and Android phones without VPN clients or app distribution. The API manages fleets, associates internal domains, configures audit streams, registers website certificate authorities, attaches SAML identity providers, and lists devices. The 33 operations include Associate/Disassociate verbs for domains, certificate authorities, and authorization providers, and the standard fleet CRUD plus device listing. Note: AWS ended Amazon WorkLink on April 30, 2024 - this spec is provided for legacy automation maintenance only.

## For AI agents

Manage Amazon WorkLink fleets, domain associations, and identity provider configuration for legacy mobile-access deployments still in operation.

## Scope

Does not handle desktop streaming, full VPN tunnelling, or device management for non-mobile clients - use for managing Amazon WorkLink mobile fleets, internal domains, and identity provider configuration only. Note: AWS announced WorkLink end-of-life on April 30, 2024.

## Capabilities

- Create, describe, update, and delete WorkLink fleets
- Associate and disassociate internal web domains with a fleet
- Configure the company network (VPC, subnets, security groups) that WorkLink reaches into
- Attach SAML identity provider metadata for user authentication
- Manage trusted website certificate authorities and authorization providers
- List and describe registered iOS and Android devices
- Sign out users and revoke or restore domain access during incidents

## Use cases

### Operating a Legacy WorkLink Fleet

Customers still running an Amazon WorkLink deployment use this API to keep their fleets healthy through to migration. ListFleets and DescribeFleetMetadata enumerate fleets; ListDomains and DescribeDomain show their associated internal sites; ListDevices and DescribeDevice surface registered handsets. UpdateAuditStreamConfiguration keeps the access log flowing to Kinesis Data Streams for compliance until the workload is replaced.

Example prompt: Call ListFleets, then for each FleetArn call DescribeFleetMetadata and ListDomains, returning a per-fleet summary with domain count and device count.

### Incident Response: Revoking Access

When a phone is lost or an employee leaves, revoke their access to internal apps in seconds. SignOutUser terminates active WorkLink sessions for a username; RevokeDomainAccess blocks an internal domain from being reached through the fleet during an incident. RestoreDomainAccess re-enables the domain once the incident is resolved.

Example prompt: Call SignOutUser with FleetArn and Username 'jane.doe@example.com', then RevokeDomainAccess with FleetArn and DomainName 'sensitive.internal.example.com'.

### Migration Inventory Build

Before retiring WorkLink, capture a full inventory: fleets, domains, certificate authorities, authorization providers, devices, audit configuration, and identity provider metadata. The Describe* and List* operations together produce the source of truth for designing the replacement (e.g. a VPN with mobile MDM or a zero-trust application proxy).

Example prompt: For each fleet, call DescribeFleetMetadata, DescribeIdentityProviderConfiguration, DescribeCompanyNetworkConfiguration, DescribeAuditStreamConfiguration, ListDomains, ListWebsiteCertificateAuthorities, ListWebsiteAuthorizationProviders, and ListDevices, and aggregate into a JSON inventory.

### Agent-Driven Fleet Operations via Jentic

Even on a legacy service, an operations agent can manage WorkLink through Jentic without holding AWS keys. The agent submits intents like 'list all worklink fleets and their device counts', Jentic loads ListFleets and ListDevices, executes them, and returns structured results. This pattern keeps the secret material out of the agent's context until the workload is finally migrated off WorkLink.

Example prompt: Through Jentic, search for 'list amazon worklink fleets', load ListFleets, execute it, then for each fleet load and call ListDevices.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /listFleets | List WorkLink fleets |
| POST | /createFleet | Create a WorkLink fleet |
| POST | /associateDomain | Associate an internal domain with a fleet |
| POST | /listDevices | List devices registered to a fleet |
| POST | /signOutUser | Sign a user out of WorkLink sessions |
| POST | /revokeDomainAccess | Revoke access to an internal domain |

## Key resources

- **Fleets** — CreateFleet, DeleteFleet, DescribeFleetMetadata, ListFleets
- **Domains** — AssociateDomain, DisassociateDomain, DescribeDomain, ListDomains, RevokeDomainAccess, RestoreDomainAccess
- **Devices and users** — ListDevices, DescribeDevice, SignOutUser
- **Identity and network** — DescribeIdentityProviderConfiguration, UpdateIdentityProviderConfiguration, DescribeCompanyNetworkConfiguration, UpdateCompanyNetworkConfiguration
- **Trust and authorization** — AssociateWebsiteCertificateAuthority, AssociateWebsiteAuthorizationProvider, and their list/disassociate counterparts

## Why Jentic

- **Setup:** Wiring Amazon WorkLink by hand means computing SigV4 signatures against the us-east-1 worklink endpoint and handling its fleet and domain routing yourself. Through Jentic you install once, import WorkLink from the API Directory, store the access keys once, and your agent calls it.
- **Permission scoping:** WorkLink identifies fleets by ARN passed in the request body rather than resource ids in the path, so scope the agent to the operations it needs, such as listFleets and listDevices. You choose the operations it may call, so revokeDomainAccess or signOutUser are not included unless you add them.
- **Credential handling:** Your AWS access keys are stored once, encrypted, by your own Jentic One instance and used to sign each WorkLink request with SigV4 at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list WorkLink fleets' or 'list devices in a fleet', and Jentic returns the matching WorkLink operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **AWS Single Sign-On** — AWS SSO provides modern workforce identity and SAML federation that supersedes WorkLink's identity model.
- **Amazon Cognito Identity** — Cognito Identity issues AWS credentials to mobile apps, complementing WorkLink's web-app reach into corporate intranets.
- **AWS CloudTrail** — CloudTrail records WorkLink management API events for audit and incident response.

## FAQ

### Why is there no official OpenAPI spec for Amazon WorkLink?

AWS does not publish an OpenAPI specification for Amazon WorkLink; it ships Smithy models and language-specific SDKs instead. Jentic generates and maintains this OpenAPI spec so that AI agents and developers can call Amazon WorkLink via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does Amazon WorkLink use?

WorkLink uses AWS SigV4 in the Authorization header. The IAM principal needs worklink:* permissions on the relevant fleet ARN. Through Jentic, your AWS keys stay in the vault and Jentic signs each request.

### Can I still use Amazon WorkLink?

AWS announced end-of-life for Amazon WorkLink on April 30, 2024. This API is documented for customers maintaining or migrating off existing fleets; new deployments should use a VPN, AWS Verified Access, or another zero-trust application proxy.

### What are the rate limits for the WorkLink API?

WorkLink has modest management-API throughput intended for fleet administration: a few transactions per second per account. Throttling responses use the standard ThrottlingException; retry with exponential back-off.

### How do I list WorkLink fleets through Jentic?

Search Jentic with 'list amazon worklink fleets', load ListFleets, and execute it (paginating with NextToken if needed). Jentic returns the FleetSummaryList with each fleet's ARN, name, and creation time.

### Can I sign a user out of all WorkLink sessions at once?

Yes. SignOutUser with FleetArn and Username terminates the user's active WorkLink sessions on every device for that fleet. Pair with RevokeDomainAccess if you also need to block specific internal domains.

### Does WorkLink support SAML for user authentication?

Yes. Use UpdateIdentityProviderConfiguration to attach SAML metadata for the fleet; users then authenticate to internal apps with their corporate SSO. DescribeIdentityProviderConfiguration returns the current SAML metadata document URL.

### Can I limit what my agent is allowed to do with the AWS WorkLink API?

Yes. Because Jentic One is self-hosted, you decide which WorkLink operations and which AWS keys the agent may use, and your own rules are what grant access. You can scope the agent to read-only operations such as ListFleets and ListDevices, so state-changing calls like RevokeDomainAccess or SignOutUser are excluded unless you explicitly add them. WorkLink identifies fleets by an ARN passed in the request body rather than a resource id in the path, so the safest approach is to allow only the specific operations the agent needs.