IoTRoboRunner / Client / list_worker_fleets

list_worker_fleets#

IoTRoboRunner.Client.list_worker_fleets(**kwargs)#

Grants permission to list worker fleets

See also: AWS API Documentation

Request Syntax

response = client.list_worker_fleets(
    site='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • site (string) –

    [REQUIRED]

    Site ARN.

  • maxResults (integer) – Maximum number of results to retrieve in a single ListWorkerFleets call.

  • nextToken (string) – Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'workerFleets': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'site': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'additionalFixedProperties': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

    • workerFleets (list) –

      List of worker fleets.

      • (dict) –

        A collection of workers organized within a facility.

        • arn (string) –

          Full ARN of the worker fleet.

        • id (string) –

          Filters access by the worker fleet’s identifier

        • name (string) –

          Human friendly name of the resource.

        • site (string) –

          Site ARN.

        • createdAt (datetime) –

          Timestamp at which the resource was created.

        • updatedAt (datetime) –

          Timestamp at which the resource was last updated.

        • additionalFixedProperties (string) –

          JSON blob containing additional fixed properties regarding the worker fleet

Exceptions