Deadline

associate_member_to_farm(farm_id, identity_store_id, membership_level, principal_id, principal_type)
associate_member_to_farm(farm_id, identity_store_id, membership_level, principal_id, principal_type, params::Dict{String,<:Any})

Assigns a farm membership level to a member.

Arguments

• farm_id: The ID of the farm to associate with the member.
• identity_store_id: The identity store ID of the member to associate with the farm.
• membership_level: The principal's membership level for the associated farm.
• principal_id: The member's principal ID to associate with the farm.
• principal_type: The principal type of the member to associate with the farm.

associate_member_to_fleet(farm_id, fleet_id, identity_store_id, membership_level, principal_id, principal_type)
associate_member_to_fleet(farm_id, fleet_id, identity_store_id, membership_level, principal_id, principal_type, params::Dict{String,<:Any})

Assigns a fleet membership level to a member.

Arguments

• farm_id: The farm ID of the fleet to associate with the member.
• fleet_id: The ID of the fleet to associate with a member.
• identity_store_id: The member's identity store ID to associate with the fleet.
• membership_level: The principal's membership level for the associated fleet.
• principal_id: The member's principal ID to associate with a fleet.
• principal_type: The member's principal type to associate with the fleet.

associate_member_to_job(farm_id, identity_store_id, job_id, membership_level, principal_id, principal_type, queue_id)
associate_member_to_job(farm_id, identity_store_id, job_id, membership_level, principal_id, principal_type, queue_id, params::Dict{String,<:Any})

Assigns a job membership level to a member

Arguments

• farm_id: The farm ID of the job to associate with the member.
• identity_store_id: The member's identity store ID to associate with the job.
• job_id: The job ID to associate with the member.
• membership_level: The principal's membership level for the associated job.
• principal_id: The member's principal ID to associate with the job.
• principal_type: The member's principal type to associate with the job.
• queue_id: The queue ID to associate to the member.

associate_member_to_queue(farm_id, identity_store_id, membership_level, principal_id, principal_type, queue_id)
associate_member_to_queue(farm_id, identity_store_id, membership_level, principal_id, principal_type, queue_id, params::Dict{String,<:Any})

Assigns a queue membership level to a member

Arguments

• farm_id: The farm ID of the queue to associate with the member.
• identity_store_id: The member's identity store ID to associate with the queue.
• membership_level: The principal's membership level for the associated queue.
• principal_id: The member's principal ID to associate with the queue.
• principal_type: The member's principal type to associate with the queue.
• queue_id: The ID of the queue to associate to the member.

assume_fleet_role_for_read(farm_id, fleet_id)
assume_fleet_role_for_read(farm_id, fleet_id, params::Dict{String,<:Any})

Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.

Arguments

• farm_id: The farm ID for the fleet's farm.
• fleet_id: The fleet ID.

assume_fleet_role_for_worker(farm_id, fleet_id, worker_id)
assume_fleet_role_for_worker(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})

Get credentials from the fleet role for a worker.

Arguments

• farm_id: The farm ID for the fleet's farm.
• fleet_id: The fleet ID that contains the worker.
• worker_id: The ID of the worker assuming the fleet role.

assume_queue_role_for_read(farm_id, queue_id)
assume_queue_role_for_read(farm_id, queue_id, params::Dict{String,<:Any})

Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.

Arguments

• farm_id: The farm ID of the farm containing the queue.
• queue_id: The queue ID.

assume_queue_role_for_user(farm_id, queue_id)
assume_queue_role_for_user(farm_id, queue_id, params::Dict{String,<:Any})

Allows a user to assume a role for a queue.

Arguments

• farm_id: The farm ID of the queue that the user assumes the role for.
• queue_id: The queue ID of the queue that the user assumes the role for.

assume_queue_role_for_worker(farm_id, fleet_id, queue_id, worker_id)
assume_queue_role_for_worker(farm_id, fleet_id, queue_id, worker_id, params::Dict{String,<:Any})

Allows a worker to assume a queue role.

Arguments

• farm_id: The farm ID of the worker assuming the queue role.
• fleet_id: The fleet ID of the worker assuming the queue role.
• queue_id: The queue ID of the worker assuming the queue role.
• worker_id: The worker ID of the worker assuming the queue role.

batch_get_job_entity(farm_id, fleet_id, identifiers, worker_id)
batch_get_job_entity(farm_id, fleet_id, identifiers, worker_id, params::Dict{String,<:Any})

Get batched job details for a worker.

Arguments

• farm_id: The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
• fleet_id: The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
• identifiers: The job identifiers to include within the job entity batch details.
• worker_id: The worker ID of the worker containing the job details to get.

copy_job_template(farm_id, job_id, queue_id, target_s3_location)
copy_job_template(farm_id, job_id, queue_id, target_s3_location, params::Dict{String,<:Any})

Copies a job template to an Amazon S3 bucket.

Arguments

• farm_id: The farm ID to copy.
• job_id: The job ID to copy.
• queue_id: The queue ID to copy.
• target_s3_location: The Amazon S3 bucket name and key where you would like to add a copy of the job template.

create_budget(actions, approximate_dollar_limit, display_name, farm_id, schedule, usage_tracking_resource)
create_budget(actions, approximate_dollar_limit, display_name, farm_id, schedule, usage_tracking_resource, params::Dict{String,<:Any})

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

Arguments

• actions: The budget actions to specify what happens when the budget runs out.
• approximate_dollar_limit: The dollar limit based on consumed usage.
• display_name: The display name of the budget.
• farm_id: The farm ID to include in this budget.
• schedule: The schedule to associate with this budget.
• usage_tracking_resource: The queue ID provided to this budget to track usage.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "description": The description of the budget.

create_farm(display_name)
create_farm(display_name, params::Dict{String,<:Any})

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

Arguments

• display_name: The display name of the farm.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "description": The description of the farm.
• "kmsKeyArn": The ARN of the KMS key to use on the farm.
• "tags": The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

create_fleet(configuration, display_name, farm_id, max_worker_count, role_arn)
create_fleet(configuration, display_name, farm_id, max_worker_count, role_arn, params::Dict{String,<:Any})

Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.

Arguments

• configuration: The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.
• display_name: The display name of the fleet.
• farm_id: The farm ID of the farm to connect to the fleet.
• max_worker_count: The maximum number of workers for the fleet.
• role_arn: The IAM role ARN for the role that the fleet's workers will use.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "description": The description of the fleet.
• "minWorkerCount": The minimum number of workers for the fleet.
• "tags": Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

create_job(farm_id, priority, queue_id, template, template_type)
create_job(farm_id, priority, queue_id, template, template_type, params::Dict{String,<:Any})

Creates a job. A job is a render submission submitted by a user. It contains specific job properties outlined as steps and tasks.

Arguments

• farm_id: The farm ID of the farm to connect to the job.
• priority: The priority of the job on a scale of 1 to 100. The highest priority is 1.
• queue_id: The ID of the queue that the job is submitted to.
• template: The job template to use for this job.
• template_type: The file type for the job template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "attachments": The attachments for the job. Attach files required for the job to run to a render job.
• "maxFailedTasksCount": The number of task failures before the job stops running and is marked as FAILED.
• "maxRetriesPerTask": The maximum number of retries for a job.
• "parameters": The parameters for the job.
• "storageProfileId": The storage profile ID for the storage profile to connect to the job.
• "targetTaskRunStatus": The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

create_license_endpoint(security_group_ids, subnet_ids, vpc_id)
create_license_endpoint(security_group_ids, subnet_ids, vpc_id, params::Dict{String,<:Any})

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

Arguments

• security_group_ids: The security group IDs.
• subnet_ids: The subnet IDs.
• vpc_id: The VPC (virtual private cloud) ID to use with the license endpoint.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "tags": Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

create_monitor(display_name, identity_center_instance_arn, role_arn, subdomain)
create_monitor(display_name, identity_center_instance_arn, role_arn, subdomain, params::Dict{String,<:Any})

Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.

Arguments

• display_name: The name that you give the monitor that is displayed in the Deadline Cloud console.
• identity_center_instance_arn: The Amazon Resource Name (ARN) of the IAM Identity Center instance that authenticates monitor users.
• role_arn: The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.
• subdomain: The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.

create_queue(display_name, farm_id)
create_queue(display_name, farm_id, params::Dict{String,<:Any})

Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.

Arguments

• display_name: The display name of the queue.
• farm_id: The farm ID of the farm to connect to the queue.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "allowedStorageProfileIds": The storage profile IDs to include in the queue.
• "defaultBudgetAction": The default action to take on a queue if a budget isn't configured.
• "description": The description of the queue.
• "jobAttachmentSettings": The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.
• "jobRunAsUser": The jobs in the queue run as the specified POSIX user.
• "requiredFileSystemLocationNames": The file system location name to include in the queue.
• "roleArn": The IAM role ARN that workers will use while running jobs for this queue.
• "tags": Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

create_queue_environment(farm_id, priority, queue_id, template, template_type)
create_queue_environment(farm_id, priority, queue_id, template, template_type, params::Dict{String,<:Any})

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

Arguments

• farm_id: The farm ID of the farm to connect to the environment.
• priority: Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority. If two environments share the same priority value, the environment created first takes higher priority.
• queue_id: The queue ID to connect the queue and environment.
• template: The environment template to use in the queue.
• template_type: The template's file type, JSON or YAML.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.

create_queue_fleet_association(farm_id, fleet_id, queue_id)
create_queue_fleet_association(farm_id, fleet_id, queue_id, params::Dict{String,<:Any})

Creates an association between a queue and a fleet.

Arguments

• farm_id: The ID of the farm that the queue and fleet belong to.
• fleet_id: The fleet ID.
• queue_id: The queue ID.

create_storage_profile(display_name, farm_id, os_family)
create_storage_profile(display_name, farm_id, os_family, params::Dict{String,<:Any})

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

Arguments

• display_name: The display name of the storage profile.
• farm_id: The farm ID of the farm to connect to the storage profile.
• os_family: The type of operating system (OS) for the storage profile.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "fileSystemLocations": File system paths to include in the storage profile.

create_worker(farm_id, fleet_id)
create_worker(farm_id, fleet_id, params::Dict{String,<:Any})

Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.

Arguments

• farm_id: The farm ID of the farm to connect to the worker.
• fleet_id: The fleet ID to connect to the worker.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "hostProperties": The IP address and host name of the worker.

delete_budget(budget_id, farm_id)
delete_budget(budget_id, farm_id, params::Dict{String,<:Any})

Deletes a budget.

Arguments

• budget_id: The budget ID of the budget to delete.
• farm_id: The farm ID of the farm to remove from the budget.

delete_farm(farm_id)
delete_farm(farm_id, params::Dict{String,<:Any})

Deletes a farm.

Arguments

• farm_id: The farm ID of the farm to delete.

delete_fleet(farm_id, fleet_id)
delete_fleet(farm_id, fleet_id, params::Dict{String,<:Any})

Deletes a fleet.

Arguments

• farm_id: The farm ID of the farm to remove from the fleet.
• fleet_id: The fleet ID of the fleet to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.

delete_license_endpoint(license_endpoint_id)
delete_license_endpoint(license_endpoint_id, params::Dict{String,<:Any})

Deletes a license endpoint.

Arguments

• license_endpoint_id: The license endpoint ID of the license endpoint to delete.

delete_metered_product(license_endpoint_id, product_id)
delete_metered_product(license_endpoint_id, product_id, params::Dict{String,<:Any})

Deletes a metered product.

Arguments

• license_endpoint_id: The ID of the license endpoint from which to remove the metered product.
• product_id: The product ID to remove from the license endpoint.

delete_monitor(monitor_id)
delete_monitor(monitor_id, params::Dict{String,<:Any})

Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.

Arguments

• monitor_id: The unique identifier of the monitor to delete. This ID is returned by the CreateMonitor operation, and is included in the response to the GetMonitor operation.

delete_queue(farm_id, queue_id)
delete_queue(farm_id, queue_id, params::Dict{String,<:Any})

Deletes a queue.

Arguments

• farm_id: The ID of the farm from which to remove the queue.
• queue_id: The queue ID of the queue to delete.

delete_queue_environment(farm_id, queue_environment_id, queue_id)
delete_queue_environment(farm_id, queue_environment_id, queue_id, params::Dict{String,<:Any})

Deletes a queue environment.

Arguments

• farm_id: The farm ID of the farm from which to remove the queue environment.
• queue_environment_id: The queue environment ID of the queue environment to delete.
• queue_id: The queue ID of the queue environment to delete.

delete_queue_fleet_association(farm_id, fleet_id, queue_id)
delete_queue_fleet_association(farm_id, fleet_id, queue_id, params::Dict{String,<:Any})

Deletes a queue-fleet association.

Arguments

• farm_id: The farm ID of the farm that holds the queue-fleet association.
• fleet_id: The fleet ID of the queue-fleet association.
• queue_id: The queue ID of the queue-fleet association.

delete_storage_profile(farm_id, storage_profile_id)
delete_storage_profile(farm_id, storage_profile_id, params::Dict{String,<:Any})

Deletes a storage profile.

Arguments

• farm_id: The farm ID of the farm from which to remove the storage profile.
• storage_profile_id: The storage profile ID of the storage profile to delete.

delete_worker(farm_id, fleet_id, worker_id)
delete_worker(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})

Deletes a worker.

Arguments

• farm_id: The farm ID of the worker to delete.
• fleet_id: The fleet ID of the worker to delete.
• worker_id: The worker ID of the worker to delete.

disassociate_member_from_farm(farm_id, principal_id)
disassociate_member_from_farm(farm_id, principal_id, params::Dict{String,<:Any})

Disassociates a member from a farm.

Arguments

• farm_id: The farm ID of the farm to disassociate from the member.
• principal_id: A member's principal ID to disassociate from a farm.

disassociate_member_from_fleet(farm_id, fleet_id, principal_id)
disassociate_member_from_fleet(farm_id, fleet_id, principal_id, params::Dict{String,<:Any})

Disassociates a member from a fleet.

Arguments

• farm_id: The farm ID of the fleet to disassociate a member from.
• fleet_id: The fleet ID of the fleet to from which to disassociate a member.
• principal_id: A member's principal ID to disassociate from a fleet.

disassociate_member_from_job(farm_id, job_id, principal_id, queue_id)
disassociate_member_from_job(farm_id, job_id, principal_id, queue_id, params::Dict{String,<:Any})

Disassociates a member from a job.

Arguments

• farm_id: The farm ID for the job to disassociate from the member.
• job_id: The job ID to disassociate from a member in a job.
• principal_id: A member's principal ID to disassociate from a job.
• queue_id: The queue ID connected to a job for which you're disassociating a member.

disassociate_member_from_queue(farm_id, principal_id, queue_id)
disassociate_member_from_queue(farm_id, principal_id, queue_id, params::Dict{String,<:Any})

Disassociates a member from a queue.

Arguments

• farm_id: The farm ID for the queue to disassociate from a member.
• principal_id: A member's principal ID to disassociate from a queue.
• queue_id: The queue ID of the queue in which you're disassociating from a member.

get_budget(budget_id, farm_id)
get_budget(budget_id, farm_id, params::Dict{String,<:Any})

Get a budget.

Arguments

• budget_id: The budget ID.
• farm_id: The farm ID of the farm connected to the budget.

get_farm(farm_id)
get_farm(farm_id, params::Dict{String,<:Any})

Get a farm.

Arguments

• farm_id: The farm ID of the farm.

get_fleet(farm_id, fleet_id)
get_fleet(farm_id, fleet_id, params::Dict{String,<:Any})

Get a fleet.

Arguments

• farm_id: The farm ID of the farm in the fleet.
• fleet_id: The fleet ID of the fleet to get.

get_job(farm_id, job_id, queue_id)
get_job(farm_id, job_id, queue_id, params::Dict{String,<:Any})

Gets a Deadline Cloud job.

Arguments

• farm_id: The farm ID of the farm in the job.
• job_id: The job ID.
• queue_id: The queue ID associated with the job.

get_license_endpoint(license_endpoint_id)
get_license_endpoint(license_endpoint_id, params::Dict{String,<:Any})

Gets a licence endpoint.

Arguments

• license_endpoint_id: The license endpoint ID.

get_monitor(monitor_id)
get_monitor(monitor_id, params::Dict{String,<:Any})

Gets information about the specified monitor.

Arguments

• monitor_id: The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.

get_queue(farm_id, queue_id)
get_queue(farm_id, queue_id, params::Dict{String,<:Any})

Gets a queue.

Arguments

• farm_id: The farm ID of the farm in the queue.
• queue_id: The queue ID for the queue to retrieve.

get_queue_environment(farm_id, queue_environment_id, queue_id)
get_queue_environment(farm_id, queue_environment_id, queue_id, params::Dict{String,<:Any})

Gets a queue environment.

Arguments

• farm_id: The farm ID for the queue environment.
• queue_environment_id: The queue environment ID.
• queue_id: The queue ID for the queue environment.

get_queue_fleet_association(farm_id, fleet_id, queue_id)
get_queue_fleet_association(farm_id, fleet_id, queue_id, params::Dict{String,<:Any})

Gets a queue-fleet association.

Arguments

• farm_id: The farm ID of the farm that contains the queue-fleet association.
• fleet_id: The fleet ID for the queue-fleet association.
• queue_id: The queue ID for the queue-fleet association.

get_session(farm_id, job_id, queue_id, session_id)
get_session(farm_id, job_id, queue_id, session_id, params::Dict{String,<:Any})

Gets a session.

Arguments

• farm_id: The farm ID for the session.
• job_id: The job ID for the session.
• queue_id: The queue ID for the session.
• session_id: The session ID.

get_session_action(farm_id, job_id, queue_id, session_action_id)
get_session_action(farm_id, job_id, queue_id, session_action_id, params::Dict{String,<:Any})

Gets a session action for the job.

Arguments

• farm_id: The farm ID for the session action.
• job_id: The job ID for the session.
• queue_id: The queue ID for the session action.
• session_action_id: The session action ID for the session.

get_sessions_statistics_aggregation(aggregation_id, farm_id)
get_sessions_statistics_aggregation(aggregation_id, farm_id, params::Dict{String,<:Any})

Gets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

Arguments

• aggregation_id: The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.
• farm_id: The identifier of the farm to include in the statistics. This should be the same as the farm ID used in the call to the StartSessionsStatisticsAggregation operation.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

get_step(farm_id, job_id, queue_id, step_id)
get_step(farm_id, job_id, queue_id, step_id, params::Dict{String,<:Any})

Gets a step.

Arguments

• farm_id: The farm ID for the step.
• job_id: The job ID for the step.
• queue_id: The queue ID for the step.
• step_id: The step ID.

get_storage_profile(farm_id, storage_profile_id)
get_storage_profile(farm_id, storage_profile_id, params::Dict{String,<:Any})

Gets a storage profile.

Arguments

• farm_id: The farm ID for the storage profile.
• storage_profile_id: The storage profile ID.

get_storage_profile_for_queue(farm_id, queue_id, storage_profile_id)
get_storage_profile_for_queue(farm_id, queue_id, storage_profile_id, params::Dict{String,<:Any})

Gets a storage profile for a queue.

Arguments

• farm_id: The farm ID for the queue in storage profile.
• queue_id: The queue ID the queue in the storage profile.
• storage_profile_id: The storage profile ID for the storage profile in the queue.

get_task(farm_id, job_id, queue_id, step_id, task_id)
get_task(farm_id, job_id, queue_id, step_id, task_id, params::Dict{String,<:Any})

Gets a task.

Arguments

• farm_id: The farm ID of the farm connected to the task.
• job_id: The job ID of the job connected to the task.
• queue_id: The queue ID for the queue connected to the task.
• step_id: The step ID for the step connected to the task.
• task_id: The task ID.

get_worker(farm_id, fleet_id, worker_id)
get_worker(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})

Gets a worker.

Arguments

• farm_id: The farm ID for the worker.
• fleet_id: The fleet ID of the worker.
• worker_id: The worker ID.

list_available_metered_products()
list_available_metered_products(params::Dict{String,<:Any})

A list of the available metered products.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_budgets(farm_id)
list_budgets(farm_id, params::Dict{String,<:Any})

A list of budgets in a farm.

Arguments

• farm_id: The farm ID associated with the budgets.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.
• "status": The status to list for the budgets.

list_farm_members(farm_id)
list_farm_members(farm_id, params::Dict{String,<:Any})

Lists the members of a farm.

Arguments

• farm_id: The farm ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_farms()
list_farms(params::Dict{String,<:Any})

Lists farms.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.
• "principalId": The principal ID of the member to list on the farm.

list_fleet_members(farm_id, fleet_id)
list_fleet_members(farm_id, fleet_id, params::Dict{String,<:Any})

Lists fleet members.

Arguments

• farm_id: The farm ID of the fleet.
• fleet_id: The fleet ID to include on the list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_fleets(farm_id)
list_fleets(farm_id, params::Dict{String,<:Any})

Lists fleets.

Arguments

• farm_id: The farm ID of the fleets.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "displayName": The display names of a list of fleets.
• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.
• "principalId": The principal ID of the members to include in the fleet.
• "status": The status of the fleet.

list_job_members(farm_id, job_id, queue_id)
list_job_members(farm_id, job_id, queue_id, params::Dict{String,<:Any})

Lists members on a job.

Arguments

• farm_id: The farm ID of the job to list.
• job_id: The job ID to include on the list.
• queue_id: The queue ID to include on the list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_jobs(farm_id, queue_id)
list_jobs(farm_id, queue_id, params::Dict{String,<:Any})

Lists jobs.

Arguments

• farm_id: The farm ID for the jobs.
• queue_id: The queue ID for the job.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.
• "principalId": The principal ID of the members on the jobs.

list_license_endpoints()
list_license_endpoints(params::Dict{String,<:Any})

Lists license endpoints.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_metered_products(license_endpoint_id)
list_metered_products(license_endpoint_id, params::Dict{String,<:Any})

Lists metered products.

Arguments

• license_endpoint_id: The license endpoint ID to include on the list of metered products.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_monitors()
list_monitors(params::Dict{String,<:Any})

Gets a list of your monitors in Deadline Cloud.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_queue_environments(farm_id, queue_id)
list_queue_environments(farm_id, queue_id, params::Dict{String,<:Any})

Lists queue environments.

Arguments

• farm_id: The farm ID for the queue environment list.
• queue_id: The queue ID for the queue environment list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_queue_fleet_associations(farm_id)
list_queue_fleet_associations(farm_id, params::Dict{String,<:Any})

Lists queue-fleet associations.

Arguments

• farm_id: The farm ID for the queue-fleet association list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "fleetId": The fleet ID for the queue-fleet association list.
• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.
• "queueId": The queue ID for the queue-fleet association list.

list_queue_members(farm_id, queue_id)
list_queue_members(farm_id, queue_id, params::Dict{String,<:Any})

Lists the members in a queue.

Arguments

• farm_id: The farm ID for the queue.
• queue_id: The queue ID to include on the list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_queues(farm_id)
list_queues(farm_id, params::Dict{String,<:Any})

Lists queues.

Arguments

• farm_id: The farm ID of the queue.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.
• "principalId": The principal ID. This filter is only valid when using Nimble Studio credentials and should match the user ID in the credentials of the caller.
• "status": The status of the queues listed. ACTIVE–The queues are active. SCHEDULING–The queues are scheduling. SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.

list_session_actions(farm_id, job_id, queue_id)
list_session_actions(farm_id, job_id, queue_id, params::Dict{String,<:Any})

Lists session actions.

Arguments

• farm_id: The farm ID for the session actions list.
• job_id: The job ID for the session actions list.
• queue_id: The queue ID for the session actions list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.
• "sessionId": The session ID to include on the sessions action list.
• "taskId": The task ID for the session actions list.

list_sessions(farm_id, job_id, queue_id)
list_sessions(farm_id, job_id, queue_id, params::Dict{String,<:Any})

Lists sessions.

Arguments

• farm_id: The farm ID for the list of sessions.
• job_id: The job ID for the list of sessions.
• queue_id: The queue ID for the list of sessions

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_sessions_for_worker(farm_id, fleet_id, worker_id)
list_sessions_for_worker(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})

Lists sessions for a worker.

Arguments

• farm_id: The farm ID for the session.
• fleet_id: The fleet ID for the session.
• worker_id: The worker ID for the session.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_step_consumers(farm_id, job_id, queue_id, step_id)
list_step_consumers(farm_id, job_id, queue_id, step_id, params::Dict{String,<:Any})

Lists step consumers.

Arguments

• farm_id: The farm ID for the list of step consumers.
• job_id: The job ID for the step consumer.
• queue_id: The queue ID for the step consumer.
• step_id: The step ID to include on the list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_step_dependencies(farm_id, job_id, queue_id, step_id)
list_step_dependencies(farm_id, job_id, queue_id, step_id, params::Dict{String,<:Any})

Lists the dependencies for a step.

Arguments

• farm_id: The farm ID for the step dependencies list.
• job_id: The job ID for the step dependencies list.
• queue_id: The queue ID for the step dependencies list.
• step_id: The step ID to include on the list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_steps(farm_id, job_id, queue_id)
list_steps(farm_id, job_id, queue_id, params::Dict{String,<:Any})

Lists steps for a job.

Arguments

• farm_id: The farm ID to include on the list of steps.
• job_id: The job ID to include on the list of steps.
• queue_id: The queue ID to include on the list of steps.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_storage_profiles(farm_id)
list_storage_profiles(farm_id, params::Dict{String,<:Any})

Lists storage profiles.

Arguments

• farm_id: The farm ID of the storage profile.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_storage_profiles_for_queue(farm_id, queue_id)
list_storage_profiles_for_queue(farm_id, queue_id, params::Dict{String,<:Any})

Lists storage profiles for a queue.

Arguments

• farm_id: The farm ID of the queue's storage profile.
• queue_id: The queue ID for the storage profile.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists tags for a resource.

Arguments

• resource_arn: The resource ARN to list tags for.

list_tasks(farm_id, job_id, queue_id, step_id)
list_tasks(farm_id, job_id, queue_id, step_id, params::Dict{String,<:Any})

Lists tasks for a job.

Arguments

• farm_id: The farm ID connected to the tasks.
• job_id: The job ID for the tasks.
• queue_id: The queue ID connected to the tasks.
• step_id: The step ID for the tasks.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

list_workers(farm_id, fleet_id)
list_workers(farm_id, fleet_id, params::Dict{String,<:Any})

Lists workers.

Arguments

• farm_id: The farm ID connected to the workers.
• fleet_id: The fleet ID of the workers.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• "nextToken": The token for the next set of results, or null to start from the beginning.

put_metered_product(license_endpoint_id, product_id)
put_metered_product(license_endpoint_id, product_id, params::Dict{String,<:Any})

Adds a metered product.

Arguments

• license_endpoint_id: The license endpoint ID to add to the metered product.
• product_id: The product ID to add to the metered product.

search_jobs(farm_id, item_offset, queue_ids)
search_jobs(farm_id, item_offset, queue_ids, params::Dict{String,<:Any})

Searches for jobs.

Arguments

• farm_id: The farm ID of the job.
• item_offset: Defines how far into the scrollable list to start the return of results.
• queue_ids: The queue ID to use in the job search.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filterExpressions": The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
• "pageSize": Specifies the number of items per page for the resource.
• "sortExpressions": The search terms for a resource.

search_steps(farm_id, item_offset, queue_ids)
search_steps(farm_id, item_offset, queue_ids, params::Dict{String,<:Any})

Searches for steps.

Arguments

• farm_id: The farm ID to use for the step search.
• item_offset: Defines how far into the scrollable list to start the return of results.
• queue_ids: The queue IDs in the step search.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filterExpressions": The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
• "jobId": The job ID to use in the step search.
• "pageSize": Specifies the number of items per page for the resource.
• "sortExpressions": The search terms for a resource.

search_tasks(farm_id, item_offset, queue_ids)
search_tasks(farm_id, item_offset, queue_ids, params::Dict{String,<:Any})

Searches for tasks.

Arguments

• farm_id: The farm ID of the task.
• item_offset: Defines how far into the scrollable list to start the return of results.
• queue_ids: The queue IDs to include in the search.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filterExpressions": The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
• "jobId": The job ID for the task search.
• "pageSize": Specifies the number of items per page for the resource.
• "sortExpressions": The search terms for a resource.

search_workers(farm_id, fleet_ids, item_offset)
search_workers(farm_id, fleet_ids, item_offset, params::Dict{String,<:Any})

Searches for workers.

Arguments

• farm_id: The farm ID in the workers search.
• fleet_ids: The fleet ID of the workers to search for.
• item_offset: Defines how far into the scrollable list to start the return of results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filterExpressions": The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
• "pageSize": Specifies the number of items per page for the resource.
• "sortExpressions": The search terms for a resource.

start_sessions_statistics_aggregation(end_time, farm_id, group_by, resource_ids, start_time, statistics)
start_sessions_statistics_aggregation(end_time, farm_id, group_by, resource_ids, start_time, statistics, params::Dict{String,<:Any})

Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

Arguments

• end_time: The Linux timestamp of the date and time that the statistics end.
• farm_id: The identifier of the farm that contains queues or fleets to return statistics for.
• group_by: The field to use to group the statistics.
• resource_ids: A list of fleet IDs or queue IDs to gather statistics for.
• start_time: The Linux timestamp of the date and time that the statistics start.
• statistics: One to four statistics to return.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "period": The period to aggregate the statistics.
• "timezone": The timezone to use for the statistics. Use UTC notation such as "UTC+8."

tag_resource(resource_arn)
tag_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

• resource_arn: The ARN of the resource to apply tags to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "tags": Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

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

Arguments

• resource_arn: The ARN of the resource to remove the tag from.
• tag_keys: They keys of the tag.

update_budget(budget_id, farm_id)
update_budget(budget_id, farm_id, params::Dict{String,<:Any})

Updates a budget that sets spending thresholds for rendering activity.

Arguments

• budget_id: The budget ID to update.
• farm_id: The farm ID of the budget to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "actionsToAdd": The budget actions to add. Budget actions specify what happens when the budget runs out.
• "actionsToRemove": The budget actions to remove from the budget.
• "approximateDollarLimit": The dollar limit to update on the budget. Based on consumed usage.
• "description": The description of the budget to update.
• "displayName": The display name of the budget to update.
• "schedule": The schedule to update.
• "status": Updates the status of the budget. ACTIVE–The budget is being evaluated. INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

update_farm(farm_id)
update_farm(farm_id, params::Dict{String,<:Any})

Updates a farm.

Arguments

• farm_id: The farm ID to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The description of the farm to update.
• "displayName": The display name of the farm to update.

update_fleet(farm_id, fleet_id)
update_fleet(farm_id, fleet_id, params::Dict{String,<:Any})

Updates a fleet.

Arguments

• farm_id: The farm ID to update.
• fleet_id: The fleet ID to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "configuration": The fleet configuration to update.
• "description": The description of the fleet to update.
• "displayName": The display name of the fleet to update.
• "maxWorkerCount": The maximum number of workers in the fleet.
• "minWorkerCount": The minimum number of workers in the fleet.
• "roleArn": The IAM role ARN that the fleet's workers assume while running jobs.

update_job(farm_id, job_id, queue_id)
update_job(farm_id, job_id, queue_id, params::Dict{String,<:Any})

Updates a job.

Arguments

• farm_id: The farm ID of the job to update.
• job_id: The job ID to update.
• queue_id: The queue ID of the job to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "lifecycleStatus": The status of a job in its lifecycle.
• "maxFailedTasksCount": The number of task failures before the job stops running and is marked as FAILED.
• "maxRetriesPerTask": The maximum number of retries for a job.
• "priority": The job priority to update.
• "targetTaskRunStatus": The task status to update the job's tasks to.

update_monitor(monitor_id)
update_monitor(monitor_id, params::Dict{String,<:Any})

Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.

Arguments

• monitor_id: The unique identifier of the monitor to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "displayName": The new value to use for the monitor's display name.
• "roleArn": The Amazon Resource Name (ARN) of the new IAM role to use with the monitor.
• "subdomain": The new value of the subdomain to use when forming the monitor URL.

update_queue(farm_id, queue_id)
update_queue(farm_id, queue_id, params::Dict{String,<:Any})

Updates a queue.

Arguments

• farm_id: The farm ID to update in the queue.
• queue_id: The queue ID to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The idempotency token to update in the queue.
• "allowedStorageProfileIdsToAdd": The storage profile IDs to add.
• "allowedStorageProfileIdsToRemove": The storage profile ID to remove.
• "defaultBudgetAction": The default action to take for a queue update if a budget isn't configured.
• "description": The description of the queue to update.
• "displayName": The display name of the queue to update.
• "jobAttachmentSettings": The job attachment settings to update for the queue.
• "jobRunAsUser": Update the jobs in the queue to run as a specified POSIX user.
• "requiredFileSystemLocationNamesToAdd": The required file system location names to add to the queue.
• "requiredFileSystemLocationNamesToRemove": The required file system location names to remove from the queue.
• "roleArn": The IAM role ARN that's used to run jobs from this queue.

update_queue_environment(farm_id, queue_environment_id, queue_id)
update_queue_environment(farm_id, queue_environment_id, queue_id, params::Dict{String,<:Any})

Updates the queue environment.

Arguments

• farm_id: The farm ID of the queue environment to update.
• queue_environment_id: The queue environment ID to update.
• queue_id: The queue ID of the queue environment to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "priority": The priority to update.
• "template": The template to update.
• "templateType": The template type to update.

update_queue_fleet_association(farm_id, fleet_id, queue_id, status)
update_queue_fleet_association(farm_id, fleet_id, queue_id, status, params::Dict{String,<:Any})

Updates a queue-fleet association.

Arguments

• farm_id: The farm ID to update.
• fleet_id: The fleet ID to update.
• queue_id: The queue ID to update.
• status: The status to update.

update_session(farm_id, job_id, queue_id, session_id, target_lifecycle_status)
update_session(farm_id, job_id, queue_id, session_id, target_lifecycle_status, params::Dict{String,<:Any})

Updates a session.

Arguments

• farm_id: The farm ID to update in the session.
• job_id: The job ID to update in the session.
• queue_id: The queue ID to update in the session.
• session_id: The session ID to update.
• target_lifecycle_status: The life cycle status to update in the session.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.

update_step(farm_id, job_id, queue_id, step_id, target_task_run_status)
update_step(farm_id, job_id, queue_id, step_id, target_task_run_status, params::Dict{String,<:Any})

Updates a step.

Arguments

• farm_id: The farm ID to update.
• job_id: The job ID to update.
• queue_id: The queue ID to update.
• step_id: The step ID to update.
• target_task_run_status: The task status to update the step's tasks to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.

update_storage_profile(farm_id, storage_profile_id)
update_storage_profile(farm_id, storage_profile_id, params::Dict{String,<:Any})

Updates a storage profile.

Arguments

• farm_id: The farm ID to update.
• storage_profile_id: The storage profile ID to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.
• "displayName": The display name of the storage profile to update.
• "fileSystemLocationsToAdd": The file system location names to add.
• "fileSystemLocationsToRemove": The file system location names to remove.
• "osFamily": The OS system to update.

update_task(farm_id, job_id, queue_id, step_id, target_run_status, task_id)
update_task(farm_id, job_id, queue_id, step_id, target_run_status, task_id, params::Dict{String,<:Any})

Updates a task.

Arguments

• farm_id: The farm ID to update.
• job_id: The job ID to update.
• queue_id: The queue ID to update.
• step_id: The step ID to update.
• target_run_status: The run status with which to start the task.
• task_id: The task ID to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "X-Amz-Client-Token": The unique token which the server uses to recognize retries of the same request.

update_worker(farm_id, fleet_id, worker_id)
update_worker(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})

Updates a worker.

Arguments

• farm_id: The farm ID to update.
• fleet_id: The fleet ID to update.
• worker_id: The worker ID to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "capabilities": The worker capabilities to update.
• "hostProperties": The host properties to update.
• "status": The worker status to update.

update_worker_schedule(farm_id, fleet_id, worker_id)
update_worker_schedule(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})

Updates the schedule for a worker.

Arguments

• farm_id: The farm ID to update.
• fleet_id: The fleet ID to update.
• worker_id: The worker ID to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "updatedSessionActions": The session actions associated with the worker schedule to update.