DeadlineCloud / Client / list_workers

list_workers#

DeadlineCloud.Client.list_workers(**kwargs)#

Lists workers.

See also: AWS API Documentation

Request Syntax

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

  • farmId (string) –

    [REQUIRED]

    The farm ID connected to the workers.

  • fleetId (string) –

    [REQUIRED]

    The fleet ID of the workers.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'workers': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'farmId': 'string',
            'fleetId': 'string',
            'hostProperties': {
                'ec2InstanceArn': 'string',
                'ec2InstanceType': 'string',
                'hostName': 'string',
                'ipAddresses': {
                    'ipV4Addresses': [
                        'string',
                    ],
                    'ipV6Addresses': [
                        'string',
                    ]
                }
            },
            'log': {
                'error': 'string',
                'logDriver': 'string',
                'options': {
                    'string': 'string'
                },
                'parameters': {
                    'string': 'string'
                }
            },
            'status': 'CREATED'|'STARTED'|'STOPPING'|'STOPPED'|'NOT_RESPONDING'|'NOT_COMPATIBLE'|'RUNNING'|'IDLE',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'workerId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • 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.

    • workers (list) –

      The workers on the list.

      • (dict) –

        The summary of details for a worker.

        • createdAt (datetime) –

          The date and time the resource was created.

        • createdBy (string) –

          The user or system that created this resource.

        • farmId (string) –

          The farm ID.

        • fleetId (string) –

          The fleet ID.

        • hostProperties (dict) –

          The host properties of the worker.

          • ec2InstanceArn (string) –

            The ARN of the host EC2 instance.

          • ec2InstanceType (string) –

            The instance type of the host EC2 instance.

          • hostName (string) –

            The host name.

          • ipAddresses (dict) –

            The IP address of the host.

            • ipV4Addresses (list) –

              The IpV4 address of the network.

              • (string) –

            • ipV6Addresses (list) –

              The IpV6 address for the network and node component.

              • (string) –

        • log (dict) –

          The log configuration for the worker.

          • error (string) –

            The log configuration error details.

          • logDriver (string) –

            The log drivers for worker related logs.

          • options (dict) –

            The options for a log driver.

            • (string) –

              • (string) –

          • parameters (dict) –

            The parameters for the log configuration.

            • (string) –

              • (string) –

        • status (string) –

          The status of the worker.

        • updatedAt (datetime) –

          The date and time the resource was updated.

        • updatedBy (string) –

          The user or system that updated this resource.

        • workerId (string) –

          The worker ID.

Exceptions