POST

/createFleet

http://worklink.{region}.amazonaws.com/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.

Access Token Required: API Key

Body Params

Tagsobject

The tags to add to the resource. A tag is a key-value pair.

FleetNamestringrequired

A unique name for the fleet.

DisplayNamestring

The fleet name to display.

OptimizeForEndUserLocationboolean

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://worklink.{region}.amazonaws.com/createFleet' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}