list_fleets¶

list_fleets(**kwargs)¶

Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.

Warning

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

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,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ]
)

Parameters

nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Note

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
maxResults (integer) -- When this parameter is used, ListFleets only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListFleets returns up to 200 results and a nextToken value if applicable.
filters (list) --
Optional filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
- (dict) --
  Information about a filter.
  - name (string) --
    The name of the filter.
  - values (list) --
    A list of values.
    - (string) --

Return type

dict

Returns

Response Syntax

{
    'fleetDetails': [
        {
            'name': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastDeploymentStatus': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
            'lastDeploymentJob': 'string',
            'lastDeploymentTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- fleetDetails (list) --
  
  A list of fleet details meeting the request criteria.
  - (dict) --
    
    Information about a fleet.
    - name (string) --
      
      The name of the fleet.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the fleet.
    - createdAt (datetime) --
      
      The time, in milliseconds since the epoch, when the fleet was created.
    - lastDeploymentStatus (string) --
      
      The status of the last fleet deployment.
    - lastDeploymentJob (string) --
      
      The Amazon Resource Name (ARN) of the last deployment job.
    - lastDeploymentTime (datetime) --
      
      The time of the last deployment.
- nextToken (string) --
  
  If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Exceptions

RoboMaker.Client.exceptions.ResourceNotFoundException
RoboMaker.Client.exceptions.InvalidParameterException
RoboMaker.Client.exceptions.InternalServerException
RoboMaker.Client.exceptions.ThrottlingException

Table Of Contents

list_fleets¶