Skip to content

UpdateFleetRequest

Source code in docs_src/capo_deadline/types/update_fleet_request.py
class UpdateFleetRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID to update.</p>"""
    fleet_id: "capo_deadline.types.fleet_id.FleetId"
    """<p>The fleet ID to update.</p>"""
    client_token: NotRequired["capo_deadline.types.client_token.ClientToken"]
    """<p>The unique token which the server uses to recognize retries of the same request.</p>"""
    display_name: NotRequired["capo_deadline.types.resource_name.ResourceName"]
    """<p>The display name of the fleet to update.</p> <important> <p>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.</p> </important>"""
    description: NotRequired["capo_deadline.types.description.Description"]
    """<p>The description of the fleet to update.</p> <important> <p>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.</p> </important>"""
    role_arn: NotRequired["capo_deadline.types.iam_role_arn.IamRoleArn"]
    """<p>The IAM role ARN that the fleet's workers assume while running jobs.</p>"""
    min_worker_count: NotRequired[
        "capo_deadline.types.min_zero_max_integer.MinZeroMaxInteger"
    ]
    """<p>The minimum number of workers in the fleet.</p>"""
    max_worker_count: NotRequired[
        "capo_deadline.types.min_zero_max_integer.MinZeroMaxInteger"
    ]
    """<p>The maximum number of workers in the fleet.</p> <p>Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to <code>CreateWorker</code> before the field updates, you might exceed your fleet's maximum worker count. For example, if your <code>maxWorkerCount</code> is 10 and you currently have 9 workers, making two quick <code>CreateWorker</code> calls might successfully create 2 workers instead of 1, resulting in 11 total workers.</p>"""
    configuration: NotRequired[
        "capo_deadline.types.fleet_configuration.FleetConfiguration"
    ]
    """<p>The fleet configuration to update.</p>"""
    host_configuration: NotRequired[
        "capo_deadline.types.host_configuration.HostConfiguration"
    ]
    """<p>Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

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

configuration instance-attribute

configuration: NotRequired[FleetConfiguration]

The fleet configuration to update.

description instance-attribute

description: NotRequired[Description]

The description of the fleet to update.

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.

display_name instance-attribute

display_name: NotRequired[ResourceName]

The display name of the fleet to update.

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.

farm_id instance-attribute

farm_id: FarmId

The farm ID to update.

fleet_id instance-attribute

fleet_id: FleetId

The fleet ID to update.

host_configuration instance-attribute

host_configuration: NotRequired[HostConfiguration]

Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

max_worker_count instance-attribute

max_worker_count: NotRequired[MinZeroMaxInteger]

The maximum number of workers in the fleet.

Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.

min_worker_count instance-attribute

min_worker_count: NotRequired[MinZeroMaxInteger]

The minimum number of workers in the fleet.

role_arn instance-attribute

role_arn: NotRequired[IamRoleArn]

The IAM role ARN that the fleet's workers assume while running jobs.