Skip to content

GetQueueResponse

Source code in docs_src/capo_deadline/types/get_queue_response.py
class GetQueueResponse(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID for the queue.</p>"""
    queue_id: "capo_deadline.types.queue_id.QueueId"
    """<p>The queue ID.</p>"""
    display_name: "capo_deadline.types.resource_name.ResourceName"
    """<p>The display name of the queue.</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.queue_status.QueueStatus"
    """<p>The status of the queue.</p> <ul> <li> <p> <code>ACTIVE</code>–The queue is active.</p> </li> <li> <p> <code>SCHEDULING</code>–The queue is scheduling.</p> </li> <li> <p> <code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked. See the provided reason.</p> </li> </ul>"""
    default_budget_action: (
        "capo_deadline.types.default_queue_budget_action.DefaultQueueBudgetAction"
    )
    """<p>The default action taken on a queue if a budget wasn't configured.</p>"""
    blocked_reason: NotRequired[
        "capo_deadline.types.queue_blocked_reason.QueueBlockedReason"
    ]
    """<p>The reason the queue was blocked.</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 queue.</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>"""
    job_attachment_settings: NotRequired[
        "capo_deadline.types.job_attachment_settings.JobAttachmentSettings"
    ]
    """<p>The job attachment settings for the queue.</p>"""
    role_arn: NotRequired["capo_deadline.types.iam_role_arn.IamRoleArn"]
    """<p>The IAM role ARN.</p>"""
    required_file_system_location_names: NotRequired[
        "capo_deadline.types.required_file_system_location_names.RequiredFileSystemLocationNames"
    ]
    """<p>A list of the required file system location names in the queue.</p>"""
    allowed_storage_profile_ids: NotRequired[
        "capo_deadline.types.allowed_storage_profile_ids.AllowedStorageProfileIds"
    ]
    """<p>The storage profile IDs for the queue.</p>"""
    job_run_as_user: NotRequired["capo_deadline.types.job_run_as_user.JobRunAsUser"]
    """<p>The jobs in the queue ran as this specified POSIX user.</p>"""
    scheduling_configuration: NotRequired[
        "capo_deadline.types.scheduling_configuration.SchedulingConfiguration"
    ]
    """<p>The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.</p>"""

allowed_storage_profile_ids instance-attribute

allowed_storage_profile_ids: NotRequired[AllowedStorageProfileIds]

The storage profile IDs for the queue.

blocked_reason instance-attribute

blocked_reason: NotRequired[QueueBlockedReason]

The reason the queue was blocked.

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.

default_budget_action instance-attribute

default_budget_action: DefaultQueueBudgetAction

The default action taken on a queue if a budget wasn't configured.

description instance-attribute

description: NotRequired[Description]

The description of the queue.

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

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 for the queue.

job_attachment_settings instance-attribute

job_attachment_settings: NotRequired[JobAttachmentSettings]

The job attachment settings for the queue.

job_run_as_user instance-attribute

job_run_as_user: NotRequired[JobRunAsUser]

The jobs in the queue ran as this specified POSIX user.

queue_id instance-attribute

queue_id: QueueId

The queue ID.

required_file_system_location_names instance-attribute

required_file_system_location_names: NotRequired[RequiredFileSystemLocationNames]

A list of the required file system location names in the queue.

role_arn instance-attribute

role_arn: NotRequired[IamRoleArn]

The IAM role ARN.

scheduling_configuration instance-attribute

scheduling_configuration: NotRequired[SchedulingConfiguration]

The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.

status instance-attribute

status: QueueStatus

The status of the queue.

  • ACTIVE–The queue is active.

  • SCHEDULING–The queue is scheduling.

  • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

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.