DeadlineCloudClient

Index > DeadlineCloud > DeadlineCloudClient

Auto-generated documentation for DeadlineCloud type annotations stubs module mypy-boto3-deadline.

DeadlineCloudClient

Type annotations and code completion for boto3.client("deadline"). boto3 documentation

# DeadlineCloudClient usage example

from boto3.session import Session
from mypy_boto3_deadline.client import DeadlineCloudClient

def get_deadline_client() -> DeadlineCloudClient:
    return Session().client("deadline")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("deadline").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("deadline")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_deadline.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("deadline").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("deadline").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

associate_member_to_farm

Assigns a farm membership level to a member.

Type annotations and code completion for boto3.client("deadline").associate_member_to_farm method. boto3 documentation

# associate_member_to_farm method definition

def associate_member_to_farm(
    self,
    *,
    farmId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
) -> Dict[str, Any]:
    ...

1. See PrincipalTypeType
2. See MembershipLevelType

# associate_member_to_farm method usage example with argument unpacking

kwargs: AssociateMemberToFarmRequestTypeDef = {  # (1)
    "farmId": ...,
    "principalId": ...,
    "principalType": ...,
    "identityStoreId": ...,
    "membershipLevel": ...,
}

parent.associate_member_to_farm(**kwargs)

1. See AssociateMemberToFarmRequestTypeDef

associate_member_to_fleet

Assigns a fleet membership level to a member.

Type annotations and code completion for boto3.client("deadline").associate_member_to_fleet method. boto3 documentation

# associate_member_to_fleet method definition

def associate_member_to_fleet(
    self,
    *,
    farmId: str,
    fleetId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
) -> Dict[str, Any]:
    ...

1. See PrincipalTypeType
2. See MembershipLevelType

# associate_member_to_fleet method usage example with argument unpacking

kwargs: AssociateMemberToFleetRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "principalId": ...,
    "principalType": ...,
    "identityStoreId": ...,
    "membershipLevel": ...,
}

parent.associate_member_to_fleet(**kwargs)

1. See AssociateMemberToFleetRequestTypeDef

associate_member_to_job

Assigns a job membership level to a member.

Type annotations and code completion for boto3.client("deadline").associate_member_to_job method. boto3 documentation

# associate_member_to_job method definition

def associate_member_to_job(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
) -> Dict[str, Any]:
    ...

1. See PrincipalTypeType
2. See MembershipLevelType

# associate_member_to_job method usage example with argument unpacking

kwargs: AssociateMemberToJobRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "principalId": ...,
    "principalType": ...,
    "identityStoreId": ...,
    "membershipLevel": ...,
}

parent.associate_member_to_job(**kwargs)

1. See AssociateMemberToJobRequestTypeDef

associate_member_to_queue

Assigns a queue membership level to a member.

Type annotations and code completion for boto3.client("deadline").associate_member_to_queue method. boto3 documentation

# associate_member_to_queue method definition

def associate_member_to_queue(
    self,
    *,
    farmId: str,
    queueId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
) -> Dict[str, Any]:
    ...

1. See PrincipalTypeType
2. See MembershipLevelType

# associate_member_to_queue method usage example with argument unpacking

kwargs: AssociateMemberToQueueRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "principalId": ...,
    "principalType": ...,
    "identityStoreId": ...,
    "membershipLevel": ...,
}

parent.associate_member_to_queue(**kwargs)

1. See AssociateMemberToQueueRequestTypeDef

assume_fleet_role_for_read

Get Amazon Web Services credentials from the fleet role.

Type annotations and code completion for boto3.client("deadline").assume_fleet_role_for_read method. boto3 documentation

# assume_fleet_role_for_read method definition

def assume_fleet_role_for_read(
    self,
    *,
    farmId: str,
    fleetId: str,
) -> AssumeFleetRoleForReadResponseTypeDef:  # (1)
    ...

1. See AssumeFleetRoleForReadResponseTypeDef

# assume_fleet_role_for_read method usage example with argument unpacking

kwargs: AssumeFleetRoleForReadRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
}

parent.assume_fleet_role_for_read(**kwargs)

1. See AssumeFleetRoleForReadRequestTypeDef

assume_fleet_role_for_worker

Get credentials from the fleet role for a worker.

Type annotations and code completion for boto3.client("deadline").assume_fleet_role_for_worker method. boto3 documentation

# assume_fleet_role_for_worker method definition

def assume_fleet_role_for_worker(
    self,
    *,
    farmId: str,
    fleetId: str,
    workerId: str,
) -> AssumeFleetRoleForWorkerResponseTypeDef:  # (1)
    ...

1. See AssumeFleetRoleForWorkerResponseTypeDef

# assume_fleet_role_for_worker method usage example with argument unpacking

kwargs: AssumeFleetRoleForWorkerRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "workerId": ...,
}

parent.assume_fleet_role_for_worker(**kwargs)

1. See AssumeFleetRoleForWorkerRequestTypeDef

assume_queue_role_for_read

Gets Amazon Web Services credentials from the queue role.

Type annotations and code completion for boto3.client("deadline").assume_queue_role_for_read method. boto3 documentation

# assume_queue_role_for_read method definition

def assume_queue_role_for_read(
    self,
    *,
    farmId: str,
    queueId: str,
) -> AssumeQueueRoleForReadResponseTypeDef:  # (1)
    ...

1. See AssumeQueueRoleForReadResponseTypeDef

# assume_queue_role_for_read method usage example with argument unpacking

kwargs: AssumeQueueRoleForReadRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
}

parent.assume_queue_role_for_read(**kwargs)

1. See AssumeQueueRoleForReadRequestTypeDef

assume_queue_role_for_user

Allows a user to assume a role for a queue.

Type annotations and code completion for boto3.client("deadline").assume_queue_role_for_user method. boto3 documentation

# assume_queue_role_for_user method definition

def assume_queue_role_for_user(
    self,
    *,
    farmId: str,
    queueId: str,
) -> AssumeQueueRoleForUserResponseTypeDef:  # (1)
    ...

1. See AssumeQueueRoleForUserResponseTypeDef

# assume_queue_role_for_user method usage example with argument unpacking

kwargs: AssumeQueueRoleForUserRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
}

parent.assume_queue_role_for_user(**kwargs)

1. See AssumeQueueRoleForUserRequestTypeDef

assume_queue_role_for_worker

Allows a worker to assume a queue role.

Type annotations and code completion for boto3.client("deadline").assume_queue_role_for_worker method. boto3 documentation

# assume_queue_role_for_worker method definition

def assume_queue_role_for_worker(
    self,
    *,
    farmId: str,
    fleetId: str,
    workerId: str,
    queueId: str,
) -> AssumeQueueRoleForWorkerResponseTypeDef:  # (1)
    ...

1. See AssumeQueueRoleForWorkerResponseTypeDef

# assume_queue_role_for_worker method usage example with argument unpacking

kwargs: AssumeQueueRoleForWorkerRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "workerId": ...,
    "queueId": ...,
}

parent.assume_queue_role_for_worker(**kwargs)

1. See AssumeQueueRoleForWorkerRequestTypeDef

batch_get_job_entity

Get batched job details for a worker.

Type annotations and code completion for boto3.client("deadline").batch_get_job_entity method. boto3 documentation

# batch_get_job_entity method definition

def batch_get_job_entity(
    self,
    *,
    farmId: str,
    fleetId: str,
    workerId: str,
    identifiers: Sequence[JobEntityIdentifiersUnionTypeDef],  # (1)
) -> BatchGetJobEntityResponseTypeDef:  # (2)
    ...

1. See JobEntityIdentifiersUnionTypeDef
2. See BatchGetJobEntityResponseTypeDef

# batch_get_job_entity method usage example with argument unpacking

kwargs: BatchGetJobEntityRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "workerId": ...,
    "identifiers": ...,
}

parent.batch_get_job_entity(**kwargs)

1. See BatchGetJobEntityRequestTypeDef

copy_job_template

Copies a job template to an Amazon S3 bucket.

Type annotations and code completion for boto3.client("deadline").copy_job_template method. boto3 documentation

# copy_job_template method definition

def copy_job_template(
    self,
    *,
    farmId: str,
    jobId: str,
    queueId: str,
    targetS3Location: S3LocationTypeDef,  # (1)
) -> CopyJobTemplateResponseTypeDef:  # (2)
    ...

1. See S3LocationTypeDef
2. See CopyJobTemplateResponseTypeDef

# copy_job_template method usage example with argument unpacking

kwargs: CopyJobTemplateRequestTypeDef = {  # (1)
    "farmId": ...,
    "jobId": ...,
    "queueId": ...,
    "targetS3Location": ...,
}

parent.copy_job_template(**kwargs)

1. See CopyJobTemplateRequestTypeDef

create_budget

Creates a budget to set spending thresholds for your rendering activity.

Type annotations and code completion for boto3.client("deadline").create_budget method. boto3 documentation

# create_budget method definition

def create_budget(
    self,
    *,
    farmId: str,
    usageTrackingResource: UsageTrackingResourceTypeDef,  # (1)
    displayName: str,
    approximateDollarLimit: float,
    actions: Sequence[BudgetActionToAddTypeDef],  # (2)
    schedule: BudgetScheduleUnionTypeDef,  # (3)
    clientToken: str = ...,
    description: str = ...,
) -> CreateBudgetResponseTypeDef:  # (4)
    ...

1. See UsageTrackingResourceTypeDef
2. See BudgetActionToAddTypeDef
3. See BudgetScheduleTypeDef BudgetScheduleOutputTypeDef
4. See CreateBudgetResponseTypeDef

# create_budget method usage example with argument unpacking

kwargs: CreateBudgetRequestTypeDef = {  # (1)
    "farmId": ...,
    "usageTrackingResource": ...,
    "displayName": ...,
    "approximateDollarLimit": ...,
    "actions": ...,
    "schedule": ...,
}

parent.create_budget(**kwargs)

1. See CreateBudgetRequestTypeDef

create_farm

Creates a farm to allow space for queues and fleets.

Type annotations and code completion for boto3.client("deadline").create_farm method. boto3 documentation

# create_farm method definition

def create_farm(
    self,
    *,
    displayName: str,
    clientToken: str = ...,
    description: str = ...,
    kmsKeyArn: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateFarmResponseTypeDef:  # (1)
    ...

1. See CreateFarmResponseTypeDef

# create_farm method usage example with argument unpacking

kwargs: CreateFarmRequestTypeDef = {  # (1)
    "displayName": ...,
}

parent.create_farm(**kwargs)

1. See CreateFarmRequestTypeDef

create_fleet

Creates a fleet.

Type annotations and code completion for boto3.client("deadline").create_fleet method. boto3 documentation

# create_fleet method definition

def create_fleet(
    self,
    *,
    farmId: str,
    displayName: str,
    roleArn: str,
    maxWorkerCount: int,
    configuration: FleetConfigurationUnionTypeDef,  # (1)
    clientToken: str = ...,
    description: str = ...,
    minWorkerCount: int = ...,
    tags: Mapping[str, str] = ...,
) -> CreateFleetResponseTypeDef:  # (2)
    ...

1. See FleetConfigurationTypeDef FleetConfigurationOutputTypeDef
2. See CreateFleetResponseTypeDef

# create_fleet method usage example with argument unpacking

kwargs: CreateFleetRequestTypeDef = {  # (1)
    "farmId": ...,
    "displayName": ...,
    "roleArn": ...,
    "maxWorkerCount": ...,
    "configuration": ...,
}

parent.create_fleet(**kwargs)

1. See CreateFleetRequestTypeDef

create_job

Creates a job.

Type annotations and code completion for boto3.client("deadline").create_job method. boto3 documentation

# create_job method definition

def create_job(
    self,
    *,
    farmId: str,
    queueId: str,
    priority: int,
    clientToken: str = ...,
    template: str = ...,
    templateType: JobTemplateTypeType = ...,  # (1)
    parameters: Mapping[str, JobParameterTypeDef] = ...,  # (2)
    attachments: AttachmentsUnionTypeDef = ...,  # (3)
    storageProfileId: str = ...,
    targetTaskRunStatus: CreateJobTargetTaskRunStatusType = ...,  # (4)
    maxFailedTasksCount: int = ...,
    maxRetriesPerTask: int = ...,
    maxWorkerCount: int = ...,
    sourceJobId: str = ...,
) -> CreateJobResponseTypeDef:  # (5)
    ...

1. See JobTemplateTypeType
2. See JobParameterTypeDef
3. See AttachmentsTypeDef AttachmentsOutputTypeDef
4. See CreateJobTargetTaskRunStatusType
5. See CreateJobResponseTypeDef

# create_job method usage example with argument unpacking

kwargs: CreateJobRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "priority": ...,
}

parent.create_job(**kwargs)

1. See CreateJobRequestTypeDef

create_license_endpoint

Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.

Type annotations and code completion for boto3.client("deadline").create_license_endpoint method. boto3 documentation

# create_license_endpoint method definition

def create_license_endpoint(
    self,
    *,
    vpcId: str,
    subnetIds: Sequence[str],
    securityGroupIds: Sequence[str],
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateLicenseEndpointResponseTypeDef:  # (1)
    ...

1. See CreateLicenseEndpointResponseTypeDef

# create_license_endpoint method usage example with argument unpacking

kwargs: CreateLicenseEndpointRequestTypeDef = {  # (1)
    "vpcId": ...,
    "subnetIds": ...,
    "securityGroupIds": ...,
}

parent.create_license_endpoint(**kwargs)

1. See CreateLicenseEndpointRequestTypeDef

create_limit

Creates a limit that manages the distribution of shared resources, such as floating licenses.

Type annotations and code completion for boto3.client("deadline").create_limit method. boto3 documentation

# create_limit method definition

def create_limit(
    self,
    *,
    displayName: str,
    amountRequirementName: str,
    maxCount: int,
    farmId: str,
    clientToken: str = ...,
    description: str = ...,
) -> CreateLimitResponseTypeDef:  # (1)
    ...

1. See CreateLimitResponseTypeDef

# create_limit method usage example with argument unpacking

kwargs: CreateLimitRequestTypeDef = {  # (1)
    "displayName": ...,
    "amountRequirementName": ...,
    "maxCount": ...,
    "farmId": ...,
}

parent.create_limit(**kwargs)

1. See CreateLimitRequestTypeDef

create_monitor

Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets.

Type annotations and code completion for boto3.client("deadline").create_monitor method. boto3 documentation

# create_monitor method definition

def create_monitor(
    self,
    *,
    displayName: str,
    identityCenterInstanceArn: str,
    subdomain: str,
    roleArn: str,
    clientToken: str = ...,
) -> CreateMonitorResponseTypeDef:  # (1)
    ...

1. See CreateMonitorResponseTypeDef

# create_monitor method usage example with argument unpacking

kwargs: CreateMonitorRequestTypeDef = {  # (1)
    "displayName": ...,
    "identityCenterInstanceArn": ...,
    "subdomain": ...,
    "roleArn": ...,
}

parent.create_monitor(**kwargs)

1. See CreateMonitorRequestTypeDef

create_queue

Creates a queue to coordinate the order in which jobs run on a farm.

Type annotations and code completion for boto3.client("deadline").create_queue method. boto3 documentation

# create_queue method definition

def create_queue(
    self,
    *,
    farmId: str,
    displayName: str,
    clientToken: str = ...,
    description: str = ...,
    defaultBudgetAction: DefaultQueueBudgetActionType = ...,  # (1)
    jobAttachmentSettings: JobAttachmentSettingsTypeDef = ...,  # (2)
    roleArn: str = ...,
    jobRunAsUser: JobRunAsUserTypeDef = ...,  # (3)
    requiredFileSystemLocationNames: Sequence[str] = ...,
    allowedStorageProfileIds: Sequence[str] = ...,
    tags: Mapping[str, str] = ...,
) -> CreateQueueResponseTypeDef:  # (4)
    ...

1. See DefaultQueueBudgetActionType
2. See JobAttachmentSettingsTypeDef
3. See JobRunAsUserTypeDef
4. See CreateQueueResponseTypeDef

# create_queue method usage example with argument unpacking

kwargs: CreateQueueRequestTypeDef = {  # (1)
    "farmId": ...,
    "displayName": ...,
}

parent.create_queue(**kwargs)

1. See CreateQueueRequestTypeDef

create_queue_environment

Creates an environment for a queue that defines how jobs in the queue run.

Type annotations and code completion for boto3.client("deadline").create_queue_environment method. boto3 documentation

# create_queue_environment method definition

def create_queue_environment(
    self,
    *,
    farmId: str,
    queueId: str,
    priority: int,
    templateType: EnvironmentTemplateTypeType,  # (1)
    template: str,
    clientToken: str = ...,
) -> CreateQueueEnvironmentResponseTypeDef:  # (2)
    ...

1. See EnvironmentTemplateTypeType
2. See CreateQueueEnvironmentResponseTypeDef

# create_queue_environment method usage example with argument unpacking

kwargs: CreateQueueEnvironmentRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "priority": ...,
    "templateType": ...,
    "template": ...,
}

parent.create_queue_environment(**kwargs)

1. See CreateQueueEnvironmentRequestTypeDef

create_queue_fleet_association

Creates an association between a queue and a fleet.

Type annotations and code completion for boto3.client("deadline").create_queue_fleet_association method. boto3 documentation

# create_queue_fleet_association method definition

def create_queue_fleet_association(
    self,
    *,
    farmId: str,
    queueId: str,
    fleetId: str,
) -> Dict[str, Any]:
    ...

# create_queue_fleet_association method usage example with argument unpacking

kwargs: CreateQueueFleetAssociationRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "fleetId": ...,
}

parent.create_queue_fleet_association(**kwargs)

1. See CreateQueueFleetAssociationRequestTypeDef

create_queue_limit_association

Associates a limit with a particular queue.

Type annotations and code completion for boto3.client("deadline").create_queue_limit_association method. boto3 documentation

# create_queue_limit_association method definition

def create_queue_limit_association(
    self,
    *,
    farmId: str,
    queueId: str,
    limitId: str,
) -> Dict[str, Any]:
    ...

# create_queue_limit_association method usage example with argument unpacking

kwargs: CreateQueueLimitAssociationRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "limitId": ...,
}

parent.create_queue_limit_association(**kwargs)

1. See CreateQueueLimitAssociationRequestTypeDef

create_storage_profile

Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.

Type annotations and code completion for boto3.client("deadline").create_storage_profile method. boto3 documentation

# create_storage_profile method definition

def create_storage_profile(
    self,
    *,
    farmId: str,
    displayName: str,
    osFamily: StorageProfileOperatingSystemFamilyType,  # (1)
    clientToken: str = ...,
    fileSystemLocations: Sequence[FileSystemLocationTypeDef] = ...,  # (2)
) -> CreateStorageProfileResponseTypeDef:  # (3)
    ...

1. See StorageProfileOperatingSystemFamilyType
2. See FileSystemLocationTypeDef
3. See CreateStorageProfileResponseTypeDef

# create_storage_profile method usage example with argument unpacking

kwargs: CreateStorageProfileRequestTypeDef = {  # (1)
    "farmId": ...,
    "displayName": ...,
    "osFamily": ...,
}

parent.create_storage_profile(**kwargs)

1. See CreateStorageProfileRequestTypeDef

create_worker

Creates a worker.

Type annotations and code completion for boto3.client("deadline").create_worker method. boto3 documentation

# create_worker method definition

def create_worker(
    self,
    *,
    farmId: str,
    fleetId: str,
    hostProperties: HostPropertiesRequestTypeDef = ...,  # (1)
    clientToken: str = ...,
) -> CreateWorkerResponseTypeDef:  # (2)
    ...

1. See HostPropertiesRequestTypeDef
2. See CreateWorkerResponseTypeDef

# create_worker method usage example with argument unpacking

kwargs: CreateWorkerRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
}

parent.create_worker(**kwargs)

1. See CreateWorkerRequestTypeDef

delete_budget

Deletes a budget.

Type annotations and code completion for boto3.client("deadline").delete_budget method. boto3 documentation

# delete_budget method definition

def delete_budget(
    self,
    *,
    farmId: str,
    budgetId: str,
) -> Dict[str, Any]:
    ...

# delete_budget method usage example with argument unpacking

kwargs: DeleteBudgetRequestTypeDef = {  # (1)
    "farmId": ...,
    "budgetId": ...,
}

parent.delete_budget(**kwargs)

1. See DeleteBudgetRequestTypeDef

delete_farm

Deletes a farm.

Type annotations and code completion for boto3.client("deadline").delete_farm method. boto3 documentation

# delete_farm method definition

def delete_farm(
    self,
    *,
    farmId: str,
) -> Dict[str, Any]:
    ...

# delete_farm method usage example with argument unpacking

kwargs: DeleteFarmRequestTypeDef = {  # (1)
    "farmId": ...,
}

parent.delete_farm(**kwargs)

1. See DeleteFarmRequestTypeDef

delete_fleet

Deletes a fleet.

Type annotations and code completion for boto3.client("deadline").delete_fleet method. boto3 documentation

# delete_fleet method definition

def delete_fleet(
    self,
    *,
    farmId: str,
    fleetId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_fleet method usage example with argument unpacking

kwargs: DeleteFleetRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
}

parent.delete_fleet(**kwargs)

1. See DeleteFleetRequestTypeDef

delete_license_endpoint

Deletes a license endpoint.

Type annotations and code completion for boto3.client("deadline").delete_license_endpoint method. boto3 documentation

# delete_license_endpoint method definition

def delete_license_endpoint(
    self,
    *,
    licenseEndpointId: str,
) -> Dict[str, Any]:
    ...

# delete_license_endpoint method usage example with argument unpacking

kwargs: DeleteLicenseEndpointRequestTypeDef = {  # (1)
    "licenseEndpointId": ...,
}

parent.delete_license_endpoint(**kwargs)

1. See DeleteLicenseEndpointRequestTypeDef

delete_limit

Removes a limit from the specified farm.

Type annotations and code completion for boto3.client("deadline").delete_limit method. boto3 documentation

# delete_limit method definition

def delete_limit(
    self,
    *,
    farmId: str,
    limitId: str,
) -> Dict[str, Any]:
    ...

# delete_limit method usage example with argument unpacking

kwargs: DeleteLimitRequestTypeDef = {  # (1)
    "farmId": ...,
    "limitId": ...,
}

parent.delete_limit(**kwargs)

1. See DeleteLimitRequestTypeDef

delete_metered_product

Deletes a metered product.

Type annotations and code completion for boto3.client("deadline").delete_metered_product method. boto3 documentation

# delete_metered_product method definition

def delete_metered_product(
    self,
    *,
    licenseEndpointId: str,
    productId: str,
) -> Dict[str, Any]:
    ...

# delete_metered_product method usage example with argument unpacking

kwargs: DeleteMeteredProductRequestTypeDef = {  # (1)
    "licenseEndpointId": ...,
    "productId": ...,
}

parent.delete_metered_product(**kwargs)

1. See DeleteMeteredProductRequestTypeDef

delete_monitor

Removes a Deadline Cloud monitor.

Type annotations and code completion for boto3.client("deadline").delete_monitor method. boto3 documentation

# delete_monitor method definition

def delete_monitor(
    self,
    *,
    monitorId: str,
) -> Dict[str, Any]:
    ...

# delete_monitor method usage example with argument unpacking

kwargs: DeleteMonitorRequestTypeDef = {  # (1)
    "monitorId": ...,
}

parent.delete_monitor(**kwargs)

1. See DeleteMonitorRequestTypeDef

delete_queue

Deletes a queue.

Type annotations and code completion for boto3.client("deadline").delete_queue method. boto3 documentation

# delete_queue method definition

def delete_queue(
    self,
    *,
    farmId: str,
    queueId: str,
) -> Dict[str, Any]:
    ...

# delete_queue method usage example with argument unpacking

kwargs: DeleteQueueRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
}

parent.delete_queue(**kwargs)

1. See DeleteQueueRequestTypeDef

delete_queue_environment

Deletes a queue environment.

Type annotations and code completion for boto3.client("deadline").delete_queue_environment method. boto3 documentation

# delete_queue_environment method definition

def delete_queue_environment(
    self,
    *,
    farmId: str,
    queueId: str,
    queueEnvironmentId: str,
) -> Dict[str, Any]:
    ...

# delete_queue_environment method usage example with argument unpacking

kwargs: DeleteQueueEnvironmentRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "queueEnvironmentId": ...,
}

parent.delete_queue_environment(**kwargs)

1. See DeleteQueueEnvironmentRequestTypeDef

delete_queue_fleet_association

Deletes a queue-fleet association.

Type annotations and code completion for boto3.client("deadline").delete_queue_fleet_association method. boto3 documentation

# delete_queue_fleet_association method definition

def delete_queue_fleet_association(
    self,
    *,
    farmId: str,
    queueId: str,
    fleetId: str,
) -> Dict[str, Any]:
    ...

# delete_queue_fleet_association method usage example with argument unpacking

kwargs: DeleteQueueFleetAssociationRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "fleetId": ...,
}

parent.delete_queue_fleet_association(**kwargs)

1. See DeleteQueueFleetAssociationRequestTypeDef

delete_queue_limit_association

Removes the association between a queue and a limit.

Type annotations and code completion for boto3.client("deadline").delete_queue_limit_association method. boto3 documentation

# delete_queue_limit_association method definition

def delete_queue_limit_association(
    self,
    *,
    farmId: str,
    queueId: str,
    limitId: str,
) -> Dict[str, Any]:
    ...

# delete_queue_limit_association method usage example with argument unpacking

kwargs: DeleteQueueLimitAssociationRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "limitId": ...,
}

parent.delete_queue_limit_association(**kwargs)

1. See DeleteQueueLimitAssociationRequestTypeDef

delete_storage_profile

Deletes a storage profile.

Type annotations and code completion for boto3.client("deadline").delete_storage_profile method. boto3 documentation

# delete_storage_profile method definition

def delete_storage_profile(
    self,
    *,
    farmId: str,
    storageProfileId: str,
) -> Dict[str, Any]:
    ...

# delete_storage_profile method usage example with argument unpacking

kwargs: DeleteStorageProfileRequestTypeDef = {  # (1)
    "farmId": ...,
    "storageProfileId": ...,
}

parent.delete_storage_profile(**kwargs)

1. See DeleteStorageProfileRequestTypeDef

delete_worker

Deletes a worker.

Type annotations and code completion for boto3.client("deadline").delete_worker method. boto3 documentation

# delete_worker method definition

def delete_worker(
    self,
    *,
    farmId: str,
    fleetId: str,
    workerId: str,
) -> Dict[str, Any]:
    ...

# delete_worker method usage example with argument unpacking

kwargs: DeleteWorkerRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "workerId": ...,
}

parent.delete_worker(**kwargs)

1. See DeleteWorkerRequestTypeDef

disassociate_member_from_farm

Disassociates a member from a farm.

Type annotations and code completion for boto3.client("deadline").disassociate_member_from_farm method. boto3 documentation

# disassociate_member_from_farm method definition

def disassociate_member_from_farm(
    self,
    *,
    farmId: str,
    principalId: str,
) -> Dict[str, Any]:
    ...

# disassociate_member_from_farm method usage example with argument unpacking

kwargs: DisassociateMemberFromFarmRequestTypeDef = {  # (1)
    "farmId": ...,
    "principalId": ...,
}

parent.disassociate_member_from_farm(**kwargs)

1. See DisassociateMemberFromFarmRequestTypeDef

disassociate_member_from_fleet

Disassociates a member from a fleet.

Type annotations and code completion for boto3.client("deadline").disassociate_member_from_fleet method. boto3 documentation

# disassociate_member_from_fleet method definition

def disassociate_member_from_fleet(
    self,
    *,
    farmId: str,
    fleetId: str,
    principalId: str,
) -> Dict[str, Any]:
    ...

# disassociate_member_from_fleet method usage example with argument unpacking

kwargs: DisassociateMemberFromFleetRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "principalId": ...,
}

parent.disassociate_member_from_fleet(**kwargs)

1. See DisassociateMemberFromFleetRequestTypeDef

disassociate_member_from_job

Disassociates a member from a job.

Type annotations and code completion for boto3.client("deadline").disassociate_member_from_job method. boto3 documentation

# disassociate_member_from_job method definition

def disassociate_member_from_job(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    principalId: str,
) -> Dict[str, Any]:
    ...

# disassociate_member_from_job method usage example with argument unpacking

kwargs: DisassociateMemberFromJobRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "principalId": ...,
}

parent.disassociate_member_from_job(**kwargs)

1. See DisassociateMemberFromJobRequestTypeDef

disassociate_member_from_queue

Disassociates a member from a queue.

Type annotations and code completion for boto3.client("deadline").disassociate_member_from_queue method. boto3 documentation

# disassociate_member_from_queue method definition

def disassociate_member_from_queue(
    self,
    *,
    farmId: str,
    queueId: str,
    principalId: str,
) -> Dict[str, Any]:
    ...

# disassociate_member_from_queue method usage example with argument unpacking

kwargs: DisassociateMemberFromQueueRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "principalId": ...,
}

parent.disassociate_member_from_queue(**kwargs)

1. See DisassociateMemberFromQueueRequestTypeDef

get_budget

Get a budget.

Type annotations and code completion for boto3.client("deadline").get_budget method. boto3 documentation

# get_budget method definition

def get_budget(
    self,
    *,
    farmId: str,
    budgetId: str,
) -> GetBudgetResponseTypeDef:  # (1)
    ...

1. See GetBudgetResponseTypeDef

# get_budget method usage example with argument unpacking

kwargs: GetBudgetRequestTypeDef = {  # (1)
    "farmId": ...,
    "budgetId": ...,
}

parent.get_budget(**kwargs)

1. See GetBudgetRequestTypeDef

get_farm

Get a farm.

Type annotations and code completion for boto3.client("deadline").get_farm method. boto3 documentation

# get_farm method definition

def get_farm(
    self,
    *,
    farmId: str,
) -> GetFarmResponseTypeDef:  # (1)
    ...

1. See GetFarmResponseTypeDef

# get_farm method usage example with argument unpacking

kwargs: GetFarmRequestTypeDef = {  # (1)
    "farmId": ...,
}

parent.get_farm(**kwargs)

1. See GetFarmRequestTypeDef

get_fleet

Get a fleet.

Type annotations and code completion for boto3.client("deadline").get_fleet method. boto3 documentation

# get_fleet method definition

def get_fleet(
    self,
    *,
    farmId: str,
    fleetId: str,
) -> GetFleetResponseTypeDef:  # (1)
    ...

1. See GetFleetResponseTypeDef

# get_fleet method usage example with argument unpacking

kwargs: GetFleetRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
}

parent.get_fleet(**kwargs)

1. See GetFleetRequestTypeDef

get_job

Gets a Deadline Cloud job.

Type annotations and code completion for boto3.client("deadline").get_job method. boto3 documentation

# get_job method definition

def get_job(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
) -> GetJobResponseTypeDef:  # (1)
    ...

1. See GetJobResponseTypeDef

# get_job method usage example with argument unpacking

kwargs: GetJobRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
}

parent.get_job(**kwargs)

1. See GetJobRequestTypeDef

get_license_endpoint

Gets a licence endpoint.

Type annotations and code completion for boto3.client("deadline").get_license_endpoint method. boto3 documentation

# get_license_endpoint method definition

def get_license_endpoint(
    self,
    *,
    licenseEndpointId: str,
) -> GetLicenseEndpointResponseTypeDef:  # (1)
    ...

1. See GetLicenseEndpointResponseTypeDef

# get_license_endpoint method usage example with argument unpacking

kwargs: GetLicenseEndpointRequestTypeDef = {  # (1)
    "licenseEndpointId": ...,
}

parent.get_license_endpoint(**kwargs)

1. See GetLicenseEndpointRequestTypeDef

get_limit

Gets information about a specific limit.

Type annotations and code completion for boto3.client("deadline").get_limit method. boto3 documentation

# get_limit method definition

def get_limit(
    self,
    *,
    farmId: str,
    limitId: str,
) -> GetLimitResponseTypeDef:  # (1)
    ...

1. See GetLimitResponseTypeDef

# get_limit method usage example with argument unpacking

kwargs: GetLimitRequestTypeDef = {  # (1)
    "farmId": ...,
    "limitId": ...,
}

parent.get_limit(**kwargs)

1. See GetLimitRequestTypeDef

get_monitor

Gets information about the specified monitor.

Type annotations and code completion for boto3.client("deadline").get_monitor method. boto3 documentation

# get_monitor method definition

def get_monitor(
    self,
    *,
    monitorId: str,
) -> GetMonitorResponseTypeDef:  # (1)
    ...

1. See GetMonitorResponseTypeDef

# get_monitor method usage example with argument unpacking

kwargs: GetMonitorRequestTypeDef = {  # (1)
    "monitorId": ...,
}

parent.get_monitor(**kwargs)

1. See GetMonitorRequestTypeDef

get_queue

Gets a queue.

Type annotations and code completion for boto3.client("deadline").get_queue method. boto3 documentation

# get_queue method definition

def get_queue(
    self,
    *,
    farmId: str,
    queueId: str,
) -> GetQueueResponseTypeDef:  # (1)
    ...

1. See GetQueueResponseTypeDef

# get_queue method usage example with argument unpacking

kwargs: GetQueueRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
}

parent.get_queue(**kwargs)

1. See GetQueueRequestTypeDef

get_queue_environment

Gets a queue environment.

Type annotations and code completion for boto3.client("deadline").get_queue_environment method. boto3 documentation

# get_queue_environment method definition

def get_queue_environment(
    self,
    *,
    farmId: str,
    queueId: str,
    queueEnvironmentId: str,
) -> GetQueueEnvironmentResponseTypeDef:  # (1)
    ...

1. See GetQueueEnvironmentResponseTypeDef

# get_queue_environment method usage example with argument unpacking

kwargs: GetQueueEnvironmentRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "queueEnvironmentId": ...,
}

parent.get_queue_environment(**kwargs)

1. See GetQueueEnvironmentRequestTypeDef

get_queue_fleet_association

Gets a queue-fleet association.

Type annotations and code completion for boto3.client("deadline").get_queue_fleet_association method. boto3 documentation

# get_queue_fleet_association method definition

def get_queue_fleet_association(
    self,
    *,
    farmId: str,
    queueId: str,
    fleetId: str,
) -> GetQueueFleetAssociationResponseTypeDef:  # (1)
    ...

1. See GetQueueFleetAssociationResponseTypeDef

# get_queue_fleet_association method usage example with argument unpacking

kwargs: GetQueueFleetAssociationRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "fleetId": ...,
}

parent.get_queue_fleet_association(**kwargs)

1. See GetQueueFleetAssociationRequestTypeDef

get_queue_limit_association

Gets information about a specific association between a queue and a limit.

Type annotations and code completion for boto3.client("deadline").get_queue_limit_association method. boto3 documentation

# get_queue_limit_association method definition

def get_queue_limit_association(
    self,
    *,
    farmId: str,
    queueId: str,
    limitId: str,
) -> GetQueueLimitAssociationResponseTypeDef:  # (1)
    ...

1. See GetQueueLimitAssociationResponseTypeDef

# get_queue_limit_association method usage example with argument unpacking

kwargs: GetQueueLimitAssociationRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "limitId": ...,
}

parent.get_queue_limit_association(**kwargs)

1. See GetQueueLimitAssociationRequestTypeDef

get_session

Gets a session.

Type annotations and code completion for boto3.client("deadline").get_session method. boto3 documentation

# get_session method definition

def get_session(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    sessionId: str,
) -> GetSessionResponseTypeDef:  # (1)
    ...

1. See GetSessionResponseTypeDef

# get_session method usage example with argument unpacking

kwargs: GetSessionRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "sessionId": ...,
}

parent.get_session(**kwargs)

1. See GetSessionRequestTypeDef

get_session_action

Gets a session action for the job.

Type annotations and code completion for boto3.client("deadline").get_session_action method. boto3 documentation

# get_session_action method definition

def get_session_action(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    sessionActionId: str,
) -> GetSessionActionResponseTypeDef:  # (1)
    ...

1. See GetSessionActionResponseTypeDef

# get_session_action method usage example with argument unpacking

kwargs: GetSessionActionRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "sessionActionId": ...,
}

parent.get_session_action(**kwargs)

1. See GetSessionActionRequestTypeDef

get_sessions_statistics_aggregation

Gets a set of statistics for queues or farms.

Type annotations and code completion for boto3.client("deadline").get_sessions_statistics_aggregation method. boto3 documentation

# get_sessions_statistics_aggregation method definition

def get_sessions_statistics_aggregation(
    self,
    *,
    farmId: str,
    aggregationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetSessionsStatisticsAggregationResponseTypeDef:  # (1)
    ...

1. See GetSessionsStatisticsAggregationResponseTypeDef

# get_sessions_statistics_aggregation method usage example with argument unpacking

kwargs: GetSessionsStatisticsAggregationRequestTypeDef = {  # (1)
    "farmId": ...,
    "aggregationId": ...,
}

parent.get_sessions_statistics_aggregation(**kwargs)

1. See GetSessionsStatisticsAggregationRequestTypeDef

get_step

Gets a step.

Type annotations and code completion for boto3.client("deadline").get_step method. boto3 documentation

# get_step method definition

def get_step(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
) -> GetStepResponseTypeDef:  # (1)
    ...

1. See GetStepResponseTypeDef

# get_step method usage example with argument unpacking

kwargs: GetStepRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "stepId": ...,
}

parent.get_step(**kwargs)

1. See GetStepRequestTypeDef

get_storage_profile

Gets a storage profile.

Type annotations and code completion for boto3.client("deadline").get_storage_profile method. boto3 documentation

# get_storage_profile method definition

def get_storage_profile(
    self,
    *,
    farmId: str,
    storageProfileId: str,
) -> GetStorageProfileResponseTypeDef:  # (1)
    ...

1. See GetStorageProfileResponseTypeDef

# get_storage_profile method usage example with argument unpacking

kwargs: GetStorageProfileRequestTypeDef = {  # (1)
    "farmId": ...,
    "storageProfileId": ...,
}

parent.get_storage_profile(**kwargs)

1. See GetStorageProfileRequestTypeDef

get_storage_profile_for_queue

Gets a storage profile for a queue.

Type annotations and code completion for boto3.client("deadline").get_storage_profile_for_queue method. boto3 documentation

# get_storage_profile_for_queue method definition

def get_storage_profile_for_queue(
    self,
    *,
    farmId: str,
    queueId: str,
    storageProfileId: str,
) -> GetStorageProfileForQueueResponseTypeDef:  # (1)
    ...

1. See GetStorageProfileForQueueResponseTypeDef

# get_storage_profile_for_queue method usage example with argument unpacking

kwargs: GetStorageProfileForQueueRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "storageProfileId": ...,
}

parent.get_storage_profile_for_queue(**kwargs)

1. See GetStorageProfileForQueueRequestTypeDef

get_task

Gets a task.

Type annotations and code completion for boto3.client("deadline").get_task method. boto3 documentation

# get_task method definition

def get_task(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    taskId: str,
) -> GetTaskResponseTypeDef:  # (1)
    ...

1. See GetTaskResponseTypeDef

# get_task method usage example with argument unpacking

kwargs: GetTaskRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "stepId": ...,
    "taskId": ...,
}

parent.get_task(**kwargs)

1. See GetTaskRequestTypeDef

get_worker

Gets a worker.

Type annotations and code completion for boto3.client("deadline").get_worker method. boto3 documentation

# get_worker method definition

def get_worker(
    self,
    *,
    farmId: str,
    fleetId: str,
    workerId: str,
) -> GetWorkerResponseTypeDef:  # (1)
    ...

1. See GetWorkerResponseTypeDef

# get_worker method usage example with argument unpacking

kwargs: GetWorkerRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "workerId": ...,
}

parent.get_worker(**kwargs)

1. See GetWorkerRequestTypeDef

list_available_metered_products

A list of the available metered products.

Type annotations and code completion for boto3.client("deadline").list_available_metered_products method. boto3 documentation

# list_available_metered_products method definition

def list_available_metered_products(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAvailableMeteredProductsResponseTypeDef:  # (1)
    ...

1. See ListAvailableMeteredProductsResponseTypeDef

# list_available_metered_products method usage example with argument unpacking

kwargs: ListAvailableMeteredProductsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_available_metered_products(**kwargs)

1. See ListAvailableMeteredProductsRequestTypeDef

list_budgets

A list of budgets in a farm.

Type annotations and code completion for boto3.client("deadline").list_budgets method. boto3 documentation

# list_budgets method definition

def list_budgets(
    self,
    *,
    farmId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    status: BudgetStatusType = ...,  # (1)
) -> ListBudgetsResponseTypeDef:  # (2)
    ...

1. See BudgetStatusType
2. See ListBudgetsResponseTypeDef

# list_budgets method usage example with argument unpacking

kwargs: ListBudgetsRequestTypeDef = {  # (1)
    "farmId": ...,
}

parent.list_budgets(**kwargs)

1. See ListBudgetsRequestTypeDef

list_farm_members

Lists the members of a farm.

Type annotations and code completion for boto3.client("deadline").list_farm_members method. boto3 documentation

# list_farm_members method definition

def list_farm_members(
    self,
    *,
    farmId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListFarmMembersResponseTypeDef:  # (1)
    ...

1. See ListFarmMembersResponseTypeDef

# list_farm_members method usage example with argument unpacking

kwargs: ListFarmMembersRequestTypeDef = {  # (1)
    "farmId": ...,
}

parent.list_farm_members(**kwargs)

1. See ListFarmMembersRequestTypeDef

list_farms

Lists farms.

Type annotations and code completion for boto3.client("deadline").list_farms method. boto3 documentation

# list_farms method definition

def list_farms(
    self,
    *,
    nextToken: str = ...,
    principalId: str = ...,
    maxResults: int = ...,
) -> ListFarmsResponseTypeDef:  # (1)
    ...

1. See ListFarmsResponseTypeDef

# list_farms method usage example with argument unpacking

kwargs: ListFarmsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_farms(**kwargs)

1. See ListFarmsRequestTypeDef

list_fleet_members

Lists fleet members.

Type annotations and code completion for boto3.client("deadline").list_fleet_members method. boto3 documentation

# list_fleet_members method definition

def list_fleet_members(
    self,
    *,
    farmId: str,
    fleetId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListFleetMembersResponseTypeDef:  # (1)
    ...

1. See ListFleetMembersResponseTypeDef

# list_fleet_members method usage example with argument unpacking

kwargs: ListFleetMembersRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
}

parent.list_fleet_members(**kwargs)

1. See ListFleetMembersRequestTypeDef

list_fleets

Lists fleets.

Type annotations and code completion for boto3.client("deadline").list_fleets method. boto3 documentation

# list_fleets method definition

def list_fleets(
    self,
    *,
    farmId: str,
    principalId: str = ...,
    displayName: str = ...,
    status: FleetStatusType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListFleetsResponseTypeDef:  # (2)
    ...

1. See FleetStatusType
2. See ListFleetsResponseTypeDef

# list_fleets method usage example with argument unpacking

kwargs: ListFleetsRequestTypeDef = {  # (1)
    "farmId": ...,
}

parent.list_fleets(**kwargs)

1. See ListFleetsRequestTypeDef

list_job_members

Lists members on a job.

Type annotations and code completion for boto3.client("deadline").list_job_members method. boto3 documentation

# list_job_members method definition

def list_job_members(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListJobMembersResponseTypeDef:  # (1)
    ...

1. See ListJobMembersResponseTypeDef

# list_job_members method usage example with argument unpacking

kwargs: ListJobMembersRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
}

parent.list_job_members(**kwargs)

1. See ListJobMembersRequestTypeDef

list_job_parameter_definitions

Lists parameter definitions of a job.

Type annotations and code completion for boto3.client("deadline").list_job_parameter_definitions method. boto3 documentation

# list_job_parameter_definitions method definition

def list_job_parameter_definitions(
    self,
    *,
    farmId: str,
    jobId: str,
    queueId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListJobParameterDefinitionsResponseTypeDef:  # (1)
    ...

1. See ListJobParameterDefinitionsResponseTypeDef

# list_job_parameter_definitions method usage example with argument unpacking

kwargs: ListJobParameterDefinitionsRequestTypeDef = {  # (1)
    "farmId": ...,
    "jobId": ...,
    "queueId": ...,
}

parent.list_job_parameter_definitions(**kwargs)

1. See ListJobParameterDefinitionsRequestTypeDef

list_jobs

Lists jobs.

Type annotations and code completion for boto3.client("deadline").list_jobs method. boto3 documentation

# list_jobs method definition

def list_jobs(
    self,
    *,
    farmId: str,
    queueId: str,
    principalId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListJobsResponseTypeDef:  # (1)
    ...

1. See ListJobsResponseTypeDef

# list_jobs method usage example with argument unpacking

kwargs: ListJobsRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
}

parent.list_jobs(**kwargs)

1. See ListJobsRequestTypeDef

list_license_endpoints

Lists license endpoints.

Type annotations and code completion for boto3.client("deadline").list_license_endpoints method. boto3 documentation

# list_license_endpoints method definition

def list_license_endpoints(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListLicenseEndpointsResponseTypeDef:  # (1)
    ...

1. See ListLicenseEndpointsResponseTypeDef

# list_license_endpoints method usage example with argument unpacking

kwargs: ListLicenseEndpointsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_license_endpoints(**kwargs)

1. See ListLicenseEndpointsRequestTypeDef

list_limits

Gets a list of limits defined in the specified farm.

Type annotations and code completion for boto3.client("deadline").list_limits method. boto3 documentation

# list_limits method definition

def list_limits(
    self,
    *,
    farmId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListLimitsResponseTypeDef:  # (1)
    ...

1. See ListLimitsResponseTypeDef

# list_limits method usage example with argument unpacking

kwargs: ListLimitsRequestTypeDef = {  # (1)
    "farmId": ...,
}

parent.list_limits(**kwargs)

1. See ListLimitsRequestTypeDef

list_metered_products

Lists metered products.

Type annotations and code completion for boto3.client("deadline").list_metered_products method. boto3 documentation

# list_metered_products method definition

def list_metered_products(
    self,
    *,
    licenseEndpointId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMeteredProductsResponseTypeDef:  # (1)
    ...

1. See ListMeteredProductsResponseTypeDef

# list_metered_products method usage example with argument unpacking

kwargs: ListMeteredProductsRequestTypeDef = {  # (1)
    "licenseEndpointId": ...,
}

parent.list_metered_products(**kwargs)

1. See ListMeteredProductsRequestTypeDef

list_monitors

Gets a list of your monitors in Deadline Cloud.

Type annotations and code completion for boto3.client("deadline").list_monitors method. boto3 documentation

# list_monitors method definition

def list_monitors(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMonitorsResponseTypeDef:  # (1)
    ...

1. See ListMonitorsResponseTypeDef

# list_monitors method usage example with argument unpacking

kwargs: ListMonitorsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_monitors(**kwargs)

1. See ListMonitorsRequestTypeDef

list_queue_environments

Lists queue environments.

Type annotations and code completion for boto3.client("deadline").list_queue_environments method. boto3 documentation

# list_queue_environments method definition

def list_queue_environments(
    self,
    *,
    farmId: str,
    queueId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListQueueEnvironmentsResponseTypeDef:  # (1)
    ...

1. See ListQueueEnvironmentsResponseTypeDef

# list_queue_environments method usage example with argument unpacking

kwargs: ListQueueEnvironmentsRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
}

parent.list_queue_environments(**kwargs)

1. See ListQueueEnvironmentsRequestTypeDef

list_queue_fleet_associations

Lists queue-fleet associations.

Type annotations and code completion for boto3.client("deadline").list_queue_fleet_associations method. boto3 documentation

# list_queue_fleet_associations method definition

def list_queue_fleet_associations(
    self,
    *,
    farmId: str,
    queueId: str = ...,
    fleetId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListQueueFleetAssociationsResponseTypeDef:  # (1)
    ...

1. See ListQueueFleetAssociationsResponseTypeDef

# list_queue_fleet_associations method usage example with argument unpacking

kwargs: ListQueueFleetAssociationsRequestTypeDef = {  # (1)
    "farmId": ...,
}

parent.list_queue_fleet_associations(**kwargs)

1. See ListQueueFleetAssociationsRequestTypeDef

list_queue_limit_associations

Gets a list of the associations between queues and limits defined in a farm.

Type annotations and code completion for boto3.client("deadline").list_queue_limit_associations method. boto3 documentation

# list_queue_limit_associations method definition

def list_queue_limit_associations(
    self,
    *,
    farmId: str,
    queueId: str = ...,
    limitId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListQueueLimitAssociationsResponseTypeDef:  # (1)
    ...

1. See ListQueueLimitAssociationsResponseTypeDef

# list_queue_limit_associations method usage example with argument unpacking

kwargs: ListQueueLimitAssociationsRequestTypeDef = {  # (1)
    "farmId": ...,
}

parent.list_queue_limit_associations(**kwargs)

1. See ListQueueLimitAssociationsRequestTypeDef

list_queue_members

Lists the members in a queue.

Type annotations and code completion for boto3.client("deadline").list_queue_members method. boto3 documentation

# list_queue_members method definition

def list_queue_members(
    self,
    *,
    farmId: str,
    queueId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListQueueMembersResponseTypeDef:  # (1)
    ...

1. See ListQueueMembersResponseTypeDef

# list_queue_members method usage example with argument unpacking

kwargs: ListQueueMembersRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
}

parent.list_queue_members(**kwargs)

1. See ListQueueMembersRequestTypeDef

list_queues

Lists queues.

Type annotations and code completion for boto3.client("deadline").list_queues method. boto3 documentation

# list_queues method definition

def list_queues(
    self,
    *,
    farmId: str,
    principalId: str = ...,
    status: QueueStatusType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListQueuesResponseTypeDef:  # (2)
    ...

1. See QueueStatusType
2. See ListQueuesResponseTypeDef

# list_queues method usage example with argument unpacking

kwargs: ListQueuesRequestTypeDef = {  # (1)
    "farmId": ...,
}

parent.list_queues(**kwargs)

1. See ListQueuesRequestTypeDef

list_session_actions

Lists session actions.

Type annotations and code completion for boto3.client("deadline").list_session_actions method. boto3 documentation

# list_session_actions method definition

def list_session_actions(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    sessionId: str = ...,
    taskId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSessionActionsResponseTypeDef:  # (1)
    ...

1. See ListSessionActionsResponseTypeDef

# list_session_actions method usage example with argument unpacking

kwargs: ListSessionActionsRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
}

parent.list_session_actions(**kwargs)

1. See ListSessionActionsRequestTypeDef

list_sessions

Lists sessions.

Type annotations and code completion for boto3.client("deadline").list_sessions method. boto3 documentation

# list_sessions method definition

def list_sessions(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSessionsResponseTypeDef:  # (1)
    ...

1. See ListSessionsResponseTypeDef

# list_sessions method usage example with argument unpacking

kwargs: ListSessionsRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
}

parent.list_sessions(**kwargs)

1. See ListSessionsRequestTypeDef

list_sessions_for_worker

Lists sessions for a worker.

Type annotations and code completion for boto3.client("deadline").list_sessions_for_worker method. boto3 documentation

# list_sessions_for_worker method definition

def list_sessions_for_worker(
    self,
    *,
    farmId: str,
    fleetId: str,
    workerId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSessionsForWorkerResponseTypeDef:  # (1)
    ...

1. See ListSessionsForWorkerResponseTypeDef

# list_sessions_for_worker method usage example with argument unpacking

kwargs: ListSessionsForWorkerRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "workerId": ...,
}

parent.list_sessions_for_worker(**kwargs)

1. See ListSessionsForWorkerRequestTypeDef

list_step_consumers

Lists step consumers.

Type annotations and code completion for boto3.client("deadline").list_step_consumers method. boto3 documentation

# list_step_consumers method definition

def list_step_consumers(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListStepConsumersResponseTypeDef:  # (1)
    ...

1. See ListStepConsumersResponseTypeDef

# list_step_consumers method usage example with argument unpacking

kwargs: ListStepConsumersRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "stepId": ...,
}

parent.list_step_consumers(**kwargs)

1. See ListStepConsumersRequestTypeDef

list_step_dependencies

Lists the dependencies for a step.

Type annotations and code completion for boto3.client("deadline").list_step_dependencies method. boto3 documentation

# list_step_dependencies method definition

def list_step_dependencies(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListStepDependenciesResponseTypeDef:  # (1)
    ...

1. See ListStepDependenciesResponseTypeDef

# list_step_dependencies method usage example with argument unpacking

kwargs: ListStepDependenciesRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "stepId": ...,
}

parent.list_step_dependencies(**kwargs)

1. See ListStepDependenciesRequestTypeDef

list_steps

Lists steps for a job.

Type annotations and code completion for boto3.client("deadline").list_steps method. boto3 documentation

# list_steps method definition

def list_steps(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListStepsResponseTypeDef:  # (1)
    ...

1. See ListStepsResponseTypeDef

# list_steps method usage example with argument unpacking

kwargs: ListStepsRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
}

parent.list_steps(**kwargs)

1. See ListStepsRequestTypeDef

list_storage_profiles

Lists storage profiles.

Type annotations and code completion for boto3.client("deadline").list_storage_profiles method. boto3 documentation

# list_storage_profiles method definition

def list_storage_profiles(
    self,
    *,
    farmId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListStorageProfilesResponseTypeDef:  # (1)
    ...

1. See ListStorageProfilesResponseTypeDef

# list_storage_profiles method usage example with argument unpacking

kwargs: ListStorageProfilesRequestTypeDef = {  # (1)
    "farmId": ...,
}

parent.list_storage_profiles(**kwargs)

1. See ListStorageProfilesRequestTypeDef

list_storage_profiles_for_queue

Lists storage profiles for a queue.

Type annotations and code completion for boto3.client("deadline").list_storage_profiles_for_queue method. boto3 documentation

# list_storage_profiles_for_queue method definition

def list_storage_profiles_for_queue(
    self,
    *,
    farmId: str,
    queueId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListStorageProfilesForQueueResponseTypeDef:  # (1)
    ...

1. See ListStorageProfilesForQueueResponseTypeDef

# list_storage_profiles_for_queue method usage example with argument unpacking

kwargs: ListStorageProfilesForQueueRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
}

parent.list_storage_profiles_for_queue(**kwargs)

1. See ListStorageProfilesForQueueRequestTypeDef

list_tags_for_resource

Lists tags for a resource.

Type annotations and code completion for boto3.client("deadline").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_tasks

Lists tasks for a job.

Type annotations and code completion for boto3.client("deadline").list_tasks method. boto3 documentation

# list_tasks method definition

def list_tasks(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTasksResponseTypeDef:  # (1)
    ...

1. See ListTasksResponseTypeDef

# list_tasks method usage example with argument unpacking

kwargs: ListTasksRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "stepId": ...,
}

parent.list_tasks(**kwargs)

1. See ListTasksRequestTypeDef

list_workers

Lists workers.

Type annotations and code completion for boto3.client("deadline").list_workers method. boto3 documentation

# list_workers method definition

def list_workers(
    self,
    *,
    farmId: str,
    fleetId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListWorkersResponseTypeDef:  # (1)
    ...

1. See ListWorkersResponseTypeDef

# list_workers method usage example with argument unpacking

kwargs: ListWorkersRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
}

parent.list_workers(**kwargs)

1. See ListWorkersRequestTypeDef

put_metered_product

Adds a metered product.

Type annotations and code completion for boto3.client("deadline").put_metered_product method. boto3 documentation

# put_metered_product method definition

def put_metered_product(
    self,
    *,
    licenseEndpointId: str,
    productId: str,
) -> Dict[str, Any]:
    ...

# put_metered_product method usage example with argument unpacking

kwargs: PutMeteredProductRequestTypeDef = {  # (1)
    "licenseEndpointId": ...,
    "productId": ...,
}

parent.put_metered_product(**kwargs)

1. See PutMeteredProductRequestTypeDef

search_jobs

Searches for jobs.

Type annotations and code completion for boto3.client("deadline").search_jobs method. boto3 documentation

# search_jobs method definition

def search_jobs(
    self,
    *,
    farmId: str,
    queueIds: Sequence[str],
    itemOffset: int,
    filterExpressions: SearchGroupedFilterExpressionsTypeDef = ...,  # (1)
    sortExpressions: Sequence[SearchSortExpressionTypeDef] = ...,  # (2)
    pageSize: int = ...,
) -> SearchJobsResponseTypeDef:  # (3)
    ...

1. See SearchGroupedFilterExpressionsTypeDef
2. See SearchSortExpressionTypeDef
3. See SearchJobsResponseTypeDef

# search_jobs method usage example with argument unpacking

kwargs: SearchJobsRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueIds": ...,
    "itemOffset": ...,
}

parent.search_jobs(**kwargs)

1. See SearchJobsRequestTypeDef

search_steps

Searches for steps.

Type annotations and code completion for boto3.client("deadline").search_steps method. boto3 documentation

# search_steps method definition

def search_steps(
    self,
    *,
    farmId: str,
    queueIds: Sequence[str],
    itemOffset: int,
    jobId: str = ...,
    filterExpressions: SearchGroupedFilterExpressionsTypeDef = ...,  # (1)
    sortExpressions: Sequence[SearchSortExpressionTypeDef] = ...,  # (2)
    pageSize: int = ...,
) -> SearchStepsResponseTypeDef:  # (3)
    ...

1. See SearchGroupedFilterExpressionsTypeDef
2. See SearchSortExpressionTypeDef
3. See SearchStepsResponseTypeDef

# search_steps method usage example with argument unpacking

kwargs: SearchStepsRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueIds": ...,
    "itemOffset": ...,
}

parent.search_steps(**kwargs)

1. See SearchStepsRequestTypeDef

search_tasks

Searches for tasks.

Type annotations and code completion for boto3.client("deadline").search_tasks method. boto3 documentation

# search_tasks method definition

def search_tasks(
    self,
    *,
    farmId: str,
    queueIds: Sequence[str],
    itemOffset: int,
    jobId: str = ...,
    filterExpressions: SearchGroupedFilterExpressionsTypeDef = ...,  # (1)
    sortExpressions: Sequence[SearchSortExpressionTypeDef] = ...,  # (2)
    pageSize: int = ...,
) -> SearchTasksResponseTypeDef:  # (3)
    ...

1. See SearchGroupedFilterExpressionsTypeDef
2. See SearchSortExpressionTypeDef
3. See SearchTasksResponseTypeDef

# search_tasks method usage example with argument unpacking

kwargs: SearchTasksRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueIds": ...,
    "itemOffset": ...,
}

parent.search_tasks(**kwargs)

1. See SearchTasksRequestTypeDef

search_workers

Searches for workers.

Type annotations and code completion for boto3.client("deadline").search_workers method. boto3 documentation

# search_workers method definition

def search_workers(
    self,
    *,
    farmId: str,
    fleetIds: Sequence[str],
    itemOffset: int,
    filterExpressions: SearchGroupedFilterExpressionsTypeDef = ...,  # (1)
    sortExpressions: Sequence[SearchSortExpressionTypeDef] = ...,  # (2)
    pageSize: int = ...,
) -> SearchWorkersResponseTypeDef:  # (3)
    ...

1. See SearchGroupedFilterExpressionsTypeDef
2. See SearchSortExpressionTypeDef
3. See SearchWorkersResponseTypeDef

# search_workers method usage example with argument unpacking

kwargs: SearchWorkersRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetIds": ...,
    "itemOffset": ...,
}

parent.search_workers(**kwargs)

1. See SearchWorkersRequestTypeDef

start_sessions_statistics_aggregation

Starts an asynchronous request for getting aggregated statistics about queues and farms.

Type annotations and code completion for boto3.client("deadline").start_sessions_statistics_aggregation method. boto3 documentation

# start_sessions_statistics_aggregation method definition

def start_sessions_statistics_aggregation(
    self,
    *,
    farmId: str,
    resourceIds: SessionsStatisticsResourcesTypeDef,  # (1)
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    groupBy: Sequence[UsageGroupByFieldType],  # (2)
    statistics: Sequence[UsageStatisticType],  # (3)
    timezone: str = ...,
    period: PeriodType = ...,  # (4)
) -> StartSessionsStatisticsAggregationResponseTypeDef:  # (5)
    ...

1. See SessionsStatisticsResourcesTypeDef
2. See UsageGroupByFieldType
3. See UsageStatisticType
4. See PeriodType
5. See StartSessionsStatisticsAggregationResponseTypeDef

# start_sessions_statistics_aggregation method usage example with argument unpacking

kwargs: StartSessionsStatisticsAggregationRequestTypeDef = {  # (1)
    "farmId": ...,
    "resourceIds": ...,
    "startTime": ...,
    "endTime": ...,
    "groupBy": ...,
    "statistics": ...,
}

parent.start_sessions_statistics_aggregation(**kwargs)

1. See StartSessionsStatisticsAggregationRequestTypeDef

tag_resource

Tags a resource using the resource's ARN and desired tags.

Type annotations and code completion for boto3.client("deadline").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes a tag from a resource using the resource's ARN and tag to remove.

Type annotations and code completion for boto3.client("deadline").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_budget

Updates a budget that sets spending thresholds for rendering activity.

Type annotations and code completion for boto3.client("deadline").update_budget method. boto3 documentation

# update_budget method definition

def update_budget(
    self,
    *,
    farmId: str,
    budgetId: str,
    clientToken: str = ...,
    displayName: str = ...,
    description: str = ...,
    status: BudgetStatusType = ...,  # (1)
    approximateDollarLimit: float = ...,
    actionsToAdd: Sequence[BudgetActionToAddTypeDef] = ...,  # (2)
    actionsToRemove: Sequence[BudgetActionToRemoveTypeDef] = ...,  # (3)
    schedule: BudgetScheduleUnionTypeDef = ...,  # (4)
) -> Dict[str, Any]:
    ...

1. See BudgetStatusType
2. See BudgetActionToAddTypeDef
3. See BudgetActionToRemoveTypeDef
4. See BudgetScheduleTypeDef BudgetScheduleOutputTypeDef

# update_budget method usage example with argument unpacking

kwargs: UpdateBudgetRequestTypeDef = {  # (1)
    "farmId": ...,
    "budgetId": ...,
}

parent.update_budget(**kwargs)

1. See UpdateBudgetRequestTypeDef

update_farm

Updates a farm.

Type annotations and code completion for boto3.client("deadline").update_farm method. boto3 documentation

# update_farm method definition

def update_farm(
    self,
    *,
    farmId: str,
    displayName: str = ...,
    description: str = ...,
) -> Dict[str, Any]:
    ...

# update_farm method usage example with argument unpacking

kwargs: UpdateFarmRequestTypeDef = {  # (1)
    "farmId": ...,
}

parent.update_farm(**kwargs)

1. See UpdateFarmRequestTypeDef

update_fleet

Updates a fleet.

Type annotations and code completion for boto3.client("deadline").update_fleet method. boto3 documentation

# update_fleet method definition

def update_fleet(
    self,
    *,
    farmId: str,
    fleetId: str,
    clientToken: str = ...,
    displayName: str = ...,
    description: str = ...,
    roleArn: str = ...,
    minWorkerCount: int = ...,
    maxWorkerCount: int = ...,
    configuration: FleetConfigurationUnionTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See FleetConfigurationTypeDef FleetConfigurationOutputTypeDef

# update_fleet method usage example with argument unpacking

kwargs: UpdateFleetRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
}

parent.update_fleet(**kwargs)

1. See UpdateFleetRequestTypeDef

update_job

Updates a job.

Type annotations and code completion for boto3.client("deadline").update_job method. boto3 documentation

# update_job method definition

def update_job(
    self,
    *,
    farmId: str,
    queueId: str,
    jobId: str,
    clientToken: str = ...,
    targetTaskRunStatus: JobTargetTaskRunStatusType = ...,  # (1)
    priority: int = ...,
    maxFailedTasksCount: int = ...,
    maxRetriesPerTask: int = ...,
    lifecycleStatus: UpdateJobLifecycleStatusType = ...,  # (2)
    maxWorkerCount: int = ...,
) -> Dict[str, Any]:
    ...

1. See JobTargetTaskRunStatusType
2. See UpdateJobLifecycleStatusType

# update_job method usage example with argument unpacking

kwargs: UpdateJobRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
}

parent.update_job(**kwargs)

1. See UpdateJobRequestTypeDef

update_limit

Updates the properties of the specified limit.

Type annotations and code completion for boto3.client("deadline").update_limit method. boto3 documentation

# update_limit method definition

def update_limit(
    self,
    *,
    farmId: str,
    limitId: str,
    displayName: str = ...,
    description: str = ...,
    maxCount: int = ...,
) -> Dict[str, Any]:
    ...

# update_limit method usage example with argument unpacking

kwargs: UpdateLimitRequestTypeDef = {  # (1)
    "farmId": ...,
    "limitId": ...,
}

parent.update_limit(**kwargs)

1. See UpdateLimitRequestTypeDef

update_monitor

Modifies the settings for a Deadline Cloud monitor.

Type annotations and code completion for boto3.client("deadline").update_monitor method. boto3 documentation

# update_monitor method definition

def update_monitor(
    self,
    *,
    monitorId: str,
    subdomain: str = ...,
    displayName: str = ...,
    roleArn: str = ...,
) -> Dict[str, Any]:
    ...

# update_monitor method usage example with argument unpacking

kwargs: UpdateMonitorRequestTypeDef = {  # (1)
    "monitorId": ...,
}

parent.update_monitor(**kwargs)

1. See UpdateMonitorRequestTypeDef

update_queue

Updates a queue.

Type annotations and code completion for boto3.client("deadline").update_queue method. boto3 documentation

# update_queue method definition

def update_queue(
    self,
    *,
    farmId: str,
    queueId: str,
    clientToken: str = ...,
    displayName: str = ...,
    description: str = ...,
    defaultBudgetAction: DefaultQueueBudgetActionType = ...,  # (1)
    jobAttachmentSettings: JobAttachmentSettingsTypeDef = ...,  # (2)
    roleArn: str = ...,
    jobRunAsUser: JobRunAsUserTypeDef = ...,  # (3)
    requiredFileSystemLocationNamesToAdd: Sequence[str] = ...,
    requiredFileSystemLocationNamesToRemove: Sequence[str] = ...,
    allowedStorageProfileIdsToAdd: Sequence[str] = ...,
    allowedStorageProfileIdsToRemove: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...

1. See DefaultQueueBudgetActionType
2. See JobAttachmentSettingsTypeDef
3. See JobRunAsUserTypeDef

# update_queue method usage example with argument unpacking

kwargs: UpdateQueueRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
}

parent.update_queue(**kwargs)

1. See UpdateQueueRequestTypeDef

update_queue_environment

Updates the queue environment.

Type annotations and code completion for boto3.client("deadline").update_queue_environment method. boto3 documentation

# update_queue_environment method definition

def update_queue_environment(
    self,
    *,
    farmId: str,
    queueId: str,
    queueEnvironmentId: str,
    clientToken: str = ...,
    priority: int = ...,
    templateType: EnvironmentTemplateTypeType = ...,  # (1)
    template: str = ...,
) -> Dict[str, Any]:
    ...

1. See EnvironmentTemplateTypeType

# update_queue_environment method usage example with argument unpacking

kwargs: UpdateQueueEnvironmentRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "queueEnvironmentId": ...,
}

parent.update_queue_environment(**kwargs)

1. See UpdateQueueEnvironmentRequestTypeDef

update_queue_fleet_association

Updates a queue-fleet association.

Type annotations and code completion for boto3.client("deadline").update_queue_fleet_association method. boto3 documentation

# update_queue_fleet_association method definition

def update_queue_fleet_association(
    self,
    *,
    farmId: str,
    queueId: str,
    fleetId: str,
    status: UpdateQueueFleetAssociationStatusType,  # (1)
) -> Dict[str, Any]:
    ...

1. See UpdateQueueFleetAssociationStatusType

# update_queue_fleet_association method usage example with argument unpacking

kwargs: UpdateQueueFleetAssociationRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "fleetId": ...,
    "status": ...,
}

parent.update_queue_fleet_association(**kwargs)

1. See UpdateQueueFleetAssociationRequestTypeDef

update_queue_limit_association

Updates the status of the queue.

Type annotations and code completion for boto3.client("deadline").update_queue_limit_association method. boto3 documentation

# update_queue_limit_association method definition

def update_queue_limit_association(
    self,
    *,
    farmId: str,
    queueId: str,
    limitId: str,
    status: UpdateQueueLimitAssociationStatusType,  # (1)
) -> Dict[str, Any]:
    ...

1. See UpdateQueueLimitAssociationStatusType

# update_queue_limit_association method usage example with argument unpacking

kwargs: UpdateQueueLimitAssociationRequestTypeDef = {  # (1)
    "farmId": ...,
    "queueId": ...,
    "limitId": ...,
    "status": ...,
}

parent.update_queue_limit_association(**kwargs)

1. See UpdateQueueLimitAssociationRequestTypeDef

update_session

Updates a session.

Type annotations and code completion for boto3.client("deadline").update_session method. boto3 documentation

# update_session method definition

def update_session(
    self,
    *,
    targetLifecycleStatus: SessionLifecycleTargetStatusType,  # (1)
    farmId: str,
    queueId: str,
    jobId: str,
    sessionId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See SessionLifecycleTargetStatusType

# update_session method usage example with argument unpacking

kwargs: UpdateSessionRequestTypeDef = {  # (1)
    "targetLifecycleStatus": ...,
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "sessionId": ...,
}

parent.update_session(**kwargs)

1. See UpdateSessionRequestTypeDef

update_step

Updates a step.

Type annotations and code completion for boto3.client("deadline").update_step method. boto3 documentation

# update_step method definition

def update_step(
    self,
    *,
    targetTaskRunStatus: StepTargetTaskRunStatusType,  # (1)
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See StepTargetTaskRunStatusType

# update_step method usage example with argument unpacking

kwargs: UpdateStepRequestTypeDef = {  # (1)
    "targetTaskRunStatus": ...,
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "stepId": ...,
}

parent.update_step(**kwargs)

1. See UpdateStepRequestTypeDef

update_storage_profile

Updates a storage profile.

Type annotations and code completion for boto3.client("deadline").update_storage_profile method. boto3 documentation

# update_storage_profile method definition

def update_storage_profile(
    self,
    *,
    farmId: str,
    storageProfileId: str,
    clientToken: str = ...,
    displayName: str = ...,
    osFamily: StorageProfileOperatingSystemFamilyType = ...,  # (1)
    fileSystemLocationsToAdd: Sequence[FileSystemLocationTypeDef] = ...,  # (2)
    fileSystemLocationsToRemove: Sequence[FileSystemLocationTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See StorageProfileOperatingSystemFamilyType
2. See FileSystemLocationTypeDef
3. See FileSystemLocationTypeDef

# update_storage_profile method usage example with argument unpacking

kwargs: UpdateStorageProfileRequestTypeDef = {  # (1)
    "farmId": ...,
    "storageProfileId": ...,
}

parent.update_storage_profile(**kwargs)

1. See UpdateStorageProfileRequestTypeDef

update_task

Updates a task.

Type annotations and code completion for boto3.client("deadline").update_task method. boto3 documentation

# update_task method definition

def update_task(
    self,
    *,
    targetRunStatus: TaskTargetRunStatusType,  # (1)
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    taskId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See TaskTargetRunStatusType

# update_task method usage example with argument unpacking

kwargs: UpdateTaskRequestTypeDef = {  # (1)
    "targetRunStatus": ...,
    "farmId": ...,
    "queueId": ...,
    "jobId": ...,
    "stepId": ...,
    "taskId": ...,
}

parent.update_task(**kwargs)

1. See UpdateTaskRequestTypeDef

update_worker

Updates a worker.

Type annotations and code completion for boto3.client("deadline").update_worker method. boto3 documentation

# update_worker method definition

def update_worker(
    self,
    *,
    farmId: str,
    fleetId: str,
    workerId: str,
    status: UpdatedWorkerStatusType = ...,  # (1)
    capabilities: WorkerCapabilitiesTypeDef = ...,  # (2)
    hostProperties: HostPropertiesRequestTypeDef = ...,  # (3)
) -> UpdateWorkerResponseTypeDef:  # (4)
    ...

1. See UpdatedWorkerStatusType
2. See WorkerCapabilitiesTypeDef
3. See HostPropertiesRequestTypeDef
4. See UpdateWorkerResponseTypeDef

# update_worker method usage example with argument unpacking

kwargs: UpdateWorkerRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "workerId": ...,
}

parent.update_worker(**kwargs)

1. See UpdateWorkerRequestTypeDef

update_worker_schedule

Updates the schedule for a worker.

Type annotations and code completion for boto3.client("deadline").update_worker_schedule method. boto3 documentation

# update_worker_schedule method definition

def update_worker_schedule(
    self,
    *,
    farmId: str,
    fleetId: str,
    workerId: str,
    updatedSessionActions: Mapping[str, UpdatedSessionActionInfoTypeDef] = ...,  # (1)
) -> UpdateWorkerScheduleResponseTypeDef:  # (2)
    ...

1. See UpdatedSessionActionInfoTypeDef
2. See UpdateWorkerScheduleResponseTypeDef

# update_worker_schedule method usage example with argument unpacking

kwargs: UpdateWorkerScheduleRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "workerId": ...,
}

parent.update_worker_schedule(**kwargs)

1. See UpdateWorkerScheduleRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("deadline").get_paginator method with overloads.

• client.get_paginator("get_sessions_statistics_aggregation") -> GetSessionsStatisticsAggregationPaginator
• client.get_paginator("list_available_metered_products") -> ListAvailableMeteredProductsPaginator
• client.get_paginator("list_budgets") -> ListBudgetsPaginator
• client.get_paginator("list_farm_members") -> ListFarmMembersPaginator
• client.get_paginator("list_farms") -> ListFarmsPaginator
• client.get_paginator("list_fleet_members") -> ListFleetMembersPaginator
• client.get_paginator("list_fleets") -> ListFleetsPaginator
• client.get_paginator("list_job_members") -> ListJobMembersPaginator
• client.get_paginator("list_job_parameter_definitions") -> ListJobParameterDefinitionsPaginator
• client.get_paginator("list_jobs") -> ListJobsPaginator
• client.get_paginator("list_license_endpoints") -> ListLicenseEndpointsPaginator
• client.get_paginator("list_limits") -> ListLimitsPaginator
• client.get_paginator("list_metered_products") -> ListMeteredProductsPaginator
• client.get_paginator("list_monitors") -> ListMonitorsPaginator
• client.get_paginator("list_queue_environments") -> ListQueueEnvironmentsPaginator
• client.get_paginator("list_queue_fleet_associations") -> ListQueueFleetAssociationsPaginator
• client.get_paginator("list_queue_limit_associations") -> ListQueueLimitAssociationsPaginator
• client.get_paginator("list_queue_members") -> ListQueueMembersPaginator
• client.get_paginator("list_queues") -> ListQueuesPaginator
• client.get_paginator("list_session_actions") -> ListSessionActionsPaginator
• client.get_paginator("list_sessions_for_worker") -> ListSessionsForWorkerPaginator
• client.get_paginator("list_sessions") -> ListSessionsPaginator
• client.get_paginator("list_step_consumers") -> ListStepConsumersPaginator
• client.get_paginator("list_step_dependencies") -> ListStepDependenciesPaginator
• client.get_paginator("list_steps") -> ListStepsPaginator
• client.get_paginator("list_storage_profiles_for_queue") -> ListStorageProfilesForQueuePaginator
• client.get_paginator("list_storage_profiles") -> ListStorageProfilesPaginator
• client.get_paginator("list_tasks") -> ListTasksPaginator
• client.get_paginator("list_workers") -> ListWorkersPaginator

get_waiter

Type annotations and code completion for boto3.client("deadline").get_waiter method with overloads.

• client.get_waiter("fleet_active") -> FleetActiveWaiter
• client.get_waiter("job_create_complete") -> JobCreateCompleteWaiter
• client.get_waiter("license_endpoint_deleted") -> LicenseEndpointDeletedWaiter
• client.get_waiter("license_endpoint_valid") -> LicenseEndpointValidWaiter
• client.get_waiter("queue_fleet_association_stopped") -> QueueFleetAssociationStoppedWaiter
• client.get_waiter("queue_limit_association_stopped") -> QueueLimitAssociationStoppedWaiter
• client.get_waiter("queue_scheduling_blocked") -> QueueSchedulingBlockedWaiter
• client.get_waiter("queue_scheduling") -> QueueSchedulingWaiter