DeadlineCloud / Client / create_worker

create_worker#

DeadlineCloud.Client.create_worker(**kwargs)#

Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.

See also: AWS API Documentation

Request Syntax

response = client.create_worker(
    clientToken='string',
    farmId='string',
    fleetId='string',
    hostProperties={
        'hostName': 'string',
        'ipAddresses': {
            'ipV4Addresses': [
                'string',
            ],
            'ipV6Addresses': [
                'string',
            ]
        }
    }
)
Parameters:

  • clientToken (string) –

    The unique token which the server uses to recognize retries of the same request.

    This field is autopopulated if not provided.

  • farmId (string) –

    [REQUIRED]

    The farm ID of the farm to connect to the worker.

  • fleetId (string) –

    [REQUIRED]

    The fleet ID to connect to the worker.

  • hostProperties (dict) –

    The IP address and host name of the worker.

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

Return type:

dict

Returns:

Response Syntax

{
    'workerId': 'string'
}

Response Structure

  • (dict) –

    • workerId (string) –

      The worker ID.

Exceptions