Skip to content

GetFleetResponse

Source code in docs_src/capo_deadline/types/get_fleet_response.py
class GetFleetResponse(TypedDict, closed=True):
    fleet_id: "capo_deadline.types.fleet_id.FleetId"
    """<p>The fleet ID.</p>"""
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the farm in the fleet.</p>"""
    display_name: "capo_deadline.types.resource_name.ResourceName"
    """<p>The display name of the fleet.</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>"""
    status: "capo_deadline.types.fleet_status.FleetStatus"
    """<p>The status of the fleet.</p>"""
    status_message: NotRequired["capo_deadline.types.string.String"]
    """<p>A message that communicates a suspended status of the fleet.</p>"""
    auto_scaling_status: NotRequired[
        "capo_deadline.types.auto_scaling_status.AutoScalingStatus"
    ]
    """<p>The Auto Scaling status of the fleet. Either <code>GROWING</code>, <code>STEADY</code>, or <code>SHRINKING</code>.</p>"""
    target_worker_count: NotRequired["capo_deadline.types.integer.Integer"]
    """<p>The number of target workers in the fleet.</p>"""
    worker_count: "capo_deadline.types.integer.Integer"
    """<p>The number of workers in the fleet.</p>"""
    min_worker_count: "capo_deadline.types.min_zero_max_integer.MinZeroMaxInteger"
    """<p>The minimum number of workers specified in the fleet.</p>"""
    max_worker_count: "capo_deadline.types.min_zero_max_integer.MinZeroMaxInteger"
    """<p>The maximum number of workers specified in the fleet.</p>"""
    configuration: "capo_deadline.types.fleet_configuration.FleetConfiguration"
    """<p>The configuration setting for the fleet.</p>"""
    created_at: "capo_deadline.types.created_at.CreatedAt"
    """<p>The date and time the resource was created.</p>"""
    created_by: "capo_deadline.types.created_by.CreatedBy"
    """<p>The user or system that created this resource.</p>"""
    updated_at: NotRequired["capo_deadline.types.updated_at.UpdatedAt"]
    """<p>The date and time the resource was updated.</p>"""
    updated_by: NotRequired["capo_deadline.types.updated_by.UpdatedBy"]
    """<p>The user or system that updated this resource.</p>"""
    description: NotRequired["capo_deadline.types.description.Description"]
    """<p>The description of the fleet.</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>"""
    host_configuration: NotRequired[
        "capo_deadline.types.host_configuration.HostConfiguration"
    ]
    """<p>The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.</p>"""
    capabilities: NotRequired[
        "capo_deadline.types.fleet_capabilities.FleetCapabilities"
    ]
    """<p>Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.</p>"""
    role_arn: "capo_deadline.types.iam_role_arn.IamRoleArn"
    """<p>The IAM role ARN.</p>"""

auto_scaling_status instance-attribute

auto_scaling_status: NotRequired[AutoScalingStatus]

The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING.

capabilities instance-attribute

capabilities: NotRequired[FleetCapabilities]

Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.

configuration instance-attribute

configuration: FleetConfiguration

The configuration setting for the fleet.

created_at instance-attribute

created_at: CreatedAt

The date and time the resource was created.

created_by instance-attribute

created_by: CreatedBy

The user or system that created this resource.

description instance-attribute

description: NotRequired[Description]

The description of the fleet.

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: ResourceName

The display name of the fleet.

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 of the farm in the fleet.

fleet_id instance-attribute

fleet_id: FleetId

The fleet ID.

host_configuration instance-attribute

host_configuration: NotRequired[HostConfiguration]

The 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: MinZeroMaxInteger

The maximum number of workers specified in the fleet.

min_worker_count instance-attribute

min_worker_count: MinZeroMaxInteger

The minimum number of workers specified in the fleet.

role_arn instance-attribute

role_arn: IamRoleArn

The IAM role ARN.

status instance-attribute

status: FleetStatus

The status of the fleet.

status_message instance-attribute

status_message: NotRequired[String]

A message that communicates a suspended status of the fleet.

target_worker_count instance-attribute

target_worker_count: NotRequired[Integer]

The number of target workers in the fleet.

updated_at instance-attribute

updated_at: NotRequired[UpdatedAt]

The date and time the resource was updated.

updated_by instance-attribute

updated_by: NotRequired[UpdatedBy]

The user or system that updated this resource.

worker_count instance-attribute

worker_count: Integer

The number of workers in the fleet.