DeadlineCloud / Client / create_farm

create_farm

DeadlineCloud.Client.create_farm(**kwargs)

Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.

See also: AWS API Documentation

Request Syntax

response = client.create_farm(
    clientToken='string',
    displayName='string',
    description='string',
    kmsKeyArn='string',
    costScaleFactor=...,
    tags={
        'string': '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.

  • displayName (string) –

    [REQUIRED]

    The display name of the farm.

    Warning

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • description (string) –

    The description of the farm.

    Warning

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • kmsKeyArn (string) – The ARN of the KMS key to use on the farm.

  • costScaleFactor (float) – A multiplier applied to the farm’s calculated costs for usage data and budget tracking. A value less than 1 represents a discount, a value greater than 1 represents a premium, and a value of 1 represents no adjustment. The default value is 1.

  • tags (dict) –

    The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'farmId': 'string'
}

Response Structure

  • (dict) –

    Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.

    • farmId (string) –

      The farm ID.

Exceptions