DeadlineCloud / Client / get_worker

get_worker

DeadlineCloud.Client.get_worker(**kwargs)

Gets a worker.

See also: AWS API Documentation

Request Syntax

response = client.get_worker(
    farmId='string',
    fleetId='string',
    workerId='string'
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID for the worker.

• fleetId (string) –

  [REQUIRED]

  The fleet ID of the worker.

• workerId (string) –

  [REQUIRED]

  The worker ID.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • workerId (string) –

    The worker ID.

  • farmId (string) –

    The farm ID.

  • fleetId (string) –

    The fleet ID.

  • hostProperties (dict) –

    The host properties for the worker.

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

    • hostName (string) –

      The host name.

    • ec2InstanceArn (string) –

      The ARN of the host EC2 instance.

    • ec2InstanceType (string) –

      The instance type of the host EC2 instance.

  • status (string) –

    The status of the worker.

  • log (dict) –

    The logs for the associated worker.

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

    • error (string) –

      The log configuration error details.

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

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException