WorkLink / Client / list_fleets

list_fleets

WorkLink.Client.list_fleets(**kwargs)

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

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.

See also: AWS API Documentation

Request Syntax

response = client.list_fleets(
    NextToken='string',
    MaxResults=123
)

Parameters:

• NextToken (string) – The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

• MaxResults (integer) – The maximum number of results to be included in the next page.

Return type:

dict

Returns:

Response Syntax

{
    'FleetSummaryList': [
        {
            'FleetArn': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'FleetName': 'string',
            'DisplayName': 'string',
            'CompanyCode': 'string',
            'FleetStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED_TO_CREATE'|'FAILED_TO_DELETE',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • FleetSummaryList (list) –

    The summary list of the fleets.

    • (dict) –

      The summary of the fleet.

      • FleetArn (string) –

        The Amazon Resource Name (ARN) of the fleet.

      • CreatedTime (datetime) –

        The time when the fleet was created.

      • LastUpdatedTime (datetime) –

        The time when the fleet was last updated.

      • FleetName (string) –

        The name of the fleet.

      • DisplayName (string) –

        The name of the fleet to display.

      • CompanyCode (string) –

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

      • FleetStatus (string) –

        The status of the fleet.

      • Tags (dict) –

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

        • (string) –

          • (string) –

  • NextToken (string) –

    The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Exceptions

• WorkLink.Client.exceptions.UnauthorizedException

• WorkLink.Client.exceptions.InternalServerErrorException

• WorkLink.Client.exceptions.InvalidRequestException

• WorkLink.Client.exceptions.TooManyRequestsException