DeadlineCloud / Client / list_queue_fleet_associations

list_queue_fleet_associations#

DeadlineCloud.Client.list_queue_fleet_associations(**kwargs)#

Lists queue-fleet associations.

See also: AWS API Documentation

Request Syntax

response = client.list_queue_fleet_associations(
    farmId='string',
    queueId='string',
    fleetId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID for the queue-fleet association list.

  • queueId (string) – The queue ID for the queue-fleet association list.

  • fleetId (string) – The fleet ID for the queue-fleet association list.

  • nextToken (string) – The token for the next set of results, or null to start from the beginning.

  • maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Return type:

dict

Returns:

Response Syntax

{
    'queueFleetAssociations': [
        {
            'queueId': 'string',
            'fleetId': 'string',
            'status': 'ACTIVE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'|'STOPPED',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • queueFleetAssociations (list) –

      The queue-fleet associations on the list.

      • (dict) –

        The details of a queue-fleet association.

        • queueId (string) –

          The queue ID.

        • fleetId (string) –

          The fleet ID.

        • status (string) –

          The status of task scheduling in the queue-fleet association.

          • ACTIVE–Association is active.

          • STOP_SCHEDULING_AND_COMPLETE_TASKS–Association has stopped scheduling new tasks and is completing current tasks.

          • STOP_SCHEDULING_AND_CANCEL_TASKS–Association has stopped scheduling new tasks and is canceling current tasks.

          • STOPPED–Association has been stopped.

        • createdAt (datetime) –

          The date and time the resource was created.

        • createdBy (string) –

          The user or system that created this resource.

        • updatedAt (datetime) –

          The date and time the resource was updated.

        • updatedBy (string) –

          The user or system that updated this resource.

    • nextToken (string) –

      If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

Exceptions