Amazon WorkLink
API Reference (API Version 2018-09-25)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeFleetMetadata

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

Request Syntax

POST /describeFleetMetadata HTTP/1.1 Content-type: application/json { "FleetArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

FleetArn

The ARN of the fleet.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CompanyCode": "string", "CreatedTime": number, "DisplayName": "string", "FleetName": "string", "FleetStatus": "string", "LastUpdatedTime": number, "OptimizeForEndUserLocation": boolean }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CompanyCode

The identifier used by users to sign in to the Amazon WorkLink app.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

CreatedTime

The time that the fleet was created.

Type: Timestamp

DisplayName

The name to display.

Type: String

Length Constraints: Maximum length of 100.

FleetName

The name of the fleet.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,46}[a-z0-9])?$

FleetStatus

The current state of the fleet.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | DELETED | FAILED_TO_CREATE | FAILED_TO_DELETE

LastUpdatedTime

The time that the fleet was last updated.

Type: Timestamp

OptimizeForEndUserLocation

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.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerErrorException

The service is temporarily unavailable.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

TooManyRequestsException

The number of requests exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this action.

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: