WorkLink / Client / describe_fleet_metadata

describe_fleet_metadata#

WorkLink.Client.describe_fleet_metadata(**kwargs)#

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

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

response = client.describe_fleet_metadata(
    FleetArn='string'
)

Parameters:

FleetArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the fleet.

Return type:

dict

Returns:

Response Syntax

{
    'CreatedTime': datetime(2015, 1, 1),
    'LastUpdatedTime': datetime(2015, 1, 1),
    'FleetName': 'string',
    'DisplayName': 'string',
    'OptimizeForEndUserLocation': True|False,
    'CompanyCode': 'string',
    'FleetStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED_TO_CREATE'|'FAILED_TO_DELETE',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- CreatedTime (datetime) –
  
  The time that the fleet was created.
- LastUpdatedTime (datetime) –
  
  The time that the fleet was last updated.
- FleetName (string) –
  
  The name of the fleet.
- DisplayName (string) –
  
  The name to display.
- OptimizeForEndUserLocation (boolean) –
  
  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.
- CompanyCode (string) –
  
  The identifier used by users to sign in to the Amazon WorkLink app.
- FleetStatus (string) –
  
  The current state of the fleet.
- Tags (dict) –
  
  The tags attached to the resource. A tag is a key-value pair.
  - (string) –
    - (string) –

Exceptions

WorkLink.Client.exceptions.UnauthorizedException
WorkLink.Client.exceptions.InternalServerErrorException
WorkLink.Client.exceptions.InvalidRequestException
WorkLink.Client.exceptions.ResourceNotFoundException
WorkLink.Client.exceptions.TooManyRequestsException