DeadlineCloud / Client / update_worker

update_worker#

DeadlineCloud.Client.update_worker(**kwargs)#

Updates a worker.

See also: AWS API Documentation

Request Syntax

response = client.update_worker(
    capabilities={
        'amounts': [
            {
                'name': 'string',
                'value': ...
            },
        ],
        'attributes': [
            {
                'name': 'string',
                'values': [
                    'string',
                ]
            },
        ]
    },
    farmId='string',
    fleetId='string',
    hostProperties={
        'hostName': 'string',
        'ipAddresses': {
            'ipV4Addresses': [
                'string',
            ],
            'ipV6Addresses': [
                'string',
            ]
        }
    },
    status='STARTED'|'STOPPING'|'STOPPED',
    workerId='string'
)
Parameters:

  • capabilities (dict) –

    The worker capabilities to update.

    • amounts (list) – [REQUIRED]

      The worker capabilities amounts on a list of worker capabilities.

      • (dict) –

        The details of the worker amount capability.

        • name (string) – [REQUIRED]

          The name of the worker amount capability.

        • value (float) – [REQUIRED]

          The value of the worker amount capability.

    • attributes (list) – [REQUIRED]

      The worker attribute capabilities in the list of attribute capabilities.

      • (dict) –

        The details of the worker attribute capability.

        • name (string) – [REQUIRED]

          The name of the worker attribute capability.

        • values (list) – [REQUIRED]

          The values of the worker amount capability.

          • (string) –

  • farmId (string) –

    [REQUIRED]

    The farm ID to update.

  • fleetId (string) –

    [REQUIRED]

    The fleet ID to update.

  • hostProperties (dict) –

    The host properties to update.

    • 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) –

  • status (string) – The worker status to update.

  • workerId (string) –

    [REQUIRED]

    The worker ID to update.

Return type:

dict

Returns:

Response Syntax

{
    'log': {
        'error': 'string',
        'logDriver': 'string',
        'options': {
            'string': 'string'
        },
        'parameters': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • log (dict) –

      The worker log to update.

      • 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) –

Exceptions